feathers-utils 2.0.0-9 → 2.1.0

package/src/utils/mergeQuery/utils.ts

@@ -2,20 +2,15 @@ import { Forbidden } from "@feathersjs/errors";
 import _get from "lodash/get.js";
 import _has from "lodash/has.js";
 import _isEmpty from "lodash/isEmpty.js";
-import _isEqual from "lodash/isEqual.js";
 
 import _set from "lodash/set.js";
 import _uniqWith from "lodash/uniqWith.js";
 import type { Path } from "../../typesInternal";
 import { mergeArrays } from "./mergeArrays";
 import type { Handle, MergeQueryOptions } from "./types";
-
-export const hasOwnProperty = (
-  obj: Record<string, unknown>,
-  key: string
-): boolean => {
-  return Object.prototype.hasOwnProperty.call(obj, key);
-};
+import { deepEqual as _isEqual } from "fast-equals";
+import type { Query } from "@feathersjs/feathers";
+import { hasOwnProperty } from "../internal.utils";
 
 export function handleArray<T>(
   target: Record<string, unknown>,
@@ -265,19 +260,12 @@ export function handleCircular<T>(
 export function makeDefaultOptions<T>(
   options?: Partial<MergeQueryOptions<T>>
 ): MergeQueryOptions<T> {
-  options = options || ({} as MergeQueryOptions<T>);
-  options.defaultHandle = options.defaultHandle || "combine";
-  options.useLogicalConjunction = Object.prototype.hasOwnProperty.call(
-    options,
-    "useLogicalConjunction"
-  )
-    ? options.useLogicalConjunction
-    : false;
-  options.actionOnEmptyIntersect =
-    options.actionOnEmptyIntersect ||
-    (() => {
-      throw new Forbidden("You're not allowed to make this request");
-    });
+  options ??= {} as MergeQueryOptions<T>;
+  options.defaultHandle ??= "combine";
+  options.useLogicalConjunction ??= false;
+  options.actionOnEmptyIntersect ??= () => {
+    throw new Forbidden("You're not allowed to make this request");
+  };
   options.handle = options.handle || {};
   if (options.defaultHandle === "intersect") {
     options.handle.$select = options.handle.$select || "intersectOrFull";
@@ -286,15 +274,17 @@ export function makeDefaultOptions<T>(
 }
 
 export function moveProperty(
-  source: Record<string, any>,
-  target: Record<string, any>,
-  key: string
+  from: Record<string, any>,
+  to: Record<string, any>,
+  ...keys: string[]
 ): void {
-  if (!Object.prototype.hasOwnProperty.call(source, key)) {
-    return;
-  }
-  target[key] = source[key];
-  delete source[key];
+  keys.forEach((key) => {
+    if (!hasOwnProperty(from, key)) {
+      return;
+    }
+    to[key] = from[key];
+    delete from[key];
+  });
 }
 
 export function getParentProp(target: Record<string, unknown>, path: Path) {
@@ -338,5 +328,68 @@ export function arrayWithoutDuplicates<T>(target: T[]): T[] {
   if (!target || !Array.isArray(target)) {
     return target;
   }
+
   return _uniqWith(target, _isEqual);
 }
+
+/**
+ * Checks if one query is a superset of the target query
+ * @param target The target query
+ * @param source The source query
+ * @returns The query that is the superset of the other query, returns undefined otherwise
+ */
+export function isQueryMoreExplicitThanQuery(
+  target: Query,
+  source: Query
+): Query | undefined {
+  if (!target || !source) {
+    return;
+  }
+
+  const targetKeys = Object.keys(target);
+  const sourceKeys = Object.keys(source);
+
+  // sourceQuery: {}; targetQuery: { something }
+  if (!sourceKeys.length) {
+    return target;
+  }
+
+  // sourceQuery: { something }; targetQuery: {}
+  if (!targetKeys.length) {
+    return source;
+  }
+
+  if (targetKeys.every((key) => _isEqual(target[key], source[key]))) {
+    // every property of target is exactly in source
+    return source;
+  }
+
+  if (sourceKeys.every((key) => _isEqual(target[key], source[key]))) {
+    // every property of source is exactly in target
+    return target;
+  }
+
+  return;
+}
+
+export function areQueriesOverlapping(target: Query, source: Query): boolean {
+  if (!target || !source) {
+    return false;
+  }
+
+  const targetKeys = Object.keys(target);
+  const sourceKeys = Object.keys(source);
+
+  if (!sourceKeys.length || !targetKeys.length) {
+    return false;
+  }
+
+  if (
+    targetKeys.some((x) => sourceKeys.includes(x)) ||
+    sourceKeys.some((x) => targetKeys.includes(x))
+  ) {
+    return true;
+  }
+
+  return false;
+}

package/dist/esm/filters/array.d.ts

@@ -1,2 +0,0 @@
-import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };

package/dist/esm/filters/array.js

@@ -1,17 +0,0 @@
-import { validateQueryProperty } from "../utils/validateQueryProperty";
-const filterQueryArray = (key) => (arr, { operators }) => {
-    if (arr && !Array.isArray(arr)) {
-        throw new Error(`Invalid query parameter '${key}'. It has to be an array`);
-    }
-    if (Array.isArray(arr)) {
-        return arr.map((current) => validateQueryProperty(current, operators));
-    }
-    return arr;
-};
-export const filterArray = (...keys) => {
-    const result = {};
-    for (const key of keys) {
-        result[key] = filterQueryArray(key);
-    }
-    return result;
-};

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

@@ -1,2 +0,0 @@
-export * from "./array";
-export * from "./object";

package/dist/esm/filters/index.js

@@ -1,2 +0,0 @@
-export * from "./array";
-export * from "./object";

package/dist/esm/filters/object.d.ts

@@ -1,2 +0,0 @@
-import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };

package/dist/esm/filters/object.js

@@ -1,15 +0,0 @@
-import { validateQueryProperty } from "../utils/validateQueryProperty";
-import _isObject from "lodash/isObject";
-const filterQueryObject = (key) => (obj, { operators }) => {
-    if (obj && !_isObject(obj)) {
-        throw new Error(`Invalid query parameter: '${key}'. It has to be an object`);
-    }
-    return validateQueryProperty(obj, operators);
-};
-export const filterObject = (...keys) => {
-    const result = {};
-    for (const key of keys) {
-        result[key] = filterQueryObject(key);
-    }
-    return result;
-};

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

@@ -1,5 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * hook to check if context is multi patch/remove and if the service allows it
- */
-export declare function checkMulti<H extends HookContext = HookContext>(): (context: H) => H;

package/dist/esm/hooks/checkMulti.js

@@ -1,20 +0,0 @@
-import { MethodNotAllowed } from "@feathersjs/errors";
-import { shouldSkip, isMulti } from "../utils";
-/**
- * hook to check if context is multi patch/remove and if the service allows it
- */
-export function checkMulti() {
-    return (context) => {
-        if (shouldSkip("checkMulti", context)) {
-            return context;
-        }
-        const { service, method } = context;
-        if (!service.allowsMulti || !isMulti(context) || method === "find") {
-            return context;
-        }
-        if (!service.allowsMulti(method)) {
-            throw new MethodNotAllowed(`Can not ${method} multiple entries`);
-        }
-        return context;
-    };
-}

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

@@ -1,12 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "../typesInternal";
-export interface CreateRelatedOptions<S = Record<string, any>> {
-    service: keyof S;
-    multi?: boolean;
-    data: (item: any, context: HookContext) => Promisable<Record<string, any>>;
-    createItemsInDataArraySeparately?: boolean;
-}
-/**
- * hook to create related items
- */
-export declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, multi, data, createItemsInDataArraySeparately, }: CreateRelatedOptions<S>): (context: H) => Promise<H>;

package/dist/esm/hooks/createRelated.js

@@ -1,31 +0,0 @@
-import { checkContext } from "feathers-hooks-common";
-import { getItemsIsArray, shouldSkip } from "../utils";
-/**
- * hook to create related items
- */
-export function createRelated({ service, multi = true, data, createItemsInDataArraySeparately = true, }) {
-    if (!service || !data) {
-        throw "initialize hook 'createRelated' completely!";
-    }
-    return async (context) => {
-        if (shouldSkip("createRelated", context)) {
-            return context;
-        }
-        checkContext(context, "after", undefined, "createRelated");
-        const { items } = getItemsIsArray(context);
-        let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter((x) => !!x);
-        if (createItemsInDataArraySeparately) {
-            dataToCreate = dataToCreate.flat();
-        }
-        if (!dataToCreate || dataToCreate.length <= 0) {
-            return context;
-        }
-        if (multi) {
-            await context.app.service(service).create(dataToCreate);
-        }
-        else {
-            await Promise.all(dataToCreate.map(async (item) => context.app.service(service).create(item)));
-        }
-        return context;
-    };
-}

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

@@ -1,6 +0,0 @@
-export * from "./checkMulti";
-export * from "./createRelated";
-export * from "./onDelete";
-export * from "./removeRelated";
-export * from "./runPerItem";
-export * from "./setData";

package/dist/esm/hooks/index.js

@@ -1,6 +0,0 @@
-export * from "./checkMulti";
-export * from "./createRelated";
-export * from "./onDelete";
-export * from "./removeRelated";
-export * from "./runPerItem";
-export * from "./setData";

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

@@ -1,12 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export type OnDeleteAction = "cascade" | "set null";
-export interface OnDeleteOptions {
-    keyThere: string;
-    keyHere: string;
-    onDelete: OnDeleteAction;
-    blocking?: boolean;
-}
-/**
- * hook to manipulate related items on delete
- */
-export declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(service: keyof S, { keyThere, keyHere, onDelete, blocking, }: OnDeleteOptions): (context: H) => Promise<H>;

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,10 +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.result` if it is existent. otherwise uses context.data
- */
-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,29 +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.result` if it is existent. otherwise uses context.data
- */
-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.result` (if existent) or `context.data` (otherwise)
- */
-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.result` (if existent) or `context.data` (otherwise)
- */
-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 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 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 type Predicate<T = any> = (item: T) => boolean;
-export 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 type MaybeArray<T> = T | T[];
-export type Promisable<T> = T | Promise<T>;
-export 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 {};