feathers-utils 3.1.1 → 3.1.2

package/dist/index.d.cts

@@ -13,7 +13,7 @@ declare function checkMulti<H extends HookContext = HookContext>(): (context: H)
 type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
-type ReturnAsyncHook = (context: HookContext$1) => Promise<HookContext$1>;
+type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -39,7 +39,7 @@ interface HookForEachOptions {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
 }
-declare const forEach: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {
@@ -79,7 +79,7 @@ interface HookRunPerItemOptions {
  * hook to run a hook for each item in the context
  * uses `context.result` if it is existent. otherwise uses context.data
  */
-declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(actionPerItem: (item: any, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
 
 type Predicate<T = any> = (item: T) => boolean;
 type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/dist/index.d.mts

@@ -13,7 +13,7 @@ declare function checkMulti<H extends HookContext = HookContext>(): (context: H)
 type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
-type ReturnAsyncHook = (context: HookContext$1) => Promise<HookContext$1>;
+type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -39,7 +39,7 @@ interface HookForEachOptions {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
 }
-declare const forEach: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {
@@ -79,7 +79,7 @@ interface HookRunPerItemOptions {
  * hook to run a hook for each item in the context
  * uses `context.result` if it is existent. otherwise uses context.data
  */
-declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(actionPerItem: (item: any, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
 
 type Predicate<T = any> = (item: T) => boolean;
 type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare function checkMulti<H extends HookContext = HookContext>(): (context: H)
 type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
-type ReturnAsyncHook = (context: HookContext$1) => Promise<HookContext$1>;
+type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -39,7 +39,7 @@ interface HookForEachOptions {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
 }
-declare const forEach: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookForEachOptions) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {
@@ -79,7 +79,7 @@ interface HookRunPerItemOptions {
  * hook to run a hook for each item in the context
  * uses `context.result` if it is existent. otherwise uses context.data
  */
-declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(actionPerItem: (item: any, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
 
 type Predicate<T = any> = (item: T) => boolean;
 type PredicateWithContext<T = any> = (item: T, context: HookContext) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "3.1.1",
+  "version": "3.1.2",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -40,29 +40,29 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^5.0.10",
-    "@feathersjs/commons": "^5.0.10",
-    "@feathersjs/errors": "^5.0.10",
+    "@feathersjs/adapter-commons": "^5.0.11",
+    "@feathersjs/commons": "^5.0.11",
+    "@feathersjs/errors": "^5.0.11",
     "fast-equals": "^5.0.1",
     "feathers-hooks-common": "^8.1.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@feathersjs/feathers": "^5.0.10",
-    "@feathersjs/memory": "^5.0.10",
-    "@types/lodash": "^4.14.199",
-    "@types/node": "^20.8.3",
-    "@typescript-eslint/eslint-plugin": "^6.7.4",
-    "@typescript-eslint/parser": "^6.7.4",
+    "@feathersjs/feathers": "^5.0.11",
+    "@feathersjs/memory": "^5.0.11",
+    "@types/lodash": "^4.14.201",
+    "@types/node": "^20.9.0",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
     "@vitest/coverage-v8": "^0.34.6",
-    "eslint": "^8.51.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-security": "^1.7.1",
     "np": "^8.0.4",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.0",
     "shx": "^0.3.4",
     "typescript": "^5.2.2",
     "unbuild": "^2.0.0",

package/src/hooks/forEach.ts

@@ -10,18 +10,18 @@ export interface HookForEachOptions {
   items?: GetItemsIsArrayOptions["from"];
 }
 
-export const forEach = (
+export const forEach = <H extends HookContext = HookContext, T = any>(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  actionPerItem: (item: any, context: HookContext) => Promisable<any>,
+  actionPerItem: (item: T, context: H) => Promisable<any>,
   _options?: HookForEachOptions,
-): ReturnAsyncHook => {
+): ReturnAsyncHook<H> => {
   const options: Required<HookForEachOptions> = {
     wait: "parallel",
     items: "automatic",
     ..._options,
   };
 
-  return async (context: HookContext): Promise<HookContext> => {
+  return async (context: H): Promise<H> => {
     if (shouldSkip("runForItems", context)) {
       return context;
     }

package/src/hooks/runPerItem.ts

@@ -21,9 +21,9 @@ const makeOptions = (
  * 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 = <H extends HookContext = HookContext>(
+export const runPerItem = <H extends HookContext = HookContext, T = any>(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  actionPerItem: (item: any, context: H) => Promisable<any>,
+  actionPerItem: (item: T, context: H) => Promisable<any>,
   _options?: HookRunPerItemOptions,
 ) => {
   const options = makeOptions(_options);
@@ -34,7 +34,7 @@ export const runPerItem = <H extends HookContext = HookContext>(
 
     const { items } = getItemsIsArray(context);
 
-    const promises = items.map(async (item: unknown) => {
+    const promises = items.map(async (item: T) => {
       await actionPerItem(item, context);
     });
 

package/src/typesInternal.ts

@@ -15,5 +15,10 @@ export type ServiceMethodName =
   | "update"
   | "patch"
   | "remove";
-export type ReturnSyncHook = (context: HookContext) => HookContext;
-export type ReturnAsyncHook = (context: HookContext) => Promise<HookContext>;
+
+export type ReturnSyncHook<H extends HookContext = HookContext> = (
+  context: H,
+) => H;
+export type ReturnAsyncHook<H extends HookContext = HookContext> = (
+  context: H,
+) => Promise<H>;

package/src/utility-types/index.ts

@@ -41,8 +41,8 @@ export type InferCreateResult<S, D = unknown> = S extends {
   ? D extends any[]
     ? AsArray<Awaited<R>>
     : D extends InferCreateDataSingle<S>
-    ? Single<Awaited<R>>
-    : Awaited<R>
+      ? Single<Awaited<R>>
+      : Awaited<R>
   : never;
 
 export type InferCreateResultSingle<S> = Single<InferCreateResult<S>>;
@@ -59,8 +59,8 @@ export type InferPatchResult<S, IdOrNullable = any> = S extends {
   ? IdOrNullable extends Id
     ? Single<Awaited<R>>
     : IdOrNullable extends null
-    ? AsArray<Awaited<R>>
-    : Awaited<R>
+      ? AsArray<Awaited<R>>
+      : Awaited<R>
   : never;
 
 export type InferRemoveResult<S, IdOrNullable = any> = S extends {
@@ -69,8 +69,8 @@ export type InferRemoveResult<S, IdOrNullable = any> = S extends {
   ? IdOrNullable extends Id
     ? Single<Awaited<R>>
     : IdOrNullable extends null
-    ? AsArray<Awaited<R>>
-    : Awaited<R>
+      ? AsArray<Awaited<R>>
+      : Awaited<R>
   : never;
 
 export type GetService<
@@ -138,10 +138,10 @@ export type InferDataFromPath<
 > = Method extends "create"
   ? InferCreateDataFromPath<App, Path>
   : Method extends "update"
-  ? InferUpdateDataFromPath<App, Path>
-  : Method extends "patch"
-  ? InferPatchDataFromPath<App, Path>
-  : never;
+    ? InferUpdateDataFromPath<App, Path>
+    : Method extends "patch"
+      ? InferPatchDataFromPath<App, Path>
+      : never;
 
 export type InferResultFromPath<
   App extends Application,
@@ -150,13 +150,13 @@ export type InferResultFromPath<
 > = Method extends "get"
   ? InferGetResultFromPath<App, Path>
   : Method extends "find"
-  ? InferFindResultFromPath<App, Path>
-  : Method extends "create"
-  ? InferCreateResultFromPath<App, Path>
-  : Method extends "update"
-  ? InferUpdateResultFromPath<App, Path>
-  : Method extends "patch"
-  ? InferPatchResultFromPath<App, Path>
-  : Method extends "remove"
-  ? InferRemoveResultFromPath<App, Path>
-  : never;
+    ? InferFindResultFromPath<App, Path>
+    : Method extends "create"
+      ? InferCreateResultFromPath<App, Path>
+      : Method extends "update"
+        ? InferUpdateResultFromPath<App, Path>
+        : Method extends "patch"
+          ? InferPatchResultFromPath<App, Path>
+          : Method extends "remove"
+            ? InferRemoveResultFromPath<App, Path>
+            : never;