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

package/lib/query.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterQuery = exports.FILTERS = exports.OPERATORS = void 0;
+const commons_1 = require("@feathersjs/commons");
+const errors_1 = require("@feathersjs/errors");
+const parse = (value) => typeof value !== 'undefined' ? parseInt(value, 10) : value;
+const isPlainObject = (value) => commons_1._.isObject(value) && value.constructor === {}.constructor;
+const validateQueryProperty = (query, operators = []) => {
+    if (!isPlainObject(query)) {
+        return query;
+    }
+    for (const key of Object.keys(query)) {
+        if (key.startsWith('$') && !operators.includes(key)) {
+            throw new errors_1.BadRequest(`Invalid query parameter ${key}`, query);
+        }
+        const value = query[key];
+        if (isPlainObject(value)) {
+            query[key] = validateQueryProperty(value, operators);
+        }
+    }
+    return {
+        ...query
+    };
+};
+const getFilters = (query, settings) => {
+    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;
+    }, {});
+};
+const getQuery = (query, settings) => {
+    const keys = Object.keys(query).concat(Object.getOwnPropertySymbols(query));
+    return keys.reduce((result, key) => {
+        if (typeof key === 'string' && key.startsWith('$')) {
+            if (settings.filters[key] === undefined) {
+                throw new errors_1.BadRequest(`Invalid filter value ${key}`);
+            }
+        }
+        else {
+            result[key] = validateQueryProperty(query[key], settings.operators);
+        }
+        return result;
+    }, {});
+};
+exports.OPERATORS = ['$in', '$nin', '$lt', '$lte', '$gt', '$gte', '$ne', '$or'];
+exports.FILTERS = {
+    $skip: (value) => parse(value),
+    $sort: (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] : parse(sort[key]);
+            return result;
+        }, {});
+    },
+    $limit: (_limit, { paginate }) => {
+        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) => {
+        if (Array.isArray(select)) {
+            return select.map(current => `${current}`);
+        }
+        return select;
+    },
+    $or: (or, { operators }) => {
+        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.
+ */
+function filterQuery(_query, options = {}) {
+    const query = _query || {};
+    const settings = {
+        ...options,
+        filters: {
+            ...exports.FILTERS,
+            ...options.filters
+        },
+        operators: exports.OPERATORS.concat(options.operators || [])
+    };
+    return {
+        filters: getFilters(query, settings),
+        query: getQuery(query, settings)
+    };
+}
+exports.filterQuery = filterQuery;
+//# sourceMappingURL=query.js.map

package/lib/query.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;AAAA,iDAAwC;AACxC,+CAAgD;AAIhD,MAAM,KAAK,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAEzF,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,WAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,CAAC;AAEhG,MAAM,qBAAqB,GAAG,CAAC,KAAU,EAAE,YAAsB,EAAE,EAAS,EAAE;IAC5E,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;QACzB,OAAO,KAAK,CAAC;KACd;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QACpC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACnD,MAAM,IAAI,mBAAU,CAAC,2BAA2B,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;SAC/D;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAEzB,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YACxB,KAAK,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;SACtD;KACF;IAED,OAAO;QACL,GAAG,KAAK;KACT,CAAA;AACH,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,CAAC,KAAY,EAAE,QAA4B,EAAE,EAAE;IAChE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAElD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;QACzC,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAErC,IAAI,MAAM,EAAE;YACV,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;YAEvF,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;aACtB;SACF;QAED,OAAO,OAAO,CAAC;IACjB,CAAC,EAAE,EAA4B,CAAC,CAAC;AACnC,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,CAAC,KAAY,EAAE,QAA4B,EAAE,EAAE;IAC9D,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,qBAAqB,CAAC,KAAK,CAAoB,CAAC,CAAC;IAE/F,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QACjC,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAClD,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;gBACvC,MAAM,IAAI,mBAAU,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAC;aACrD;SACF;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;SACrE;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,EAAW,CAAC,CAAA;AACjB,CAAC,CAAA;AAEY,QAAA,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAExE,QAAA,OAAO,GAAmB;IACrC,KAAK,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC;IACnC,KAAK,EAAE,CAAC,IAAS,EAA6B,EAAE;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACnD,OAAO,IAAI,CAAC;SACb;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YAC9C,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,QAAQ;gBACzC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAEjC,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,EAA+B,CAAC,CAAC;IACtC,CAAC;IACD,MAAM,EAAE,CAAC,MAAW,EAAE,EAAE,QAAQ,EAAsB,EAAE,EAAE;QACxD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE;YAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YACtF,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;YAEjF,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;SAC/B;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,EAAE,CAAC,MAAW,EAAE,EAAE;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,CAAC;SAC5C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,GAAG,EAAE,CAAC,EAAO,EAAE,EAAE,SAAS,EAAsB,EAAE,EAAE;QAClD,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACrB,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;SACrE;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAA;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAE,MAAa,EAAE,UAA8B,EAAE;IAC1E,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG;QACf,GAAG,OAAO;QACV,OAAO,EAAE;YACP,GAAG,eAAO;YACV,GAAG,OAAO,CAAC,OAAO;SACnB;QACD,SAAS,EAAE,iBAAS,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;KACrD,CAAA;IAED,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,KAAK,EAAE,QAAQ,CAAC;QACpC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC;KACjC,CAAA;AACH,CAAC;AAfD,kCAeC"}

package/lib/service.d.ts

@@ -1,60 +1,96 @@
-import { ServiceMethods, Params, Id, NullableId } from '@feathersjs/feathers';
-export interface Paginated<T> {
-    total: number;
-    limit: number;
-    skip: number;
-    data: T[];
-}
-export interface ServiceOptions {
-    events: string[];
-    multi: boolean | string[];
-    id: string;
-    paginate: {
-        default?: number;
-        max?: number;
-    };
-    whitelist: string[];
-    filters: string[];
-}
+import { Id, NullableId, Paginated, Query } from '@feathersjs/feathers';
+import { AdapterParams, AdapterServiceOptions, InternalServiceMethods, PaginationOptions } from './declarations';
 /**
- * Hook-less (internal) service methods. Directly call database adapter service methods
- * without running any service-level hooks. 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}
+ * An abstract base class that a database adapter can extend from to implement the
+ * `__find`, `__get`, `__update`, `__patch` and `__remove` methods.
  */
-export interface InternalServiceMethods<T = any> {
+export declare abstract class AdapterBase<T = any, D = Partial<T>, P extends AdapterParams = AdapterParams, O extends AdapterServiceOptions = AdapterServiceOptions> implements InternalServiceMethods<T, D, P> {
+    options: O;
+    constructor(options: O);
+    get id(): string;
+    get events(): string[];
+    /**
+     * 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: string, params?: P): boolean;
+    /**
+     * 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: P): O;
     /**
-     * Retrieve all resources from this service, skipping any service-level hooks.
+     * 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
+     */
+    sanitizeData<X = Partial<D>>(data: X, _params: P): Promise<X>;
+    /**
+     * 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.
+     */
+    sanitizeQuery(params?: P): Promise<Query>;
+    abstract $find(_params?: P & {
+        paginate?: PaginationOptions;
+    }): Promise<Paginated<T>>;
+    abstract $find(_params?: P & {
+        paginate: false;
+    }): Promise<T[]>;
+    abstract $find(params?: P): Promise<T[] | Paginated<T>>;
+    /**
+     * Retrieve all resources from this service, skipping any service-level hooks but sanitize the query
+     * with allowed filters and properties by calling `sanitizeQuery`.
      *
      * @param params - Service call parameters {@link Params}
      * @see {@link HookLessServiceMethods}
      * @see {@link https://docs.feathersjs.com/api/services.html#find-params|Feathers API Documentation: .find(params)}
      */
-    _find(params?: Params): Promise<T | T[] | Paginated<T>>;
+    _find(_params?: P & {
+        paginate?: PaginationOptions;
+    }): Promise<Paginated<T>>;
+    _find(_params?: P & {
+        paginate: false;
+    }): Promise<T[]>;
+    _find(params?: P): Promise<T | T[] | Paginated<T>>;
+    abstract $get(id: Id, params?: P): Promise<T>;
     /**
-     * Retrieve a single resource matching the given ID, skipping any service-level hooks.
+     * 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)}
      */
-    _get(id: Id, params?: Params): Promise<T>;
+    _get(id: Id, params?: P): Promise<T>;
+    abstract $create(data: Partial<D>, params?: P): Promise<T>;
+    abstract $create(data: Partial<D>[], params?: P): Promise<T[]>;
+    abstract $create(data: Partial<D> | Partial<D>[], params?: P): Promise<T | T[]>;
     /**
-     * Create a new resource for this service, skipping any service-level hooks.
+     * Create a new resource for this service, skipping any service-level hooks, sanitize the data
+     * and check if multiple updates are allowed.
      *
      * @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<T> | Partial<T>[], params?: Params): Promise<T | T[]>;
+    _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[]>;
+    abstract $update(id: Id, data: D, params?: P): Promise<T>;
     /**
      * Replace any resources matching the given ID with the given data, skipping any service-level hooks.
      *
@@ -64,9 +100,13 @@ export interface InternalServiceMethods<T = any> {
      * @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: T, params?: Params): Promise<T>;
+    _update(id: Id, data: D, params?: P): Promise<T>;
+    abstract $patch(id: null, data: Partial<D>, params?: P): Promise<T[]>;
+    abstract $patch(id: Id, data: Partial<D>, params?: P): Promise<T>;
+    abstract $patch(id: NullableId, data: Partial<D>, params?: P): Promise<T | T[]>;
     /**
      * Merge any resources matching the given ID with the given data, skipping any service-level hooks.
+     * Sanitizes the query and data and checks it multiple updates are allowed.
      *
      * @param id - ID of the resource to be patched
      * @param data - Data to merge with the current resource.
@@ -74,38 +114,22 @@ export interface InternalServiceMethods<T = any> {
      * @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: NullableId, data: Partial<T>, params?: Params): Promise<T | T[]>;
+    _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[]>;
+    abstract $remove(id: null, params?: P): Promise<T[]>;
+    abstract $remove(id: Id, params?: P): Promise<T>;
+    abstract $remove(id: NullableId, params?: P): Promise<T | T[]>;
     /**
      * Remove resources matching the given ID from the this service, skipping any service-level hooks.
+     * Sanitized the query and verifies that multiple updates are allowed.
      *
      * @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: NullableId, params?: Params): Promise<T | T[]>;
-}
-export declare class AdapterService<T = any> implements ServiceMethods<T | Paginated<T>> {
-    options: ServiceOptions;
-    constructor(options: Partial<ServiceOptions>);
-    get id(): string;
-    get events(): string[];
-    filterQuery(params?: Params, opts?: any): {
-        [key: string]: any;
-    } & {
-        paginate: any;
-    };
-    allowsMulti(method: string): boolean;
-    find(params?: Params): Promise<T[] | Paginated<T>>;
-    get(id: Id, params?: Params): Promise<T>;
-    create(data: Partial<T>, params?: Params): Promise<T>;
-    create(data: Partial<T>[], params?: Params): Promise<T[]>;
-    update(id: Id, data: T, params?: Params): Promise<T>;
-    patch(id: Id, data: Partial<T>, params?: Params): Promise<T>;
-    patch(id: null, data: Partial<T>, params?: Params): Promise<T[]>;
-    patch(id: NullableId, data: Partial<T>, params?: Params): Promise<T | T[]>;
-    remove(id: Id, params?: Params): Promise<T>;
-    remove(id: null, params?: Params): Promise<T[]>;
-    remove(id: NullableId, params?: Params): Promise<T | T[]>;
-    setup(): Promise<void>;
+    _remove(id: null, params?: P): Promise<T[]>;
+    _remove(id: Id, params?: P): Promise<T>;
+    _remove(id: NullableId, params?: P): Promise<T | T[]>;
 }

package/lib/service.js

@@ -1,38 +1,28 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 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: [],
-            whitelist: []
-        }, options);
+            filters: {},
+            operators: [],
+            ...options
+        };
     }
     get id() {
         return this.options.id;
@@ -40,64 +30,138 @@ class AdapterService {
     get events() {
         return this.options.events;
     }
-    filterQuery(params = {}, opts = {}) {
-        const paginate = typeof params.paginate !== 'undefined'
-            ? params.paginate : this.options.paginate;
-        const { query = {} } = params;
-        const options = Object.assign({
-            operators: this.options.whitelist || [],
-            filters: this.options.filters,
-            paginate
-        }, opts);
-        const result = filter_query_1.filterQuery(query, options);
-        return Object.assign(result, { paginate });
-    }
-    allowsMulti(method) {
+    /**
+     * 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 option = this.options.multi;
-        if (option === true || option === false) {
-            return option;
-        }
-        else {
-            return option.includes(method);
+        const { multi } = this.getOptions(params);
+        if (multi === true || multi === false) {
+            return multi;
         }
+        return multi.includes(method);
     }
-    find(params) {
-        return callMethod(this, '_find', params);
+    /**
+     * 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
+        };
     }
-    get(id, params) {
-        return callMethod(this, '_get', id, 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;
     }
-    create(data, params) {
-        if (Array.isArray(data) && !this.allowsMulti('create')) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not create multiple entries'));
+    /**
+     * 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
+        });
+    }
+    /**
+     * 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
+        });
+    }
+    async _create(data, params) {
+        if (Array.isArray(data) && !this.allowsMulti('create', params)) {
+            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) {
-        if (id === null && !this.allowsMulti('patch')) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not patch multiple entries'));
+    async _patch(id, data, params) {
+        if (id === null && !this.allowsMulti('patch', params)) {
+            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) {
-        if (id === null && !this.allowsMulti('remove')) {
-            return Promise.reject(new errors_1.MethodNotAllowed('Can not remove multiple entries'));
+    async _remove(id, params) {
+        if (id === null && !this.allowsMulti('remove', params)) {
+            throw new errors_1.MethodNotAllowed('Can not remove multiple entries');
         }
-        return callMethod(this, '_remove', id, params);
-    }
-    setup() {
-        return __awaiter(this, void 0, void 0, function* () { });
+        const query = await this.sanitizeQuery(params);
+        return this.$remove(id, {
+            ...params,
+            query
+        });
     }
 }
-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;AAS7C,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;AA0FF,MAAa,cAAc;IAGzB,YAAa,OAAgC;QAC3C,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,SAAS,EAAE,EAAE;SACd,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,SAAiB,EAAE,EAAE,OAAY,EAAE;QAC9C,MAAM,QAAQ,GAAG,OAAO,MAAM,CAAC,QAAQ,KAAK,WAAW;YACrD,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC5C,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,EAAE;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO;YAC7B,QAAQ;SACT,EAAE,IAAI,CAAC,CAAC;QACT,MAAM,MAAM,GAAG,0BAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE3C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,WAAW,CAAE,MAAc;QACzB,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;QAEnC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE;YACjC,OAAO,MAAM,CAAC;SACf;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAElC,IAAI,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,KAAK,EAAE;YACvC,OAAO,MAAM,CAAC;SACf;aAAM;YACL,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAChC;IACH,CAAC;IAED,IAAI,CAAE,MAAe;QACnB,OAAO,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,GAAG,CAAE,EAAM,EAAE,MAAe;QAC1B,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAID,MAAM,CAAE,IAA+B,EAAE,MAAe;QACtD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;YACtD,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,MAAe;QACtC,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,MAAe;QACtD,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;YAC7C,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,MAAe;QACrC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;YAC9C,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;IAEK,KAAK;8DAAK,CAAC;KAAA;CAClB;AAvGD,wCAuGC"}
+{"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/lib/sort.d.ts

@@ -1,4 +1,6 @@
-export declare function compareNSB(a: any, b: any): 1 | 0 | -1;
-export declare function compareArrays(a: any, b: any): any;
-export declare function compare(a: any, b: any, compareStrings?: any): any;
-export declare function sorter($sort: any): (a: any, b: any) => number;
+export declare function compareNSB(a: any, b: any): 1 | -1 | 0;
+export declare function compareArrays(a: any[], b: any[]): 1 | -1 | 0;
+export declare function compare(a: any, b: any, compareStrings?: any): 0 | 1 | -1;
+export declare function sorter($sort: {
+    [key: string]: -1 | 1;
+}): (a: any, b: any) => number;