feathers-utils 2.0.0-8 → 2.0.0

package/dist/esm/hooks/onDelete.js

@@ -1,47 +0,0 @@
-import { checkContext } from "feathers-hooks-common";
-import { getItemsIsArray, shouldSkip } from "../utils";
-/**
- * hook to manipulate related items on delete
- */
-export function onDelete(service, { keyThere, keyHere = "id", onDelete = "cascade", blocking = true, }) {
-    if (!service || !keyThere) {
-        throw "initialize hook 'removeRelated' completely!";
-    }
-    if (!["cascade", "set null"].includes(onDelete)) {
-        throw "onDelete must be 'cascade' or 'set null'";
-    }
-    return async (context) => {
-        if (shouldSkip("onDelete", context)) {
-            return context;
-        }
-        checkContext(context, "after", "remove", "onDelete");
-        const { items } = getItemsIsArray(context);
-        let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
-        ids = [...new Set(ids)];
-        if (!ids || ids.length <= 0) {
-            return context;
-        }
-        const params = {
-            query: {
-                [keyThere]: {
-                    $in: ids,
-                },
-            },
-            paginate: false,
-        };
-        let promise;
-        if (onDelete === "cascade") {
-            promise = context.app.service(service).remove(null, params);
-        }
-        else if (onDelete === "set null") {
-            const data = { [keyThere]: null };
-            promise = context.app
-                .service(service)
-                .patch(null, data, params);
-        }
-        if (blocking) {
-            await promise;
-        }
-        return context;
-    };
-}

package/dist/esm/hooks/removeRelated.d.ts

@@ -1,11 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export interface RemoveRelatedOptions<S = Record<string, any>> {
-    service: keyof S;
-    keyThere: string;
-    keyHere: string;
-    blocking?: boolean;
-}
-/**
- * hook to remove related items
- */
-export declare function removeRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, keyThere, keyHere, blocking, }: RemoveRelatedOptions<S>): (context: H) => Promise<H>;

package/dist/esm/hooks/removeRelated.js

@@ -1,37 +0,0 @@
-import { checkContext } from "feathers-hooks-common";
-import { getItemsIsArray, shouldSkip } from "../utils";
-/**
- * hook to remove related items
- */
-export function removeRelated({ service, keyThere, keyHere = "id", blocking = true, }) {
-    if (!service || !keyThere) {
-        throw "initialize hook 'removeRelated' completely!";
-    }
-    return async (context) => {
-        if (shouldSkip("removeRelated", context)) {
-            return context;
-        }
-        checkContext(context, "after", "remove", "removeRelated");
-        const { items } = getItemsIsArray(context);
-        let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
-        ids = [...new Set(ids)];
-        if (!ids || ids.length <= 0) {
-            return context;
-        }
-        // feathers does not accept `paginate: false` for remove, but some adapters need it to work properly
-        const promise = context.app
-            .service(service)
-            .remove(null, {
-            query: {
-                [keyThere]: {
-                    $in: ids,
-                },
-            },
-            paginate: false,
-        });
-        if (blocking) {
-            await promise;
-        }
-        return context;
-    };
-}

package/dist/esm/hooks/runPerItem.d.ts

@@ -1,11 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "../typesInternal";
-export interface HookRunPerItemOptions {
-    wait?: boolean;
-}
-/**
- * hook to run a hook for each item in the context
- * uses `context.data` in a before hook
- * uses `context.result` in an after hook
- */
-export declare const runPerItem: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(actionPerItem: (item: any, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;

package/dist/esm/hooks/runPerItem.js

@@ -1,30 +0,0 @@
-import { shouldSkip, getItemsIsArray } from "../utils";
-const makeOptions = (options) => {
-    options = options || {};
-    return Object.assign({
-        wait: true,
-    }, options);
-};
-/**
- * hook to run a hook for each item in the context
- * uses `context.data` in a before hook
- * uses `context.result` in an after hook
- */
-export const runPerItem = (
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-actionPerItem, _options) => {
-    const options = makeOptions(_options);
-    return async (context) => {
-        if (shouldSkip("runForItems", context)) {
-            return context;
-        }
-        const { items } = getItemsIsArray(context);
-        const promises = items.map(async (item) => {
-            await actionPerItem(item, context);
-        });
-        if (options.wait) {
-            await Promise.all(promises);
-        }
-        return context;
-    };
-};

package/dist/esm/hooks/setData.d.ts

@@ -1,11 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { PropertyPath } from "lodash";
-import type { PredicateWithContext } from "../types";
-export interface HookSetDataOptions {
-    allowUndefined?: boolean;
-    overwrite?: boolean | PredicateWithContext;
-}
-/**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
- */
-export declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;

package/dist/esm/hooks/setData.js

@@ -1,46 +0,0 @@
-import _get from "lodash/get.js";
-import _set from "lodash/set.js";
-import _has from "lodash/has.js";
-import { Forbidden } from "@feathersjs/errors";
-import { getItemsIsArray, shouldSkip } from "../utils";
-const defaultOptions = {
-    allowUndefined: false,
-    overwrite: true,
-};
-/**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
- */
-export function setData(from, to, _options) {
-    const options = Object.assign({}, defaultOptions, _options);
-    return (context) => {
-        if (shouldSkip("setData", context)) {
-            return context;
-        }
-        const { items } = getItemsIsArray(context);
-        if (!_has(context, from)) {
-            if (!context.params?.provider || options.allowUndefined === true) {
-                return context;
-            }
-            if (!options.overwrite &&
-                items.every((item) => _has(item, to))) {
-                return context;
-            }
-            throw new Forbidden(`Expected field ${from.toString()} not available`);
-        }
-        const val = _get(context, from);
-        items.forEach((item) => {
-            let overwrite;
-            if (typeof options.overwrite === "function") {
-                overwrite = options.overwrite(item, context);
-            }
-            else {
-                overwrite = options.overwrite;
-            }
-            if (!overwrite && _has(item, to)) {
-                return;
-            }
-            _set(item, to, val);
-        });
-        return context;
-    };
-}

package/dist/esm/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./hooks";
-export * from "./mixins";
-export * from "./utils";
-export * from "./filters";
-export * from "./types";

package/dist/esm/index.js

@@ -1,5 +0,0 @@
-export * from "./hooks";
-export * from "./mixins";
-export * from "./utils";
-export * from "./filters";
-export * from "./types";

package/dist/esm/mixins/debounce-mixin/DebouncedStore.d.ts

@@ -1,18 +0,0 @@
-import type { DebouncedFunc } from "lodash";
-import type { Application, Id } from "@feathersjs/feathers";
-import type { DebouncedFunctionApp, DebouncedStoreOptions } from "./types";
-export declare const makeDefaultOptions: () => DebouncedStoreOptions;
-export declare type DebouncedService<T = any> = T & {
-    debouncedStore: DebouncedStore;
-};
-export declare class DebouncedStore {
-    private _app;
-    private _options;
-    private _isRunningById;
-    _queueById: Record<string, DebouncedFunc<(id: Id, action: DebouncedFunctionApp) => void | Promise<void>>>;
-    add: (id: Id, action: (app?: Application) => void | Promise<void>) => void | Promise<void> | undefined;
-    constructor(app: Application, options?: Partial<DebouncedStoreOptions>);
-    private unbounced;
-    private debounceById;
-    cancel(id: Id): void;
-}

package/dist/esm/mixins/debounce-mixin/DebouncedStore.js

@@ -1,46 +0,0 @@
-import _debounce from "lodash/debounce.js";
-export const makeDefaultOptions = () => {
-    return {
-        leading: false,
-        maxWait: undefined,
-        trailing: true,
-        wait: 100,
-    };
-};
-export class DebouncedStore {
-    constructor(app, options) {
-        this._app = app;
-        this._options = Object.assign(makeDefaultOptions(), options);
-        this._queueById = {};
-        this._isRunningById = {};
-        //this._waitingById = {};
-        this.add = this.debounceById(this.unbounced, this._options.wait, {
-            leading: this._options.leading,
-            maxWait: this._options.maxWait,
-            trailing: this._options.trailing,
-        });
-    }
-    async unbounced(id, action) {
-        if (this._queueById[id] === undefined) {
-            return;
-        }
-        delete this._queueById[id];
-        this._isRunningById[id] = true;
-        await action(this._app);
-        delete this._isRunningById[id];
-    }
-    debounceById(func, wait, options) {
-        return (id, action) => {
-            if (typeof this._queueById[id] === "function") {
-                return this._queueById[id](id, action);
-            }
-            this._queueById[id] = _debounce((id, action) => {
-                this.unbounced(id, action);
-            }, wait, { ...options, leading: false }); // leading required for return promise
-            return this._queueById[id](id, action);
-        };
-    }
-    cancel(id) {
-        delete this._queueById[id];
-    }
-}

package/dist/esm/mixins/debounce-mixin/debounceMixin.d.ts

@@ -1,3 +0,0 @@
-import type { Application } from "@feathersjs/feathers/lib";
-import type { InitDebounceMixinOptions } from "./types";
-export declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application) => void;

package/dist/esm/mixins/debounce-mixin/debounceMixin.js

@@ -1,19 +0,0 @@
-import { DebouncedStore, makeDefaultOptions } from "./DebouncedStore";
-export function debounceMixin(options) {
-    return (app) => {
-        options = options || {};
-        const defaultOptions = Object.assign(makeDefaultOptions(), options?.default);
-        app.mixins.push((service, path) => {
-            // if path is on blacklist, don't add debouncedStore to service
-            if (options?.blacklist && options.blacklist.includes(path))
-                return;
-            // if service already has registered something on `debouncedStore`
-            if (service.debouncedStore) {
-                console.warn(`[feathers-utils] service: '${path}' already has a property 'debouncedStore'. Mixin will skip creating a new debouncedStore`);
-                return;
-            }
-            const serviceOptions = Object.assign({}, defaultOptions, options?.[path]);
-            service.debouncedStore = new DebouncedStore(app, serviceOptions);
-        });
-    };
-}

package/dist/esm/mixins/debounce-mixin/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./types";
-export * from "./DebouncedStore";
-export * from "./debounceMixin";

package/dist/esm/mixins/debounce-mixin/index.js

@@ -1,3 +0,0 @@
-export * from "./types";
-export * from "./DebouncedStore";
-export * from "./debounceMixin";

package/dist/esm/mixins/debounce-mixin/types.d.ts

@@ -1,13 +0,0 @@
-import type { Application } from "@feathersjs/feathers";
-export interface InitDebounceMixinOptions {
-    default: Partial<DebouncedStoreOptions>;
-    blacklist: string[];
-    [key: string]: unknown;
-}
-export declare type DebouncedFunctionApp = (app?: Application) => void | Promise<void>;
-export interface DebouncedStoreOptions {
-    leading: boolean;
-    maxWait: number | undefined;
-    trailing: boolean;
-    wait: number;
-}

package/dist/esm/mixins/debounce-mixin/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/mixins/index.d.ts

@@ -1 +0,0 @@
-export * from "./debounce-mixin";

package/dist/esm/mixins/index.js

@@ -1 +0,0 @@
-export * from "./debounce-mixin";

package/dist/esm/types.d.ts

@@ -1,3 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export declare type Predicate<T = any> = (item: T) => boolean;
-export declare type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/dist/esm/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/typesInternal.d.ts

@@ -1,3 +0,0 @@
-export declare type MaybeArray<T> = T | T[];
-export declare type Promisable<T> = T | Promise<T>;
-export declare type Path = Array<string | number>;

package/dist/esm/typesInternal.js

@@ -1,3 +0,0 @@
-// here are types that are not meant to be exported!
-// just for internal use of this package
-export {};

package/dist/esm/utils/filterQuery.d.ts

@@ -1,8 +0,0 @@
-import type { FilterQueryOptions as PlainFilterQueryOptions, AdapterBase } from "@feathersjs/adapter-commons";
-import type { Query } from "@feathersjs/feathers";
-export interface FilterQueryOptions<T> {
-    service?: AdapterBase<T>;
-    operators?: PlainFilterQueryOptions["operators"];
-    filters?: PlainFilterQueryOptions["filters"];
-}
-export declare function filterQuery<T>(query: Query, _options?: FilterQueryOptions<T>): any;

package/dist/esm/utils/filterQuery.js

@@ -1,32 +0,0 @@
-import { filterQuery as plainFilterQuery } from "@feathersjs/adapter-commons";
-export function filterQuery(query, _options) {
-    query = query || {};
-    _options = _options || {};
-    const { service, ...options } = _options;
-    if (service) {
-        const operators = options.operators
-            ? options.operators
-            : service.options?.operators;
-        const filters = options.filters
-            ? options.filters
-            : service.options?.filters;
-        const optionsForFilterQuery = {};
-        if (operators) {
-            optionsForFilterQuery.operators = operators;
-        }
-        if (filters) {
-            optionsForFilterQuery.filters = filters;
-        }
-        if (service &&
-            "filterQuery" in service &&
-            // @ts-expect-error service is of type 'never'
-            typeof service.filterQuery === "function") {
-            // @ts-expect-error service has no filterQuery method
-            return service.filterQuery({ query }, optionsForFilterQuery);
-        }
-        else {
-            return plainFilterQuery(query, optionsForFilterQuery);
-        }
-    }
-    return plainFilterQuery(query, options);
-}

package/dist/esm/utils/getItemsIsArray.d.ts

@@ -1,10 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export interface GetItemsIsArrayOptions<T = any> {
-    items: T[];
-    isArray: boolean;
-}
-/**
- * util to get items from context, return it as an array, no matter if it is an array or not
- * in a before hook, it uses `context.data`. in an after hook, it uses `context.result`
- */
-export declare const getItemsIsArray: <T = any, H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(context: H) => GetItemsIsArrayOptions<T>;

package/dist/esm/utils/getItemsIsArray.js

@@ -1,16 +0,0 @@
-/**
- * util to get items from context, return it as an array, no matter if it is an array or not
- * in a before hook, it uses `context.data`. in an after hook, it uses `context.result`
- */
-export const getItemsIsArray = (context) => {
-    let itemOrItems = context.type === "before" ? context.data : context.result;
-    itemOrItems =
-        itemOrItems && context.method === "find"
-            ? itemOrItems.data || itemOrItems
-            : itemOrItems;
-    const isArray = Array.isArray(itemOrItems);
-    return {
-        items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
-        isArray,
-    };
-};

package/dist/esm/utils/getPaginate.d.ts

@@ -1,9 +0,0 @@
-import type { PaginationOptions } from "@feathersjs/adapter-commons";
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * util to get paginate options from context
- * 1. it uses `context.params.paginate` if it exists
- * 2. it uses `service.options.paginate` if it exists
- * 3. it uses `context.params.adapter` if it exists
- */
-export declare const getPaginate: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(context: H) => PaginationOptions | undefined;

package/dist/esm/utils/getPaginate.js

@@ -1,20 +0,0 @@
-/**
- * util to get paginate options from context
- * 1. it uses `context.params.paginate` if it exists
- * 2. it uses `service.options.paginate` if it exists
- * 3. it uses `context.params.adapter` if it exists
- */
-export const getPaginate = (context) => {
-    if (Object.prototype.hasOwnProperty.call(context.params, "paginate")) {
-        return context.params.paginate || undefined;
-    }
-    if (context.params.paginate === false) {
-        return undefined;
-    }
-    let options = context.service.options || {};
-    options = {
-        ...options,
-        ...context.params.adapter,
-    };
-    return options.paginate || undefined;
-};

package/dist/esm/utils/index.d.ts

@@ -1,11 +0,0 @@
-export * from "./mergeQuery";
-export * from "./filterQuery";
-export * from "./getItemsIsArray";
-export * from "./getPaginate";
-export * from "./isMulti";
-export * from "./isPaginated";
-export * from "./markHookForSkip";
-export * from "./pushSet";
-export * from "./setResultEmpty";
-export * from "./shouldSkip";
-export * from "./validateQueryProperty";

package/dist/esm/utils/index.js

@@ -1,11 +0,0 @@
-export * from "./mergeQuery";
-export * from "./filterQuery";
-export * from "./getItemsIsArray";
-export * from "./getPaginate";
-export * from "./isMulti";
-export * from "./isPaginated";
-export * from "./markHookForSkip";
-export * from "./pushSet";
-export * from "./setResultEmpty";
-export * from "./shouldSkip";
-export * from "./validateQueryProperty";

package/dist/esm/utils/isMulti.d.ts

@@ -1,11 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * util to check if a hook is a multi hook:
- * - find: true
- * - get: false
- * - create: `context.data` is an array
- * - update: false
- * - patch: `context.id == null`
- * - remove: `context.id == null`
- */
-export declare const isMulti: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(context: H) => boolean;

package/dist/esm/utils/isMulti.js

@@ -1,26 +0,0 @@
-/**
- * util to check if a hook is a multi hook:
- * - find: true
- * - get: false
- * - create: `context.data` is an array
- * - update: false
- * - patch: `context.id == null`
- * - remove: `context.id == null`
- */
-export const isMulti = (context) => {
-    const { method } = context;
-    if (method === "find") {
-        return true;
-    }
-    else if (["patch", "remove"].includes(method)) {
-        return context.id == null;
-    }
-    else if (method === "create") {
-        const items = context.type === "before" ? context.data : context.result;
-        return Array.isArray(items);
-    }
-    else if (["get", "update"].includes(method)) {
-        return false;
-    }
-    return false;
-};

package/dist/esm/utils/isPaginated.d.ts

@@ -1,5 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * util to check if a hook is a paginated hook using `getPaginate`
- */
-export declare const isPaginated: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(context: H) => boolean;

package/dist/esm/utils/isPaginated.js

@@ -1,11 +0,0 @@
-import { getPaginate } from "./getPaginate";
-/**
- * util to check if a hook is a paginated hook using `getPaginate`
- */
-export const isPaginated = (context) => {
-    if (context.params.paginate === false) {
-        return false;
-    }
-    const paginate = getPaginate(context);
-    return !!paginate;
-};

package/dist/esm/utils/markHookForSkip.d.ts

@@ -1,7 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { HookType } from "feathers-hooks-common";
-import type { MaybeArray } from "../typesInternal";
-/**
- * util to mark a hook for skip, has to be used with `shouldSkip`
- */
-export declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H | undefined;

package/dist/esm/utils/markHookForSkip.js

@@ -1,18 +0,0 @@
-import { pushSet } from "./pushSet";
-/**
- * util to mark a hook for skip, has to be used with `shouldSkip`
- */
-export function markHookForSkip(hookName, type, context) {
-    // @ts-expect-error context is not of type 'H'
-    context = context || {};
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const params = context.params || {};
-    const types = Array.isArray(type) ? type : [type];
-    types.forEach((t) => {
-        const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
-        pushSet(params, ["skipHooks"], combinedName, { unique: true });
-    });
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    context.params = params;
-    return context;
-}

package/dist/esm/utils/mergeQuery/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./mergeArrays";
-export * from "./mergeQuery";
-export * from "./types";

package/dist/esm/utils/mergeQuery/index.js

@@ -1,3 +0,0 @@
-export * from "./mergeArrays";
-export * from "./mergeQuery";
-export * from "./types";

package/dist/esm/utils/mergeQuery/mergeArrays.d.ts

@@ -1,3 +0,0 @@
-import type { Path } from "../../typesInternal";
-import type { Handle, ActionOnEmptyIntersect } from "./types";
-export declare function mergeArrays<T>(targetArr: T[], sourceArr: T[], handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;

package/dist/esm/utils/mergeQuery/mergeArrays.js

@@ -1,37 +0,0 @@
-export function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyIntersect) {
-    if (!sourceArr && !targetArr) {
-        return;
-    }
-    if (handle === "target") {
-        return targetArr;
-    }
-    else if (handle === "source") {
-        return sourceArr;
-    }
-    else if (handle === "combine") {
-        if (!sourceArr || !Array.isArray(sourceArr)) {
-            return targetArr;
-        }
-        if (!targetArr || !Array.isArray(targetArr)) {
-            return sourceArr;
-        }
-        const arr = targetArr.concat(sourceArr);
-        return [...new Set(arr)];
-    }
-    else if (handle === "intersect" || handle === "intersectOrFull") {
-        const targetIsArray = !targetArr || !Array.isArray(targetArr);
-        const sourceIsArray = !sourceArr || !Array.isArray(sourceArr);
-        if ((targetIsArray || sourceIsArray) && handle === "intersect") {
-            if (actionOnEmptyIntersect) {
-                actionOnEmptyIntersect(targetArr, sourceArr, prependKey || []);
-            }
-            return;
-        }
-        if (handle === "intersectOrFull") {
-            const val = !targetIsArray ? targetArr : sourceArr;
-            return val;
-        }
-        return targetArr.filter((val) => sourceArr.includes(val));
-    }
-    return undefined;
-}

package/dist/esm/utils/mergeQuery/mergeQuery.d.ts

@@ -1,3 +0,0 @@
-import type { Query } from "@feathersjs/feathers";
-import type { MergeQueryOptions } from "./types";
-export declare function mergeQuery<T>(target: Query, source: Query, options?: Partial<MergeQueryOptions<T>>): Query;