feathers-utils 1.9.0 → 1.9.4

package/README.md

@@ -19,8 +19,9 @@ npm i feathers-utils
 
 ### Hooks
 
-- `hooks/checkMulti()`: throws if the request is **multi** data, but the service has `allowsMulti(method)` returns `false`
-- `hooks/setData({ allowUndefined: Boolean })`
+- `checkMulti()`: throws if the request is **multi** data, but the service has `allowsMulti(method)` returns `false`
+- `runPerItem`
+- `setData({ allowUndefined: Boolean })`
 
 ### Mixins
 
@@ -30,9 +31,13 @@ npm i feathers-utils
 
 - `addHook`: add hooks to specific services
 - `filterQuery`
+- `getItemsIsArray(context)`: returns `{ items: any[], isArray: boolean }`
+- `getPaginate`
 - `isMulti(context) => Boolean`: returns true, if `find`, `create/patch/remove`: multi
+- `isPaginated`
 - `markHookForSkip`: add hookName to `context.params.skipHooks` - also see `shouldSkip`
 - `mergeQuery`: deeply merges queries
 - `mergeArrays`: merges arrays with intersection options
 - `pushSet`: if existing array: *push*, else *set*
+- `setResultEmpty`
 - `shouldSkip`: checks `context.params.skipHooks` for `'all' | '${hookName}' | '${type}:${hookName}'` - also see `markHookForSkip`

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

@@ -1,2 +1,2 @@
-import type { HookContext } from "@feathersjs/feathers";
-export declare function checkMulti(): ((context: HookContext) => HookContext);
+import type { ReturnSyncHook } from "../types";
+export declare function checkMulti(): ReturnSyncHook;

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

@@ -1,4 +1,3 @@
-import type { HookRunPerItemOptions } from "../types";
+import type { HookRunPerItemOptions, ReturnAsyncHook, Promisable } from "../types";
 import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "type-fest";
-export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => (context: HookContext) => Promise<HookContext>;
+export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => ReturnAsyncHook;

package/dist/esm/hooks/runPerItem.js

@@ -1,5 +1,5 @@
-import { getItems } from "feathers-hooks-common";
 import { shouldSkip } from "../utils/shouldSkip";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
 const makeOptions = (options) => {
     options = options || {};
     return Object.assign({
@@ -14,8 +14,7 @@ actionPerItem, options) => {
         if (shouldSkip("runForItems", context)) {
             return context;
         }
-        let items = getItems(context);
-        items = (Array.isArray(items)) ? items : [items];
+        const { items } = getItemsIsArray(context);
         const promises = items.map(async (item) => {
             await actionPerItem(item, context);
         });

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

@@ -1,4 +1,3 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { HookSetDataOptions } from "../types";
 import type { PropertyPath } from "lodash";
-export declare function setData(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): ((context: HookContext) => HookContext);
+import type { HookSetDataOptions, ReturnSyncHook } from "../types";
+export declare function setData(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): ReturnSyncHook;

package/dist/esm/hooks/setData.js

@@ -1,8 +1,8 @@
 import _get from "lodash/get";
 import _set from "lodash/set";
 import _has from "lodash/has";
-import { getItems } from "feathers-hooks-common";
 import { Forbidden } from "@feathersjs/errors";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
 const defaultOptions = {
     allowUndefined: false,
     overwrite: true
@@ -10,8 +10,7 @@ const defaultOptions = {
 export function setData(from, to, _options) {
     const options = Object.assign({}, defaultOptions, _options);
     return (context) => {
-        let items = getItems(context);
-        items = (Array.isArray(items)) ? items : [items];
+        const { items } = getItemsIsArray(context);
         if (!_has(context, from)) {
             if (!context.params?.provider || options.allowUndefined === true) {
                 return context;

package/dist/esm/index.d.ts

@@ -4,7 +4,7 @@ import { runPerItem } from "./hooks/runPerItem";
 export declare const hooks: {
     checkMulti: typeof checkMulti;
     setData: typeof setData;
-    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => (context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => Promise<import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>>;
+    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => import("./types").ReturnAsyncHook;
 };
 export { checkMulti };
 export { setData };

package/dist/esm/types.d.ts

@@ -1,7 +1,11 @@
 import type { Application, HookContext, Service } from "@feathersjs/feathers";
 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";
 export declare type Predicate<T = any> = (item: T) => boolean;

package/dist/esm/utils/getItemsIsArray.js

@@ -1,10 +1,18 @@
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export 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],
+        items: (isArray)
+            ? itemOrItems
+            : (itemOrItems != null)
+                ? [itemOrItems]
+                : [],
         isArray
     };
 };

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

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

package/dist/hooks/checkMulti.d.ts

@@ -1,2 +1,2 @@
-import type { HookContext } from "@feathersjs/feathers";
-export declare function checkMulti(): ((context: HookContext) => HookContext);
+import type { ReturnSyncHook } from "../types";
+export declare function checkMulti(): ReturnSyncHook;

package/dist/hooks/runPerItem.d.ts

@@ -1,4 +1,3 @@
-import type { HookRunPerItemOptions } from "../types";
+import type { HookRunPerItemOptions, ReturnAsyncHook, Promisable } from "../types";
 import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "type-fest";
-export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => (context: HookContext) => Promise<HookContext>;
+export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => ReturnAsyncHook;

package/dist/hooks/runPerItem.js

@@ -10,8 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runPerItem = void 0;
-const feathers_hooks_common_1 = require("feathers-hooks-common");
 const shouldSkip_1 = require("../utils/shouldSkip");
+const getItemsIsArray_1 = require("../utils/getItemsIsArray");
 const makeOptions = (options) => {
     options = options || {};
     return Object.assign({
@@ -26,8 +26,7 @@ actionPerItem, options) => {
         if ((0, shouldSkip_1.shouldSkip)("runForItems", context)) {
             return context;
         }
-        let items = (0, feathers_hooks_common_1.getItems)(context);
-        items = (Array.isArray(items)) ? items : [items];
+        const { items } = (0, getItemsIsArray_1.getItemsIsArray)(context);
         const promises = items.map((item) => __awaiter(void 0, void 0, void 0, function* () {
             yield actionPerItem(item, context);
         }));

package/dist/hooks/setData.d.ts

@@ -1,4 +1,3 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { HookSetDataOptions } from "../types";
 import type { PropertyPath } from "lodash";
-export declare function setData(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): ((context: HookContext) => HookContext);
+import type { HookSetDataOptions, ReturnSyncHook } from "../types";
+export declare function setData(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): ReturnSyncHook;

package/dist/hooks/setData.js

@@ -7,8 +7,8 @@ exports.setData = void 0;
 const get_1 = __importDefault(require("lodash/get"));
 const set_1 = __importDefault(require("lodash/set"));
 const has_1 = __importDefault(require("lodash/has"));
-const feathers_hooks_common_1 = require("feathers-hooks-common");
 const errors_1 = require("@feathersjs/errors");
+const getItemsIsArray_1 = require("../utils/getItemsIsArray");
 const defaultOptions = {
     allowUndefined: false,
     overwrite: true
@@ -17,8 +17,7 @@ function setData(from, to, _options) {
     const options = Object.assign({}, defaultOptions, _options);
     return (context) => {
         var _a;
-        let items = (0, feathers_hooks_common_1.getItems)(context);
-        items = (Array.isArray(items)) ? items : [items];
+        const { items } = (0, getItemsIsArray_1.getItemsIsArray)(context);
         if (!(0, has_1.default)(context, from)) {
             if (!((_a = context.params) === null || _a === void 0 ? void 0 : _a.provider) || options.allowUndefined === true) {
                 return context;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { runPerItem } from "./hooks/runPerItem";
 export declare const hooks: {
     checkMulti: typeof checkMulti;
     setData: typeof setData;
-    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => (context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => Promise<import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>>;
+    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => import("./types").ReturnAsyncHook;
 };
 export { checkMulti };
 export { setData };

package/dist/types.d.ts

@@ -1,7 +1,11 @@
 import type { Application, HookContext, Service } from "@feathersjs/feathers";
 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";
 export declare type Predicate<T = any> = (item: T) => boolean;

package/dist/utils/getItemsIsArray.js

@@ -3,11 +3,19 @@ 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],
+        items: (isArray)
+            ? itemOrItems
+            : (itemOrItems != null)
+                ? [itemOrItems]
+                : [],
         isArray
     };
 };

package/dist/utils/markHookForSkip.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "1.9.0",
+  "version": "1.9.4",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -42,28 +42,26 @@
     "@feathersjs/adapter-commons": "^4.5.12",
     "@feathersjs/errors": "^4.5.12",
     "@feathersjs/feathers": "^4.5.12",
-    "feathers-hooks-common": "^5.0.6",
-    "lodash": "^4.17.21",
-    "type-fest": "^2.11.1"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@types/lodash": "^4.14.178",
     "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.14",
-    "@typescript-eslint/eslint-plugin": "^5.10.2",
-    "@typescript-eslint/parser": "^5.10.2",
+    "@types/node": "^17.0.19",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.8.0",
+    "eslint": "^8.9.0",
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-security": "^1.4.0",
     "feathers-memory": "^4.1.0",
-    "mocha": "^9.2.0",
+    "mocha": "^9.2.1",
     "np": "^7.6.0",
     "nyc": "^15.1.0",
     "shx": "^0.3.4",
-    "ts-node": "^10.4.0",
+    "ts-node": "^10.5.0",
     "typescript": "^4.5.5"
   }
 }

package/src/hooks/checkMulti.ts

@@ -3,8 +3,10 @@ import { shouldSkip } from "../utils/shouldSkip";
 import { isMulti } from "../utils/isMulti";
 
 import type { HookContext } from "@feathersjs/feathers";
+import type { ReturnSyncHook } from "../types";
 
-export function checkMulti(): ((context: HookContext) => HookContext) {
+export function checkMulti(
+): ReturnSyncHook {
   return (context: HookContext): HookContext => {
     if (shouldSkip("checkMulti", context)) { return context; }
     const { service, method } = context;

package/src/hooks/runPerItem.ts

@@ -1,10 +1,8 @@
-import { getItems } from "feathers-hooks-common";
-
 import { shouldSkip } from "../utils/shouldSkip";
 
-import type { HookRunPerItemOptions } from "../types";
+import type { HookRunPerItemOptions, ReturnAsyncHook, Promisable } from "../types";
 import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "type-fest";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
 
 const makeOptions = (
   options: HookRunPerItemOptions
@@ -19,13 +17,11 @@ export const runPerItem = (
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   actionPerItem: (item: any, context: HookContext) => Promisable<any>, 
   options: HookRunPerItemOptions
-): ((context: HookContext) => Promise<HookContext>) => {
+): ReturnAsyncHook => {
   options = makeOptions(options);
   return async (context: HookContext): Promise<HookContext> => {
     if (shouldSkip("runForItems", context)) { return context; }
-    let items = getItems(context);
-    items = (Array.isArray(items)) ? items : [items];
-
+    const { items } = getItemsIsArray(context);
     const promises = items.map(async (item: unknown) => {
       await actionPerItem(item, context);
     });

package/src/hooks/setData.ts

@@ -2,16 +2,16 @@ import _get from "lodash/get";
 import _set from "lodash/set";
 import _has from "lodash/has";
 
-import { getItems } from "feathers-hooks-common";
-
 import { Forbidden } from "@feathersjs/errors";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
 
 import type { HookContext } from "@feathersjs/feathers";
+import type { PropertyPath } from "lodash";
 
 import type {
-  HookSetDataOptions
+  HookSetDataOptions, 
+  ReturnSyncHook 
 } from "../types";
-import type { PropertyPath } from "lodash";
 
 const defaultOptions: Required<HookSetDataOptions> = {
   allowUndefined: false,
@@ -22,12 +22,11 @@ export function setData(
   from: PropertyPath, 
   to: PropertyPath, 
   _options?: HookSetDataOptions
-): ((context: HookContext) => HookContext) {
+): ReturnSyncHook {
   const options: Required<HookSetDataOptions> = Object.assign({}, defaultOptions, _options);
   return (context: HookContext): HookContext => {
 
-    let items = getItems(context);
-    items = (Array.isArray(items)) ? items : [items];
+    const { items } = getItemsIsArray(context);
 
     if (!_has(context, from)) {
       if (!context.params?.provider || options.allowUndefined === true) {

package/src/mixins/debounce-mixin/index.ts

@@ -10,7 +10,9 @@ import type {
   DebouncedStoreOptions,
 } from "../../types";
 
-export function debounceMixin(options?: Partial<InitDebounceMixinOptions>): ((app: Application) => void) {
+export function debounceMixin(
+  options?: Partial<InitDebounceMixinOptions>
+): ((app: Application) => void) {
   return (app: Application): void => {
     options = options || {};
     const defaultOptions = Object.assign(makeDefaultOptions(), options?.default);

package/src/types.ts

@@ -1,8 +1,13 @@
 import type { Application, HookContext, Service } from "@feathersjs/feathers";
 
 export type Path = Array<string|number>;
+export type MaybeArray<T> = T | T[]
+export type Promisable<T> = T | Promise<T>
+
 export type HookType = "before" | "after" | "error";
 export type ServiceMethodName = "find" | "get" | "create" | "update" | "patch" | "remove";
+export type ReturnSyncHook = (context: HookContext) => HookContext
+export type ReturnAsyncHook = (context: HookContext) => Promise<HookContext>
 
 export type Handle = "target" | "source" | "combine" | "intersect"| "intersectOrFull";
 export type FirstLast = "first" | "last";

package/src/utils/addHook.ts

@@ -8,7 +8,11 @@ const defaultOptions = (): Partial<AddHookOptions> => {
   };
 };
 
-export const addHook = (app: Application, hook: unknown, options: AddHookOptions): void => {
+export const addHook = (
+  app: Application, 
+  hook: unknown, 
+  options: AddHookOptions
+): void => {
   options = Object.assign(defaultOptions(), options);
 
   const {

package/src/utils/getItemsIsArray.ts

@@ -5,11 +5,19 @@ import type { GetItemsIsArrayOptions } from "..";
 export const getItemsIsArray = <T = any>(
   context: HookContext
 ): GetItemsIsArrayOptions<T> => {
-  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],
+    items: (isArray) 
+      ? itemOrItems 
+      : (itemOrItems != null) 
+        ? [itemOrItems] 
+        : [],
     isArray
   };
 };

package/src/utils/isMulti.ts

@@ -1,6 +1,8 @@
 import type { HookContext } from "@feathersjs/feathers";
 
-export const isMulti = (context: HookContext): boolean => {
+export const isMulti = (
+  context: HookContext
+): boolean => {
   const { method } = context;
   if (method === "find") {
     return true;

package/src/utils/markHookForSkip.ts

@@ -1,11 +1,11 @@
 import { pushSet } from "./pushSet";
 
 import type { HookContext } from "@feathersjs/feathers";
-import type { HookType } from "feathers-hooks-common/types";
+import type { HookType, MaybeArray } from "../types";
 
 export function markHookForSkip<T>(
   hookName: string, 
-  type: "all" | HookType | HookType[], 
+  type: "all" | MaybeArray<HookType>, 
   context?: Partial<HookContext<T>>
 ): Partial<HookContext<T>> {
   context = context || {};

package/src/utils/shouldSkip.ts

@@ -5,7 +5,10 @@ import { GeneralError } from "@feathersjs/errors";
 
 import type { HookContext } from "@feathersjs/feathers";
 
-export const shouldSkip = (hookName: string, context: HookContext): boolean => {
+export const shouldSkip = (
+  hookName: string, 
+  context: HookContext
+): boolean => {
   if (!context.params || !context.params.skipHooks) {
     return false;
   }