Merge pull request #43 from molgenis/feat/readDepth

Add <,>,<=,>= operators

src/__tests__/index.test.ts

@@ -242,6 +242,114 @@ test('get - one record with invalid selector', async () => {
   await expect(api.getRecords(params)).rejects.toThrow("value '10042538' is of type 'number' instead of 'object'");
 });
 
+test('get - records with greater than query', async () => {
+  const params: Params = {
+    query: {
+      selector: ['n', 'n_number2'],
+      operator: '>',
+      args: 0,
+    },
+  };
+  const records = await api.getRecords(params);
+  expect(records).toEqual({
+    items: [record0],
+    page: { number: 0, size: 10, totalElements: 1 },
+    total: 32,
+  });
+});
+
+test('get - records with greater than or equal query', async () => {
+  const params: Params = {
+    query: {
+      selector: ['n', 'n_number2'],
+      operator: '>=',
+      args: 1,
+    },
+  };
+  const records = await api.getRecords(params);
+  expect(records).toEqual({
+    items: [record0],
+    page: { number: 0, size: 10, totalElements: 1 },
+    total: 32,
+  });
+});
+
+test('get - records with less than query', async () => {
+  const params: Params = {
+    query: {
+      selector: ['n', 'n_number2'],
+      operator: '<',
+      args: 1,
+    },
+  };
+  const records = await api.getRecords(params);
+  expect(records).toEqual({
+    items: [record1],
+    page: { number: 0, size: 10, totalElements: 1 },
+    total: 32,
+  });
+});
+
+test('get - records with less than or equal query', async () => {
+  const params: Params = {
+    query: {
+      selector: ['n', 'n_number2'],
+      operator: '<=',
+      args: 1,
+    },
+  };
+  const records = await api.getRecords(params);
+  expect(records).toEqual({
+    items: [record0, record1],
+    page: { number: 0, size: 10, totalElements: 2 },
+    total: 32,
+  });
+});
+
+test('get - records with less than or equal query invalid field', async () => {
+  const params: Params = {
+    query: {
+      selector: ['n', 'n_string0'],
+      operator: '<=',
+      args: 1,
+    },
+  };
+  await expect(api.getRecords(params)).rejects.toThrow("value 'a' is of type 'string' instead of 'number'");
+});
+
+test('get - one record with invalid selector', async () => {
+  const params: Params = {
+    query: {
+      selector: ['p', 'x', 'y', 'z'],
+      operator: '==',
+      args: 10042538,
+    },
+  };
+  await expect(api.getRecords(params)).rejects.toThrow("value '10042538' is of type 'number' instead of 'object'");
+});
+
+test('get - one record with invalid selector', async () => {
+  const params: Params = {
+    query: {
+      selector: ['p', 'x', 'y', 'z'],
+      operator: '==',
+      args: 10042538,
+    },
+  };
+  await expect(api.getRecords(params)).rejects.toThrow("value '10042538' is of type 'number' instead of 'object'");
+});
+
+test('get - one record with invalid selector', async () => {
+  const params: Params = {
+    query: {
+      selector: ['p', 'x', 'y', 'z'],
+      operator: '==',
+      args: 10042538,
+    },
+  };
+  await expect(api.getRecords(params)).rejects.toThrow("value '10042538' is of type 'number' instead of 'object'");
+});
+
 test('get - one record using composed and query', async () => {
   const params: Params = {
     query: {

src/index.ts

@@ -116,7 +116,7 @@ export interface ComposedQuery {
 }
 
 export interface Query {
-  operator: '==' | '!=' | 'in' | '!in' | 'has_any' | '!has_any' | 'any_has_any' | '!any_has_any';
+  operator: '==' | '!=' | 'in' | '!in' | 'has_any' | '!has_any' | 'any_has_any' | '!any_has_any' | '>' | '>=' | '<' | '<=';
   selector: Selector;
   args: string | number | boolean | string[] | number[];
 }
@@ -356,6 +356,18 @@ function matches(query: Query | ComposedQuery, resource: Resource): boolean {
       case '!in':
         match = !matchesIn(query, resource);
         break;
+      case '>':
+        match = matchesGreaterThan(query, resource);
+        break;
+      case '>=':
+        match = matchesGreaterThanOrEqual(query, resource);
+        break;
+      case '<':
+        match = matchesLesserThan(query, resource);
+        break;
+      case '<=':
+        match = matchesLesserThanOrEqual(query, resource);
+        break;
       default:
         throw new Error('unexpected query operator ' + query.operator);
     }
@@ -427,6 +439,62 @@ function matchesHasAny(query: Query, resource: Resource): boolean {
   return match;
 }
 
+function matchesGreaterThan(query: Query, resource: Resource): boolean {
+  const value: any = select(query.selector, resource);
+
+  if (value === undefined || value === null) {
+    return false;
+  }
+
+  if (typeof value !== 'number') {
+    throw new Error(`value '${value}' is of type '${typeof value}' instead of 'number'`);
+  }
+
+  return value > query.args;
+}
+
+function matchesGreaterThanOrEqual(query: Query, resource: Resource): boolean {
+  const value: any = select(query.selector, resource);
+
+  if (value === undefined || value === null) {
+    return false;
+  }
+
+  if (typeof value !== 'number') {
+    throw new Error(`value '${value}' is of type '${typeof value}' instead of 'number'`);
+  }
+
+  return value >= query.args;
+}
+
+function matchesLesserThan(query: Query, resource: Resource): boolean {
+  const value: any = select(query.selector, resource);
+
+  if (value === undefined || value === null) {
+    return false;
+  }
+
+  if (typeof value !== 'number') {
+    throw new Error(`value '${value}' is of type '${typeof value}' instead of 'number'`);
+  }
+
+  return value < query.args;
+}
+
+function matchesLesserThanOrEqual(query: Query, resource: Resource): boolean {
+  const value: any = select(query.selector, resource);
+
+  if (value === undefined || value === null) {
+    return false;
+  }
+
+  if (typeof value !== 'number') {
+    throw new Error(`value '${value}' is of type '${typeof value}' instead of 'number'`);
+  }
+
+  return value <= query.args;
+}
+
 function select(selector: Selector, resource: Resource) {
   let parts: SelectorPart[];
   if (Array.isArray(selector)) {