feathers-utils 4.2.0 → 5.0.1

package/dist/index.cjs

@@ -682,27 +682,30 @@ function createRelated({
   };
 }
 
-const forEach = (actionPerItem, _options) => {
-  const options = {
-    wait: "parallel",
-    items: "automatic",
-    ..._options
-  };
+const forEach = (actionPerItem, options) => {
+  const { wait = "parallel", items: from = "automatic" } = options || {};
   return async (context) => {
-    if (shouldSkip("runForItems", context)) {
+    if (shouldSkip("forEach", context)) {
       return context;
     }
-    const { items } = getItemsIsArray(context, { from: options.items });
+    const { items } = getItemsIsArray(context, { from });
+    const forAll = options?.forAll ? await options.forAll(items, context) : {};
     const promises = [];
+    let i = 0;
     for (const item of items) {
-      const promise = actionPerItem(item, context);
-      if (options.wait === "sequential") {
+      const promise = actionPerItem(item, {
+        context,
+        i,
+        ...forAll ? { fromAll: forAll } : {}
+      });
+      if (wait === "sequential") {
         await promise;
       } else {
         promises.push(promise);
       }
+      i++;
     }
-    if (options.wait === "parallel") {
+    if (wait === "parallel") {
       await Promise.all(promises);
     }
     return context;

package/dist/index.d.cts

@@ -36,11 +36,18 @@ interface GetItemsIsArrayResult<T = any> {
 }
 declare const getItemsIsArray: <T = any, H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
-interface HookForEachOptions {
+type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
-}
-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>;
+    forAll?: (items: T[], context: H) => Promisable<R>;
+};
+type ActionPerItem<T, H, R> = (item: T, options: {
+    context: H;
+    i: number;
+} & (undefined extends R ? {} : {
+    fromAll: R;
+})) => Promisable<any>;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any, R = any>(actionPerItem: ActionPerItem<T, H, R>, options?: HookForEachOptions<T, H, R>) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {

package/dist/index.d.mts

@@ -36,11 +36,18 @@ interface GetItemsIsArrayResult<T = any> {
 }
 declare const getItemsIsArray: <T = any, H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
-interface HookForEachOptions {
+type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
-}
-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>;
+    forAll?: (items: T[], context: H) => Promisable<R>;
+};
+type ActionPerItem<T, H, R> = (item: T, options: {
+    context: H;
+    i: number;
+} & (undefined extends R ? {} : {
+    fromAll: R;
+})) => Promisable<any>;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any, R = any>(actionPerItem: ActionPerItem<T, H, R>, options?: HookForEachOptions<T, H, R>) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {

package/dist/index.d.ts

@@ -36,11 +36,18 @@ interface GetItemsIsArrayResult<T = any> {
 }
 declare const getItemsIsArray: <T = any, H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
-interface HookForEachOptions {
+type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
     items?: GetItemsIsArrayOptions["from"];
-}
-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>;
+    forAll?: (items: T[], context: H) => Promisable<R>;
+};
+type ActionPerItem<T, H, R> = (item: T, options: {
+    context: H;
+    i: number;
+} & (undefined extends R ? {} : {
+    fromAll: R;
+})) => Promisable<any>;
+declare const forEach: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>, T = any, R = any>(actionPerItem: ActionPerItem<T, H, R>, options?: HookForEachOptions<T, H, R>) => ReturnAsyncHook<H>;
 
 type OnDeleteAction = "cascade" | "set null";
 interface OnDeleteOptions {

package/dist/index.mjs

@@ -668,27 +668,30 @@ function createRelated({
   };
 }
 
-const forEach = (actionPerItem, _options) => {
-  const options = {
-    wait: "parallel",
-    items: "automatic",
-    ..._options
-  };
+const forEach = (actionPerItem, options) => {
+  const { wait = "parallel", items: from = "automatic" } = options || {};
   return async (context) => {
-    if (shouldSkip("runForItems", context)) {
+    if (shouldSkip("forEach", context)) {
       return context;
     }
-    const { items } = getItemsIsArray(context, { from: options.items });
+    const { items } = getItemsIsArray(context, { from });
+    const forAll = options?.forAll ? await options.forAll(items, context) : {};
     const promises = [];
+    let i = 0;
     for (const item of items) {
-      const promise = actionPerItem(item, context);
-      if (options.wait === "sequential") {
+      const promise = actionPerItem(item, {
+        context,
+        i,
+        ...forAll ? { fromAll: forAll } : {}
+      });
+      if (wait === "sequential") {
         await promise;
       } else {
         promises.push(promise);
       }
+      i++;
     }
-    if (options.wait === "parallel") {
+    if (wait === "parallel") {
       await Promise.all(promises);
     }
     return context;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "4.2.0",
+  "version": "5.0.1",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {

package/src/hooks/forEach.ts

@@ -5,42 +5,59 @@ import type { HookContext } from "@feathersjs/feathers";
 import type { GetItemsIsArrayOptions } from "../utils/getItemsIsArray";
 import { getItemsIsArray } from "../utils/getItemsIsArray";
 
-export interface HookForEachOptions {
+export type HookForEachOptions<T = any, H = HookContext, R = any> = {
   wait?: "sequential" | "parallel" | false;
   items?: GetItemsIsArrayOptions["from"];
-}
+  forAll?: (items: T[], context: H) => Promisable<R>;
+};
+
+type ActionPerItem<T, H, R> = (
+  item: T,
+  options: {
+    context: H;
+    i: number;
+    // eslint-disable-next-line @typescript-eslint/ban-types
+  } & (undefined extends R ? {} : { fromAll: R }),
+) => Promisable<any>;
 
-export const forEach = <H extends HookContext = HookContext, T = any>(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  actionPerItem: (item: T, context: H) => Promisable<any>,
-  _options?: HookForEachOptions,
+export const forEach = <H extends HookContext = HookContext, T = any, R = any>(
+  actionPerItem: ActionPerItem<T, H, R>,
+  options?: HookForEachOptions<T, H, R>,
 ): ReturnAsyncHook<H> => {
-  const options: Required<HookForEachOptions> = {
-    wait: "parallel",
-    items: "automatic",
-    ..._options,
-  };
+  const { wait = "parallel", items: from = "automatic" } = options || {};
 
   return async (context: H): Promise<H> => {
-    if (shouldSkip("runForItems", context)) {
+    if (shouldSkip("forEach", context)) {
       return context;
     }
 
-    const { items } = getItemsIsArray(context, { from: options.items });
+    const { items } = getItemsIsArray(context, { from });
+
+    const forAll = options?.forAll
+      ? await options.forAll(items, context)
+      : ({} as R);
 
     const promises: Promise<any>[] = [];
 
+    let i = 0;
+
     for (const item of items) {
-      const promise = actionPerItem(item, context);
+      const promise = actionPerItem(item, {
+        context,
+        i,
+        ...(forAll ? { fromAll: forAll } : {}),
+      } as any);
 
-      if (options.wait === "sequential") {
+      if (wait === "sequential") {
         await promise;
       } else {
         promises.push(promise);
       }
+
+      i++;
     }
 
-    if (options.wait === "parallel") {
+    if (wait === "parallel") {
       await Promise.all(promises);
     }