@feathersjs/adapter-commons 5.0.0-pre.16 → 5.0.0-pre.19

package/lib/service.js

@@ -1,29 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdapterService = void 0;
+exports.AdapterBase = void 0;
 const errors_1 = require("@feathersjs/errors");
-const filter_query_1 = require("./filter-query");
-const callMethod = (self, name, ...args) => {
-    if (typeof self[name] !== 'function') {
-        return Promise.reject(new errors_1.NotImplemented(`Method ${name} not available`));
-    }
-    return self[name](...args);
-};
+const query_1 = require("./query");
 const alwaysMulti = {
     find: true,
     get: false,
     update: false
 };
-class AdapterService {
+/**
+ * An abstract base class that a database adapter can extend from to implement the
+ * `__find`, `__get`, `__update`, `__patch` and `__remove` methods.
+ */
+class AdapterBase {
     constructor(options) {
-        this.options = Object.assign({
+        this.options = {
             id: 'id',
             events: [],
-            paginate: {},
+            paginate: false,
             multi: false,
-            filters: [],
-            allow: []
-        }, options);
+            filters: {},
+            operators: [],
+            ...options
+        };
     }
     get id() {
         return this.options.id;
@@ -31,67 +30,138 @@ class AdapterService {
     get events() {
         return this.options.events;
     }
-    filterQuery(params = {}, opts = {}) {
-        const paginate = typeof params.paginate !== 'undefined'
-            ? params.paginate
-            : this.getOptions(params).paginate;
-        const { query = {} } = params;
-        const options = Object.assign({
-            operators: this.options.whitelist || this.options.allow || [],
-            filters: this.options.filters,
-            paginate
-        }, opts);
-        const result = (0, filter_query_1.filterQuery)(query, options);
-        return Object.assign(result, { paginate });
-    }
+    /**
+     * Check if this adapter allows multiple updates for a method.
+     * @param method The method name to check.
+     * @param params The service call params.
+     * @returns Wether or not multiple updates are allowed.
+     */
     allowsMulti(method, params = {}) {
         const always = alwaysMulti[method];
         if (typeof always !== 'undefined') {
             return always;
         }
-        const { multi: option } = this.getOptions(params);
-        if (option === true || option === false) {
-            return option;
+        const { multi } = this.getOptions(params);
+        if (multi === true || multi === false) {
+            return multi;
         }
-        return option.includes(method);
+        return multi.includes(method);
     }
+    /**
+     * Returns the combined options for a service call. Options will be merged
+     * with `this.options` and `params.adapter` for dynamic overrides.
+     *
+     * @param params The parameters for the service method call
+     * @returns The actual options for this call
+     */
     getOptions(params) {
+        const paginate = params.paginate !== undefined ? params.paginate : this.options.paginate;
         return {
             ...this.options,
+            paginate,
             ...params.adapter
         };
     }
-    find(params) {
-        return callMethod(this, '_find', params);
+    /**
+     * Sanitize the incoming data, e.g. removing invalid keywords etc.
+     *
+     * @param data The data to sanitize
+     * @param _params Service call parameters
+     * @returns The sanitized data
+     */
+    async sanitizeData(data, _params) {
+        return data;
+    }
+    /**
+     * Returns a sanitized version of `params.query`, converting filter values
+     * (like $limit and $skip) into the expected type. Will throw an error if
+     * a `$` prefixed filter or operator value that is not allowed in `filters`
+     * or `operators` is encountered.
+     *
+     * @param params The service call parameter.
+     * @returns A new object containing the sanitized query.
+     */
+    async sanitizeQuery(params = {}) {
+        const options = this.getOptions(params);
+        const { query, filters } = (0, query_1.filterQuery)(params.query, options);
+        return {
+            ...filters,
+            ...query
+        };
+    }
+    async _find(params) {
+        const query = await this.sanitizeQuery(params);
+        return this.$find({
+            ...params,
+            query
+        });
     }
-    get(id, params) {
-        return callMethod(this, '_get', id, params);
+    /**
+     * Retrieve a single resource matching the given ID, skipping any service-level hooks but sanitize the query
+     * with allowed filters and properties by calling `sanitizeQuery`.
+     *
+     * @param id - ID of the resource to locate
+     * @param params - Service call parameters {@link Params}
+     * @see {@link HookLessServiceMethods}
+     * @see {@link https://docs.feathersjs.com/api/services.html#get-id-params|Feathers API Documentation: .get(id, params)}
+     */
+    async _get(id, params) {
+        const query = await this.sanitizeQuery(params);
+        return this.$get(id, {
+            ...params,
+            query
+        });
     }
-    create(data, params) {
+    async _create(data, params) {
         if (Array.isArray(data) && !this.allowsMulti('create', params)) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not create multiple entries'));
+            throw new errors_1.MethodNotAllowed('Can not create multiple entries');
         }
-        return callMethod(this, '_create', data, params);
+        const payload = Array.isArray(data)
+            ? (await Promise.all(data.map(current => this.sanitizeData(current, params))))
+            : (await this.sanitizeData(data, params));
+        return this.$create(payload, params);
     }
-    update(id, data, params) {
+    /**
+     * Replace any resources matching the given ID with the given data, skipping any service-level hooks.
+     *
+     * @param id - ID of the resource to be updated
+     * @param data - Data to be put in place of the current resource.
+     * @param params - Service call parameters {@link Params}
+     * @see {@link HookLessServiceMethods}
+     * @see {@link https://docs.feathersjs.com/api/services.html#update-id-data-params|Feathers API Documentation: .update(id, data, params)}
+     */
+    async _update(id, data, params) {
         if (id === null || Array.isArray(data)) {
-            return Promise.reject(new errors_1.BadRequest('You can not replace multiple instances. Did you mean \'patch\'?'));
+            throw new errors_1.BadRequest('You can not replace multiple instances. Did you mean \'patch\'?');
         }
-        return callMethod(this, '_update', id, data, params);
+        const payload = await this.sanitizeData(data, params);
+        const query = await this.sanitizeQuery(params);
+        return this.$update(id, payload, {
+            ...params,
+            query
+        });
     }
-    patch(id, data, params) {
+    async _patch(id, data, params) {
         if (id === null && !this.allowsMulti('patch', params)) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not patch multiple entries'));
+            throw new errors_1.MethodNotAllowed('Can not patch multiple entries');
         }
-        return callMethod(this, '_patch', id, data, params);
+        const query = await this.sanitizeQuery(params);
+        const payload = await this.sanitizeData(data, params);
+        return this.$patch(id, payload, {
+            ...params,
+            query
+        });
     }
-    remove(id, params) {
+    async _remove(id, params) {
         if (id === null && !this.allowsMulti('remove', params)) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not remove multiple entries'));
+            throw new errors_1.MethodNotAllowed('Can not remove multiple entries');
         }
-        return callMethod(this, '_remove', id, params);
+        const query = await this.sanitizeQuery(params);
+        return this.$remove(id, {
+            ...params,
+            query
+        });
     }
-    async setup() { }
 }
-exports.AdapterService = AdapterService;
+exports.AdapterBase = AdapterBase;
 //# sourceMappingURL=service.js.map

package/lib/service.js.map

@@ -1 +1 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":";;;AAAA,+CAAkF;AAElF,iDAA6C;AAE7C,MAAM,UAAU,GAAG,CAAC,IAAS,EAAE,IAAS,EAAE,GAAG,IAAW,EAAE,EAAE;IAC1D,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,UAAU,EAAE;QACpC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,uBAAc,CAAC,UAAU,IAAI,gBAAgB,CAAC,CAAC,CAAC;KAC3E;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,WAAW,GAA+B;IAC9C,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,KAAK;CACd,CAAC;AAsGF,MAAa,cAAc;IAOzB,YAAa,OAAU;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,EAAE;YACZ,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,EAAE;SACV,EAAE,OAAO,CAAC,CAAC;IACd,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED,WAAW,CAAE,SAAwB,EAAE,EAAE,OAAY,EAAE;QACrD,MAAM,QAAQ,GAAG,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW;YACrD,CAAC,CAAC,MAAM,CAAC,QAAQ;YACjB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC;QACrC,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,MAAM,CAAC;QAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE;YAC7D,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;YAC7B,QAAQ;SACT,EAAE,IAAI,CAAC,CAAC;QACT,MAAM,MAAM,GAAG,IAAA,0BAAW,EAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,WAAW,CAAE,MAAc,EAAE,SAAwB,EAAE;QACrD,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,OAAO,MAAM,CAAC;SACf;QAED,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,KAAK,EAAE;YACvC,OAAO,MAAM,CAAC;SACf;QAED,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED,UAAU,CAAE,MAAqB;QAC/B,OAAO;YACL,GAAG,IAAI,CAAC,OAAO;YACf,GAAG,MAAM,CAAC,OAAO;SAClB,CAAA;IACH,CAAC;IAED,IAAI,CAAE,MAAsB;QAC1B,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,GAAG,CAAE,EAAM,EAAE,MAAsB;QACjC,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAID,MAAM,CAAE,IAA+B,EAAE,MAAsB;QAC7D,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YAC9D,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,iCAAiC,CAAC,CAAC,CAAC;SAChF;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAE,EAAM,EAAE,IAAO,EAAE,MAAsB;QAC7C,IAAI,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtC,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,mBAAU,CAClC,iEAAiE,CAClE,CAAC,CAAC;SACJ;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAKD,KAAK,CAAE,EAAc,EAAE,IAAgB,EAAE,MAAsB;QAC7D,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACrD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,gCAAgC,CAAC,CAAC,CAAC;SAC/E;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAKD,MAAM,CAAE,EAAc,EAAE,MAAsB;QAC5C,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YACtD,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,yBAAgB,CAAC,iCAAiC,CAAC,CAAC,CAAC;SAChF;QAED,OAAO,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,KAAK,KAAK,CAAC;CAClB;AAnHD,wCAmHC"}
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":";;;AAAA,+CAAkE;AAGlE,mCAAsC;AAEtC,MAAM,WAAW,GAA+B;IAC9C,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,KAAK;IACV,MAAM,EAAE,KAAK;CACd,CAAC;AAEF;;;GAGG;AACH,MAAsB,WAAW;IAQ/B,YAAa,OAAU;QACrB,IAAI,CAAC,OAAO,GAAG;YACb,EAAE,EAAE,IAAI;YACR,MAAM,EAAE,EAAE;YACV,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,EAAE;YACX,SAAS,EAAE,EAAE;YACb,GAAG,OAAO;SACX,CAAC;IACJ,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACF,WAAW,CAAE,MAAc,EAAE,SAAY,EAAO;QAC/C,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,OAAO,MAAM,CAAC;SACf;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAE1C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,KAAK,EAAE;YACrC,OAAO,KAAK,CAAC;SACd;QAED,OAAO,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAE,MAAS;QACnB,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAEzF,OAAO;YACL,GAAG,IAAI,CAAC,OAAO;YACf,QAAQ;YACR,GAAG,MAAM,CAAC,OAAO;SAClB,CAAA;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAAkB,IAAO,EAAE,OAAU;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,aAAa,CAAE,SAAY,EAAO;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAA,mBAAW,EAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAE7D,OAAO;YACL,GAAG,OAAO;YACV,GAAG,KAAK;SACT,CAAC;IACJ,CAAC;IAiBD,KAAK,CAAC,KAAK,CAAE,MAAU;QACrB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,KAAK,CAAC;YAChB,GAAG,MAAM;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAID;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAE,EAAM,EAAE,MAAU;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACnB,GAAG,MAAM;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAkBD,KAAK,CAAC,OAAO,CAAE,IAA+B,EAAE,MAAU;QACxD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YAC9D,MAAM,IAAI,yBAAgB,CAAC,iCAAiC,CAAC,CAAC;SAC/D;QAED,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;YACjC,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9E,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAID;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,CAAE,EAAM,EAAE,IAAO,EAAE,MAAU;QACxC,IAAI,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACtC,MAAM,IAAI,mBAAU,CAClB,iEAAiE,CAClE,CAAC;SACH;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,EAAE;YAC/B,GAAG,MAAM;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAmBD,KAAK,CAAC,MAAM,CAAE,EAAc,EAAE,IAAgB,EAAE,MAAU;QACxD,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACrD,MAAM,IAAI,yBAAgB,CAAC,gCAAgC,CAAC,CAAC;SAC9D;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,EAAE;YAC9B,GAAG,MAAM;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAkBD,KAAK,CAAC,OAAO,CAAE,EAAc,EAAE,MAAU;QACvC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE;YACtD,MAAM,IAAI,yBAAgB,CAAC,iCAAiC,CAAC,CAAC;SAC/D;QAED,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE/C,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE;YACtB,GAAG,MAAM;YACT,KAAK;SACN,CAAC,CAAC;IACL,CAAC;CACF;AA/PD,kCA+PC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feathersjs/adapter-commons",
-  "version": "5.0.0-pre.16",
+  "version": "5.0.0-pre.19",
   "description": "Shared database adapter utility functions",
   "homepage": "https://feathersjs.com",
   "keywords": [
@@ -13,7 +13,8 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/feathersjs/feathers.git"
+    "url": "git://github.com/feathersjs/feathers.git",
+    "directory": "packages/adapter-commons"
   },
   "author": {
     "name": "Feathers contributor",
@@ -48,19 +49,19 @@
     "access": "public"
   },
   "dependencies": {
-    "@feathersjs/commons": "^5.0.0-pre.16",
-    "@feathersjs/errors": "^5.0.0-pre.16",
-    "@feathersjs/feathers": "^5.0.0-pre.16"
+    "@feathersjs/commons": "^5.0.0-pre.19",
+    "@feathersjs/errors": "^5.0.0-pre.19",
+    "@feathersjs/feathers": "^5.0.0-pre.19"
   },
   "devDependencies": {
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^9.1.1",
     "@types/mongodb": "^4.0.6",
-    "@types/node": "^17.0.5",
-    "mocha": "^9.1.3",
-    "mongodb": "^4.2.2",
-    "shx": "^0.3.3",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.4"
+    "@types/node": "^17.0.31",
+    "mocha": "^10.0.0",
+    "mongodb": "^4.5.0",
+    "shx": "^0.3.4",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.4"
   },
-  "gitHead": "f0cd227a82d159b528193bd33747c97684a48773"
+  "gitHead": "57f3e18bb62735e1869ffafee90286498738fdfa"
 }

package/src/declarations.ts

@@ -0,0 +1,153 @@
+import { Query, Params, Paginated, Id, NullableId } from '@feathersjs/feathers';
+
+export type FilterQueryOptions = {
+  filters?: FilterSettings;
+  operators?: string[];
+  paginate?: PaginationParams;
+}
+
+export type QueryFilter = (value: any, options: FilterQueryOptions) => any
+
+export type FilterSettings = {
+  [key: string]: QueryFilter | true
+}
+
+export interface PaginationOptions {
+  default?: number;
+  max?: number;
+}
+
+export type PaginationParams = false | PaginationOptions;
+
+export interface AdapterServiceOptions {
+  /**
+   * Whether to allow multiple updates for everything (`true`) or specific methods (e.g. `['create', 'remove']`)
+   */
+  multi?: boolean | string[];
+  /**
+   * The name of the id property
+   */
+  id?: string;
+  /**
+   * Pagination settings for this service
+   */
+  paginate?: PaginationParams;
+  /**
+   * A list of additional property query operators to allow in a query
+   */
+  operators?: string[];
+  /**
+   * An object of additional top level query filters, e.g. `{ $populate: true }`
+   * Can also be a converter function like `{ $ignoreCase: (value) => value === 'true' ? true : false }`
+   */
+  filters?: FilterSettings;
+  /**
+   * @deprecated Use service `events` option when registering the service with `app.use`.
+   */
+  events?: string[];
+  /**
+ * @deprecated renamed to `operators`.
+ */
+  whitelist?: string[];
+}
+
+export interface AdapterQuery extends Query {
+  $limit?: number,
+  $skip?: number,
+  $select?: string[],
+  $sort?: { [key: string]: 1|-1 }
+}
+/**
+ * Additional `params` that can be passed to an adapter service method call.
+ */
+export interface AdapterParams<Q = AdapterQuery, A extends Partial<AdapterServiceOptions> = Partial<AdapterServiceOptions>> extends Params<Q> {
+  adapter?: A;
+  paginate?: PaginationParams;
+}
+
+/**
+ * Hook-less (internal) service methods. Directly call database adapter service methods
+ * without running any service-level hooks or sanitization. This can be useful if you need the raw data
+ * from the service and don't want to trigger any of its hooks.
+ *
+ * Important: These methods are only available internally on the server, not on the client
+ * side and only for the Feathers database adapters.
+ *
+ * These methods do not trigger events.
+ *
+ * @see {@link https://docs.feathersjs.com/guides/migrating.html#hook-less-service-methods}
+ */
+export interface InternalServiceMethods<T = any, D = Partial<T>, P extends AdapterParams = AdapterParams> {
+  /**
+   * Retrieve all resources from this service.
+   * Does not sanitize the query and should only be used on the server.
+   *
+   * @param _params - Service call parameters {@link Params}
+   */
+  $find(_params?: P & { paginate?: PaginationOptions }): Promise<Paginated<T>>;
+  $find(_params?: P & { paginate: false }): Promise<T[]>;
+  $find(params?: P): Promise<T[] | Paginated<T>>;
+
+  /**
+   * Retrieve a single resource matching the given ID, skipping any service-level hooks.
+   * Does not sanitize the query and should only be used on the server.
+   *
+   * @param id - ID of the resource to locate
+   * @param params - Service call parameters {@link Params}
+   * @see {@link HookLessServiceMethods}
+   * @see {@link https://docs.feathersjs.com/api/services.html#get-id-params|Feathers API Documentation: .get(id, params)}
+   */
+  $get(id: Id, params?: P): Promise<T>;
+
+  /**
+   * Create a new resource for this service, skipping any service-level hooks.
+   * Does not sanitize data or checks if multiple updates are allowed and should only be used on the server.
+   *
+   * @param data - Data to insert into this service.
+   * @param params - Service call parameters {@link Params}
+   * @see {@link HookLessServiceMethods}
+   * @see {@link https://docs.feathersjs.com/api/services.html#create-data-params|Feathers API Documentation: .create(data, params)}
+   */
+  $create(data: Partial<D>, params?: P): Promise<T>;
+  $create(data: Partial<D>[], params?: P): Promise<T[]>;
+  $create(data: Partial<D> | Partial<D>[], params?: P): Promise<T | T[]>;
+
+  /**
+   * Completely replace the resource identified by id, skipping any service-level hooks.
+   * Does not sanitize data or query and should only be used on the server.
+   *
+   * @param id - ID of the resource to be updated
+   * @param data - Data to be put in place of the current resource.
+   * @param params - Service call parameters {@link Params}
+   * @see {@link HookLessServiceMethods}
+   * @see {@link https://docs.feathersjs.com/api/services.html#update-id-data-params|Feathers API Documentation: .update(id, data, params)}
+   */
+  $update(id: Id, data: D, params?: P): Promise<T>;
+
+  /**
+   * Merge any resources matching the given ID with the given data, skipping any service-level hooks.
+   * Does not sanitize the data or query and should only be used on the server.
+   *
+   * @param id - ID of the resource to be patched
+   * @param data - Data to merge with the current resource.
+   * @param params - Service call parameters {@link Params}
+   * @see {@link HookLessServiceMethods}
+   * @see {@link https://docs.feathersjs.com/api/services.html#patch-id-data-params|Feathers API Documentation: .patch(id, data, params)}
+   */
+  $patch(id: null, data: Partial<D>, params?: P): Promise<T[]>;
+  $patch(id: Id, data: Partial<D>, params?: P): Promise<T>;
+  $patch(id: NullableId, data: Partial<D>, params?: P): Promise<T | T[]>;
+
+  /**
+   * Remove resources matching the given ID from the this service, skipping any service-level hooks.
+   * Does not sanitize query and should only be used on the server.
+   *
+   * @param id - ID of the resource to be removed
+   * @param params - Service call parameters {@link Params}
+   * @see {@link HookLessServiceMethods}
+   * @see {@link https://docs.feathersjs.com/api/services.html#remove-id-params|Feathers API Documentation: .remove(id, params)}
+   */
+   $remove(id: null, params?: P): Promise<T[]>;
+   $remove(id: Id, params?: P): Promise<T>;
+   $remove(id: NullableId, params?: P): Promise<T | T[]>;
+}

package/src/index.ts

@@ -1,13 +1,15 @@
 import { _ } from '@feathersjs/commons';
+import { Params } from '@feathersjs/feathers';
 
-export { AdapterService, InternalServiceMethods, ServiceOptions, AdapterParams } from './service';
-export { filterQuery, FILTERS, OPERATORS } from './filter-query';
+export * from './declarations';
+export * from './service';
+export { filterQuery, FILTERS, OPERATORS } from './query';
 export * from './sort';
 
 // Return a function that filters a result object or array
 // and picks only the fields passed as `params.query.$select`
 // and additional `otherFields`
-export function select (params: any, ...otherFields: string[]) {
+export function select (params: Params, ...otherFields: string[]) {
   const queryFields: string[] | undefined = params?.query?.$select;
 
   if (!queryFields) {

package/src/query.ts

@@ -0,0 +1,138 @@
+import { _ } from '@feathersjs/commons';
+import { BadRequest } from '@feathersjs/errors';
+import { Query } from '@feathersjs/feathers';
+import { FilterQueryOptions, FilterSettings } from './declarations';
+
+const parse = (value: any) => typeof value !== 'undefined' ? parseInt(value, 10) : value;
+
+const isPlainObject = (value: any) => _.isObject(value) && value.constructor === {}.constructor;
+
+const validateQueryProperty = (query: any, operators: string[] = []): Query => {
+  if (!isPlainObject(query)) {
+    return query;
+  }
+
+  for (const key of Object.keys(query)) {
+    if (key.startsWith('$') && !operators.includes(key)) {
+      throw new BadRequest(`Invalid query parameter ${key}`, query);
+    }
+
+    const value = query[key];
+
+    if (isPlainObject(value)) {
+      query[key] = validateQueryProperty(value, operators);
+    }
+  }
+
+  return {
+    ...query
+  }
+}
+
+const getFilters = (query: Query, settings: FilterQueryOptions) => {
+  const filterNames = Object.keys(settings.filters);
+
+  return filterNames.reduce((current, key) => {
+    const queryValue = query[key];
+    const filter = settings.filters[key];
+
+    if (filter) {
+      const value = typeof filter === 'function' ? filter(queryValue, settings) : queryValue;
+
+      if (value !== undefined) {
+        current[key] = value;
+      }
+    }
+
+    return current;
+  }, {} as { [key: string]: any });
+}
+
+const getQuery = (query: Query, settings: FilterQueryOptions) => {
+  const keys = Object.keys(query).concat(Object.getOwnPropertySymbols(query) as any as string[]);
+
+  return keys.reduce((result, key) => {
+    if (typeof key === 'string' && key.startsWith('$')) {
+      if (settings.filters[key] === undefined) {
+        throw new BadRequest(`Invalid filter value ${key}`);
+      }
+    } else {
+      result[key] = validateQueryProperty(query[key], settings.operators);
+    }
+
+    return result;
+  }, {} as Query)
+}
+
+export const OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or'];
+
+export const FILTERS: FilterSettings = {
+  $skip: (value: any) => parse(value),
+  $sort: (sort: any): { [key: string]: number } => {
+    if (typeof sort !== 'object' || Array.isArray(sort)) {
+      return sort;
+    }
+
+    return Object.keys(sort).reduce((result, key) => {
+      result[key] = typeof sort[key] === 'object'
+        ? sort[key] : parse(sort[key]);
+
+      return result;
+    }, {} as { [key: string]: number });
+  },
+  $limit: (_limit: any, { paginate }: FilterQueryOptions) => {
+    const limit = parse(_limit);
+
+    if (paginate && (paginate.default || paginate.max)) {
+      const base = paginate.default || 0;
+      const lower = typeof limit === 'number' && !isNaN(limit) && limit >= 0 ? limit : base;
+      const upper = typeof paginate.max === 'number' ? paginate.max : Number.MAX_VALUE;
+
+      return Math.min(lower, upper);
+    }
+
+    return limit;
+  },
+  $select: (select: any) => {
+    if (Array.isArray(select)) {
+      return select.map(current => `${current}`);
+    }
+
+    return select;
+  },
+  $or: (or: any, { operators }: FilterQueryOptions) => {
+    if (Array.isArray(or)) {
+      return or.map(current => validateQueryProperty(current, operators));
+    }
+
+    return or;
+  }
+}
+
+/**
+ * Converts Feathers special query parameters and pagination settings
+ * and returns them separately as `filters` and the rest of the query
+ * as `query`. `options` also gets passed the pagination settings and
+ * a list of additional `operators` to allow when querying properties.
+ *
+ * @param query The initial query
+ * @param options Options for filtering the query
+ * @returns An object with `query` which contains the query without `filters`
+ * and `filters` which contains the converted values for each filter.
+ */
+export function filterQuery (_query: Query, options: FilterQueryOptions = {}) {
+  const query = _query || {};
+  const settings = {
+    ...options,
+    filters: {
+      ...FILTERS,
+      ...options.filters
+    },
+    operators: OPERATORS.concat(options.operators || [])
+  }
+
+  return {
+    filters: getFilters(query, settings),
+    query: getQuery(query, settings)
+  }
+}