Merge pull request #80 from molgenis/feat/sortByPath

Sort on path instead of metadata

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@molgenis/vip-report-api",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "TypeScript Report API for Variant Call Format (VCF) Report Templates",
   "scripts": {
     "build": "tsc --build",

src/Api.d.ts

@@ -1,5 +1,4 @@
 import { Metadata as RecordMetadata, Record } from "@molgenis/vip-report-vcf/src/Vcf";
-import { FieldMetadata } from "@molgenis/vip-report-vcf/src/MetadataParser";
 
 export interface Api {
   getRecordsMeta(): Promise<RecordMetadata>;
@@ -39,7 +38,7 @@ export interface Params {
 }
 
 export interface SortOrder {
-  property: string | FieldMetadata;
+  property: string | string[];
   compare?: "asc" | "desc" | CompareFn;
 }
 

src/ApiClient.ts

@@ -21,7 +21,6 @@ import {
   SortOrder,
 } from "./Api";
 import { Metadata as RecordMetadata, Record } from "@molgenis/vip-report-vcf/src/Vcf";
-import { FieldMetadata, NestedFieldMetadata } from "@molgenis/vip-report-vcf/src/MetadataParser";
 import { compareAsc, compareDesc } from "./compare";
 
 export interface ReportData {
@@ -231,43 +230,8 @@ function getCompareFn(sortOrder: SortOrder): CompareFn {
   return compareFn;
 }
 
-class UnknownFieldError extends Error {
-  constructor(fieldId: string, path: Path) {
-    super(`unknown field '${fieldId}' in path '[${path.join(",")}]'`);
-    this.name = "UnknownFieldError";
-  }
-}
-
 type Path = (string | number)[];
 
-function getPath(property: string | FieldMetadata): Path {
-  if (typeof property === "string") {
-    return [property];
-  }
-
-  const path = [];
-  let field: FieldMetadata = property;
-  do {
-    const parent = field.parent;
-    if (parent && parent.number.count !== 1) {
-      const index = (parent.nested as NestedFieldMetadata).items.findIndex((item) => field.id === item.id);
-      if (index === -1) {
-        throw new UnknownFieldError(field.id, path);
-      }
-      path.push(index);
-    } else {
-      path.push(field.id);
-    }
-
-    if (parent) field = parent;
-    else break;
-  } while (true);
-  path.push("n");
-  path.reverse();
-
-  return path;
-}
-
 function getValue(item: Item<Resource>, path: Path): CompareValue {
   let value: unknown = item.data;
   for (const token of path) {
@@ -289,7 +253,7 @@ function sort<T extends Resource>(resources: Item<T>[], sortOrders: SortOrder[])
   resources.sort((a, b) => {
     let val = 0;
     for (const sortOrder of sortOrders) {
-      const path = getPath(sortOrder.property);
+      const path = typeof sortOrder.property === "string" ? [sortOrder.property] : sortOrder.property;
       const valueA = getValue(a, path);
       const valueB = getValue(b, path);