@feathersjs/knex 5.0.0-pre.24

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [5.0.0-pre.24](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.23...v5.0.0-pre.24) (2022-06-21)
+
+
+### Features
+
+* **knex:** Add KnexJS SQL database adapter to core ([#2671](https://github.com/feathersjs/feathers/issues/2671)) ([9380fff](https://github.com/feathersjs/feathers/commit/9380fff58596e8bb90b8bb098d2795b7eadfec20))

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,22 @@
+# @feathersjs/knex
+
+[![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
+[![Download Status](https://img.shields.io/npm/dm/@feathersjs/mongodb.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/mongodb)
+
+> Feathers SQL service adapter using KnexJS
+
+## Installation
+
+```
+npm install @feathersjs/knex --save
+```
+
+## Documentation
+
+Refer to the [Feathers documentation](https://docs.feathersjs.com) for more details.
+
+## License
+
+Copyright (c) 2022 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
+
+Licensed under the [MIT license](LICENSE).

package/lib/adapter.d.ts

@@ -0,0 +1,64 @@
+import { Id, NullableId, Paginated, Query } from '@feathersjs/feathers';
+import { AdapterBase, AdapterServiceOptions, AdapterParams, AdapterQuery, PaginationOptions } from '@feathersjs/adapter-commons';
+import { Knex } from 'knex';
+export interface KnexAdapterOptions extends AdapterServiceOptions {
+    Model: Knex;
+    name: string;
+    schema?: string;
+}
+export interface KnexAdapterParams<Q = AdapterQuery> extends AdapterParams<Q, Partial<KnexAdapterOptions>> {
+    knex?: Knex.QueryBuilder;
+    transaction?: Knex.Transaction;
+}
+export declare class KnexAdapter<T, D = Partial<T>, P extends KnexAdapterParams<any> = KnexAdapterParams> extends AdapterBase<T, D, P, KnexAdapterOptions> {
+    table: string;
+    schema?: string;
+    constructor(options: KnexAdapterOptions);
+    get Model(): Knex<any, any[]>;
+    get fullName(): string;
+    db(_params?: P): Knex.QueryBuilder<any, {
+        _base: any;
+        _hasSelection: false;
+        _keys: never;
+        _aliases: {};
+        _single: false;
+        _intersectProps: {};
+        _unionProps: never;
+    }[]>;
+    knexify(knexQuery: Knex.QueryBuilder, query?: Query, parentKey?: string): Knex.QueryBuilder;
+    createQuery(params: P): Knex.QueryBuilder<any, {
+        _base: any;
+        _hasSelection: false;
+        _keys: never;
+        _aliases: {};
+        _single: false;
+        _intersectProps: {};
+        _unionProps: never;
+    }[]>;
+    filterQuery(params: P): {
+        filters: {
+            [key: string]: any;
+        };
+        query: Query;
+        paginate: import("@feathersjs/adapter-commons").PaginationParams;
+    };
+    $find(params?: P & {
+        paginate?: PaginationOptions;
+    }): Promise<Paginated<T>>;
+    $find(params?: P & {
+        paginate: false;
+    }): Promise<T[]>;
+    $find(params?: P): Promise<Paginated<T> | T[]>;
+    _findOrGet(id: NullableId, params?: P): Promise<T[]>;
+    $get(id: Id, params?: P): Promise<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[]>;
+    $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[]>;
+    $update(id: Id, _data: D, params?: P): Promise<T>;
+    $remove(id: null, params?: P): Promise<T[]>;
+    $remove(id: Id, params?: P): Promise<T>;
+    $remove(id: NullableId, _params?: P): Promise<T | T[]>;
+}

package/lib/adapter.js

@@ -0,0 +1,239 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnexAdapter = void 0;
+const commons_1 = require("@feathersjs/commons");
+const adapter_commons_1 = require("@feathersjs/adapter-commons");
+const errors_1 = require("@feathersjs/errors");
+const error_handler_1 = require("./error-handler");
+const METHODS = {
+    $ne: 'whereNot',
+    $in: 'whereIn',
+    $nin: 'whereNotIn',
+    $or: 'orWhere',
+    $and: 'andWhere'
+};
+const OPERATORS = {
+    $lt: '<',
+    $lte: '<=',
+    $gt: '>',
+    $gte: '>=',
+    $like: 'like',
+    $notlike: 'not like',
+    $ilike: 'ilike'
+};
+class KnexAdapter extends adapter_commons_1.AdapterBase {
+    constructor(options) {
+        if (!options || !options.Model) {
+            throw new Error('You must provide a Model (the initialized knex object)');
+        }
+        if (typeof options.name !== 'string') {
+            throw new Error('No table name specified.');
+        }
+        super({
+            id: 'id',
+            ...options,
+            filters: {
+                ...options.filters,
+                $and: (value) => value
+            },
+            operators: [...(options.operators || []), '$like', '$notlike', '$ilike', '$and', '$or']
+        });
+        this.table = options.name;
+        this.schema = options.schema;
+    }
+    get Model() {
+        return this.options.Model;
+    }
+    get fullName() {
+        return this.schema ? `${this.schema}.${this.table}` : this.table;
+    }
+    db(_params) {
+        // const { Model, table, schema, fullName } = this
+        // if (params && params.transaction) {
+        //   const { trx, id } = params.transaction
+        //   debug('ran %s with transaction %s', fullName, id)
+        //   return schema ? trx.withSchema(schema).table(table) : trx(table)
+        // }
+        // return schema ? Model.withSchema(schema).table(table) : Model(table)
+        return this.Model(this.table);
+    }
+    knexify(knexQuery, query = {}, parentKey) {
+        const knexify = this.knexify.bind(this);
+        return Object.keys(query || {}).reduce((currentQuery, key) => {
+            const value = query[key];
+            if (commons_1._.isObject(value)) {
+                return knexify(currentQuery, value, key);
+            }
+            const column = parentKey || key;
+            const method = METHODS[key];
+            if (method) {
+                if (key === '$or' || key === '$and') {
+                    // This will create a nested query
+                    currentQuery.where(function () {
+                        for (const condition of value) {
+                            this[method](function () {
+                                knexify(this, condition);
+                            });
+                        }
+                    });
+                    return currentQuery;
+                }
+                return currentQuery[method](column, value);
+            }
+            const operator = OPERATORS[key] || '=';
+            return operator === '='
+                ? currentQuery.where(column, value)
+                : currentQuery.where(column, operator, value);
+        }, knexQuery);
+    }
+    createQuery(params) {
+        const { table, id } = this;
+        const { filters, query } = this.filterQuery(params);
+        const builder = this.db(params);
+        // $select uses a specific find syntax, so it has to come first.
+        if (filters.$select) {
+            // always select the id field, but make sure we only select it once
+            builder.select(...new Set([...filters.$select, `${table}.${id}`]));
+        }
+        else {
+            builder.select(`${table}.*`);
+        }
+        // build up the knex query out of the query params, include $and and $or filters
+        this.knexify(builder, {
+            ...query,
+            ...commons_1._.pick(filters, '$and', '$or')
+        });
+        // Handle $sort
+        if (filters.$sort) {
+            return Object.keys(filters.$sort).reduce((currentQuery, key) => currentQuery.orderBy(key, filters.$sort[key] === 1 ? 'asc' : 'desc'), builder);
+        }
+        return builder;
+    }
+    filterQuery(params) {
+        const options = this.getOptions(params);
+        const { filters, query } = (0, adapter_commons_1.filterQuery)((params === null || params === void 0 ? void 0 : params.query) || {}, options);
+        return { filters, query, paginate: options.paginate };
+    }
+    async $find(params = {}) {
+        const { filters, paginate } = this.filterQuery(params);
+        const builder = params.knex ? params.knex.clone() : this.createQuery(params);
+        const countBuilder = builder.clone().count(`${this.table}.${this.id} as total`);
+        // Handle $limit
+        if (filters.$limit) {
+            builder.limit(filters.$limit);
+        }
+        // Handle $skip
+        if (filters.$skip) {
+            builder.offset(filters.$skip);
+        }
+        // provide default sorting if its not set
+        if (!filters.$sort) {
+            builder.orderBy(`${this.table}.${this.id}`, 'asc');
+        }
+        const data = filters.$limit === 0 ? [] : await builder;
+        if (paginate && paginate.default) {
+            return {
+                total: await countBuilder.then((count) => (count[0] ? count[0].total : 0)),
+                limit: filters.$limit,
+                skip: filters.$skip || 0,
+                data
+            };
+        }
+        return data;
+    }
+    async _findOrGet(id, params) {
+        const findParams = {
+            ...params,
+            paginate: false,
+            query: {
+                ...params === null || params === void 0 ? void 0 : params.query,
+                ...(id !== null ? { [`${this.table}.${this.id}`]: id } : {})
+            }
+        };
+        return this.$find(findParams);
+    }
+    async $get(id, params = {}) {
+        const data = await this._findOrGet(id, params);
+        if (data.length !== 1) {
+            throw new errors_1.NotFound(`No record found for id '${id}'`);
+        }
+        return data[0];
+    }
+    async $create(_data, params = {}) {
+        const data = _data;
+        if (Array.isArray(data)) {
+            return Promise.all(data.map((current) => this.$create(current, params)));
+        }
+        const client = this.db(params).client.config.client;
+        const returning = client === 'pg' || client === 'oracledb' || client === 'mssql' ? [this.id] : [];
+        const rows = await this.db(params).insert(data, returning).catch(error_handler_1.errorHandler);
+        const id = data[this.id] || rows[0][this.id] || rows[0];
+        if (!id) {
+            return rows;
+        }
+        return this.$get(id, params);
+    }
+    async $patch(id, raw, params = {}) {
+        var _a, _b;
+        const data = commons_1._.omit(raw, this.id);
+        const results = await this._findOrGet(id, {
+            ...params,
+            query: {
+                ...params === null || params === void 0 ? void 0 : params.query,
+                $select: [`${this.table}.${this.id}`]
+            }
+        });
+        const idList = results.map((current) => current[this.id]);
+        const updateParams = {
+            ...params,
+            query: {
+                [`${this.table}.${this.id}`]: { $in: idList },
+                ...(((_a = params === null || params === void 0 ? void 0 : params.query) === null || _a === void 0 ? void 0 : _a.$select) ? { $select: (_b = params === null || params === void 0 ? void 0 : params.query) === null || _b === void 0 ? void 0 : _b.$select } : {})
+            }
+        };
+        const builder = this.createQuery(updateParams);
+        await builder.update(data);
+        const items = await this._findOrGet(null, updateParams);
+        if (id !== null) {
+            if (items.length === 1) {
+                return items[0];
+            }
+            else {
+                throw new errors_1.NotFound(`No record found for id '${id}'`);
+            }
+        }
+        return items;
+    }
+    async $update(id, _data, params = {}) {
+        const data = commons_1._.omit(_data, this.id);
+        const oldData = await this.$get(id, params);
+        const newObject = Object.keys(oldData).reduce((result, key) => {
+            if (key !== this.id) {
+                // We don't want the id field to be changed
+                result[key] = data[key] === undefined ? null : data[key];
+            }
+            return result;
+        }, {});
+        await this.db(params).update(newObject, '*').where(this.id, id);
+        return this.$get(id, params);
+    }
+    async $remove(id, params = {}) {
+        const items = await this._findOrGet(id, params);
+        const { query } = this.filterQuery(params);
+        const q = this.db(params);
+        const idList = items.map((current) => current[this.id]);
+        query[this.id] = { $in: idList };
+        // build up the knex query out of the query params
+        this.knexify(q, query);
+        await q.del().catch(error_handler_1.errorHandler);
+        if (id !== null) {
+            if (items.length === 1) {
+                return items[0];
+            }
+            throw new errors_1.NotFound(`No record found for id '${id}'`);
+        }
+        return items;
+    }
+}
+exports.KnexAdapter = KnexAdapter;
+//# sourceMappingURL=adapter.js.map

package/lib/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":";;;AACA,iDAAuC;AACvC,iEAOoC;AACpC,+CAA6C;AAG7C,mDAA8C;AAE9C,MAAM,OAAO,GAAG;IACd,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,YAAY;IAClB,GAAG,EAAE,SAAS;IACd,IAAI,EAAE,UAAU;CACjB,CAAA;AAED,MAAM,SAAS,GAAG;IAChB,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,GAAG;IACR,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,MAAM;IACb,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,OAAO;CAChB,CAAA;AAaD,MAAa,WAIX,SAAQ,6BAAwC;IAIhD,YAAY,OAA2B;QACrC,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;SAC1E;QAED,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;YACpC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,KAAK,CAAC;YACJ,EAAE,EAAE,IAAI;YACR,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,OAAO,CAAC,OAAO;gBAClB,IAAI,EAAE,CAAC,KAAU,EAAE,EAAE,CAAC,KAAK;aAC5B;YACD,SAAS,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;SACxF,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAA;QACzB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;IAC9B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAA;IAC3B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;IAClE,CAAC;IAED,EAAE,CAAC,OAAW;QACZ,kDAAkD;QAElD,sCAAsC;QACtC,2CAA2C;QAC3C,sDAAsD;QACtD,qEAAqE;QACrE,IAAI;QACJ,uEAAuE;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;IAED,OAAO,CAAC,SAA4B,EAAE,QAAe,EAAE,EAAE,SAAkB;QACzE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEvC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE;YAC3D,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;YAExB,IAAI,WAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBACrB,OAAO,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,GAAG,CAAC,CAAA;aACzC;YAED,MAAM,MAAM,GAAG,SAAS,IAAI,GAAG,CAAA;YAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,GAA2B,CAAC,CAAA;YAEnD,IAAI,MAAM,EAAE;gBACV,IAAI,GAAG,KAAK,KAAK,IAAI,GAAG,KAAK,MAAM,EAAE;oBACnC,kCAAkC;oBAClC,YAAY,CAAC,KAAK,CAAC;wBACjB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE;4BAC7B,IAAI,CAAC,MAAM,CAAC,CAAC;gCACX,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;4BAC1B,CAAC,CAAC,CAAA;yBACH;oBACH,CAAC,CAAC,CAAA;oBAEF,OAAO,YAAY,CAAA;iBACpB;gBAED,OAAQ,YAAoB,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;aACpD;YAED,MAAM,QAAQ,GAAG,SAAS,CAAC,GAA6B,CAAC,IAAI,GAAG,CAAA;YAEhE,OAAO,QAAQ,KAAK,GAAG;gBACrB,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC;gBACnC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAA;QACjD,CAAC,EAAE,SAAS,CAAC,CAAA;IACf,CAAC;IAED,WAAW,CAAC,MAAS;QACnB,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,IAAI,CAAA;QAC1B,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;QAE/B,gEAAgE;QAChE,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,mEAAmE;YACnE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;SACnE;aAAM;YACL,OAAO,CAAC,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC,CAAA;SAC7B;QAED,gFAAgF;QAChF,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACpB,GAAG,KAAK;YACR,GAAG,WAAC,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC;SAClC,CAAC,CAAA;QAEF,eAAe;QACf,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CACtC,CAAC,YAAY,EAAE,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAC3F,OAAO,CACR,CAAA;SACF;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,WAAW,CAAC,MAAS;QACnB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAA,6BAAW,EAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,KAAI,EAAE,EAAE,OAAO,CAAC,CAAA;QAEpE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAA;IACvD,CAAC;IAKD,KAAK,CAAC,KAAK,CAAC,SAAY,EAAO;QAC7B,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QACtD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC5E,MAAM,YAAY,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,WAAW,CAAC,CAAA;QAE/E,gBAAgB;QAChB,IAAI,OAAO,CAAC,MAAM,EAAE;YAClB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAA;SAC9B;QAED,eAAe;QACf,IAAI,OAAO,CAAC,KAAK,EAAE;YACjB,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;SAC9B;QAED,yCAAyC;QACzC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;YAClB,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;SACnD;QAED,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,OAAO,CAAA;QAEtD,IAAI,QAAQ,IAAI,QAAQ,CAAC,OAAO,EAAE;YAChC,OAAO;gBACL,KAAK,EAAE,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC1E,KAAK,EAAE,OAAO,CAAC,MAAM;gBACrB,IAAI,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;gBACxB,IAAI;aACL,CAAA;SACF;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAc,EAAE,MAAU;QACzC,MAAM,UAAU,GAAG;YACjB,GAAG,MAAM;YACT,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE;gBACL,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK;gBAChB,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC7D;SACF,CAAA;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,UAAiB,CAAwB,CAAA;IAC7D,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,EAAM,EAAE,SAAY,EAAO;QACpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAE9C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,MAAM,IAAI,iBAAQ,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;SACrD;QAED,OAAO,IAAI,CAAC,CAAC,CAAC,CAAA;IAChB,CAAC;IAKD,KAAK,CAAC,OAAO,CAAC,KAAgC,EAAE,SAAY,EAAO;QACjE,MAAM,IAAI,GAAG,KAAY,CAAA;QAEzB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;SACzE;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAA;QACnD,MAAM,SAAS,GAAG,MAAM,KAAK,IAAI,IAAI,MAAM,KAAK,UAAU,IAAI,MAAM,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACjG,MAAM,IAAI,GAAQ,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,KAAK,CAAC,4BAAY,CAAC,CAAA;QACnF,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAA;QAEvD,IAAI,CAAC,EAAE,EAAE;YACP,OAAO,IAAW,CAAA;SACnB;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC;IAKD,KAAK,CAAC,MAAM,CAAC,EAAc,EAAE,GAAe,EAAE,SAAY,EAAO;;QAC/D,MAAM,IAAI,GAAG,WAAC,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QACjC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE;YACxC,GAAG,MAAM;YACT,KAAK,EAAE;gBACL,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK;gBAChB,OAAO,EAAE,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;aACtC;SACF,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QAC9D,MAAM,YAAY,GAAG;YACnB,GAAG,MAAM;YACT,KAAK,EAAE;gBACL,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE;gBAC7C,GAAG,CAAC,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,0CAAE,OAAO,EAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACvE;SACF,CAAA;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAA;QAE9C,MAAM,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAE1B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;QAEvD,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAA;aAChB;iBAAM;gBACL,MAAM,IAAI,iBAAQ,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;aACrD;SACF;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAM,EAAE,KAAQ,EAAE,SAAY,EAAO;QACjD,MAAM,IAAI,GAAG,WAAC,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC3C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,MAAW,EAAE,GAAG,EAAE,EAAE;YACjE,IAAI,GAAG,KAAK,IAAI,CAAC,EAAE,EAAE;gBACnB,2CAA2C;gBAC3C,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;aACzD;YAED,OAAO,MAAM,CAAA;QACf,CAAC,EAAE,EAAE,CAAC,CAAA;QAEN,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,CAAA;QAE/D,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC;IAKD,KAAK,CAAC,OAAO,CAAC,EAAc,EAAE,SAAY,EAAO;QAC/C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC1C,MAAM,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAA;QACzB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,OAAY,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QAE5D,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAA;QAEhC,kDAAkD;QAClD,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAEtB,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,4BAAY,CAAC,CAAA;QAEjC,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACtB,OAAO,KAAK,CAAC,CAAC,CAAC,CAAA;aAChB;YAED,MAAM,IAAI,iBAAQ,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAA;SACrD;QAED,OAAO,KAAK,CAAA;IACd,CAAC;CACF;AAhSD,kCAgSC"}

package/lib/error-handler.d.ts

@@ -0,0 +1,2 @@
+export declare const ERROR: unique symbol;
+export declare function errorHandler(error: any): void;

package/lib/error-handler.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorHandler = exports.ERROR = void 0;
+const errors_1 = require("@feathersjs/errors");
+exports.ERROR = Symbol('@feathersjs/knex/error');
+function errorHandler(error) {
+    const { message } = error;
+    let feathersError = error;
+    if (error.sqlState && error.sqlState.length) {
+        // remove SQLSTATE marker (#) and pad/truncate SQLSTATE to 5 chars
+        const sqlState = ('00000' + error.sqlState.replace('#', '')).slice(-5);
+        switch (sqlState.slice(0, 2)) {
+            case '02':
+                feathersError = new errors_1.errors.NotFound(message);
+                break;
+            case '28':
+                feathersError = new errors_1.errors.Forbidden(message);
+                break;
+            case '08':
+            case '0A':
+            case '0K':
+                feathersError = new errors_1.errors.Unavailable(message);
+                break;
+            case '20':
+            case '21':
+            case '22':
+            case '23':
+            case '24':
+            case '25':
+            case '40':
+            case '42':
+            case '70':
+                feathersError = new errors_1.errors.BadRequest(message);
+                break;
+            default:
+                feathersError = new errors_1.errors.GeneralError(message);
+        }
+    }
+    else if (error.code === 'SQLITE_ERROR') {
+        // NOTE (EK): Error codes taken from
+        // https://www.sqlite.org/c3ref/c_abort.html
+        switch (error.errno) {
+            case 1:
+            case 8:
+            case 18:
+            case 19:
+            case 20:
+                feathersError = new errors_1.errors.BadRequest(message);
+                break;
+            case 2:
+                feathersError = new errors_1.errors.Unavailable(message);
+                break;
+            case 3:
+            case 23:
+                feathersError = new errors_1.errors.Forbidden(message);
+                break;
+            case 12:
+                feathersError = new errors_1.errors.NotFound(message);
+                break;
+            default:
+                feathersError = new errors_1.errors.GeneralError(message);
+                break;
+        }
+    }
+    else if (typeof error.code === 'string' && error.severity && error.routine) {
+        // NOTE: Error codes taken from
+        // https://www.postgresql.org/docs/9.6/static/errcodes-appendix.html
+        // Omit query information
+        const messages = error.message.split('-');
+        error.message = messages[messages.length - 1];
+        switch (error.code.slice(0, 2)) {
+            case '22':
+            case '23':
+                feathersError = new errors_1.errors.BadRequest(message);
+                break;
+            case '28':
+                feathersError = new errors_1.errors.Forbidden(message);
+                break;
+            case '3D':
+            case '3F':
+            case '42':
+                feathersError = new errors_1.errors.Unprocessable(message);
+                break;
+            default:
+                feathersError = new errors_1.errors.GeneralError(message);
+                break;
+        }
+    }
+    else if (!(error instanceof errors_1.errors.FeathersError)) {
+        feathersError = new errors_1.errors.GeneralError(message);
+    }
+    feathersError[exports.ERROR] = error;
+    throw feathersError;
+}
+exports.errorHandler = errorHandler;
+//# sourceMappingURL=error-handler.js.map

package/lib/error-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-handler.js","sourceRoot":"","sources":["../src/error-handler.ts"],"names":[],"mappings":";;;AAAA,+CAA2C;AAE9B,QAAA,KAAK,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAA;AAErD,SAAgB,YAAY,CAAC,KAAU;IACrC,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAA;IACzB,IAAI,aAAa,GAAG,KAAK,CAAA;IAEzB,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE;QAC3C,kEAAkE;QAClE,MAAM,QAAQ,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;QAEtE,QAAQ,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;YAC5B,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;gBAC5C,MAAK;YACP,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBAC7C,MAAK;YACP,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;gBAC/C,MAAK;YACP,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;gBAC9C,MAAK;YACP;gBACE,aAAa,GAAG,IAAI,eAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;SACnD;KACF;SAAM,IAAI,KAAK,CAAC,IAAI,KAAK,cAAc,EAAE;QACxC,oCAAoC;QACpC,4CAA4C;QAC5C,QAAQ,KAAK,CAAC,KAAK,EAAE;YACnB,KAAK,CAAC,CAAC;YACP,KAAK,CAAC,CAAC;YACP,KAAK,EAAE,CAAC;YACR,KAAK,EAAE,CAAC;YACR,KAAK,EAAE;gBACL,aAAa,GAAG,IAAI,eAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;gBAC9C,MAAK;YACP,KAAK,CAAC;gBACJ,aAAa,GAAG,IAAI,eAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;gBAC/C,MAAK;YACP,KAAK,CAAC,CAAC;YACP,KAAK,EAAE;gBACL,aAAa,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBAC7C,MAAK;YACP,KAAK,EAAE;gBACL,aAAa,GAAG,IAAI,eAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;gBAC5C,MAAK;YACP;gBACE,aAAa,GAAG,IAAI,eAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;gBAChD,MAAK;SACR;KACF;SAAM,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,OAAO,EAAE;QAC5E,+BAA+B;QAC/B,oEAAoE;QACpE,yBAAyB;QACzB,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACzC,KAAK,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;QAE7C,QAAQ,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE;YAC9B,KAAK,IAAI,CAAC;YACV,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;gBAC9C,MAAK;YACP,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;gBAC7C,MAAK;YACP,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,IAAI;gBACP,aAAa,GAAG,IAAI,eAAM,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;gBACjD,MAAK;YACP;gBACE,aAAa,GAAG,IAAI,eAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;gBAChD,MAAK;SACR;KACF;SAAM,IAAI,CAAC,CAAC,KAAK,YAAY,eAAM,CAAC,aAAa,CAAC,EAAE;QACnD,aAAa,GAAG,IAAI,eAAM,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;KACjD;IAED,aAAa,CAAC,aAAK,CAAC,GAAG,KAAK,CAAA;IAE5B,MAAM,aAAa,CAAA;AACrB,CAAC;AA1FD,oCA0FC"}

package/lib/hooks.js

@@ -0,0 +1,82 @@
+"use strict";
+// import { createDebug } from '@feathersjs/commons'
+// import { HookContext } from '@feathersjs/feathers'
+// const debug = createDebug('feathers-knex-transaction')
+// const ROLLBACK = { rollback: true }
+// export const getKnex = (context: HookContext) => {
+//   const knex = context.service.Model
+//   return knex && typeof knex.transaction === 'function' ? knex : undefined
+// }
+// export const start = (options = {}) => {
+//   options = Object.assign({ getKnex }, options)
+//   return (context: HookContext) => {
+//     const { transaction } = context.params
+//     const parent = transaction
+//     const knex = transaction ? transaction.trx : options.getKnex(context)
+//     if (!knex) {
+//       return
+//     }
+//     return new Promise((resolve, reject) => {
+//       const transaction = {}
+//       if (parent) {
+//         transaction.parent = parent
+//         transaction.committed = parent.committed
+//       } else {
+//         transaction.committed = new Promise((resolve) => {
+//           transaction.resolve = resolve
+//         })
+//       }
+//       transaction.starting = true
+//       transaction.promise = knex
+//         .transaction((trx) => {
+//           transaction.trx = trx
+//           transaction.id = Date.now()
+//           context.params = { ...context.params, transaction }
+//           debug('started a new transaction %s', transaction.id)
+//           resolve()
+//         })
+//         .catch((error) => {
+//           if (transaction.starting) {
+//             reject(error)
+//           } else if (error !== ROLLBACK) {
+//             throw error
+//           }
+//         })
+//     })
+//   }
+// }
+// export const end = () => {
+//   return (hook) => {
+//     const { transaction } = hook.params
+//     if (!transaction) {
+//       return
+//     }
+//     const { trx, id, promise, parent } = transaction
+//     hook.params = { ...hook.params, transaction: parent }
+//     transaction.starting = false
+//     return trx
+//       .commit()
+//       .then(() => promise)
+//       .then(() => transaction.resolve && transaction.resolve(true))
+//       .then(() => debug('ended transaction %s', id))
+//       .then(() => hook)
+//   }
+// }
+// export const rollback = () => {
+//   return (hook) => {
+//     const { transaction } = hook.params
+//     if (!transaction) {
+//       return
+//     }
+//     const { trx, id, promise, parent } = transaction
+//     hook.params = { ...hook.params, transaction: parent }
+//     transaction.starting = false
+//     return trx
+//       .rollback(ROLLBACK)
+//       .then(() => promise)
+//       .then(() => transaction.resolve && transaction.resolve(false))
+//       .then(() => debug('rolled back transaction %s', id))
+//       .then(() => hook)
+//   }
+// }
+//# sourceMappingURL=hooks.js.map

package/lib/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,qDAAqD;AAErD,yDAAyD;AAEzD,sCAAsC;AAEtC,qDAAqD;AACrD,uCAAuC;AAEvC,6EAA6E;AAC7E,IAAI;AAEJ,2CAA2C;AAC3C,kDAAkD;AAElD,uCAAuC;AACvC,6CAA6C;AAC7C,iCAAiC;AACjC,4EAA4E;AAE5E,mBAAmB;AACnB,eAAe;AACf,QAAQ;AAER,gDAAgD;AAChD,+BAA+B;AAE/B,sBAAsB;AACtB,sCAAsC;AACtC,mDAAmD;AACnD,iBAAiB;AACjB,6DAA6D;AAC7D,0CAA0C;AAC1C,aAAa;AACb,UAAU;AAEV,oCAAoC;AACpC,mCAAmC;AACnC,kCAAkC;AAClC,kCAAkC;AAClC,wCAAwC;AAExC,gEAAgE;AAEhE,kEAAkE;AAElE,sBAAsB;AACtB,aAAa;AACb,8BAA8B;AAC9B,wCAAwC;AACxC,4BAA4B;AAC5B,6CAA6C;AAC7C,0BAA0B;AAC1B,cAAc;AACd,aAAa;AACb,SAAS;AACT,MAAM;AACN,IAAI;AAEJ,6BAA6B;AAC7B,uBAAuB;AACvB,0CAA0C;AAE1C,0BAA0B;AAC1B,eAAe;AACf,QAAQ;AAER,uDAAuD;AAEvD,4DAA4D;AAC5D,mCAAmC;AAEnC,iBAAiB;AACjB,kBAAkB;AAClB,6BAA6B;AAC7B,sEAAsE;AACtE,uDAAuD;AACvD,0BAA0B;AAC1B,MAAM;AACN,IAAI;AAEJ,kCAAkC;AAClC,uBAAuB;AACvB,0CAA0C;AAE1C,0BAA0B;AAC1B,eAAe;AACf,QAAQ;AAER,uDAAuD;AAEvD,4DAA4D;AAC5D,mCAAmC;AAEnC,iBAAiB;AACjB,4BAA4B;AAC5B,6BAA6B;AAC7B,uEAAuE;AACvE,6DAA6D;AAC7D,0BAA0B;AAC1B,MAAM;AACN,IAAI"}

package/lib/index.d.ts

@@ -0,0 +1,22 @@
+import { PaginationOptions } from '@feathersjs/adapter-commons';
+import { Paginated, ServiceMethods, Id } from '@feathersjs/feathers';
+import { KnexAdapter, KnexAdapterParams } from './adapter';
+export * from './adapter';
+export * from './error-handler';
+export declare class KnexService<T = any, D = Partial<T>, P extends KnexAdapterParams<any> = KnexAdapterParams> extends KnexAdapter<T, D, P> implements ServiceMethods<T | Paginated<T>, D, P> {
+    find(params?: P & {
+        paginate?: PaginationOptions;
+    }): Promise<Paginated<T>>;
+    find(params?: P & {
+        paginate: false;
+    }): Promise<T[]>;
+    find(params?: P): Promise<Paginated<T> | T[]>;
+    get(id: Id, params?: P): Promise<T>;
+    create(data: Partial<D>, params?: P): Promise<T>;
+    create(data: Partial<D>[], params?: P): Promise<T[]>;
+    update(id: Id, data: D, params?: P): Promise<T>;
+    patch(id: Id, data: Partial<D>, params?: P): Promise<T>;
+    patch(id: null, data: Partial<D>, params?: P): Promise<T[]>;
+    remove(id: Id, params?: P): Promise<T>;
+    remove(id: null, params?: P): Promise<T[]>;
+}

package/lib/index.js

@@ -0,0 +1,43 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+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.KnexService = void 0;
+const adapter_1 = require("./adapter");
+__exportStar(require("./adapter"), exports);
+__exportStar(require("./error-handler"), exports);
+// export * from './hooks'
+class KnexService extends adapter_1.KnexAdapter {
+    async find(params) {
+        return this._find(params);
+    }
+    async get(id, params) {
+        return this._get(id, params);
+    }
+    async create(data, params) {
+        return this._create(data, params);
+    }
+    async update(id, data, params) {
+        return this._update(id, data, params);
+    }
+    async patch(id, data, params) {
+        return this._patch(id, data, params);
+    }
+    async remove(id, params) {
+        return this._remove(id, params);
+    }
+}
+exports.KnexService = KnexService;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAEA,uCAA0D;AAE1D,4CAAyB;AACzB,kDAA+B;AAC/B,0BAA0B;AAE1B,MAAa,WACX,SAAQ,qBAAoB;IAM5B,KAAK,CAAC,IAAI,CAAC,MAAU;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAQ,CAAA;IAClC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EAAM,EAAE,MAAU;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IAC9B,CAAC;IAID,KAAK,CAAC,MAAM,CAAC,IAA+B,EAAE,MAAU;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACnC,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAM,EAAE,IAAO,EAAE,MAAU;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACvC,CAAC;IAID,KAAK,CAAC,KAAK,CAAC,EAAc,EAAE,IAAgB,EAAE,MAAU;QACtD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;IACtC,CAAC;IAID,KAAK,CAAC,MAAM,CAAC,EAAc,EAAE,MAAU;QACrC,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;IACjC,CAAC;CACF;AApCD,kCAoCC"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@feathersjs/knex",
+  "description": "Feathers SQL service adapter using KnexJS",
+  "version": "5.0.0-pre.24",
+  "homepage": "https://feathersjs.com",
+  "main": "lib/",
+  "keywords": [
+    "feathers",
+    "feathers-plugin"
+  ],
+  "license": "MIT",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/daffl"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/feathersjs/feathers.git"
+  },
+  "author": {
+    "name": "Feathers contributors",
+    "email": "hello@feathersjs.com",
+    "url": "https://feathersjs.com"
+  },
+  "contributors": [],
+  "bugs": {
+    "url": "https://github.com/feathersjs/feathers/issues"
+  },
+  "engines": {
+    "node": ">= 14"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "src/**",
+    "lib/**",
+    "*.d.ts",
+    "*.js"
+  ],
+  "scripts": {
+    "compile": "shx rm -rf lib/ && tsc",
+    "test": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@feathersjs/adapter-commons": "^5.0.0-pre.24",
+    "@feathersjs/commons": "^5.0.0-pre.24",
+    "@feathersjs/errors": "^5.0.0-pre.24",
+    "@feathersjs/feathers": "^5.0.0-pre.24"
+  },
+  "peerDependencies": {
+    "knex": "^2.1.0"
+  },
+  "devDependencies": {
+    "@feathersjs/adapter-tests": "^5.0.0-pre.24",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.40",
+    "knex": "^2.1.0",
+    "mocha": "^10.0.0",
+    "shx": "^0.3.4",
+    "sqlite3": "^5.0.8",
+    "typescript": "^4.7.3"
+  },
+  "gitHead": "72779fa2938f43d7b345b6861ff0035481a07de3"
+}

package/src/adapter.ts

@@ -0,0 +1,314 @@
+import { Id, NullableId, Paginated, Query } from '@feathersjs/feathers'
+import { _ } from '@feathersjs/commons'
+import { AdapterBase, PaginationOptions, filterQuery } from '@feathersjs/adapter-commons'
+import { NotFound } from '@feathersjs/errors'
+import { Knex } from 'knex'
+
+import { errorHandler } from './error-handler'
+import { KnexAdapterOptions, KnexAdapterParams } from './declarations'
+const METHODS = {
+  $ne: 'whereNot',
+  $in: 'whereIn',
+  $nin: 'whereNotIn',
+  $or: 'orWhere',
+  $and: 'andWhere'
+}
+
+const OPERATORS = {
+  $lt: '<',
+  $lte: '<=',
+  $gt: '>',
+  $gte: '>=',
+  $like: 'like',
+  $notlike: 'not like',
+  $ilike: 'ilike'
+}
+
+export class KnexAdapter<
+  T,
+  D = Partial<T>,
+  P extends KnexAdapterParams<any> = KnexAdapterParams
+> extends AdapterBase<T, D, P, KnexAdapterOptions> {
+  table: string
+  schema?: string
+
+  constructor(options: KnexAdapterOptions) {
+    if (!options || !options.Model) {
+      throw new Error('You must provide a Model (the initialized knex object)')
+    }
+
+    if (typeof options.name !== 'string') {
+      throw new Error('No table name specified.')
+    }
+
+    super({
+      id: 'id',
+      ...options,
+      filters: {
+        ...options.filters,
+        $and: (value: any) => value
+      },
+      operators: [...(options.operators || []), '$like', '$notlike', '$ilike', '$and', '$or']
+    })
+
+    this.table = options.name
+    this.schema = options.schema
+  }
+
+  get Model() {
+    return this.options.Model
+  }
+
+  get fullName() {
+    return this.schema ? `${this.schema}.${this.table}` : this.table
+  }
+
+  db(params?: P) {
+    const { Model, table, schema } = this
+
+    if (params && params.transaction && params.transaction.trx) {
+      const { trx } = params.transaction
+      // debug('ran %s with transaction %s', fullName, id)
+      return schema ? (trx.withSchema(schema).table(table) as Knex.QueryBuilder) : trx(table)
+    }
+    return schema ? (Model.withSchema(schema).table(table) as Knex.QueryBuilder) : Model(table)
+  }
+
+  knexify(knexQuery: Knex.QueryBuilder, query: Query = {}, parentKey?: string): Knex.QueryBuilder {
+    const knexify = this.knexify.bind(this)
+
+    return Object.keys(query || {}).reduce((currentQuery, key) => {
+      const value = query[key]
+
+      if (_.isObject(value)) {
+        return knexify(currentQuery, value, key)
+      }
+
+      const column = parentKey || key
+      const method = METHODS[key as keyof typeof METHODS]
+
+      if (method) {
+        if (key === '$or' || key === '$and') {
+          // This will create a nested query
+          currentQuery.where(function (this: any) {
+            for (const condition of value) {
+              this[method](function (this: Knex.QueryBuilder) {
+                knexify(this, condition)
+              })
+            }
+          })
+
+          return currentQuery
+        }
+
+        return (currentQuery as any)[method](column, value)
+      }
+
+      const operator = OPERATORS[key as keyof typeof OPERATORS] || '='
+
+      return operator === '='
+        ? currentQuery.where(column, value)
+        : currentQuery.where(column, operator, value)
+    }, knexQuery)
+  }
+
+  createQuery(params: P) {
+    const { table, id } = this
+    const { filters, query } = this.filterQuery(params)
+    const builder = this.db(params)
+
+    // $select uses a specific find syntax, so it has to come first.
+    if (filters.$select) {
+      // always select the id field, but make sure we only select it once
+      builder.select(...new Set([...filters.$select, `${table}.${id}`]))
+    } else {
+      builder.select(`${table}.*`)
+    }
+
+    // build up the knex query out of the query params, include $and and $or filters
+    this.knexify(builder, {
+      ...query,
+      ..._.pick(filters, '$and', '$or')
+    })
+
+    // Handle $sort
+    if (filters.$sort) {
+      return Object.keys(filters.$sort).reduce(
+        (currentQuery, key) => currentQuery.orderBy(key, filters.$sort[key] === 1 ? 'asc' : 'desc'),
+        builder
+      )
+    }
+
+    return builder
+  }
+
+  filterQuery(params: P) {
+    const options = this.getOptions(params)
+    const { filters, query } = filterQuery(params?.query || {}, options)
+
+    return { filters, query, paginate: options.paginate }
+  }
+
+  async $find(params?: P & { paginate?: PaginationOptions }): Promise<Paginated<T>>
+  async $find(params?: P & { paginate: false }): Promise<T[]>
+  async $find(params?: P): Promise<Paginated<T> | T[]>
+  async $find(params: P = {} as P): Promise<Paginated<T> | T[]> {
+    const { filters, paginate } = this.filterQuery(params)
+    const builder = params.knex ? params.knex.clone() : this.createQuery(params)
+    const countBuilder = builder.clone().count(`${this.table}.${this.id} as total`)
+
+    // Handle $limit
+    if (filters.$limit) {
+      builder.limit(filters.$limit)
+    }
+
+    // Handle $skip
+    if (filters.$skip) {
+      builder.offset(filters.$skip)
+    }
+
+    // provide default sorting if its not set
+    if (!filters.$sort) {
+      builder.orderBy(`${this.table}.${this.id}`, 'asc')
+    }
+
+    const data = filters.$limit === 0 ? [] : await builder
+
+    if (paginate && paginate.default) {
+      return {
+        total: await countBuilder.then((count) => (count[0] ? count[0].total : 0)),
+        limit: filters.$limit,
+        skip: filters.$skip || 0,
+        data
+      }
+    }
+
+    return data
+  }
+
+  async _findOrGet(id: NullableId, params?: P) {
+    const findParams = {
+      ...params,
+      paginate: false,
+      query: {
+        ...params?.query,
+        ...(id !== null ? { [`${this.table}.${this.id}`]: id } : {})
+      }
+    }
+
+    return this.$find(findParams as any) as any as Promise<T[]>
+  }
+
+  async $get(id: Id, params: P = {} as P): Promise<T> {
+    const data = await this._findOrGet(id, params)
+
+    if (data.length !== 1) {
+      throw new NotFound(`No record found for id '${id}'`)
+    }
+
+    return data[0]
+  }
+
+  async $create(data: Partial<D>, params?: P): Promise<T>
+  async $create(data: Partial<D>[], params?: P): Promise<T[]>
+  async $create(data: Partial<D> | Partial<D>[], _params?: P): Promise<T | T[]>
+  async $create(_data: Partial<D> | Partial<D>[], params: P = {} as P): Promise<T | T[]> {
+    const data = _data as any
+
+    if (Array.isArray(data)) {
+      return Promise.all(data.map((current) => this.$create(current, params)))
+    }
+
+    const client = this.db(params).client.config.client
+    const returning = client === 'pg' || client === 'oracledb' || client === 'mssql' ? [this.id] : []
+    const rows: any = await this.db(params).insert(data, returning).catch(errorHandler)
+    const id = data[this.id] || rows[0][this.id] || rows[0]
+
+    if (!id) {
+      return rows as T[]
+    }
+
+    return this.$get(id, params)
+  }
+
+  async $patch(id: null, data: Partial<D>, params?: P): Promise<T[]>
+  async $patch(id: Id, data: Partial<D>, params?: P): Promise<T>
+  async $patch(id: NullableId, data: Partial<D>, _params?: P): Promise<T | T[]>
+  async $patch(id: NullableId, raw: Partial<D>, params: P = {} as P): Promise<T | T[]> {
+    const data = _.omit(raw, this.id)
+    const results = await this._findOrGet(id, {
+      ...params,
+      query: {
+        ...params?.query,
+        $select: [`${this.table}.${this.id}`]
+      }
+    })
+    const idList = results.map((current: any) => current[this.id])
+    const updateParams = {
+      ...params,
+      query: {
+        [`${this.table}.${this.id}`]: { $in: idList },
+        ...(params?.query?.$select ? { $select: params?.query?.$select } : {})
+      }
+    }
+    const builder = this.createQuery(updateParams)
+
+    await builder.update(data)
+
+    const items = await this._findOrGet(null, updateParams)
+
+    if (id !== null) {
+      if (items.length === 1) {
+        return items[0]
+      } else {
+        throw new NotFound(`No record found for id '${id}'`)
+      }
+    }
+
+    return items
+  }
+
+  async $update(id: Id, _data: D, params: P = {} as P): Promise<T> {
+    const data = _.omit(_data, this.id)
+    const oldData = await this.$get(id, params)
+    const newObject = Object.keys(oldData).reduce((result: any, key) => {
+      if (key !== this.id) {
+        // We don't want the id field to be changed
+        result[key] = data[key] === undefined ? null : data[key]
+      }
+
+      return result
+    }, {})
+
+    await this.db(params).update(newObject, '*').where(this.id, id)
+
+    return this.$get(id, params)
+  }
+
+  async $remove(id: null, params?: P): Promise<T[]>
+  async $remove(id: Id, params?: P): Promise<T>
+  async $remove(id: NullableId, _params?: P): Promise<T | T[]>
+  async $remove(id: NullableId, params: P = {} as P): Promise<T | T[]> {
+    const items = await this._findOrGet(id, params)
+    const { query } = this.filterQuery(params)
+    const q = this.db(params)
+    const idList = items.map((current: any) => current[this.id])
+
+    query[this.id] = { $in: idList }
+
+    // build up the knex query out of the query params
+    this.knexify(q, query)
+
+    await q.del().catch(errorHandler)
+
+    if (id !== null) {
+      if (items.length === 1) {
+        return items[0]
+      }
+
+      throw new NotFound(`No record found for id '${id}'`)
+    }
+
+    return items
+  }
+}

package/src/declarations.ts

@@ -0,0 +1,23 @@
+import { Knex } from 'knex'
+import { AdapterServiceOptions, AdapterParams, AdapterQuery } from '@feathersjs/adapter-commons'
+
+export interface KnexAdapterOptions extends AdapterServiceOptions {
+  Model: Knex
+  name: string
+  schema?: string
+}
+
+export interface KnexAdapterTransaction {
+  starting: boolean
+  parent?: KnexAdapterTransaction
+  committed?: any
+  resolve?: any
+  trx?: Knex.Transaction
+  id?: number
+  promise?: Promise<any>
+}
+
+export interface KnexAdapterParams<Q = AdapterQuery> extends AdapterParams<Q, Partial<KnexAdapterOptions>> {
+  knex?: Knex.QueryBuilder
+  transaction?: KnexAdapterTransaction
+}

package/src/error-handler.ts

@@ -0,0 +1,95 @@
+import { errors } from '@feathersjs/errors'
+
+export const ERROR = Symbol('@feathersjs/knex/error')
+
+export function errorHandler(error: any) {
+  const { message } = error
+  let feathersError = error
+
+  if (error.sqlState && error.sqlState.length) {
+    // remove SQLSTATE marker (#) and pad/truncate SQLSTATE to 5 chars
+    const sqlState = ('00000' + error.sqlState.replace('#', '')).slice(-5)
+
+    switch (sqlState.slice(0, 2)) {
+      case '02':
+        feathersError = new errors.NotFound(message)
+        break
+      case '28':
+        feathersError = new errors.Forbidden(message)
+        break
+      case '08':
+      case '0A':
+      case '0K':
+        feathersError = new errors.Unavailable(message)
+        break
+      case '20':
+      case '21':
+      case '22':
+      case '23':
+      case '24':
+      case '25':
+      case '40':
+      case '42':
+      case '70':
+        feathersError = new errors.BadRequest(message)
+        break
+      default:
+        feathersError = new errors.GeneralError(message)
+    }
+  } else if (error.code === 'SQLITE_ERROR') {
+    // NOTE (EK): Error codes taken from
+    // https://www.sqlite.org/c3ref/c_abort.html
+    switch (error.errno) {
+      case 1:
+      case 8:
+      case 18:
+      case 19:
+      case 20:
+        feathersError = new errors.BadRequest(message)
+        break
+      case 2:
+        feathersError = new errors.Unavailable(message)
+        break
+      case 3:
+      case 23:
+        feathersError = new errors.Forbidden(message)
+        break
+      case 12:
+        feathersError = new errors.NotFound(message)
+        break
+      default:
+        feathersError = new errors.GeneralError(message)
+        break
+    }
+  } else if (typeof error.code === 'string' && error.severity && error.routine) {
+    // NOTE: Error codes taken from
+    // https://www.postgresql.org/docs/9.6/static/errcodes-appendix.html
+    // Omit query information
+    const messages = error.message.split('-')
+    error.message = messages[messages.length - 1]
+
+    switch (error.code.slice(0, 2)) {
+      case '22':
+      case '23':
+        feathersError = new errors.BadRequest(message)
+        break
+      case '28':
+        feathersError = new errors.Forbidden(message)
+        break
+      case '3D':
+      case '3F':
+      case '42':
+        feathersError = new errors.Unprocessable(message)
+        break
+      default:
+        feathersError = new errors.GeneralError(message)
+        break
+    }
+  } else if (!(error instanceof errors.FeathersError)) {
+    feathersError = new errors.GeneralError(message)
+  }
+
+  feathersError[ERROR] = error
+
+  throw feathersError
+}

package/src/hooks.ts

@@ -0,0 +1,101 @@
+import { createDebug } from '@feathersjs/commons'
+import { HookContext } from '@feathersjs/feathers'
+import { Knex } from 'knex'
+import { KnexAdapterTransaction } from './declarations'
+
+const debug = createDebug('feathers-knex-transaction')
+
+const ROLLBACK = { rollback: true }
+
+export const getKnex = (context: HookContext): Knex => {
+  const knex = context.service.Model
+
+  return knex && typeof knex.transaction === 'function' ? knex : undefined
+}
+
+export const start =
+  () =>
+  async (context: HookContext): Promise<void> => {
+    const { transaction } = context.params
+    const parent = transaction
+    const knex: Knex = transaction ? transaction.trx : getKnex(context)
+
+    if (!knex) {
+      return
+    }
+
+    return new Promise<void>((resolve, reject) => {
+      const transaction: KnexAdapterTransaction = {
+        starting: true
+      }
+
+      if (parent) {
+        transaction.parent = parent
+        transaction.committed = parent.committed
+      } else {
+        transaction.committed = new Promise((resolve) => {
+          transaction.resolve = resolve
+        })
+      }
+
+      transaction.starting = true
+      transaction.promise = knex
+        .transaction((trx) => {
+          transaction.trx = trx
+          transaction.id = Date.now()
+
+          context.params = { ...context.params, transaction }
+
+          debug('started a new transaction %s', transaction.id)
+
+          resolve()
+        })
+        .catch((error) => {
+          if (transaction.starting) {
+            reject(error)
+          } else if (error !== ROLLBACK) {
+            throw error
+          }
+        })
+    })
+  }
+
+export const end = () => (context: HookContext) => {
+  const { transaction } = context.params
+
+  if (!transaction) {
+    return
+  }
+
+  const { trx, id, promise, parent } = transaction
+
+  context.params = { ...context.params, transaction: parent }
+  transaction.starting = false
+
+  return trx
+    .commit()
+    .then(() => promise)
+    .then(() => transaction.resolve && transaction.resolve(true))
+    .then(() => debug('ended transaction %s', id))
+    .then(() => context)
+}
+
+export const rollback = () => (context: HookContext) => {
+  const { transaction } = context.params
+
+  if (!transaction) {
+    return
+  }
+
+  const { trx, id, promise, parent } = transaction
+
+  context.params = { ...context.params, transaction: parent }
+  transaction.starting = false
+
+  return trx
+    .rollback(ROLLBACK)
+    .then(() => promise)
+    .then(() => transaction.resolve && transaction.resolve(false))
+    .then(() => debug('rolled back transaction %s', id))
+    .then(() => context)
+}

package/src/index.ts

@@ -0,0 +1,47 @@
+import { PaginationOptions } from '@feathersjs/adapter-commons'
+import { Paginated, ServiceMethods, Id, NullableId } from '@feathersjs/feathers'
+import { KnexAdapter } from './adapter'
+import { KnexAdapterParams } from './declarations'
+
+export * from './declarations'
+export * from './adapter'
+export * from './error-handler'
+export * as transaction from './hooks'
+
+export class KnexService<T = any, D = Partial<T>, P extends KnexAdapterParams<any> = KnexAdapterParams>
+  extends KnexAdapter<T, D, P>
+  implements ServiceMethods<T | Paginated<T>, D, P>
+{
+  async find(params?: P & { paginate?: PaginationOptions }): Promise<Paginated<T>>
+  async find(params?: P & { paginate: false }): Promise<T[]>
+  async find(params?: P): Promise<Paginated<T> | T[]>
+  async find(params?: P): Promise<Paginated<T> | T[]> {
+    return this._find(params) as any
+  }
+
+  async get(id: Id, params?: P): Promise<T> {
+    return this._get(id, params)
+  }
+
+  async create(data: Partial<D>, params?: P): Promise<T>
+  async create(data: Partial<D>[], params?: P): Promise<T[]>
+  async create(data: Partial<D> | Partial<D>[], params?: P): Promise<T | T[]> {
+    return this._create(data, params)
+  }
+
+  async update(id: Id, data: D, params?: P): Promise<T> {
+    return this._update(id, data, params)
+  }
+
+  async patch(id: Id, data: Partial<D>, params?: P): Promise<T>
+  async patch(id: null, data: Partial<D>, params?: P): Promise<T[]>
+  async patch(id: NullableId, data: Partial<D>, params?: P): Promise<T | T[]> {
+    return this._patch(id, data, params)
+  }
+
+  async remove(id: Id, params?: P): Promise<T>
+  async remove(id: null, params?: P): Promise<T[]>
+  async remove(id: NullableId, params?: P): Promise<T | T[]> {
+    return this._remove(id, params)
+  }
+}