@feathersjs/adapter-commons 5.0.0-pre.3 → 5.0.0-pre.31

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Feathers
+Copyright (c) 2022 Feathers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,8 +1,8 @@
 # Feathers Adapter Commons
 
 [![CI](https://github.com/feathersjs/feathers/workflows/Node.js%20CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3A%22Node.js+CI%22)
-[![Dependency Status](https://img.shields.io/david/feathersjs/feathers.svg?style=flat-square&path=packages/adapter-commons)](https://david-dm.org/feathersjs/feathers?path=packages/adapter-commons)
 [![Download Status](https://img.shields.io/npm/dm/@feathersjs/adapter-commons.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/adapter-commons)
+[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
 
 > Shared utility functions for Feathers adatabase adapters
 
@@ -17,6 +17,6 @@ This is a repository for handling Feathers common database syntax. See the [API
 
 ## License
 
-Copyright (c) 2021 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
+Copyright (c) 2022 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
 
 Licensed under the [MIT license](LICENSE).

package/lib/declarations.d.ts

@@ -0,0 +1,146 @@
+import { Query, Params, Paginated, Id, NullableId } from '@feathersjs/feathers';
+export declare type FilterQueryOptions = {
+    filters?: FilterSettings;
+    operators?: string[];
+    paginate?: PaginationParams;
+};
+export declare type QueryFilter = (value: any, options: FilterQueryOptions) => any;
+export declare type FilterSettings = {
+    [key: string]: QueryFilter | true;
+};
+export interface PaginationOptions {
+    default?: number;
+    max?: number;
+}
+export declare 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/lib/declarations.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=declarations.js.map

package/lib/declarations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"declarations.js","sourceRoot":"","sources":["../src/declarations.ts"],"names":[],"mappings":""}

package/lib/index.d.ts

@@ -1,4 +1,6 @@
-export { AdapterService, InternalServiceMethods, ServiceOptions, Paginated } from './service';
-export { filterQuery, FILTERS, OPERATORS } from './filter-query';
+import { Params } from '@feathersjs/feathers';
+export * from './declarations';
+export * from './service';
+export { filterQuery, FILTERS, OPERATORS } from './query';
 export * from './sort';
-export declare function select(params: any, ...otherFields: any[]): (result: any) => any;
+export declare function select(params: Params, ...otherFields: string[]): (result: any) => any;

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,29 +14,26 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.select = exports.OPERATORS = exports.FILTERS = exports.filterQuery = exports.AdapterService = void 0;
+exports.select = exports.OPERATORS = exports.FILTERS = exports.filterQuery = void 0;
 const commons_1 = require("@feathersjs/commons");
-var service_1 = require("./service");
-Object.defineProperty(exports, "AdapterService", { enumerable: true, get: function () { return service_1.AdapterService; } });
-var filter_query_1 = require("./filter-query");
-Object.defineProperty(exports, "filterQuery", { enumerable: true, get: function () { return filter_query_1.filterQuery; } });
-Object.defineProperty(exports, "FILTERS", { enumerable: true, get: function () { return filter_query_1.FILTERS; } });
-Object.defineProperty(exports, "OPERATORS", { enumerable: true, get: function () { return filter_query_1.OPERATORS; } });
+__exportStar(require("./declarations"), exports);
+__exportStar(require("./service"), exports);
+var query_1 = require("./query");
+Object.defineProperty(exports, "filterQuery", { enumerable: true, get: function () { return query_1.filterQuery; } });
+Object.defineProperty(exports, "FILTERS", { enumerable: true, get: function () { return query_1.FILTERS; } });
+Object.defineProperty(exports, "OPERATORS", { enumerable: true, get: function () { return query_1.OPERATORS; } });
 __exportStar(require("./sort"), exports);
 // Return a function that filters a result object or array
 // and picks only the fields passed as `params.query.$select`
 // and additional `otherFields`
 function select(params, ...otherFields) {
-    const fields = params && params.query && params.query.$select;
-    if (Array.isArray(fields) && otherFields.length) {
-        fields.push(...otherFields);
+    var _a;
+    const queryFields = (_a = params === null || params === void 0 ? void 0 : params.query) === null || _a === void 0 ? void 0 : _a.$select;
+    if (!queryFields) {
+        return (result) => result;
     }
-    const convert = (result) => {
-        if (!Array.isArray(fields)) {
-            return result;
-        }
-        return commons_1._.pick(result, ...fields);
-    };
+    const resultFields = queryFields.concat(otherFields);
+    const convert = (result) => commons_1._.pick(result, ...resultFields);
     return (result) => {
         if (Array.isArray(result)) {
             return result.map(convert);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,iDAAwC;AAExC,qCAA8F;AAArF,yGAAA,cAAc,OAAA;AACvB,+CAAiE;AAAxD,2GAAA,WAAW,OAAA;AAAE,uGAAA,OAAO,OAAA;AAAE,yGAAA,SAAS,OAAA;AACxC,yCAAuB;AAEvB,0DAA0D;AAC1D,6DAA6D;AAC7D,+BAA+B;AAC/B,SAAgB,MAAM,CAAE,MAAW,EAAE,GAAG,WAAkB;IACxD,MAAM,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;IAE9D,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,MAAM,EAAE;QAC/C,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;KAC7B;IAED,MAAM,OAAO,GAAG,CAAC,MAAW,EAAE,EAAE;QAC9B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YAC1B,OAAO,MAAM,CAAC;SACf;QAED,OAAO,WAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,OAAO,CAAC,MAAW,EAAE,EAAE;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;SAC5B;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;IACzB,CAAC,CAAC;AACJ,CAAC;AAtBD,wBAsBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAAuC;AAGvC,iDAA8B;AAC9B,4CAAyB;AACzB,iCAAyD;AAAhD,oGAAA,WAAW,OAAA;AAAE,gGAAA,OAAO,OAAA;AAAE,kGAAA,SAAS,OAAA;AACxC,yCAAsB;AAEtB,0DAA0D;AAC1D,6DAA6D;AAC7D,+BAA+B;AAC/B,SAAgB,MAAM,CAAC,MAAc,EAAE,GAAG,WAAqB;;IAC7D,MAAM,WAAW,GAAyB,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,0CAAE,OAAO,CAAA;IAEhE,IAAI,CAAC,WAAW,EAAE;QAChB,OAAO,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAA;KAC/B;IAED,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;IACpD,MAAM,OAAO,GAAG,CAAC,MAAW,EAAE,EAAE,CAAC,WAAC,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,YAAY,CAAC,CAAA;IAEhE,OAAO,CAAC,MAAW,EAAE,EAAE;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;SAC3B;QAED,OAAO,OAAO,CAAC,MAAM,CAAC,CAAA;IACxB,CAAC,CAAA;AACH,CAAC;AAjBD,wBAiBC"}

package/lib/query.d.ts

@@ -0,0 +1,21 @@
+import { Query } from '@feathersjs/feathers';
+import { FilterQueryOptions, FilterSettings } from './declarations';
+export declare const OPERATORS: string[];
+export declare const FILTERS: FilterSettings;
+/**
+ * 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 declare function filterQuery(_query: Query, options?: FilterQueryOptions): {
+    filters: {
+        [key: string]: any;
+    };
+    query: Query;
+};

package/lib/query.js

@@ -0,0 +1,115 @@
+"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,iDAAuC;AACvC,+CAA+C;AAI/C,MAAM,KAAK,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,CAAC,OAAO,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;AAE1F,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE,CAAC,WAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,WAAW,KAAK,EAAE,CAAC,WAAW,CAAA;AAE/F,MAAM,qBAAqB,GAAG,CAAC,KAAU,EAAE,YAAsB,EAAE,EAAS,EAAE;IAC5E,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE;QACzB,OAAO,KAAK,CAAA;KACb;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,CAAA;SAC9D;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QAExB,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE;YACxB,KAAK,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;SACrD;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,CAAA;IAEjD,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;QACzC,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAEpC,IAAI,MAAM,EAAE;YACV,MAAM,KAAK,GAAG,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAA;YAEtF,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;aACrB;SACF;QAED,OAAO,OAAO,CAAA;IAChB,CAAC,EAAE,EAA4B,CAAC,CAAA;AAClC,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,CAAA;IAE9F,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,CAAA;aACpD;SACF;aAAM;YACL,MAAM,CAAC,GAAG,CAAC,GAAG,qBAAqB,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;SACpE;QAED,OAAO,MAAM,CAAA;IACf,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,CAAA;AAEvE,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,CAAA;SACZ;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,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;YAE1E,OAAO,MAAM,CAAA;QACf,CAAC,EAAE,EAA+B,CAAC,CAAA;IACrC,CAAC;IACD,MAAM,EAAE,CAAC,MAAW,EAAE,EAAE,QAAQ,EAAsB,EAAE,EAAE;QACxD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;QAE3B,IAAI,QAAQ,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,QAAQ,CAAC,GAAG,CAAC,EAAE;YAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAA;YAClC,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,CAAA;YACrF,MAAM,KAAK,GAAG,OAAO,QAAQ,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAA;YAEhF,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;SAC9B;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,EAAE,CAAC,MAAW,EAAE,EAAE;QACvB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,EAAE,CAAC,CAAA;SAC7C;QAED,OAAO,MAAM,CAAA;IACf,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,CAAC,OAAO,EAAE,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAA;SACtE;QAED,OAAO,EAAE,CAAA;IACX,CAAC;CACF,CAAA;AAED;;;;;;;;;;GAUG;AACH,SAAgB,WAAW,CAAC,MAAa,EAAE,UAA8B,EAAE;IACzE,MAAM,KAAK,GAAG,MAAM,IAAI,EAAE,CAAA;IAC1B,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[]>;
 }