@feathersjs/adapter-commons 5.0.0-pre.2 → 5.0.0-pre.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/sort.js CHANGED
@@ -14,77 +14,76 @@ function compareNSB(a, b) {
14
14
  }
15
15
  exports.compareNSB = compareNSB;
16
16
  function compareArrays(a, b) {
17
- let i;
18
- let comp;
19
- for (i = 0; i < Math.min(a.length, b.length); i += 1) {
20
- comp = exports.compare(a[i], b[i]);
21
- if (comp !== 0) {
22
- return comp;
17
+ for (let i = 0, l = Math.min(a.length, b.length); i < l; i++) {
18
+ const comparison = compare(a[i], b[i]);
19
+ if (comparison !== 0) {
20
+ return comparison;
23
21
  }
24
22
  }
25
23
  // Common section was identical, longest one wins
26
- return exports.compareNSB(a.length, b.length);
24
+ return compareNSB(a.length, b.length);
27
25
  }
28
26
  exports.compareArrays = compareArrays;
29
- function compare(a, b, compareStrings = exports.compareNSB) {
30
- const { compareNSB, compare, compareArrays } = exports;
27
+ function compare(a, b, compareStrings = compareNSB) {
28
+ if (a === b) {
29
+ return 0;
30
+ }
31
31
  // undefined
32
32
  if (a === undefined) {
33
- return b === undefined ? 0 : -1;
33
+ return -1;
34
34
  }
35
35
  if (b === undefined) {
36
- return a === undefined ? 0 : 1;
36
+ return 1;
37
37
  }
38
38
  // null
39
39
  if (a === null) {
40
- return b === null ? 0 : -1;
40
+ return -1;
41
41
  }
42
42
  if (b === null) {
43
- return a === null ? 0 : 1;
43
+ return 1;
44
44
  }
45
45
  // Numbers
46
46
  if (typeof a === 'number') {
47
47
  return typeof b === 'number' ? compareNSB(a, b) : -1;
48
48
  }
49
49
  if (typeof b === 'number') {
50
- return typeof a === 'number' ? compareNSB(a, b) : 1;
50
+ return 1;
51
51
  }
52
52
  // Strings
53
53
  if (typeof a === 'string') {
54
54
  return typeof b === 'string' ? compareStrings(a, b) : -1;
55
55
  }
56
56
  if (typeof b === 'string') {
57
- return typeof a === 'string' ? compareStrings(a, b) : 1;
57
+ return 1;
58
58
  }
59
59
  // Booleans
60
60
  if (typeof a === 'boolean') {
61
61
  return typeof b === 'boolean' ? compareNSB(a, b) : -1;
62
62
  }
63
63
  if (typeof b === 'boolean') {
64
- return typeof a === 'boolean' ? compareNSB(a, b) : 1;
64
+ return 1;
65
65
  }
66
66
  // Dates
67
67
  if (a instanceof Date) {
68
68
  return b instanceof Date ? compareNSB(a.getTime(), b.getTime()) : -1;
69
69
  }
70
70
  if (b instanceof Date) {
71
- return a instanceof Date ? compareNSB(a.getTime(), b.getTime()) : 1;
71
+ return 1;
72
72
  }
73
73
  // Arrays (first element is most significant and so on)
74
74
  if (Array.isArray(a)) {
75
75
  return Array.isArray(b) ? compareArrays(a, b) : -1;
76
76
  }
77
77
  if (Array.isArray(b)) {
78
- return Array.isArray(a) ? compareArrays(a, b) : 1;
78
+ return 1;
79
79
  }
80
80
  // Objects
81
81
  const aKeys = Object.keys(a).sort();
82
82
  const bKeys = Object.keys(b).sort();
83
- let comp = 0;
84
- for (let i = 0; i < Math.min(aKeys.length, bKeys.length); i += 1) {
85
- comp = compare(a[aKeys[i]], b[bKeys[i]]);
86
- if (comp !== 0) {
87
- return comp;
83
+ for (let i = 0, l = Math.min(aKeys.length, bKeys.length); i < l; i++) {
84
+ const comparison = compare(a[aKeys[i]], b[bKeys[i]]);
85
+ if (comparison !== 0) {
86
+ return comparison;
88
87
  }
89
88
  }
90
89
  return compareNSB(aKeys.length, bKeys.length);
@@ -93,33 +92,22 @@ exports.compare = compare;
93
92
  // An in-memory sorting function according to the
94
93
  // $sort special query parameter
95
94
  function sorter($sort) {
96
- let sortLevels = false; // True if $sort has tags with '.' i.e. '{a: 1, b: -1, "c.x.z": 1}'
97
- const getVal = (a, sortKeys) => {
98
- let keys = sortKeys.map(key => key);
99
- let val = a;
100
- do {
101
- let key = keys.shift();
102
- val = val[key];
103
- } while (keys.length);
104
- return val;
105
- };
106
- const criteria = Object.keys($sort).map(key => {
95
+ const get = (value, path) => path.reduce((value, key) => value[key], value);
96
+ const compares = Object.keys($sort).map(key => {
107
97
  const direction = $sort[key];
108
- const keys = key.split('.');
109
- sortLevels = keys.length > 1;
110
- return { keys, direction };
98
+ const path = key.split('.');
99
+ if (path.length === 1) {
100
+ return (a, b) => direction * compare(a[key], b[key]);
101
+ }
102
+ else {
103
+ return (a, b) => direction * compare(get(a, path), get(b, path));
104
+ }
111
105
  });
112
106
  return function (a, b) {
113
- let compare;
114
- for (const criterion of criteria) {
115
- if (sortLevels) {
116
- compare = criterion.direction * exports.compare(getVal(a, criterion.keys), getVal(b, criterion.keys));
117
- }
118
- else {
119
- compare = criterion.direction * exports.compare(a[criterion.keys[0]], b[criterion.keys[0]]);
120
- }
121
- if (compare !== 0) {
122
- return compare;
107
+ for (const compare of compares) {
108
+ const comparasion = compare(a, b);
109
+ if (comparasion !== 0) {
110
+ return comparasion;
123
111
  }
124
112
  }
125
113
  return 0;
package/lib/sort.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"sort.js","sourceRoot":"","sources":["../src/sort.ts"],"names":[],"mappings":";AAAA,4EAA4E;AAC5E,4GAA4G;;;AAE5G,SAAgB,UAAU,CAAE,CAAM,EAAE,CAAM;IACxC,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC;KAAE;IACzB,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IACxB,OAAO,CAAC,CAAC;AACX,CAAC;AAJD,gCAIC;AAED,SAAgB,aAAa,CAAE,CAAM,EAAE,CAAM;IAC3C,IAAI,CAAC,CAAC;IACN,IAAI,IAAI,CAAC;IAET,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QACpD,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEnC,IAAI,IAAI,KAAK,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;SAAE;KACjC;IAED,iDAAiD;IACjD,OAAO,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AAZD,sCAYC;AAED,SAAgB,OAAO,CAAE,CAAM,EAAE,CAAM,EAAE,iBAAsB,OAAO,CAAC,UAAU;IAC/E,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAEvD,YAAY;IACZ,IAAI,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACzD,IAAI,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAExD,OAAO;IACP,IAAI,CAAC,KAAK,IAAI,EAAE;QAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAC/C,IAAI,CAAC,KAAK,IAAI,EAAE;QAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAE9C,UAAU;IACV,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACpF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAEnF,UAAU;IACV,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACxF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAEvF,WAAW;IACX,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACtF,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAErF,QAAQ;IACR,IAAI,CAAC,YAAY,IAAI,EAAE;QAAE,OAAO,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAChG,IAAI,CAAC,YAAY,IAAI,EAAE;QAAE,OAAO,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAE/F,uDAAuD;IACvD,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAE5E,UAAU;IACV,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QAChE,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEzC,IAAI,IAAI,KAAK,CAAC,EAAE;YAAE,OAAO,IAAI,CAAC;SAAE;KACjC;IAED,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AA3CD,0BA2CC;AAED,iDAAiD;AACjD,gCAAgC;AAChC,SAAgB,MAAM,CAAE,KAAU;IAChC,IAAI,UAAU,GAAG,KAAK,CAAC,CAAC,mEAAmE;IAE3F,MAAM,MAAM,GAAG,CAAC,CAAM,EAAE,QAAe,EAAE,EAAE;QACzC,IAAI,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,GAAG;YACD,IAAI,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;YACvB,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;SAChB,QAAQ,IAAI,CAAC,MAAM,EAAE;QAEtB,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;IAEA,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QAC5C,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5B,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAE7B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEL,OAAO,UAAU,CAAM,EAAE,CAAM;QAC7B,IAAI,OAAO,CAAC;QAEZ,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE;YAClC,IAAI,UAAU,EAAE;gBACd,OAAO,GAAG,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;aACvG;iBAAM;gBACL,OAAO,GAAG,SAAS,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC7F;YAEC,IAAI,OAAO,KAAK,CAAC,EAAE;gBACjB,OAAO,OAAO,CAAC;aAChB;SACF;QAED,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;AACJ,CAAC;AAvCD,wBAuCC"}
1
+ {"version":3,"file":"sort.js","sourceRoot":"","sources":["../src/sort.ts"],"names":[],"mappings":";AAAA,4EAA4E;AAC5E,4GAA4G;;;AAE5G,SAAgB,UAAU,CAAE,CAAM,EAAE,CAAM;IACxC,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC;KAAE;IACzB,IAAI,CAAC,GAAG,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IACxB,OAAO,CAAC,CAAC;AACX,CAAC;AAJD,gCAIC;AAED,SAAgB,aAAa,CAAE,CAAQ,EAAE,CAAQ;IAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QAC5D,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvC,IAAI,UAAU,KAAK,CAAC,EAAE;YAAE,OAAO,UAAU,CAAC;SAAE;KAC7C;IAED,iDAAiD;IACjD,OAAO,UAAU,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AACxC,CAAC;AATD,sCASC;AAED,SAAgB,OAAO,CAAE,CAAM,EAAE,CAAM,EAAE,iBAAsB,UAAU;IACvE,IAAI,CAAC,KAAK,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAE1B,YAAY;IACZ,IAAI,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC;KAAE;IACnC,IAAI,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAElC,OAAO;IACP,IAAI,CAAC,KAAK,IAAI,EAAE;QAAE,OAAO,CAAC,CAAC,CAAC;KAAE;IAC9B,IAAI,CAAC,KAAK,IAAI,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAE7B,UAAU;IACV,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACpF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAExC,UAAU;IACV,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACxF,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAExC,WAAW;IACX,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,OAAO,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IACtF,IAAI,OAAO,CAAC,KAAK,SAAS,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAEzC,QAAQ;IACR,IAAI,CAAC,YAAY,IAAI,EAAE;QAAE,OAAO,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAChG,IAAI,CAAC,YAAY,IAAI,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAEpC,uDAAuD;IACvD,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAAE;IAC7E,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC;KAAE;IAEnC,UAAU;IACV,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAEpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QACpE,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAErD,IAAI,UAAU,KAAK,CAAC,EAAE;YAAE,OAAO,UAAU,CAAC;SAAE;KAC7C;IAED,OAAO,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AAChD,CAAC;AA1CD,0BA0CC;AAED,iDAAiD;AACjD,gCAAgC;AAChC,SAAgB,MAAM,CAAE,KAAgC;IACtD,MAAM,GAAG,GAAG,CAAC,KAAU,EAAE,IAAc,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;IAE3F,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QAC5C,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,OAAO,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;SAChE;aAAM;YACL,OAAO,CAAC,CAAM,EAAE,CAAM,EAAE,EAAE,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;SAC5E;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,UAAU,CAAM,EAAE,CAAM;QAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,MAAM,WAAW,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAElC,IAAI,WAAW,KAAK,CAAC,EAAE;gBAAE,OAAO,WAAW,CAAC;aAAE;SAC/C;QAED,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;AACJ,CAAC;AAvBD,wBAuBC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@feathersjs/adapter-commons",
3
- "version": "5.0.0-pre.2",
3
+ "version": "5.0.0-pre.22",
4
4
  "description": "Shared database adapter utility functions",
5
5
  "homepage": "https://feathersjs.com",
6
6
  "keywords": [
@@ -13,7 +13,8 @@
13
13
  },
14
14
  "repository": {
15
15
  "type": "git",
16
- "url": "git://github.com/feathersjs/databases.git"
16
+ "url": "git://github.com/feathersjs/feathers.git",
17
+ "directory": "packages/adapter-commons"
17
18
  },
18
19
  "author": {
19
20
  "name": "Feathers contributor",
@@ -22,7 +23,7 @@
22
23
  },
23
24
  "contributors": [],
24
25
  "bugs": {
25
- "url": "https://github.com/feathersjs/databases/issues"
26
+ "url": "https://github.com/feathersjs/feathers/issues"
26
27
  },
27
28
  "engines": {
28
29
  "node": ">= 12"
@@ -48,19 +49,19 @@
48
49
  "access": "public"
49
50
  },
50
51
  "dependencies": {
51
- "@feathersjs/commons": "^5.0.0-pre.2",
52
- "@feathersjs/errors": "^5.0.0-pre.2",
53
- "@feathersjs/feathers": "^5.0.0-pre.2"
52
+ "@feathersjs/commons": "^5.0.0-pre.22",
53
+ "@feathersjs/errors": "^5.0.0-pre.22",
54
+ "@feathersjs/feathers": "^5.0.0-pre.22"
54
55
  },
55
56
  "devDependencies": {
56
- "@types/mocha": "^8.2.2",
57
- "@types/mongodb": "^3.6.11",
58
- "@types/node": "^14.14.37",
59
- "mocha": "^8.3.2",
60
- "mongodb": "^3.6.5",
61
- "shx": "^0.3.3",
62
- "ts-node": "^9.1.1",
63
- "typescript": "^4.2.3"
57
+ "@types/mocha": "^9.1.1",
58
+ "@types/mongodb": "^4.0.6",
59
+ "@types/node": "^17.0.31",
60
+ "mocha": "^10.0.0",
61
+ "mongodb": "^4.5.0",
62
+ "shx": "^0.3.4",
63
+ "ts-node": "^10.7.0",
64
+ "typescript": "^4.6.4"
64
65
  },
65
- "gitHead": "6e1f888dc5b612d2d77653177622e3f66245a0fb"
66
+ "gitHead": "e452e02063e6d8943a9cae2315ab585bc4f82fb6"
66
67
  }
@@ -0,0 +1,153 @@
1
+ import { Query, Params, Paginated, Id, NullableId } from '@feathersjs/feathers';
2
+
3
+ export type FilterQueryOptions = {
4
+ filters?: FilterSettings;
5
+ operators?: string[];
6
+ paginate?: PaginationParams;
7
+ }
8
+
9
+ export type QueryFilter = (value: any, options: FilterQueryOptions) => any
10
+
11
+ export type FilterSettings = {
12
+ [key: string]: QueryFilter | true
13
+ }
14
+
15
+ export interface PaginationOptions {
16
+ default?: number;
17
+ max?: number;
18
+ }
19
+
20
+ export type PaginationParams = false | PaginationOptions;
21
+
22
+ export interface AdapterServiceOptions {
23
+ /**
24
+ * Whether to allow multiple updates for everything (`true`) or specific methods (e.g. `['create', 'remove']`)
25
+ */
26
+ multi?: boolean | string[];
27
+ /**
28
+ * The name of the id property
29
+ */
30
+ id?: string;
31
+ /**
32
+ * Pagination settings for this service
33
+ */
34
+ paginate?: PaginationParams;
35
+ /**
36
+ * A list of additional property query operators to allow in a query
37
+ */
38
+ operators?: string[];
39
+ /**
40
+ * An object of additional top level query filters, e.g. `{ $populate: true }`
41
+ * Can also be a converter function like `{ $ignoreCase: (value) => value === 'true' ? true : false }`
42
+ */
43
+ filters?: FilterSettings;
44
+ /**
45
+ * @deprecated Use service `events` option when registering the service with `app.use`.
46
+ */
47
+ events?: string[];
48
+ /**
49
+ * @deprecated renamed to `operators`.
50
+ */
51
+ whitelist?: string[];
52
+ }
53
+
54
+ export interface AdapterQuery extends Query {
55
+ $limit?: number,
56
+ $skip?: number,
57
+ $select?: string[],
58
+ $sort?: { [key: string]: 1|-1 }
59
+ }
60
+ /**
61
+ * Additional `params` that can be passed to an adapter service method call.
62
+ */
63
+ export interface AdapterParams<Q = AdapterQuery, A extends Partial<AdapterServiceOptions> = Partial<AdapterServiceOptions>> extends Params<Q> {
64
+ adapter?: A;
65
+ paginate?: PaginationParams;
66
+ }
67
+
68
+ /**
69
+ * Hook-less (internal) service methods. Directly call database adapter service methods
70
+ * without running any service-level hooks or sanitization. This can be useful if you need the raw data
71
+ * from the service and don't want to trigger any of its hooks.
72
+ *
73
+ * Important: These methods are only available internally on the server, not on the client
74
+ * side and only for the Feathers database adapters.
75
+ *
76
+ * These methods do not trigger events.
77
+ *
78
+ * @see {@link https://docs.feathersjs.com/guides/migrating.html#hook-less-service-methods}
79
+ */
80
+ export interface InternalServiceMethods<T = any, D = Partial<T>, P extends AdapterParams = AdapterParams> {
81
+ /**
82
+ * Retrieve all resources from this service.
83
+ * Does not sanitize the query and should only be used on the server.
84
+ *
85
+ * @param _params - Service call parameters {@link Params}
86
+ */
87
+ $find(_params?: P & { paginate?: PaginationOptions }): Promise<Paginated<T>>;
88
+ $find(_params?: P & { paginate: false }): Promise<T[]>;
89
+ $find(params?: P): Promise<T[] | Paginated<T>>;
90
+
91
+ /**
92
+ * Retrieve a single resource matching the given ID, skipping any service-level hooks.
93
+ * Does not sanitize the query and should only be used on the server.
94
+ *
95
+ * @param id - ID of the resource to locate
96
+ * @param params - Service call parameters {@link Params}
97
+ * @see {@link HookLessServiceMethods}
98
+ * @see {@link https://docs.feathersjs.com/api/services.html#get-id-params|Feathers API Documentation: .get(id, params)}
99
+ */
100
+ $get(id: Id, params?: P): Promise<T>;
101
+
102
+ /**
103
+ * Create a new resource for this service, skipping any service-level hooks.
104
+ * Does not sanitize data or checks if multiple updates are allowed and should only be used on the server.
105
+ *
106
+ * @param data - Data to insert into this service.
107
+ * @param params - Service call parameters {@link Params}
108
+ * @see {@link HookLessServiceMethods}
109
+ * @see {@link https://docs.feathersjs.com/api/services.html#create-data-params|Feathers API Documentation: .create(data, params)}
110
+ */
111
+ $create(data: Partial<D>, params?: P): Promise<T>;
112
+ $create(data: Partial<D>[], params?: P): Promise<T[]>;
113
+ $create(data: Partial<D> | Partial<D>[], params?: P): Promise<T | T[]>;
114
+
115
+ /**
116
+ * Completely replace the resource identified by id, skipping any service-level hooks.
117
+ * Does not sanitize data or query and should only be used on the server.
118
+ *
119
+ * @param id - ID of the resource to be updated
120
+ * @param data - Data to be put in place of the current resource.
121
+ * @param params - Service call parameters {@link Params}
122
+ * @see {@link HookLessServiceMethods}
123
+ * @see {@link https://docs.feathersjs.com/api/services.html#update-id-data-params|Feathers API Documentation: .update(id, data, params)}
124
+ */
125
+ $update(id: Id, data: D, params?: P): Promise<T>;
126
+
127
+ /**
128
+ * Merge any resources matching the given ID with the given data, skipping any service-level hooks.
129
+ * Does not sanitize the data or query and should only be used on the server.
130
+ *
131
+ * @param id - ID of the resource to be patched
132
+ * @param data - Data to merge with the current resource.
133
+ * @param params - Service call parameters {@link Params}
134
+ * @see {@link HookLessServiceMethods}
135
+ * @see {@link https://docs.feathersjs.com/api/services.html#patch-id-data-params|Feathers API Documentation: .patch(id, data, params)}
136
+ */
137
+ $patch(id: null, data: Partial<D>, params?: P): Promise<T[]>;
138
+ $patch(id: Id, data: Partial<D>, params?: P): Promise<T>;
139
+ $patch(id: NullableId, data: Partial<D>, params?: P): Promise<T | T[]>;
140
+
141
+ /**
142
+ * Remove resources matching the given ID from the this service, skipping any service-level hooks.
143
+ * Does not sanitize query and should only be used on the server.
144
+ *
145
+ * @param id - ID of the resource to be removed
146
+ * @param params - Service call parameters {@link Params}
147
+ * @see {@link HookLessServiceMethods}
148
+ * @see {@link https://docs.feathersjs.com/api/services.html#remove-id-params|Feathers API Documentation: .remove(id, params)}
149
+ */
150
+ $remove(id: null, params?: P): Promise<T[]>;
151
+ $remove(id: Id, params?: P): Promise<T>;
152
+ $remove(id: NullableId, params?: P): Promise<T | T[]>;
153
+ }
package/src/index.ts CHANGED
@@ -1,26 +1,23 @@
1
1
  import { _ } from '@feathersjs/commons';
2
+ import { Params } from '@feathersjs/feathers';
2
3
 
3
- export { AdapterService, InternalServiceMethods, ServiceOptions, Paginated } from './service';
4
- export { filterQuery, FILTERS, OPERATORS } from './filter-query';
4
+ export * from './declarations';
5
+ export * from './service';
6
+ export { filterQuery, FILTERS, OPERATORS } from './query';
5
7
  export * from './sort';
6
8
 
7
9
  // Return a function that filters a result object or array
8
10
  // and picks only the fields passed as `params.query.$select`
9
11
  // and additional `otherFields`
10
- export function select (params: any, ...otherFields: any[]) {
11
- const fields = params && params.query && params.query.$select;
12
+ export function select (params: Params, ...otherFields: string[]) {
13
+ const queryFields: string[] | undefined = params?.query?.$select;
12
14
 
13
- if (Array.isArray(fields) && otherFields.length) {
14
- fields.push(...otherFields);
15
+ if (!queryFields) {
16
+ return (result: any) => result;
15
17
  }
16
18
 
17
- const convert = (result: any) => {
18
- if (!Array.isArray(fields)) {
19
- return result;
20
- }
21
-
22
- return _.pick(result, ...fields);
23
- };
19
+ const resultFields = queryFields.concat(otherFields);
20
+ const convert = (result: any) => _.pick(result, ...resultFields);
24
21
 
25
22
  return (result: any) => {
26
23
  if (Array.isArray(result)) {
package/src/query.ts ADDED
@@ -0,0 +1,138 @@
1
+ import { _ } from '@feathersjs/commons';
2
+ import { BadRequest } from '@feathersjs/errors';
3
+ import { Query } from '@feathersjs/feathers';
4
+ import { FilterQueryOptions, FilterSettings } from './declarations';
5
+
6
+ const parse = (value: any) => typeof value !== 'undefined' ? parseInt(value, 10) : value;
7
+
8
+ const isPlainObject = (value: any) => _.isObject(value) && value.constructor === {}.constructor;
9
+
10
+ const validateQueryProperty = (query: any, operators: string[] = []): Query => {
11
+ if (!isPlainObject(query)) {
12
+ return query;
13
+ }
14
+
15
+ for (const key of Object.keys(query)) {
16
+ if (key.startsWith('$') && !operators.includes(key)) {
17
+ throw new BadRequest(`Invalid query parameter ${key}`, query);
18
+ }
19
+
20
+ const value = query[key];
21
+
22
+ if (isPlainObject(value)) {
23
+ query[key] = validateQueryProperty(value, operators);
24
+ }
25
+ }
26
+
27
+ return {
28
+ ...query
29
+ }
30
+ }
31
+
32
+ const getFilters = (query: Query, settings: FilterQueryOptions) => {
33
+ const filterNames = Object.keys(settings.filters);
34
+
35
+ return filterNames.reduce((current, key) => {
36
+ const queryValue = query[key];
37
+ const filter = settings.filters[key];
38
+
39
+ if (filter) {
40
+ const value = typeof filter === 'function' ? filter(queryValue, settings) : queryValue;
41
+
42
+ if (value !== undefined) {
43
+ current[key] = value;
44
+ }
45
+ }
46
+
47
+ return current;
48
+ }, {} as { [key: string]: any });
49
+ }
50
+
51
+ const getQuery = (query: Query, settings: FilterQueryOptions) => {
52
+ const keys = Object.keys(query).concat(Object.getOwnPropertySymbols(query) as any as string[]);
53
+
54
+ return keys.reduce((result, key) => {
55
+ if (typeof key === 'string' && key.startsWith('$')) {
56
+ if (settings.filters[key] === undefined) {
57
+ throw new BadRequest(`Invalid filter value ${key}`);
58
+ }
59
+ } else {
60
+ result[key] = validateQueryProperty(query[key], settings.operators);
61
+ }
62
+
63
+ return result;
64
+ }, {} as Query)
65
+ }
66
+
67
+ export const OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or'];
68
+
69
+ export const FILTERS: FilterSettings = {
70
+ $skip: (value: any) => parse(value),
71
+ $sort: (sort: any): { [key: string]: number } => {
72
+ if (typeof sort !== 'object' || Array.isArray(sort)) {
73
+ return sort;
74
+ }
75
+
76
+ return Object.keys(sort).reduce((result, key) => {
77
+ result[key] = typeof sort[key] === 'object'
78
+ ? sort[key] : parse(sort[key]);
79
+
80
+ return result;
81
+ }, {} as { [key: string]: number });
82
+ },
83
+ $limit: (_limit: any, { paginate }: FilterQueryOptions) => {
84
+ const limit = parse(_limit);
85
+
86
+ if (paginate && (paginate.default || paginate.max)) {
87
+ const base = paginate.default || 0;
88
+ const lower = typeof limit === 'number' && !isNaN(limit) && limit >= 0 ? limit : base;
89
+ const upper = typeof paginate.max === 'number' ? paginate.max : Number.MAX_VALUE;
90
+
91
+ return Math.min(lower, upper);
92
+ }
93
+
94
+ return limit;
95
+ },
96
+ $select: (select: any) => {
97
+ if (Array.isArray(select)) {
98
+ return select.map(current => `${current}`);
99
+ }
100
+
101
+ return select;
102
+ },
103
+ $or: (or: any, { operators }: FilterQueryOptions) => {
104
+ if (Array.isArray(or)) {
105
+ return or.map(current => validateQueryProperty(current, operators));
106
+ }
107
+
108
+ return or;
109
+ }
110
+ }
111
+
112
+ /**
113
+ * Converts Feathers special query parameters and pagination settings
114
+ * and returns them separately as `filters` and the rest of the query
115
+ * as `query`. `options` also gets passed the pagination settings and
116
+ * a list of additional `operators` to allow when querying properties.
117
+ *
118
+ * @param query The initial query
119
+ * @param options Options for filtering the query
120
+ * @returns An object with `query` which contains the query without `filters`
121
+ * and `filters` which contains the converted values for each filter.
122
+ */
123
+ export function filterQuery (_query: Query, options: FilterQueryOptions = {}) {
124
+ const query = _query || {};
125
+ const settings = {
126
+ ...options,
127
+ filters: {
128
+ ...FILTERS,
129
+ ...options.filters
130
+ },
131
+ operators: OPERATORS.concat(options.operators || [])
132
+ }
133
+
134
+ return {
135
+ filters: getFilters(query, settings),
136
+ query: getQuery(query, settings)
137
+ }
138
+ }