feathers-utils 2.0.0-2 → 2.0.0-4

package/dist/index.js

@@ -14,57 +14,31 @@ 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.filterArray = exports.validateQueryProperty = exports.shouldSkip = exports.onDelete = exports.getItemsIsArray = exports.filterQuery = exports.markHookForSkip = exports.setResultEmpty = exports.pushSet = exports.mergeArrays = exports.mergeQuery = exports.isPaginated = exports.isMulti = exports.getPaginate = exports.DebouncedStore = exports.debounceMixin = exports.mixins = exports.runPerItem = exports.removeRelated = exports.setData = exports.createRelated = exports.checkMulti = exports.hooks = void 0;
+exports.filterObject = exports.filterArray = void 0;
 // hooks
-const checkMulti_1 = require("./hooks/checkMulti");
-Object.defineProperty(exports, "checkMulti", { enumerable: true, get: function () { return checkMulti_1.checkMulti; } });
-const setData_1 = require("./hooks/setData");
-Object.defineProperty(exports, "setData", { enumerable: true, get: function () { return setData_1.setData; } });
-const runPerItem_1 = require("./hooks/runPerItem");
-Object.defineProperty(exports, "runPerItem", { enumerable: true, get: function () { return runPerItem_1.runPerItem; } });
-exports.hooks = {
-    checkMulti: checkMulti_1.checkMulti,
-    setData: setData_1.setData,
-    runPerItem: runPerItem_1.runPerItem
-};
-var createRelated_1 = require("./hooks/createRelated");
-Object.defineProperty(exports, "createRelated", { enumerable: true, get: function () { return createRelated_1.createRelated; } });
-var removeRelated_1 = require("./hooks/removeRelated");
-Object.defineProperty(exports, "removeRelated", { enumerable: true, get: function () { return removeRelated_1.removeRelated; } });
-const debounce_mixin_1 = require("./mixins/debounce-mixin");
-Object.defineProperty(exports, "debounceMixin", { enumerable: true, get: function () { return debounce_mixin_1.debounceMixin; } });
-Object.defineProperty(exports, "DebouncedStore", { enumerable: true, get: function () { return debounce_mixin_1.DebouncedStore; } });
-exports.mixins = {
-    debounceMixin: debounce_mixin_1.debounceMixin,
-    DebouncedStore: debounce_mixin_1.DebouncedStore
-};
-var getPaginate_1 = require("./utils/getPaginate");
-Object.defineProperty(exports, "getPaginate", { enumerable: true, get: function () { return getPaginate_1.getPaginate; } });
-var isMulti_1 = require("./utils/isMulti");
-Object.defineProperty(exports, "isMulti", { enumerable: true, get: function () { return isMulti_1.isMulti; } });
-var isPaginated_1 = require("./utils/isPaginated");
-Object.defineProperty(exports, "isPaginated", { enumerable: true, get: function () { return isPaginated_1.isPaginated; } });
-var index_1 = require("./utils/mergeQuery/index");
-Object.defineProperty(exports, "mergeQuery", { enumerable: true, get: function () { return index_1.mergeQuery; } });
-var mergeArrays_1 = require("./utils/mergeQuery/mergeArrays");
-Object.defineProperty(exports, "mergeArrays", { enumerable: true, get: function () { return mergeArrays_1.mergeArrays; } });
-var pushSet_1 = require("./utils/pushSet");
-Object.defineProperty(exports, "pushSet", { enumerable: true, get: function () { return pushSet_1.pushSet; } });
-var setResultEmpty_1 = require("./utils/setResultEmpty");
-Object.defineProperty(exports, "setResultEmpty", { enumerable: true, get: function () { return setResultEmpty_1.setResultEmpty; } });
-var markHookForSkip_1 = require("./utils/markHookForSkip");
-Object.defineProperty(exports, "markHookForSkip", { enumerable: true, get: function () { return markHookForSkip_1.markHookForSkip; } });
-var filterQuery_1 = require("./utils/filterQuery");
-Object.defineProperty(exports, "filterQuery", { enumerable: true, get: function () { return filterQuery_1.filterQuery; } });
-var getItemsIsArray_1 = require("./utils/getItemsIsArray");
-Object.defineProperty(exports, "getItemsIsArray", { enumerable: true, get: function () { return getItemsIsArray_1.getItemsIsArray; } });
-var onDelete_1 = require("./hooks/onDelete");
-Object.defineProperty(exports, "onDelete", { enumerable: true, get: function () { return onDelete_1.onDelete; } });
-var shouldSkip_1 = require("./utils/shouldSkip");
-Object.defineProperty(exports, "shouldSkip", { enumerable: true, get: function () { return shouldSkip_1.shouldSkip; } });
-var validateQueryProperty_1 = require("./utils/validateQueryProperty");
-Object.defineProperty(exports, "validateQueryProperty", { enumerable: true, get: function () { return validateQueryProperty_1.validateQueryProperty; } });
+__exportStar(require("./hooks/checkMulti"), exports);
+__exportStar(require("./hooks/createRelated"), exports);
+__exportStar(require("./hooks/onDelete"), exports);
+__exportStar(require("./hooks/removeRelated"), exports);
+__exportStar(require("./hooks/runPerItem"), exports);
+__exportStar(require("./hooks/setData"), exports);
+// mixins
+__exportStar(require("./mixins/debounce-mixin"), exports);
+// utils
+__exportStar(require("./utils/isMulti"), exports);
+__exportStar(require("./utils/getPaginate"), exports);
+__exportStar(require("./utils/isPaginated"), exports);
+__exportStar(require("./utils/mergeQuery"), exports);
+__exportStar(require("./utils/pushSet"), exports);
+__exportStar(require("./utils/setResultEmpty"), exports);
+__exportStar(require("./utils/filterQuery"), exports);
+__exportStar(require("./utils/getItemsIsArray"), exports);
+__exportStar(require("./utils/shouldSkip"), exports);
+__exportStar(require("./utils/markHookForSkip"), exports);
+__exportStar(require("./utils/validateQueryProperty"), exports);
 // query filters
 var array_1 = require("./filters/array");
 Object.defineProperty(exports, "filterArray", { enumerable: true, get: function () { return array_1.filterArray; } });
+var object_1 = require("./filters/object");
+Object.defineProperty(exports, "filterObject", { enumerable: true, get: function () { return object_1.filterObject; } });
 __exportStar(require("./types"), exports);

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

@@ -1,12 +1,15 @@
 import type { DebouncedFunc } from "lodash";
 import type { Application, Id } from "@feathersjs/feathers";
-import type { DebouncedFunctionApp, DebouncedStoreOptions } from "../../types";
+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>)>>;
+    _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;

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

@@ -19,7 +19,7 @@ const makeDefaultOptions = () => {
         leading: false,
         maxWait: undefined,
         trailing: true,
-        wait: 100
+        wait: 100,
     };
 };
 exports.makeDefaultOptions = makeDefaultOptions;
@@ -33,7 +33,7 @@ class DebouncedStore {
         this.add = this.debounceById(this.unbounced, this._options.wait, {
             leading: this._options.leading,
             maxWait: this._options.maxWait,
-            trailing: this._options.trailing
+            trailing: this._options.trailing,
         });
     }
     unbounced(id, action) {

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

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

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debounceMixin = void 0;
+const DebouncedStore_1 = require("./DebouncedStore");
+function debounceMixin(options) {
+    return (app) => {
+        options = options || {};
+        const defaultOptions = Object.assign((0, DebouncedStore_1.makeDefaultOptions)(), options === null || options === void 0 ? void 0 : options.default);
+        app.mixins.push((service, path) => {
+            // if path is on blacklist, don't add debouncedStore to service
+            if ((options === null || options === void 0 ? void 0 : 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 === null || options === void 0 ? void 0 : options[path]);
+            service.debouncedStore = new DebouncedStore_1.DebouncedStore(app, serviceOptions);
+        });
+    };
+}
+exports.debounceMixin = debounceMixin;

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

@@ -1,8 +1,3 @@
-import { DebouncedStore } from "./DebouncedStore";
-import type { Application, FeathersService } from "@feathersjs/feathers";
-import type { InitDebounceMixinOptions } from "../../types";
-export declare type DebouncedService = FeathersService & {
-    debouncedStore: DebouncedStore;
-};
-export declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): ((app: Application) => void);
-export { DebouncedStore };
+export * from "./types";
+export * from "./DebouncedStore";
+export * from "./debounceMixin";

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

@@ -1,24 +1,19 @@
 "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.DebouncedStore = exports.debounceMixin = void 0;
-const DebouncedStore_1 = require("./DebouncedStore");
-Object.defineProperty(exports, "DebouncedStore", { enumerable: true, get: function () { return DebouncedStore_1.DebouncedStore; } });
-function debounceMixin(options) {
-    return (app) => {
-        options = options || {};
-        const defaultOptions = Object.assign((0, DebouncedStore_1.makeDefaultOptions)(), options === null || options === void 0 ? void 0 : options.default);
-        app.mixins.push((service, path) => {
-            // if path is on blacklist, don't add debouncedStore to service
-            if ((options === null || options === void 0 ? void 0 : 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 === null || options === void 0 ? void 0 : options[path]);
-            service.debouncedStore = new DebouncedStore_1.DebouncedStore(app, serviceOptions);
-        });
-    };
-}
-exports.debounceMixin = debounceMixin;
+__exportStar(require("./types"), exports);
+__exportStar(require("./DebouncedStore"), exports);
+__exportStar(require("./debounceMixin"), exports);

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

@@ -0,0 +1,13 @@
+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/mixins/debounce-mixin/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -1,79 +1,3 @@
-import type { Application, HookContext } from "@feathersjs/feathers";
-import type { AdapterBase, FilterQueryOptions as PlainFilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare type Path = Array<string | number>;
-export declare type MaybeArray<T> = T | T[];
-export declare type Promisable<T> = T | Promise<T>;
-export declare type HookType = "before" | "after" | "error";
-export declare type ServiceMethodName = "find" | "get" | "create" | "update" | "patch" | "remove";
-export declare type ReturnSyncHook = (context: HookContext) => HookContext;
-export declare type ReturnAsyncHook = (context: HookContext) => Promise<HookContext>;
-export declare type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-export declare type FirstLast = "first" | "last";
+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;
-export interface HookSetDataOptions {
-    allowUndefined?: boolean;
-    overwrite?: boolean | PredicateWithContext;
-}
-export interface AddHookOptions {
-    types: HookType[];
-    methods: ServiceMethodName[];
-    orderByType: Record<HookType, FirstLast>;
-    whitelist?: string[];
-    blacklist?: string[];
-}
-export interface HookRunPerItemOptions {
-    wait?: boolean;
-}
-export interface RemoveRelatedOptions<S = Record<string, any>> {
-    service: keyof S;
-    keyThere: string;
-    keyHere: string;
-    blocking?: boolean;
-}
-export interface CreateRelatedOptions<S = Record<string, any>> {
-    service: keyof S;
-    multi?: boolean;
-    data: (item: any, context: HookContext) => Promisable<Record<string, any>>;
-    createItemsInDataArraySeparately?: boolean;
-}
-export declare type OnDeleteAction = "cascade" | "set null";
-export interface OnDeleteOptions {
-    keyThere: string;
-    keyHere: string;
-    onDelete: OnDeleteAction;
-    blocking?: boolean;
-}
-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;
-}
-export interface PushSetOptions {
-    unique?: boolean;
-}
-export declare type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-export interface MergeQueryOptions<T> extends FilterQueryOptions<T> {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-export interface FilterQueryOptions<T> {
-    service?: AdapterBase<T>;
-    operators?: PlainFilterQueryOptions["operators"];
-    filters?: PlainFilterQueryOptions["filters"];
-}
-export interface GetItemsIsArrayOptions<T = any> {
-    items: T[];
-    isArray: boolean;
-}

package/dist/types.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//#endregion

package/dist/typesInternal.d.ts

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

package/dist/typesInternal.js

@@ -0,0 +1,4 @@
+"use strict";
+// here are types that are not meant to be exported!
+// just for internal use of this package
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/filterQuery.d.ts

@@ -1,3 +1,8 @@
+import type { FilterQueryOptions as PlainFilterQueryOptions, AdapterBase } from "@feathersjs/adapter-commons";
 import type { Query } from "@feathersjs/feathers";
-import type { FilterQueryOptions } from "../types";
+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/utils/filterQuery.js

@@ -32,8 +32,10 @@ function filterQuery(query, _options) {
         if (filters) {
             optionsForFilterQuery.filters = filters;
         }
-        // @ts-expect-error service has no filterQuery method
-        if (service && "filterQuery" in service && typeof service.filterQuery === "function") {
+        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);
         }

package/dist/utils/getItemsIsArray.d.ts

@@ -1,3 +1,6 @@
 import type { HookContext } from "@feathersjs/feathers";
-import type { GetItemsIsArrayOptions } from "..";
-export declare const getItemsIsArray: <T = any>(context: HookContext) => GetItemsIsArrayOptions<T>;
+export interface GetItemsIsArrayOptions<T = any> {
+    items: T[];
+    isArray: boolean;
+}
+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/utils/getItemsIsArray.js

@@ -3,20 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getItemsIsArray = void 0;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const getItemsIsArray = (context) => {
-    let itemOrItems = context.type === "before"
-        ? context.data
-        : context.result;
-    itemOrItems = itemOrItems && context.method === "find"
-        ? (itemOrItems.data || itemOrItems)
-        : itemOrItems;
+    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
+        items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
+        isArray,
     };
 };
 exports.getItemsIsArray = getItemsIsArray;

package/dist/utils/getPaginate.d.ts

@@ -1,7 +1,3 @@
+import type { PaginationOptions } from "@feathersjs/adapter-commons";
 import type { HookContext } from "@feathersjs/feathers";
-interface PaginationOptions {
-    default: number;
-    max: number;
-}
-export declare const getPaginate: (context: HookContext) => PaginationOptions | undefined;
-export {};
+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/utils/isMulti.d.ts

@@ -1,2 +1,2 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare const isMulti: (context: HookContext) => boolean;
+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/utils/isPaginated.d.ts

@@ -1,2 +1,2 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare const isPaginated: (context: HookContext) => boolean;
+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/utils/markHookForSkip.d.ts

@@ -1,3 +1,4 @@
 import type { HookContext } from "@feathersjs/feathers";
-import type { HookType, MaybeArray } from "../types";
-export declare function markHookForSkip<T>(hookName: string, type: "all" | MaybeArray<HookType>, context?: Partial<HookContext<T>>): Partial<HookContext<T>>;
+import type { HookType } from "feathers-hooks-common";
+import type { MaybeArray } from "../typesInternal";
+export declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H | undefined;

package/dist/utils/markHookForSkip.js

@@ -3,15 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.markHookForSkip = void 0;
 const pushSet_1 = require("./pushSet");
 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}`;
+    const types = Array.isArray(type) ? type : [type];
+    types.forEach((t) => {
+        const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
         (0, pushSet_1.pushSet)(params, ["skipHooks"], combinedName, { unique: true });
     });
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     context.params = params;
     return context;
 }

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

@@ -1,3 +1,3 @@
-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;
+export * from "./mergeArrays";
+export * from "./mergeQuery";
+export * from "./types";