feathers-utils 2.0.0-8 → 2.0.0-9

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

@@ -1,5 +1,5 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare type OnDeleteAction = "cascade" | "set null";
+export type OnDeleteAction = "cascade" | "set null";
 export interface OnDeleteOptions {
     keyThere: string;
     keyHere: string;

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

@@ -5,7 +5,6 @@ export interface HookRunPerItemOptions {
 }
 /**
  * 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
+ * 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

@@ -7,8 +7,7 @@ const makeOptions = (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
+ * uses `context.result` if it is existent. otherwise uses context.data
  */
 export const runPerItem = (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

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

@@ -6,6 +6,6 @@ export interface HookSetDataOptions {
     overwrite?: boolean | PredicateWithContext;
 }
 /**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
+ * 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

@@ -8,7 +8,7 @@ const defaultOptions = {
     overwrite: true,
 };
 /**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
+ * 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);

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

@@ -2,7 +2,7 @@ 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 & {
+export type DebouncedService<T = any> = T & {
     debouncedStore: DebouncedStore;
 };
 export declare class DebouncedStore {

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

@@ -4,7 +4,7 @@ export interface InitDebounceMixinOptions {
     blacklist: string[];
     [key: string]: unknown;
 }
-export declare type DebouncedFunctionApp = (app?: Application) => void | Promise<void>;
+export type DebouncedFunctionApp = (app?: Application) => void | Promise<void>;
 export interface DebouncedStoreOptions {
     leading: boolean;
     maxWait: number | undefined;

package/dist/esm/types.d.ts

@@ -1,3 +1,3 @@
 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 type Predicate<T = any> = (item: T) => boolean;
+export type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/dist/esm/typesInternal.d.ts

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

package/dist/esm/utils/filterQuery.js

@@ -19,9 +19,7 @@ export function filterQuery(query, _options) {
         }
         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 {

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

@@ -1,10 +1,10 @@
 import type { HookContext } from "@feathersjs/feathers";
-export interface GetItemsIsArrayOptions<T = any> {
+export interface GetItemsIsArrayResult<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`
+ * uses `context.result` if existent. uses `context.data` otherwise
  */
-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>;
+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) => GetItemsIsArrayResult<T>;

package/dist/esm/utils/getItemsIsArray.js

@@ -1,9 +1,9 @@
 /**
  * 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`
+ * uses `context.result` if existent. uses `context.data` otherwise
  */
 export const getItemsIsArray = (context) => {
-    let itemOrItems = context.type === "before" ? context.data : context.result;
+    let itemOrItems = context.result !== undefined ? context.result : context.data;
     itemOrItems =
         itemOrItems && context.method === "find"
             ? itemOrItems.data || itemOrItems

package/dist/esm/utils/getPaginate.js

@@ -11,7 +11,7 @@ export const getPaginate = (context) => {
     if (context.params.paginate === false) {
         return undefined;
     }
-    let options = context.service.options || {};
+    let options = context.service?.options || {};
     options = {
         ...options,
         ...context.params.adapter,

package/dist/esm/utils/isPaginated.js

@@ -3,7 +3,7 @@ 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) {
+    if (context.params.paginate === false || context.method !== "find") {
         return false;
     }
     const paginate = getPaginate(context);

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

@@ -1,8 +1,8 @@
 import type { Path } from "../../typesInternal";
 import type { FilterQueryOptions } from "../filterQuery";
-export declare type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-export declare type FirstLast = "first" | "last";
-export declare type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+export type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+export type FirstLast = "first" | "last";
+export type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
 export interface MergeQueryOptions<T> extends FilterQueryOptions<T> {
     defaultHandle: Handle;
     actionOnEmptyIntersect: ActionOnEmptyIntersect;

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

@@ -1,5 +1,5 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare type ShouldSkipOptions = {
+export type ShouldSkipOptions = {
     notSkippable?: boolean;
 };
 /**

package/dist/esm/utils/shouldSkip.js

@@ -16,17 +16,14 @@ export const shouldSkip = (hookName, context, options) => {
     if (skipHooks.includes(hookName)) {
         return true;
     }
-    if (skipHooks.includes("all")) {
+    else if (skipHooks.includes("all")) {
         return true;
     }
-    if (type === "before") {
-        return (skipHooks.includes(`before:${hookName}`) || skipHooks.includes("before"));
-    }
-    if (type === "after") {
-        return (skipHooks.includes(`after:${hookName}`) || skipHooks.includes("after"));
+    else if (skipHooks.includes(type)) {
+        return true;
     }
-    if (type === "error") {
-        return (skipHooks.includes(`error:${hookName}`) || skipHooks.includes("error"));
+    else if (skipHooks.includes(`${type}:${hookName}`)) {
+        return true;
     }
     return false;
 };

package/dist/hooks/onDelete.d.ts

@@ -1,5 +1,5 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare type OnDeleteAction = "cascade" | "set null";
+export type OnDeleteAction = "cascade" | "set null";
 export interface OnDeleteOptions {
     keyThere: string;
     keyHere: string;

package/dist/hooks/runPerItem.d.ts

@@ -5,7 +5,6 @@ export interface HookRunPerItemOptions {
 }
 /**
  * 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
+ * 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/hooks/runPerItem.js

@@ -19,8 +19,7 @@ const makeOptions = (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
+ * uses `context.result` if it is existent. otherwise uses context.data
  */
 const runPerItem = (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/dist/hooks/setData.d.ts

@@ -6,6 +6,6 @@ export interface HookSetDataOptions {
     overwrite?: boolean | PredicateWithContext;
 }
 /**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
+ * 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/hooks/setData.js

@@ -14,7 +14,7 @@ const defaultOptions = {
     overwrite: true,
 };
 /**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
+ * hook to set properties on `context.result` (if existent) or `context.data` (otherwise)
  */
 function setData(from, to, _options) {
     const options = Object.assign({}, defaultOptions, _options);

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

@@ -2,7 +2,7 @@ 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 & {
+export type DebouncedService<T = any> = T & {
     debouncedStore: DebouncedStore;
 };
 export declare class DebouncedStore {

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

@@ -4,7 +4,7 @@ export interface InitDebounceMixinOptions {
     blacklist: string[];
     [key: string]: unknown;
 }
-export declare type DebouncedFunctionApp = (app?: Application) => void | Promise<void>;
+export type DebouncedFunctionApp = (app?: Application) => void | Promise<void>;
 export interface DebouncedStoreOptions {
     leading: boolean;
     maxWait: number | undefined;

package/dist/types.d.ts

@@ -1,3 +1,3 @@
 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 type Predicate<T = any> = (item: T) => boolean;
+export type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/dist/typesInternal.d.ts

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

package/dist/utils/filterQuery.js

@@ -34,9 +34,7 @@ function filterQuery(query, _options) {
         }
         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 {

package/dist/utils/getItemsIsArray.d.ts

@@ -1,10 +1,10 @@
 import type { HookContext } from "@feathersjs/feathers";
-export interface GetItemsIsArrayOptions<T = any> {
+export interface GetItemsIsArrayResult<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`
+ * uses `context.result` if existent. uses `context.data` otherwise
  */
-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>;
+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) => GetItemsIsArrayResult<T>;

package/dist/utils/getItemsIsArray.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getItemsIsArray = void 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`
+ * uses `context.result` if existent. uses `context.data` otherwise
  */
 const getItemsIsArray = (context) => {
-    let itemOrItems = context.type === "before" ? context.data : context.result;
+    let itemOrItems = context.result !== undefined ? context.result : context.data;
     itemOrItems =
         itemOrItems && context.method === "find"
             ? itemOrItems.data || itemOrItems

package/dist/utils/getPaginate.js

@@ -8,13 +8,14 @@ exports.getPaginate = void 0;
  * 3. it uses `context.params.adapter` if it exists
  */
 const getPaginate = (context) => {
+    var _a;
     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 || {};
+    let options = ((_a = context.service) === null || _a === void 0 ? void 0 : _a.options) || {};
     options = Object.assign(Object.assign({}, options), context.params.adapter);
     return options.paginate || undefined;
 };

package/dist/utils/isPaginated.js

@@ -6,7 +6,7 @@ const getPaginate_1 = require("./getPaginate");
  * util to check if a hook is a paginated hook using `getPaginate`
  */
 const isPaginated = (context) => {
-    if (context.params.paginate === false) {
+    if (context.params.paginate === false || context.method !== "find") {
         return false;
     }
     const paginate = (0, getPaginate_1.getPaginate)(context);

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

@@ -1,8 +1,8 @@
 import type { Path } from "../../typesInternal";
 import type { FilterQueryOptions } from "../filterQuery";
-export declare type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-export declare type FirstLast = "first" | "last";
-export declare type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+export type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+export type FirstLast = "first" | "last";
+export type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
 export interface MergeQueryOptions<T> extends FilterQueryOptions<T> {
     defaultHandle: Handle;
     actionOnEmptyIntersect: ActionOnEmptyIntersect;

package/dist/utils/shouldSkip.d.ts

@@ -1,5 +1,5 @@
 import type { HookContext } from "@feathersjs/feathers";
-export declare type ShouldSkipOptions = {
+export type ShouldSkipOptions = {
     notSkippable?: boolean;
 };
 /**

package/dist/utils/shouldSkip.js

@@ -19,17 +19,14 @@ const shouldSkip = (hookName, context, options) => {
     if (skipHooks.includes(hookName)) {
         return true;
     }
-    if (skipHooks.includes("all")) {
+    else if (skipHooks.includes("all")) {
         return true;
     }
-    if (type === "before") {
-        return (skipHooks.includes(`before:${hookName}`) || skipHooks.includes("before"));
-    }
-    if (type === "after") {
-        return (skipHooks.includes(`after:${hookName}`) || skipHooks.includes("after"));
+    else if (skipHooks.includes(type)) {
+        return true;
     }
-    if (type === "error") {
-        return (skipHooks.includes(`error:${hookName}`) || skipHooks.includes("error"));
+    else if (skipHooks.includes(`${type}:${hookName}`)) {
+        return true;
     }
     return false;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "2.0.0-8",
+  "version": "2.0.0-9",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -43,35 +43,35 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "5.0.0-pre.29",
-    "@feathersjs/errors": "5.0.0-pre.29",
-    "@feathersjs/feathers": "5.0.0-pre.29",
-    "feathers-hooks-common": "^7.0.0-pre.0",
+    "@feathersjs/adapter-commons": "5.0.0-pre.33",
+    "@feathersjs/errors": "5.0.0-pre.33",
+    "@feathersjs/feathers": "5.0.0-pre.33",
+    "feathers-hooks-common": "^7.0.0-pre.1",
     "lodash": "^4.17.21",
-    "type-fest": "^2.19.0"
+    "type-fest": "^3.2.0"
   },
   "devDependencies": {
-    "@feathersjs/memory": "^5.0.0-pre.20",
+    "@feathersjs/memory": "^5.0.0-pre.33",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/lodash": "^4.14.185",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.7.18",
-    "@typescript-eslint/eslint-plugin": "^5.37.0",
-    "@typescript-eslint/parser": "^5.37.0",
+    "@types/lodash": "^4.14.189",
+    "@types/mocha": "^10.0.0",
+    "@types/node": "^18.11.9",
+    "@typescript-eslint/eslint-plugin": "^5.44.0",
+    "@typescript-eslint/parser": "^5.44.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.23.1",
+    "eslint": "^8.28.0",
     "eslint-config-prettier": "^8.5.0",
-    "eslint-import-resolver-typescript": "^3.5.1",
+    "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-security": "^1.5.0",
     "feathers-memory": "^4.1.0",
-    "mocha": "^10.0.0",
+    "mocha": "^10.1.0",
     "np": "^7.6.2",
     "nyc": "^15.1.0",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.0",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.3"
+    "typescript": "^4.9.3"
   }
 }

package/src/hooks/runPerItem.ts

@@ -21,8 +21,7 @@ const makeOptions = (
 
 /**
  * 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
+ * uses `context.result` if it is existent. otherwise uses context.data
  */
 export const runPerItem = <H extends HookContext = HookContext>(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/hooks/setData.ts

@@ -20,7 +20,7 @@ const defaultOptions: Required<HookSetDataOptions> = {
 };
 
 /**
- * hook to set properties on `context.data` (before-hook) or `context.result` (after-hook)
+ * hook to set properties on `context.result` (if existent) or `context.data` (otherwise)
  */
 export function setData<H extends HookContext = HookContext>(
   from: PropertyPath,

package/src/utils/filterQuery.ts

@@ -34,10 +34,8 @@ export function filterQuery<T>(query: Query, _options?: FilterQueryOptions<T>) {
     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);

package/src/utils/getItemsIsArray.ts

@@ -1,18 +1,18 @@
 import type { HookContext } from "@feathersjs/feathers";
 
-export interface GetItemsIsArrayOptions<T = any> {
+export interface GetItemsIsArrayResult<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`
+ * uses `context.result` if existent. uses `context.data` otherwise
  */
 export const getItemsIsArray = <T = any, H extends HookContext = HookContext>(
   context: H
-): GetItemsIsArrayOptions<T> => {
-  let itemOrItems = context.type === "before" ? context.data : context.result;
+): GetItemsIsArrayResult<T> => {
+  let itemOrItems = context.result !== undefined ? context.result : context.data;
   itemOrItems =
     itemOrItems && context.method === "find"
       ? itemOrItems.data || itemOrItems

package/src/utils/getPaginate.ts

@@ -17,7 +17,7 @@ export const getPaginate = <H extends HookContext = HookContext>(
   if (context.params.paginate === false) {
     return undefined;
   }
-  let options = context.service.options || {};
+  let options = context.service?.options || {};
 
   options = {
     ...options,

package/src/utils/isPaginated.ts

@@ -7,7 +7,7 @@ import { getPaginate } from "./getPaginate";
 export const isPaginated = <H extends HookContext = HookContext>(
   context: H
 ): boolean => {
-  if (context.params.paginate === false) {
+  if (context.params.paginate === false || context.method !== "find") {
     return false;
   }
 

package/src/utils/shouldSkip.ts

@@ -31,24 +31,12 @@ export const shouldSkip = <
   const { type } = context;
   if (skipHooks.includes(hookName)) {
     return true;
-  }
-  if (skipHooks.includes("all")) {
+  } else if (skipHooks.includes("all")) {
+    return true;
+  } else if (skipHooks.includes(type)) {
+    return true;
+  } else if (skipHooks.includes(`${type}:${hookName}`)) {
     return true;
-  }
-  if (type === "before") {
-    return (
-      skipHooks.includes(`before:${hookName}`) || skipHooks.includes("before")
-    );
-  }
-  if (type === "after") {
-    return (
-      skipHooks.includes(`after:${hookName}`) || skipHooks.includes("after")
-    );
-  }
-  if (type === "error") {
-    return (
-      skipHooks.includes(`error:${hookName}`) || skipHooks.includes("error")
-    );
   }
 
   return false;