@feathersjs/feathers 5.0.0-pre.10

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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/lib/application.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { EventEmitter } from './dependencies';
+import { FeathersApplication, ServiceMixin, Service, ServiceOptions, ServiceInterface, Application, HookOptions, FeathersService, HookMap } from './declarations';
+export declare class Feathers<ServiceTypes, AppSettings> extends EventEmitter implements FeathersApplication<ServiceTypes, AppSettings> {
+    services: ServiceTypes;
+    settings: AppSettings;
+    mixins: ServiceMixin<Application<ServiceTypes, AppSettings>>[];
+    version: string;
+    _isSetup: boolean;
+    appHooks: HookMap<Application<ServiceTypes, AppSettings>, any>;
+    private legacyHooks;
+    constructor();
+    get<L extends keyof AppSettings & string>(name: L): AppSettings[L];
+    set<L extends keyof AppSettings & string>(name: L, value: AppSettings[L]): this;
+    configure(callback: (this: this, app: this) => void): this;
+    defaultService(location: string): ServiceInterface<any>;
+    service<L extends keyof ServiceTypes & string>(location: L): FeathersService<this, keyof any extends keyof ServiceTypes ? Service<any> : ServiceTypes[L]>;
+    use<L extends keyof ServiceTypes & string>(path: L, service: keyof any extends keyof ServiceTypes ? ServiceInterface<any> | Application : ServiceTypes[L], options?: ServiceOptions): this;
+    hooks(hookMap: HookOptions<this, any>): any;
+    setup(): Promise<this>;
+}

package/lib/application.js

@@ -0,0 +1,115 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Feathers = void 0;
+const version_1 = __importDefault(require("./version"));
+const dependencies_1 = require("./dependencies");
+const events_1 = require("./events");
+const index_1 = require("./hooks/index");
+const service_1 = require("./service");
+const legacy_1 = require("./hooks/legacy");
+const debug = (0, dependencies_1.createDebug)('@feathersjs/feathers');
+class Feathers extends dependencies_1.EventEmitter {
+    constructor() {
+        super();
+        this.services = {};
+        this.settings = {};
+        this.mixins = [index_1.hookMixin, events_1.eventMixin];
+        this.version = version_1.default;
+        this._isSetup = false;
+        this.appHooks = {
+            [dependencies_1.HOOKS]: [events_1.eventHook]
+        };
+        this.legacyHooks = (0, legacy_1.enableLegacyHooks)(this);
+    }
+    get(name) {
+        return this.settings[name];
+    }
+    set(name, value) {
+        this.settings[name] = value;
+        return this;
+    }
+    configure(callback) {
+        callback.call(this, this);
+        return this;
+    }
+    defaultService(location) {
+        throw new Error(`Can not find service '${location}'`);
+    }
+    service(location) {
+        const path = ((0, dependencies_1.stripSlashes)(location) || '/');
+        const current = this.services[path];
+        if (typeof current === 'undefined') {
+            this.use(path, this.defaultService(path));
+            return this.service(path);
+        }
+        return current;
+    }
+    use(path, service, options) {
+        if (typeof path !== 'string') {
+            throw new Error(`'${path}' is not a valid service path.`);
+        }
+        const location = ((0, dependencies_1.stripSlashes)(path) || '/');
+        const subApp = service;
+        const isSubApp = typeof subApp.service === 'function' && subApp.services;
+        if (isSubApp) {
+            Object.keys(subApp.services).forEach(subPath => this.use(`${location}/${subPath}`, subApp.service(subPath)));
+            return this;
+        }
+        const protoService = (0, service_1.wrapService)(location, service, options);
+        const serviceOptions = (0, service_1.getServiceOptions)(service, options);
+        for (const name of service_1.protectedMethods) {
+            if (serviceOptions.methods.includes(name)) {
+                throw new Error(`'${name}' on service '${location}' is not allowed as a custom method name`);
+            }
+        }
+        debug(`Registering new service at \`${location}\``);
+        // Add all the mixins
+        this.mixins.forEach(fn => fn.call(this, protoService, location, serviceOptions));
+        // If we ran setup already, set this service up explicitly, this will not `await`
+        if (this._isSetup && typeof protoService.setup === 'function') {
+            debug(`Setting up service for \`${location}\``);
+            protoService.setup(this, location);
+        }
+        this.services[location] = protoService;
+        return this;
+    }
+    hooks(hookMap) {
+        const legacyMap = hookMap;
+        if (legacyMap.before || legacyMap.after || legacyMap.error) {
+            return this.legacyHooks(legacyMap);
+        }
+        if (Array.isArray(hookMap)) {
+            this.appHooks[dependencies_1.HOOKS].push(...hookMap);
+        }
+        else {
+            const methodHookMap = hookMap;
+            Object.keys(methodHookMap).forEach(key => {
+                const methodHooks = this.appHooks[key] || [];
+                this.appHooks[key] = methodHooks.concat(methodHookMap[key]);
+            });
+        }
+        return this;
+    }
+    setup() {
+        let promise = Promise.resolve();
+        // Setup each service (pass the app so that they can look up other services etc.)
+        for (const path of Object.keys(this.services)) {
+            promise = promise.then(() => {
+                const service = this.service(path);
+                if (typeof service.setup === 'function') {
+                    debug(`Setting up service for \`${path}\``);
+                    return service.setup(this, path);
+                }
+            });
+        }
+        return promise.then(() => {
+            this._isSetup = true;
+            return this;
+        });
+    }
+}
+exports.Feathers = Feathers;
+//# sourceMappingURL=application.js.map

package/lib/application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAChC,iDAEwB;AACxB,qCAAiD;AACjD,yCAA0C;AAC1C,uCAA6E;AAa7E,2CAAmD;AAEnD,MAAM,KAAK,GAAG,IAAA,0BAAW,EAAC,sBAAsB,CAAC,CAAC;AAElD,MAAa,QAAoC,SAAQ,2BAAY;IAYnE;QACE,KAAK,EAAE,CAAC;QAZV,aAAQ,GAAkB,EAAmB,CAAC;QAC9C,aAAQ,GAAiB,EAAkB,CAAC;QAC5C,WAAM,GAA2D,CAAE,iBAAS,EAAE,mBAAU,CAAE,CAAC;QAC3F,YAAO,GAAW,iBAAO,CAAC;QAC1B,aAAQ,GAAG,KAAK,CAAC;QACjB,aAAQ,GAAyD;YAC/D,CAAC,oBAAK,CAAC,EAAE,CAAG,kBAAiB,CAAE;SAChC,CAAC;QAMA,IAAI,CAAC,WAAW,GAAG,IAAA,0BAAiB,EAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,GAAG,CAAwC,IAAO;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,GAAG,CAAwC,IAAO,EAAE,KAAqB;QACvE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAE,QAAyC;QAClD,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAE1B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAE,QAAgB;QAC9B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CACL,QAAW;QAEX,MAAM,IAAI,GAAG,CAAC,IAAA,2BAAY,EAAC,QAAQ,CAAC,IAAI,GAAG,CAAM,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE;YAClC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,IAAI,CAAQ,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC3B;QAED,OAAO,OAAc,CAAC;IACxB,CAAC;IAED,GAAG,CACD,IAAO,EACP,OAAqG,EACrG,OAAwB;QAExB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,gCAAgC,CAAC,CAAC;SAC3D;QAED,MAAM,QAAQ,GAAG,CAAC,IAAA,2BAAY,EAAC,IAAI,CAAC,IAAI,GAAG,CAAM,CAAC;QAClD,MAAM,MAAM,GAAG,OAAsB,CAAC;QACtC,MAAM,QAAQ,GAAG,OAAO,MAAM,CAAC,OAAO,KAAK,UAAU,IAAI,MAAM,CAAC,QAAQ,CAAC;QAEzE,IAAI,QAAQ,EAAE;YACZ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAC7C,IAAI,CAAC,GAAG,CAAC,GAAG,QAAQ,IAAI,OAAO,EAAS,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAQ,CAAC,CAC1E,CAAC;YAEF,OAAO,IAAI,CAAC;SACb;QAED,MAAM,YAAY,GAAG,IAAA,qBAAW,EAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7D,MAAM,cAAc,GAAG,IAAA,2BAAiB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAE3D,KAAK,MAAM,IAAI,IAAI,0BAAgB,EAAE;YACnC,IAAI,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,iBAAiB,QAAQ,0CAA0C,CAAC,CAAC;aAC9F;SACF;QAED,KAAK,CAAC,gCAAgC,QAAQ,IAAI,CAAC,CAAC;QAEpD,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;QAEjF,iFAAiF;QACjF,IAAI,IAAI,CAAC,QAAQ,IAAI,OAAO,YAAY,CAAC,KAAK,KAAK,UAAU,EAAE;YAC7D,KAAK,CAAC,4BAA4B,QAAQ,IAAI,CAAC,CAAC;YAChD,YAAY,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;SACpC;QAED,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC;QAEvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAE,OAA+B;QACpC,MAAM,SAAS,GAAG,OAAmC,CAAC;QAEtD,IAAI,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,KAAK,EAAE;YAC1D,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;SACpC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC1B,IAAI,CAAC,QAAQ,CAAC,oBAAK,CAAC,CAAC,IAAI,CAAC,GAAG,OAAc,CAAC,CAAC;SAC9C;aAAM;YACL,MAAM,aAAa,GAAG,OAA+D,CAAC;YAEtF,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBACvC,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBAE7C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK;QACH,IAAI,OAAO,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QAEhC,iFAAiF;QACjF,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC7C,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC1B,MAAM,OAAO,GAAQ,IAAI,CAAC,OAAO,CAAC,IAAW,CAAC,CAAC;gBAE/C,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,EAAE;oBACvC,KAAK,CAAC,4BAA4B,IAAI,IAAI,CAAC,CAAC;oBAE5C,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;iBAClC;YACH,CAAC,CAAC,CAAC;SACJ;QAED,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE;YACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA3ID,4BA2IC"}

package/lib/declarations.d.ts

@@ -0,0 +1,251 @@
+/// <reference types="node" />
+import { EventEmitter, NextFunction, HookContext as BaseHookContext } from './dependencies';
+declare type SelfOrArray<S> = S | S[];
+declare type OptionalPick<T, K extends PropertyKey> = Pick<T, Extract<keyof T, K>>;
+export type { NextFunction };
+export interface Paginated<T> {
+    total: number;
+    limit: number;
+    skip: number;
+    data: T[];
+}
+export interface ServiceOptions {
+    events?: string[];
+    methods?: string[];
+    serviceEvents?: string[];
+}
+export interface ServiceMethods<T, D = Partial<T>> {
+    find(params?: Params): Promise<T | T[]>;
+    get(id: Id, params?: Params): Promise<T>;
+    create(data: D, params?: Params): Promise<T>;
+    update(id: NullableId, data: D, params?: Params): Promise<T | T[]>;
+    patch(id: NullableId, data: D, params?: Params): Promise<T | T[]>;
+    remove(id: NullableId, params?: Params): Promise<T | T[]>;
+    setup(app: Application, path: string): Promise<void>;
+}
+export interface ServiceOverloads<T, D> {
+    create?(data: D[], params?: Params): Promise<T[]>;
+    update?(id: Id, data: D, params?: Params): Promise<T>;
+    update?(id: null, data: D, params?: Params): Promise<T[]>;
+    patch?(id: Id, data: D, params?: Params): Promise<T>;
+    patch?(id: null, data: D, params?: Params): Promise<T[]>;
+    remove?(id: Id, params?: Params): Promise<T>;
+    remove?(id: null, params?: Params): Promise<T[]>;
+}
+export declare type Service<T, D = Partial<T>> = ServiceMethods<T, D> & ServiceOverloads<T, D>;
+export declare type ServiceInterface<T, D = Partial<T>> = Partial<ServiceMethods<T, D>>;
+export interface ServiceAddons<A = Application, S = Service<any, any>> extends EventEmitter {
+    id?: string;
+    hooks(options: HookOptions<A, S>): this;
+}
+export interface ServiceHookOverloads<S> {
+    find(params: Params, context: HookContext): Promise<HookContext>;
+    get(id: Id, params: Params, context: HookContext): Promise<HookContext>;
+    create(data: ServiceGenericData<S> | ServiceGenericData<S>[], params: Params, context: HookContext): Promise<HookContext>;
+    update(id: NullableId, data: ServiceGenericData<S>, params: Params, context: HookContext): Promise<HookContext>;
+    patch(id: NullableId, data: ServiceGenericData<S>, params: Params, context: HookContext): Promise<HookContext>;
+    remove(id: NullableId, params: Params, context: HookContext): Promise<HookContext>;
+}
+export declare type FeathersService<A = FeathersApplication, S = Service<any>> = S & ServiceAddons<A, S> & OptionalPick<ServiceHookOverloads<S>, keyof S>;
+export declare type CustomMethod<Methods extends string> = {
+    [k in Methods]: <X = any>(data: any, params?: Params) => Promise<X>;
+};
+export declare type ServiceMixin<A> = (service: FeathersService<A>, path: string, options?: ServiceOptions) => void;
+export declare type ServiceGenericType<S> = S extends ServiceInterface<infer T> ? T : any;
+export declare type ServiceGenericData<S> = S extends ServiceInterface<infer _T, infer D> ? D : any;
+export interface FeathersApplication<ServiceTypes = any, AppSettings = any> {
+    /**
+     * The Feathers application version
+     */
+    version: string;
+    /**
+     * A list of callbacks that run when a new service is registered
+     */
+    mixins: ServiceMixin<Application<ServiceTypes, AppSettings>>[];
+    /**
+     * The index of all services keyed by their path.
+     *
+     * __Important:__ Services should always be retrieved via `app.service('name')`
+     * not via `app.services`.
+     */
+    services: ServiceTypes;
+    /**
+     * The application settings that can be used via
+     * `app.get` and `app.set`
+     */
+    settings: AppSettings;
+    /**
+     * A private-ish indicator if `app.setup()` has been called already
+     */
+    _isSetup: boolean;
+    /**
+     * Contains all registered application level hooks.
+     */
+    appHooks: HookMap<Application<ServiceTypes, AppSettings>, any>;
+    /**
+     * Retrieve an application setting by name
+     *
+     * @param name The setting name
+     */
+    get<L extends keyof AppSettings & string>(name: L): AppSettings[L];
+    /**
+     * Set an application setting
+     *
+     * @param name The setting name
+     * @param value The setting value
+     */
+    set<L extends keyof AppSettings & string>(name: L, value: AppSettings[L]): this;
+    /**
+     * Runs a callback configure function with the current application instance.
+     *
+     * @param callback The callback `(app: Application) => {}` to run
+     */
+    configure(callback: (this: this, app: this) => void): this;
+    /**
+     * Returns a fallback service instance that will be registered
+     * when no service was found. Usually throws a `NotFound` error
+     * but also used to instantiate client side services.
+     *
+     * @param location The path of the service
+     */
+    defaultService(location: string): ServiceInterface<any>;
+    /**
+     * Register a new service or a sub-app. When passed another
+     * Feathers application, all its services will be re-registered
+     * with the `path` prefix.
+     *
+     * @param path The path for the service to register
+     * @param service The service object to register or another
+     * Feathers application to use a sub-app under the `path` prefix.
+     * @param options The options for this service
+     */
+    use<L extends keyof ServiceTypes & string>(path: L, service: keyof any extends keyof ServiceTypes ? ServiceInterface<any> | Application : ServiceTypes[L], options?: ServiceOptions): this;
+    /**
+     * Get the Feathers service instance for a path. This will
+     * be the service originally registered with Feathers functionality
+     * like hooks and events added.
+     *
+     * @param path The name of the service.
+     */
+    service<L extends keyof ServiceTypes & string>(path: L): FeathersService<this, keyof any extends keyof ServiceTypes ? Service<any> : ServiceTypes[L]>;
+    setup(server?: any): Promise<this>;
+    /**
+     * Register application level hooks.
+     *
+     * @param map The application hook settings.
+     */
+    hooks(map: HookOptions<this, any>): this;
+}
+export interface Application<ServiceTypes = any, AppSettings = any> extends FeathersApplication<ServiceTypes, AppSettings>, EventEmitter {
+}
+export declare type Id = number | string;
+export declare type NullableId = Id | null;
+export interface Query {
+    [key: string]: any;
+}
+export interface Params {
+    query?: Query;
+    provider?: string;
+    route?: {
+        [key: string]: string;
+    };
+    headers?: {
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+export interface HookContext<A = Application, S = any> extends BaseHookContext<ServiceGenericType<S>> {
+    /**
+     * A read only property that contains the Feathers application object. This can be used to
+     * retrieve other services (via context.app.service('name')) or configuration values.
+     */
+    readonly app: A;
+    /**
+     * A read only property with the name of the service method (one of find, get,
+     * create, update, patch, remove).
+     */
+    readonly method: string;
+    /**
+     * A read only property and contains the service name (or path) without leading or
+     * trailing slashes.
+     */
+    readonly path: string;
+    /**
+     * A read only property and contains the service this hook currently runs on.
+     */
+    readonly service: S;
+    /**
+     * A read only property with the hook type (one of before, after or error).
+     * Will be `null` for asynchronous hooks.
+     */
+    readonly type: null | 'before' | 'after' | 'error';
+    /**
+     * The list of method arguments. Should not be modified, modify the
+     * `params`, `data` and `id` properties instead.
+     */
+    readonly arguments: any[];
+    /**
+     * A writeable property containing the data of a create, update and patch service
+     * method call.
+     */
+    data?: ServiceGenericData<S>;
+    /**
+     * A writeable property with the error object that was thrown in a failed method call.
+     * It is only available in error hooks.
+     */
+    error?: any;
+    /**
+     * A writeable property and the id for a get, remove, update and patch service
+     * method call. For remove, update and patch context.id can also be null when
+     * modifying multiple entries. In all other cases it will be undefined.
+     */
+    id?: Id;
+    /**
+     * A writeable property that contains the service method parameters (including
+     * params.query).
+     */
+    params: Params;
+    /**
+     * A writeable property containing the result of the successful service method call.
+     * It is only available in after hooks.
+     *
+     * `context.result` can also be set in
+     *
+     * - A before hook to skip the actual service method (database) call
+     * - An error hook to swallow the error and return a result instead
+     */
+    result?: ServiceGenericType<S>;
+    /**
+     * A writeable, optional property and contains a 'safe' version of the data that
+     * should be sent to any client. If context.dispatch has not been set context.result
+     * will be sent to the client instead.
+     */
+    dispatch?: ServiceGenericType<S>;
+    /**
+     * A writeable, optional property that allows to override the standard HTTP status
+     * code that should be returned.
+     */
+    statusCode?: number;
+    /**
+     * The event emitted by this method. Can be set to `null` to skip event emitting.
+     */
+    event: string | null;
+}
+export declare type LegacyHookFunction<A = Application, S = Service<any, any>> = (this: S, context: HookContext<A, S>) => (Promise<HookContext<Application, S> | void> | HookContext<Application, S> | void);
+export declare type Hook<A = Application, S = Service<any, any>> = LegacyHookFunction<A, S>;
+declare type LegacyHookMethodMap<A, S> = {
+    [L in keyof S]?: SelfOrArray<LegacyHookFunction<A, S>>;
+} & {
+    all?: SelfOrArray<LegacyHookFunction<A, S>>;
+};
+declare type LegacyHookTypeMap<A, S> = SelfOrArray<LegacyHookFunction<A, S>> | LegacyHookMethodMap<A, S>;
+export declare type LegacyHookMap<A, S> = {
+    before?: LegacyHookTypeMap<A, S>;
+    after?: LegacyHookTypeMap<A, S>;
+    error?: LegacyHookTypeMap<A, S>;
+};
+export declare type HookFunction<A = Application, S = Service<any, any>> = (context: HookContext<A, S>, next: NextFunction) => Promise<void>;
+export declare type HookMap<A, S> = {
+    [L in keyof S]?: HookFunction<A, S>[];
+};
+export declare type HookOptions<A, S> = HookMap<A, S> | HookFunction<A, S>[] | LegacyHookMap<A, S>;

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/dependencies.d.ts

@@ -0,0 +1,4 @@
+import { EventEmitter } from 'events';
+export * from '@feathersjs/commons';
+export * from '@feathersjs/hooks';
+export { EventEmitter };

package/lib/dependencies.js

@@ -0,0 +1,18 @@
+"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]; } });
+}) : (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.EventEmitter = void 0;
+const events_1 = require("events");
+Object.defineProperty(exports, "EventEmitter", { enumerable: true, get: function () { return events_1.EventEmitter; } });
+__exportStar(require("@feathersjs/commons"), exports);
+__exportStar(require("@feathersjs/hooks"), exports);
+//# sourceMappingURL=dependencies.js.map

package/lib/dependencies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencies.js","sourceRoot":"","sources":["../src/dependencies.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,mCAAsC;AAI7B,6FAJA,qBAAY,OAIA;AAHrB,sDAAoC;AACpC,oDAAkC"}

package/lib/events.d.ts

@@ -0,0 +1,4 @@
+import { NextFunction } from './dependencies';
+import { HookContext, FeathersService } from './declarations';
+export declare function eventHook(context: HookContext, next: NextFunction): Promise<void>;
+export declare function eventMixin<A>(service: FeathersService<A>): FeathersService<A, import("./declarations").Service<any, Partial<any>>>;

package/lib/events.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.eventMixin = exports.eventHook = void 0;
+const dependencies_1 = require("./dependencies");
+const service_1 = require("./service");
+function eventHook(context, next) {
+    const { events } = (0, service_1.getServiceOptions)(context.self);
+    const defaultEvent = service_1.defaultEventMap[context.method] || null;
+    context.event = defaultEvent;
+    return next().then(() => {
+        // Send the event only if the service does not do so already (indicated in the `events` option)
+        // This is used for custom events and for client services receiving event from the server
+        if (typeof context.event === 'string' && !events.includes(context.event)) {
+            const results = Array.isArray(context.result) ? context.result : [context.result];
+            results.forEach(element => context.self.emit(context.event, element, context));
+        }
+    });
+}
+exports.eventHook = eventHook;
+function eventMixin(service) {
+    const isEmitter = typeof service.on === 'function' &&
+        typeof service.emit === 'function';
+    if (!isEmitter) {
+        Object.assign(service, dependencies_1.EventEmitter.prototype);
+    }
+    return service;
+}
+exports.eventMixin = eventMixin;
+//# sourceMappingURL=events.js.map

package/lib/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":";;;AAAA,iDAA4D;AAE5D,uCAA+D;AAE/D,SAAgB,SAAS,CAAE,OAAoB,EAAE,IAAkB;IACjE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAA,2BAAiB,EAAE,OAAe,CAAC,IAAI,CAAC,CAAC;IAC5D,MAAM,YAAY,GAAI,yBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC;IAEtE,OAAO,CAAC,KAAK,GAAG,YAAY,CAAC;IAE7B,OAAO,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;QACtB,+FAA+F;QAC/F,yFAAyF;QACzF,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxE,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAE,OAAO,CAAC,MAAM,CAAE,CAAC;YAEpF,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAE,OAAe,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;SACzF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAfD,8BAeC;AAED,SAAgB,UAAU,CAAK,OAA2B;IACxD,MAAM,SAAS,GAAG,OAAO,OAAO,CAAC,EAAE,KAAK,UAAU;QAChD,OAAO,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC;IAErC,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,2BAAY,CAAC,SAAS,CAAC,CAAC;KAChD;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AATD,gCASC"}

package/lib/hooks/index.d.ts

@@ -0,0 +1,14 @@
+import { HookContextData, HookManager, Middleware } from '../dependencies';
+import { Service, ServiceOptions, HookContext, FeathersService, Application } from '../declarations';
+import { fromAfterHook, fromBeforeHook, fromErrorHooks } from './legacy';
+export { fromAfterHook, fromBeforeHook, fromErrorHooks };
+export declare function createContext(service: Service<any>, method: string, data?: HookContextData): HookContext<Application<any, any>, any>;
+export declare class FeathersHookManager<A> extends HookManager {
+    app: A;
+    method: string;
+    constructor(app: A, method: string);
+    collectMiddleware(self: any, args: any[]): Middleware[];
+    initializeContext(self: any, args: any[], context: HookContext): import("@feathersjs/hooks/lib/base").HookContext<any, any>;
+    middleware(mw: Middleware[]): this;
+}
+export declare function hookMixin<A>(this: A, service: FeathersService<A>, path: string, options: ServiceOptions): FeathersService<A, Service<any, Partial<any>>>;

package/lib/hooks/index.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hookMixin = exports.FeathersHookManager = exports.createContext = exports.fromErrorHooks = exports.fromBeforeHook = exports.fromAfterHook = void 0;
+const dependencies_1 = require("../dependencies");
+const service_1 = require("../service");
+const legacy_1 = require("./legacy");
+Object.defineProperty(exports, "fromAfterHook", { enumerable: true, get: function () { return legacy_1.fromAfterHook; } });
+Object.defineProperty(exports, "fromBeforeHook", { enumerable: true, get: function () { return legacy_1.fromBeforeHook; } });
+Object.defineProperty(exports, "fromErrorHooks", { enumerable: true, get: function () { return legacy_1.fromErrorHooks; } });
+function createContext(service, method, data = {}) {
+    const createContext = service[method].createContext;
+    if (typeof createContext !== 'function') {
+        throw new Error(`Can not create context for method ${method}`);
+    }
+    return createContext(data);
+}
+exports.createContext = createContext;
+class FeathersHookManager extends dependencies_1.HookManager {
+    constructor(app, method) {
+        super();
+        this.app = app;
+        this.method = method;
+        this._middleware = [];
+    }
+    collectMiddleware(self, args) {
+        const app = this.app;
+        const appHooks = app.appHooks[dependencies_1.HOOKS].concat(app.appHooks[this.method] || []);
+        const legacyAppHooks = (0, legacy_1.collectLegacyHooks)(this.app, this.method);
+        const middleware = super.collectMiddleware(self, args);
+        const legacyHooks = (0, legacy_1.collectLegacyHooks)(self, this.method);
+        return [...appHooks, ...legacyAppHooks, ...middleware, ...legacyHooks];
+    }
+    initializeContext(self, args, context) {
+        const ctx = super.initializeContext(self, args, context);
+        ctx.params = ctx.params || {};
+        return ctx;
+    }
+    middleware(mw) {
+        this._middleware.push(...mw);
+        return this;
+    }
+}
+exports.FeathersHookManager = FeathersHookManager;
+function hookMixin(service, path, options) {
+    if (typeof service.hooks === 'function') {
+        return service;
+    }
+    const app = this;
+    const serviceMethodHooks = (0, service_1.getHookMethods)(service, options).reduce((res, method) => {
+        const params = service_1.defaultServiceArguments[method] || ['data', 'params'];
+        res[method] = new FeathersHookManager(app, method)
+            .params(...params)
+            .props({
+            app,
+            path,
+            method,
+            service,
+            event: null,
+            type: null
+        });
+        return res;
+    }, {});
+    const handleLegacyHooks = (0, legacy_1.enableLegacyHooks)(service);
+    (0, dependencies_1.hooks)(service, serviceMethodHooks);
+    service.hooks = function (hookOptions) {
+        if (hookOptions.before || hookOptions.after || hookOptions.error) {
+            return handleLegacyHooks.call(this, hookOptions);
+        }
+        if (Array.isArray(hookOptions)) {
+            return (0, dependencies_1.hooks)(this, hookOptions);
+        }
+        Object.keys(hookOptions).forEach(method => {
+            const manager = (0, dependencies_1.getManager)(this[method]);
+            if (!(manager instanceof FeathersHookManager)) {
+                throw new Error(`Method ${method} is not a Feathers hooks enabled service method`);
+            }
+            manager.middleware(hookOptions[method]);
+        });
+        return this;
+    };
+    return service;
+}
+exports.hookMixin = hookMixin;
+//# sourceMappingURL=index.js.map

package/lib/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/hooks/index.ts"],"names":[],"mappings":";;;AAAA,kDAEyB;AAIzB,wCAAqE;AACrE,qCAMkB;AAET,8FALP,sBAAa,OAKO;AAAE,+FAJtB,uBAAc,OAIsB;AAAE,+FAHtC,uBAAc,OAGsC;AAEtD,SAAgB,aAAa,CAAE,OAAqB,EAAE,MAAc,EAAE,OAAwB,EAAE;IAC9F,MAAM,aAAa,GAAI,OAAe,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC;IAE7D,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,qCAAqC,MAAM,EAAE,CAAC,CAAC;KAChE;IAED,OAAO,aAAa,CAAC,IAAI,CAAgB,CAAC;AAC5C,CAAC;AARD,sCAQC;AAED,MAAa,mBAAuB,SAAQ,0BAAW;IACrD,YAAoB,GAAM,EAAS,MAAc;QAC/C,KAAK,EAAE,CAAC;QADU,QAAG,GAAH,GAAG,CAAG;QAAS,WAAM,GAAN,MAAM,CAAQ;QAE/C,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,iBAAiB,CAAE,IAAS,EAAE,IAAW;QACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAyB,CAAC;QAC3C,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,oBAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7E,MAAM,cAAc,GAAG,IAAA,2BAAkB,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACjE,MAAM,UAAU,GAAG,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,IAAA,2BAAkB,EAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1D,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,cAAc,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC,CAAC;IACzE,CAAC;IAED,iBAAiB,CAAE,IAAS,EAAE,IAAW,EAAE,OAAoB;QAC7D,MAAM,GAAG,GAAG,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzD,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;QAE9B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,UAAU,CAAE,EAAgB;QAC1B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA5BD,kDA4BC;AAED,SAAgB,SAAS,CACd,OAA2B,EAAE,IAAY,EAAE,OAAuB;IAE3E,IAAI,OAAO,OAAO,CAAC,KAAK,KAAK,UAAU,EAAE;QACvC,OAAO,OAAO,CAAC;KAChB;IAED,MAAM,GAAG,GAAG,IAAI,CAAC;IACjB,MAAM,kBAAkB,GAAG,IAAA,wBAAc,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QACjF,MAAM,MAAM,GAAI,iCAA+B,CAAC,MAAM,CAAC,IAAI,CAAE,MAAM,EAAE,QAAQ,CAAE,CAAC;QAEhF,GAAG,CAAC,MAAM,CAAC,GAAG,IAAI,mBAAmB,CAAI,GAAG,EAAE,MAAM,CAAC;aAClD,MAAM,CAAC,GAAG,MAAM,CAAC;aACjB,KAAK,CAAC;YACL,GAAG;YACH,IAAI;YACJ,MAAM;YACN,OAAO;YACP,KAAK,EAAE,IAAI;YACX,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QAEL,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAa,CAAC,CAAC;IAClB,MAAM,iBAAiB,GAAG,IAAA,0BAAiB,EAAC,OAAO,CAAC,CAAC;IAErD,IAAA,oBAAK,EAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAEnC,OAAO,CAAC,KAAK,GAAG,UAAqB,WAAgB;QACnD,IAAI,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE;YAChE,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SAClD;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YAC9B,OAAO,IAAA,oBAAK,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SACjC;QAED,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACxC,MAAM,OAAO,GAAG,IAAA,yBAAU,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAEzC,IAAI,CAAC,CAAC,OAAO,YAAY,mBAAmB,CAAC,EAAE;gBAC7C,MAAM,IAAI,KAAK,CAAC,UAAU,MAAM,iDAAiD,CAAC,CAAC;aACpF;YAED,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC,CAAA;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAnDD,8BAmDC"}

package/lib/hooks/legacy.d.ts

@@ -0,0 +1,7 @@
+import { LegacyHookFunction } from '../declarations';
+export declare function fromBeforeHook(hook: LegacyHookFunction): (context: any, next: any) => Promise<any>;
+export declare function fromAfterHook(hook: LegacyHookFunction): (context: any, next: any) => any;
+export declare function fromErrorHooks(hooks: LegacyHookFunction[]): (context: any, next: any) => any;
+export declare function collectLegacyHooks(target: any, method: string): any[];
+export declare function convertHookData(obj: any): any;
+export declare function enableLegacyHooks(obj: any, methods?: string[], types?: string[]): (this: any, allHooks: any) => any;