@feathersjs/adapter-commons 5.0.0-pre.6 → 5.0.0

package/src/sort.ts

@@ -1,110 +1,130 @@
 // Sorting algorithm taken from NeDB (https://github.com/louischatriot/nedb)
 // See https://github.com/louischatriot/nedb/blob/e3f0078499aa1005a59d0c2372e425ab789145c1/lib/model.js#L189
 
-export function compareNSB (a: any, b: any) {
-  if (a < b) { return -1; }
-  if (a > b) { return 1; }
-  return 0;
+export function compareNSB(a: any, b: any) {
+  if (a < b) {
+    return -1
+  }
+  if (a > b) {
+    return 1
+  }
+  return 0
 }
 
-export function compareArrays (a: any, b: any) {
-  let i;
-  let comp;
-
-  for (i = 0; i < Math.min(a.length, b.length); i += 1) {
-    comp = exports.compare(a[i], b[i]);
+export function compareArrays(a: any[], b: any[]) {
+  for (let i = 0, l = Math.min(a.length, b.length); i < l; i++) {
+    const comparison = compare(a[i], b[i])
 
-    if (comp !== 0) { return comp; }
+    if (comparison !== 0) {
+      return comparison
+    }
   }
 
   // Common section was identical, longest one wins
-  return exports.compareNSB(a.length, b.length);
+  return compareNSB(a.length, b.length)
 }
 
-export function compare (a: any, b: any, compareStrings: any = exports.compareNSB) {
-  const { compareNSB, compare, compareArrays } = exports;
+export function compare(a: any, b: any, compareStrings: any = compareNSB): 0 | 1 | -1 {
+  if (a === b) {
+    return 0
+  }
 
   // undefined
-  if (a === undefined) { return b === undefined ? 0 : -1; }
-  if (b === undefined) { return a === undefined ? 0 : 1; }
+  if (a === undefined) {
+    return -1
+  }
+  if (b === undefined) {
+    return 1
+  }
 
   // null
-  if (a === null) { return b === null ? 0 : -1; }
-  if (b === null) { return a === null ? 0 : 1; }
+  if (a === null) {
+    return -1
+  }
+  if (b === null) {
+    return 1
+  }
 
   // Numbers
-  if (typeof a === 'number') { return typeof b === 'number' ? compareNSB(a, b) : -1; }
-  if (typeof b === 'number') { return typeof a === 'number' ? compareNSB(a, b) : 1; }
+  if (typeof a === 'number') {
+    return typeof b === 'number' ? compareNSB(a, b) : -1
+  }
+  if (typeof b === 'number') {
+    return 1
+  }
 
   // Strings
-  if (typeof a === 'string') { return typeof b === 'string' ? compareStrings(a, b) : -1; }
-  if (typeof b === 'string') { return typeof a === 'string' ? compareStrings(a, b) : 1; }
+  if (typeof a === 'string') {
+    return typeof b === 'string' ? compareStrings(a, b) : -1
+  }
+  if (typeof b === 'string') {
+    return 1
+  }
 
   // Booleans
-  if (typeof a === 'boolean') { return typeof b === 'boolean' ? compareNSB(a, b) : -1; }
-  if (typeof b === 'boolean') { return typeof a === 'boolean' ? compareNSB(a, b) : 1; }
+  if (typeof a === 'boolean') {
+    return typeof b === 'boolean' ? compareNSB(a, b) : -1
+  }
+  if (typeof b === 'boolean') {
+    return 1
+  }
 
   // Dates
-  if (a instanceof Date) { return b instanceof Date ? compareNSB(a.getTime(), b.getTime()) : -1; }
-  if (b instanceof Date) { return a instanceof Date ? compareNSB(a.getTime(), b.getTime()) : 1; }
+  if (a instanceof Date) {
+    return b instanceof Date ? compareNSB(a.getTime(), b.getTime()) : -1
+  }
+  if (b instanceof Date) {
+    return 1
+  }
 
   // Arrays (first element is most significant and so on)
-  if (Array.isArray(a)) { return Array.isArray(b) ? compareArrays(a, b) : -1; }
-  if (Array.isArray(b)) { return Array.isArray(a) ? compareArrays(a, b) : 1; }
+  if (Array.isArray(a)) {
+    return Array.isArray(b) ? compareArrays(a, b) : -1
+  }
+  if (Array.isArray(b)) {
+    return 1
+  }
 
   // Objects
-  const aKeys = Object.keys(a).sort();
-  const bKeys = Object.keys(b).sort();
-  let comp = 0;
+  const aKeys = Object.keys(a).sort()
+  const bKeys = Object.keys(b).sort()
 
-  for (let i = 0; i < Math.min(aKeys.length, bKeys.length); i += 1) {
-    comp = compare(a[aKeys[i]], b[bKeys[i]]);
+  for (let i = 0, l = Math.min(aKeys.length, bKeys.length); i < l; i++) {
+    const comparison = compare(a[aKeys[i]], b[bKeys[i]])
 
-    if (comp !== 0) { return comp; }
+    if (comparison !== 0) {
+      return comparison
+    }
   }
 
-  return compareNSB(aKeys.length, bKeys.length);
+  return compareNSB(aKeys.length, bKeys.length)
 }
 
 // An in-memory sorting function according to the
 // $sort special query parameter
-export function sorter ($sort: any) {
-  let sortLevels = false; // True if $sort has tags with '.' i.e. '{a: 1, b: -1, "c.x.z": 1}'
-
-  const getVal = (a: any, sortKeys: any[]) => {
-    let keys = sortKeys.map(key => key);
-    let val = a;
-    do {
-      let key = keys.shift();
-      val = val[key];
-    } while (keys.length);
-  
-    return val;
-  };
-  
-    const criteria = Object.keys($sort).map(key => {
-      const direction = $sort[key];
-      const keys = key.split('.');
-      sortLevels = keys.length > 1;
-
-      return { keys, direction };
-    });
+export function sorter($sort: { [key: string]: -1 | 1 }) {
+  const get = (value: any, path: string[]) => path.reduce((value, key) => value[key], value)
 
-  return function (a: any, b: any) {
-    let compare;
+  const compares = Object.keys($sort).map((key) => {
+    const direction = $sort[key]
+    const path = key.split('.')
 
-    for (const criterion of criteria) {
-    if (sortLevels) {
-      compare = criterion.direction * exports.compare(getVal(a, criterion.keys), getVal(b, criterion.keys));
+    if (path.length === 1) {
+      return (a: any, b: any) => direction * compare(a[key], b[key])
     } else {
-      compare = criterion.direction * exports.compare(a[criterion.keys[0]], b[criterion.keys[0]]);
+      return (a: any, b: any) => direction * compare(get(a, path), get(b, path))
     }
+  })
 
-      if (compare !== 0) {
-        return compare;
+  return function (a: any, b: any) {
+    for (const compare of compares) {
+      const comparasion = compare(a, b)
+
+      if (comparasion !== 0) {
+        return comparasion
       }
     }
 
-    return 0;
-  };
+    return 0
+  }
 }

package/lib/filter-query.d.ts

@@ -1,10 +0,0 @@
-export declare const FILTERS: {
-    $sort: (value: any) => any;
-    $limit: (value: any, options: any) => any;
-    $skip: (value: any) => number;
-    $select: (value: any) => any;
-};
-export declare const OPERATORS: string[];
-export declare function filterQuery(query: any, options?: any): {
-    [key: string]: any;
-};

package/lib/filter-query.js

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterQuery = exports.OPERATORS = exports.FILTERS = void 0;
-const commons_1 = require("@feathersjs/commons");
-const errors_1 = require("@feathersjs/errors");
-function parse(number) {
-    if (typeof number !== 'undefined') {
-        return Math.abs(parseInt(number, 10));
-    }
-    return undefined;
-}
-// Returns the pagination limit and will take into account the
-// default and max pagination settings
-function getLimit(limit, paginate) {
-    if (paginate && (paginate.default || paginate.max)) {
-        const base = paginate.default || 0;
-        const lower = typeof limit === 'number' && !isNaN(limit) ? limit : base;
-        const upper = typeof paginate.max === 'number' ? paginate.max : Number.MAX_VALUE;
-        return Math.min(lower, upper);
-    }
-    return limit;
-}
-// Makes sure that $sort order is always converted to an actual number
-function convertSort(sort) {
-    if (typeof sort !== 'object' || Array.isArray(sort)) {
-        return sort;
-    }
-    return Object.keys(sort).reduce((result, key) => {
-        result[key] = typeof sort[key] === 'object'
-            ? sort[key] : parseInt(sort[key], 10);
-        return result;
-    }, {});
-}
-function cleanQuery(query, operators, filters) {
-    if (Array.isArray(query)) {
-        return query.map(value => cleanQuery(value, operators, filters));
-    }
-    else if (commons_1._.isObject(query) && query.constructor === {}.constructor) {
-        const result = {};
-        commons_1._.each(query, (value, key) => {
-            if (key[0] === '$') {
-                if (filters[key] !== undefined) {
-                    return;
-                }
-                if (!operators.includes(key)) {
-                    throw new errors_1.BadRequest(`Invalid query parameter ${key}`, query);
-                }
-            }
-            result[key] = cleanQuery(value, operators, filters);
-        });
-        Object.getOwnPropertySymbols(query).forEach(symbol => {
-            // @ts-ignore
-            result[symbol] = query[symbol];
-        });
-        return result;
-    }
-    return query;
-}
-function assignFilters(object, query, filters, options) {
-    if (Array.isArray(filters)) {
-        commons_1._.each(filters, (key) => {
-            if (query[key] !== undefined) {
-                object[key] = query[key];
-            }
-        });
-    }
-    else {
-        commons_1._.each(filters, (converter, key) => {
-            const converted = converter(query[key], options);
-            if (converted !== undefined) {
-                object[key] = converted;
-            }
-        });
-    }
-    return object;
-}
-exports.FILTERS = {
-    $sort: (value) => convertSort(value),
-    $limit: (value, options) => getLimit(parse(value), options.paginate),
-    $skip: (value) => parse(value),
-    $select: (value) => value
-};
-exports.OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or'];
-// Converts Feathers special query parameters and pagination settings
-// and returns them separately a `filters` and the rest of the query
-// as `query`
-function filterQuery(query, options = {}) {
-    const { filters: additionalFilters = {}, operators: additionalOperators = [] } = options;
-    const result = {};
-    result.filters = assignFilters({}, query, exports.FILTERS, options);
-    result.filters = assignFilters(result.filters, query, additionalFilters, options);
-    result.query = cleanQuery(query, exports.OPERATORS.concat(additionalOperators), result.filters);
-    return result;
-}
-exports.filterQuery = filterQuery;
-//# sourceMappingURL=filter-query.js.map

package/lib/filter-query.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"filter-query.js","sourceRoot":"","sources":["../src/filter-query.ts"],"names":[],"mappings":";;;AAAA,iDAAwC;AACxC,+CAAgD;AAEhD,SAAS,KAAK,CAAE,MAAW;IACzB,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;KACvC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,8DAA8D;AAC9D,sCAAsC;AACtC,SAAS,QAAQ,CAAE,KAAU,EAAE,QAAa;IAC1C,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE;QAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;QACnC,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QACxE,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;QAEjF,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;KAC/B;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,sEAAsE;AACtE,SAAS,WAAW,CAAE,IAAS;IAC7B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACnD,OAAO,IAAI,CAAC;KACb;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC9C,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ;YACzC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC;QAExC,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAA+B,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,UAAU,CAAE,KAAU,EAAE,SAAc,EAAE,OAAY;IAC3D,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC;KAClE;SAAM,IAAI,WAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,EAAE;QACpE,MAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,WAAC,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC3B,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;gBAClB,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;oBAC9B,OAAO;iBACR;gBAED,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;oBAC5B,MAAM,IAAI,mBAAU,CAAC,2BAA2B,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;iBAC/D;aACF;YAED,MAAM,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACnD,aAAa;YACb,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;KACf;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAE,MAAW,EAAE,KAAU,EAAE,OAAY,EAAE,OAAY;IACzE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC1B,WAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YACtB,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC,CAAC;KACJ;SAAM;QACL,WAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,EAAE;YACjC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;YAEjD,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;aACzB;QACH,CAAC,CAAC,CAAC;KACJ;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,KAAK,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC;IACzC,MAAM,EAAE,CAAC,KAAU,EAAE,OAAY,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC;IAC9E,KAAK,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;IACnC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK;CAC/B,CAAC;AAEW,QAAA,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAErF,qEAAqE;AACrE,oEAAoE;AACpE,aAAa;AACb,SAAgB,WAAW,CAAE,KAAU,EAAE,UAAe,EAAE;IACxD,MAAM,EACJ,OAAO,EAAE,iBAAiB,GAAG,EAAE,EAC/B,SAAS,EAAE,mBAAmB,GAAG,EAAE,EACpC,GAAG,OAAO,CAAC;IACZ,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,eAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAElF,MAAM,CAAC,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,iBAAS,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAExF,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,kCAaC"}

package/src/filter-query.ts

@@ -1,116 +0,0 @@
-import { _ } from '@feathersjs/commons';
-import { BadRequest } from '@feathersjs/errors';
-
-function parse (number: any) {
-  if (typeof number !== 'undefined') {
-    return Math.abs(parseInt(number, 10));
-  }
-
-  return undefined;
-}
-
-// Returns the pagination limit and will take into account the
-// default and max pagination settings
-function getLimit (limit: any, paginate: any) {
-  if (paginate && (paginate.default || paginate.max)) {
-    const base = paginate.default || 0;
-    const lower = typeof limit === 'number' && !isNaN(limit) ? limit : base;
-    const upper = typeof paginate.max === 'number' ? paginate.max : Number.MAX_VALUE;
-
-    return Math.min(lower, upper);
-  }
-
-  return limit;
-}
-
-// Makes sure that $sort order is always converted to an actual number
-function convertSort (sort: any) {
-  if (typeof sort !== 'object' || Array.isArray(sort)) {
-    return sort;
-  }
-
-  return Object.keys(sort).reduce((result, key) => {
-    result[key] = typeof sort[key] === 'object'
-      ? sort[key] : parseInt(sort[key], 10);
-
-    return result;
-  }, {} as { [key: string]: number });
-}
-
-function cleanQuery (query: any, operators: any, filters: any): any {
-  if (Array.isArray(query)) {
-    return query.map(value => cleanQuery(value, operators, filters));
-  } else if (_.isObject(query) && query.constructor === {}.constructor) {
-    const result: { [key: string]: any } = {};
-
-    _.each(query, (value, key) => {
-      if (key[0] === '$') {
-        if (filters[key] !== undefined) {
-          return;
-        }
-
-        if (!operators.includes(key)) {
-          throw new BadRequest(`Invalid query parameter ${key}`, query);
-        }
-      }
-
-      result[key] = cleanQuery(value, operators, filters);
-    });
-
-    Object.getOwnPropertySymbols(query).forEach(symbol => {
-      // @ts-ignore
-      result[symbol] = query[symbol];
-    });
-
-    return result;
-  }
-
-  return query;
-}
-
-function assignFilters (object: any, query: any, filters: any, options: any) {
-  if (Array.isArray(filters)) {
-    _.each(filters, (key) => {
-      if (query[key] !== undefined) {
-        object[key] = query[key];
-      }
-    });
-  } else {
-    _.each(filters, (converter, key) => {
-      const converted = converter(query[key], options);
-
-      if (converted !== undefined) {
-        object[key] = converted;
-      }
-    });
-  }
-
-  return object;
-}
-
-export const FILTERS = {
-  $sort: (value: any) => convertSort(value),
-  $limit: (value: any, options: any) => getLimit(parse(value), options.paginate),
-  $skip: (value: any) => parse(value),
-  $select: (value: any) => value
-};
-
-export const OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or'];
-
-// Converts Feathers special query parameters and pagination settings
-// and returns them separately a `filters` and the rest of the query
-// as `query`
-export function filterQuery (query: any, options: any = {}) {
-  const {
-    filters: additionalFilters = {},
-    operators: additionalOperators = []
-  } = options;
-  const result: { [key: string]: any } = {};
-
-  result.filters = assignFilters({}, query, FILTERS, options);
-  result.filters = assignFilters(result.filters, query, additionalFilters, options);
-
-  result.query = cleanQuery(query, OPERATORS.concat(additionalOperators), result.filters);
-
-  return result;
-}