feathers-utils 5.2.0 → 7.0.0

package/README.md

@@ -1,10 +1,9 @@
 # feathers-utils
 
 [![npm](https://img.shields.io/npm/v/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/fratzinger/feathers-utils/Node.js%20CI)](https://github.com/fratzinger/feathers-utils/actions/workflows/node.js.yml?query=branch%3Amain)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fratzinger/feathers-utils/node.js.yml?branch=main)](https://github.com/fratzinger/feathers-utils/actions/workflows/node.js.yml?query=branch%3Amain)
 [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/fratzinger/feathers-utils)](https://codeclimate.com/github/fratzinger/feathers-utils)
 [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/fratzinger/feathers-utils)](https://codeclimate.com/github/fratzinger/feathers-utils)
-[![libraries.io](https://img.shields.io/librariesio/release/npm/feathers-utils)](https://libraries.io/npm/feathers-utils)
 [![npm](https://img.shields.io/npm/dm/feathers-utils)](https://www.npmjs.com/package/feathers-utils)
 [![GitHub license](https://img.shields.io/github/license/fratzinger/feathers-utils)](https://github.com/fratzinger/feathers-utils/blob/main/LICENSE.md)
 

package/dist/index.cjs

@@ -620,13 +620,18 @@ const validateQueryProperty = (query, operators = []) => {
 
 function optimizeBatchPatch(items, options) {
   const map = [];
-  const id = options?.id ?? "id";
-  for (const [id2, data] of items) {
-    const index = map.findIndex((item) => fastEquals.deepEqual(item.data, data));
+  const idKey = options?.id ?? "id";
+  for (const _data of items) {
+    const data = _data;
+    const id = _data[idKey];
+    delete data[idKey];
+    const index = map.findIndex((item) => {
+      return fastEquals.deepEqual(item.data, data);
+    });
     if (index === -1) {
-      map.push({ ids: [id2], data });
+      map.push({ ids: [id], data });
     } else {
-      map[index].ids.push(id2);
+      map[index].ids.push(id);
     }
   }
   return map.map(({ ids, data }) => {
@@ -635,7 +640,7 @@ function optimizeBatchPatch(items, options) {
       data,
       {
         query: {
-          [id]: { $in: ids }
+          [idKey]: { $in: ids }
         }
       }
     ];
@@ -724,37 +729,35 @@ function checkMulti() {
   };
 }
 
-function createRelated({
-  service,
-  multi = true,
-  data,
-  createItemsInDataArraySeparately = true
-}) {
-  if (!service || !data) {
-    throw "initialize hook 'createRelated' completely!";
-  }
+function createRelated(options) {
   return async (context) => {
     if (shouldSkip("createRelated", context)) {
       return context;
     }
     feathersHooksCommon.checkContext(context, "after", void 0, "createRelated");
     const { items } = getItemsIsArray(context);
-    let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter((x) => !!x);
-    if (createItemsInDataArraySeparately) {
-      dataToCreate = dataToCreate.flat();
-    }
-    if (!dataToCreate || dataToCreate.length <= 0) {
-      return context;
-    }
-    if (multi) {
-      await context.app.service(service).create(dataToCreate);
-    } else {
-      await Promise.all(
-        dataToCreate.map(
-          async (item) => context.app.service(service).create(item)
-        )
-      );
-    }
+    const entries = Array.isArray(options) ? options : [options];
+    await Promise.all(
+      entries.map(async (entry) => {
+        const { data, service, createItemsInDataArraySeparately, multi } = entry;
+        let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter((x) => !!x);
+        if (createItemsInDataArraySeparately) {
+          dataToCreate = dataToCreate.flat();
+        }
+        if (!dataToCreate || dataToCreate.length <= 0) {
+          return context;
+        }
+        if (multi) {
+          await context.app.service(service).create(dataToCreate);
+        } else {
+          await Promise.all(
+            dataToCreate.map(
+              async (item) => context.app.service(service).create(item)
+            )
+          );
+        }
+      })
+    );
     return context;
   };
 }
@@ -792,46 +795,44 @@ const forEach = (actionPerItem, options) => {
   };
 };
 
-function onDelete(service, {
-  keyThere,
-  keyHere = "id",
-  onDelete: onDelete2 = "cascade",
-  blocking = true
-}) {
-  if (!service || !keyThere) {
-    throw "initialize hook 'removeRelated' completely!";
-  }
-  if (!["cascade", "set null"].includes(onDelete2)) {
-    throw "onDelete must be 'cascade' or 'set null'";
-  }
+function onDelete(options) {
   return async (context) => {
     if (shouldSkip("onDelete", context)) {
       return context;
     }
     feathersHooksCommon.checkContext(context, "after", "remove", "onDelete");
     const { items } = getItemsIsArray(context);
-    let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
-    ids = [...new Set(ids)];
-    if (!ids || ids.length <= 0) {
-      return context;
-    }
-    const params = {
-      query: {
-        [keyThere]: {
-          $in: ids
+    const entries = Array.isArray(options) ? options : [options];
+    const promises = [];
+    entries.forEach(
+      async ({ keyHere, keyThere, onDelete: onDelete2, service, blocking }) => {
+        let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
+        ids = [...new Set(ids)];
+        if (!ids || ids.length <= 0) {
+          return context;
         }
-      },
-      paginate: false
-    };
-    let promise;
-    if (onDelete2 === "cascade") {
-      promise = context.app.service(service).remove(null, params);
-    } else if (onDelete2 === "set null") {
-      const data = { [keyThere]: null };
-      promise = context.app.service(service).patch(null, data, params);
-    }
-    if (blocking) {
-      await promise;
+        const params = {
+          query: {
+            [keyThere]: {
+              $in: ids
+            }
+          },
+          paginate: false
+        };
+        let promise = void 0;
+        if (onDelete2 === "cascade") {
+          promise = context.app.service(service).remove(null, params);
+        } else if (onDelete2 === "set null") {
+          const data = { [keyThere]: null };
+          promise = context.app.service(service).patch(null, data, params);
+        }
+        if (blocking) {
+          promises.push(promise);
+        }
+      }
+    );
+    if (promises.length) {
+      await Promise.all(promises);
     }
     return context;
   };

package/dist/index.d.cts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -24,7 +25,7 @@ interface CreateRelatedOptions<S = Record<string, any>> {
 /**
  * hook to create related items
  */
-declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, multi, data, createItemsInDataArraySeparately, }: CreateRelatedOptions<S>): (context: H) => Promise<H>;
+declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<CreateRelatedOptions<S>>): (context: H) => Promise<H>;
 
 type GetItemsIsArrayFrom = "data" | "result" | "automatic";
 type GetItemsIsArrayOptions = {
@@ -34,7 +35,7 @@ interface GetItemsIsArrayResult<T = any> {
     items: T[];
     isArray: boolean;
 }
-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>;
+declare const getItemsIsArray: <T = any, H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
 type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
@@ -48,10 +49,11 @@ type ActionPerItem<T, H, R> = (item: T, options: {
 } & (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>;
+declare const forEach: <H extends HookContext = 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 {
+interface OnDeleteOptions<Path extends string = string> {
+    service: Path;
     keyThere: string;
     keyHere: string;
     onDelete: OnDeleteAction;
@@ -60,7 +62,7 @@ interface OnDeleteOptions {
 /**
  * hook to manipulate related items on delete
  */
-declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(service: keyof S, { keyThere, keyHere, onDelete, blocking, }: OnDeleteOptions): (context: H) => Promise<H>;
+declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<OnDeleteOptions<KeyOf<S>>>): (context: H) => Promise<H>;
 
 /**
  * Parse fields to date or number
@@ -78,6 +80,8 @@ interface RemoveRelatedOptions<S = Record<string, any>> {
 }
 /**
  * hook to remove related items
+ *
+ * @deprecated use 'onDelete' instead
  */
 declare function removeRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, keyThere, keyHere, blocking, }: RemoveRelatedOptions<S>): (context: H) => Promise<H>;
 
@@ -88,7 +92,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>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext = 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;
@@ -102,14 +106,14 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
-declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 /**
  * a hook to move params to query._$client
  * the server only receives 'query' from params. All other params are ignored.
  * So, to use `$populateParams` on the server, we need to move the params to query._$client
  * the server will move them back to params
  */
-declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 
 declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
 declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
@@ -175,7 +179,7 @@ declare function reassembleQuery(query: FilterQueryResult): Query;
  * 2. it uses `service.options.paginate` if it exists
  * 3. it uses `context.params.adapter` if it exists
  */
-declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
+declare const getPaginate: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
 
 /**
  * util to check if a hook is a multi hook:
@@ -186,12 +190,12 @@ declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Applicati
  * - patch: `context.id == null`
  * - remove: `context.id == null`
  */
-declare const isMulti: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isMulti: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to check if a hook is a paginated hook using `getPaginate`
  */
-declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isPaginated: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to mark a hook for skip, has to be used with `shouldSkip`
@@ -236,7 +240,7 @@ declare const setQueryKeySafely: (params: Params, key: string, value: any, opera
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
-declare const setResultEmpty: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const setResultEmpty: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
 
 type ShouldSkipOptions = {
     notSkippable?: boolean;
@@ -244,7 +248,7 @@ type ShouldSkipOptions = {
 /**
  * util to detect if a hook should be skipped
  */
-declare const shouldSkip: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
+declare const shouldSkip: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
 
 declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
 
@@ -253,11 +257,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.d.mts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -24,7 +25,7 @@ interface CreateRelatedOptions<S = Record<string, any>> {
 /**
  * hook to create related items
  */
-declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, multi, data, createItemsInDataArraySeparately, }: CreateRelatedOptions<S>): (context: H) => Promise<H>;
+declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<CreateRelatedOptions<S>>): (context: H) => Promise<H>;
 
 type GetItemsIsArrayFrom = "data" | "result" | "automatic";
 type GetItemsIsArrayOptions = {
@@ -34,7 +35,7 @@ interface GetItemsIsArrayResult<T = any> {
     items: T[];
     isArray: boolean;
 }
-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>;
+declare const getItemsIsArray: <T = any, H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
 type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
@@ -48,10 +49,11 @@ type ActionPerItem<T, H, R> = (item: T, options: {
 } & (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>;
+declare const forEach: <H extends HookContext = 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 {
+interface OnDeleteOptions<Path extends string = string> {
+    service: Path;
     keyThere: string;
     keyHere: string;
     onDelete: OnDeleteAction;
@@ -60,7 +62,7 @@ interface OnDeleteOptions {
 /**
  * hook to manipulate related items on delete
  */
-declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(service: keyof S, { keyThere, keyHere, onDelete, blocking, }: OnDeleteOptions): (context: H) => Promise<H>;
+declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<OnDeleteOptions<KeyOf<S>>>): (context: H) => Promise<H>;
 
 /**
  * Parse fields to date or number
@@ -78,6 +80,8 @@ interface RemoveRelatedOptions<S = Record<string, any>> {
 }
 /**
  * hook to remove related items
+ *
+ * @deprecated use 'onDelete' instead
  */
 declare function removeRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, keyThere, keyHere, blocking, }: RemoveRelatedOptions<S>): (context: H) => Promise<H>;
 
@@ -88,7 +92,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>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext = 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;
@@ -102,14 +106,14 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
-declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 /**
  * a hook to move params to query._$client
  * the server only receives 'query' from params. All other params are ignored.
  * So, to use `$populateParams` on the server, we need to move the params to query._$client
  * the server will move them back to params
  */
-declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 
 declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
 declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
@@ -175,7 +179,7 @@ declare function reassembleQuery(query: FilterQueryResult): Query;
  * 2. it uses `service.options.paginate` if it exists
  * 3. it uses `context.params.adapter` if it exists
  */
-declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
+declare const getPaginate: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
 
 /**
  * util to check if a hook is a multi hook:
@@ -186,12 +190,12 @@ declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Applicati
  * - patch: `context.id == null`
  * - remove: `context.id == null`
  */
-declare const isMulti: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isMulti: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to check if a hook is a paginated hook using `getPaginate`
  */
-declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isPaginated: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to mark a hook for skip, has to be used with `shouldSkip`
@@ -236,7 +240,7 @@ declare const setQueryKeySafely: (params: Params, key: string, value: any, opera
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
-declare const setResultEmpty: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const setResultEmpty: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
 
 type ShouldSkipOptions = {
     notSkippable?: boolean;
@@ -244,7 +248,7 @@ type ShouldSkipOptions = {
 /**
  * util to detect if a hook should be skipped
  */
-declare const shouldSkip: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
+declare const shouldSkip: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
 
 declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
 
@@ -253,11 +257,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.d.ts

@@ -14,6 +14,7 @@ type MaybeArray<T> = T | T[];
 type Promisable<T> = T | Promise<T>;
 type Path = Array<string | number>;
 type ReturnAsyncHook<H extends HookContext$1 = HookContext$1> = (context: H) => Promise<H>;
+type KeyOf<T> = Extract<keyof T, string>;
 
 interface CreateRelatedOptions<S = Record<string, any>> {
     service: keyof S;
@@ -24,7 +25,7 @@ interface CreateRelatedOptions<S = Record<string, any>> {
 /**
  * hook to create related items
  */
-declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, multi, data, createItemsInDataArraySeparately, }: CreateRelatedOptions<S>): (context: H) => Promise<H>;
+declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<CreateRelatedOptions<S>>): (context: H) => Promise<H>;
 
 type GetItemsIsArrayFrom = "data" | "result" | "automatic";
 type GetItemsIsArrayOptions = {
@@ -34,7 +35,7 @@ interface GetItemsIsArrayResult<T = any> {
     items: T[];
     isArray: boolean;
 }
-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>;
+declare const getItemsIsArray: <T = any, H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H, options?: GetItemsIsArrayOptions) => GetItemsIsArrayResult<T>;
 
 type HookForEachOptions<T = any, H = HookContext, R = any> = {
     wait?: "sequential" | "parallel" | false;
@@ -48,10 +49,11 @@ type ActionPerItem<T, H, R> = (item: T, options: {
 } & (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>;
+declare const forEach: <H extends HookContext = 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 {
+interface OnDeleteOptions<Path extends string = string> {
+    service: Path;
     keyThere: string;
     keyHere: string;
     onDelete: OnDeleteAction;
@@ -60,7 +62,7 @@ interface OnDeleteOptions {
 /**
  * hook to manipulate related items on delete
  */
-declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(service: keyof S, { keyThere, keyHere, onDelete, blocking, }: OnDeleteOptions): (context: H) => Promise<H>;
+declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(options: MaybeArray<OnDeleteOptions<KeyOf<S>>>): (context: H) => Promise<H>;
 
 /**
  * Parse fields to date or number
@@ -78,6 +80,8 @@ interface RemoveRelatedOptions<S = Record<string, any>> {
 }
 /**
  * hook to remove related items
+ *
+ * @deprecated use 'onDelete' instead
  */
 declare function removeRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, keyThere, keyHere, blocking, }: RemoveRelatedOptions<S>): (context: H) => Promise<H>;
 
@@ -88,7 +92,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>, T = any>(actionPerItem: (item: T, context: H) => Promisable<any>, _options?: HookRunPerItemOptions) => (context: H) => Promise<H>;
+declare const runPerItem: <H extends HookContext = 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;
@@ -102,14 +106,14 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
-declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 /**
  * a hook to move params to query._$client
  * the server only receives 'query' from params. All other params are ignored.
  * So, to use `$populateParams` on the server, we need to move the params to query._$client
  * the server will move them back to params
  */
-declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext>(context: H) => H;
 
 declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
 declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
@@ -175,7 +179,7 @@ declare function reassembleQuery(query: FilterQueryResult): Query;
  * 2. it uses `service.options.paginate` if it exists
  * 3. it uses `context.params.adapter` if it exists
  */
-declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
+declare const getPaginate: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => PaginationOptions | undefined;
 
 /**
  * util to check if a hook is a multi hook:
@@ -186,12 +190,12 @@ declare const getPaginate: <H extends HookContext<_feathersjs_feathers.Applicati
  * - patch: `context.id == null`
  * - remove: `context.id == null`
  */
-declare const isMulti: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isMulti: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to check if a hook is a paginated hook using `getPaginate`
  */
-declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
+declare const isPaginated: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => boolean;
 
 /**
  * util to mark a hook for skip, has to be used with `shouldSkip`
@@ -236,7 +240,7 @@ declare const setQueryKeySafely: (params: Params, key: string, value: any, opera
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
-declare const setResultEmpty: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+declare const setResultEmpty: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
 
 type ShouldSkipOptions = {
     notSkippable?: boolean;
@@ -244,7 +248,7 @@ type ShouldSkipOptions = {
 /**
  * util to detect if a hook should be skipped
  */
-declare const shouldSkip: <H extends HookContext<_feathersjs_feathers.Application<any, any>, any> = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
+declare const shouldSkip: <H extends HookContext = HookContext<_feathersjs_feathers.Application<any, any>, any>>(hookName: string, context: H, options?: ShouldSkipOptions) => boolean;
 
 declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
 
@@ -253,11 +257,12 @@ declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-type OptimizeBatchPatchOptions = {
-    id?: string;
+type OptimizeBatchPatchOptions<IdKey extends string> = {
+    /** the key of the id property */
+    id?: IdKey;
 };
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
-declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
+declare function optimizeBatchPatch<T extends Record<string, any>, IdKey extends KeyOf<T>, P extends Params, R extends Omit<T, IdKey> = Omit<T, IdKey>>(items: T[], options?: OptimizeBatchPatchOptions<IdKey>): OptimizeBatchPatchResultItem<R, P>[];
 
 declare function flattenQuery(q: Query): any;
 

package/dist/index.mjs

@@ -609,13 +609,18 @@ const validateQueryProperty = (query, operators = []) => {
 
 function optimizeBatchPatch(items, options) {
   const map = [];
-  const id = options?.id ?? "id";
-  for (const [id2, data] of items) {
-    const index = map.findIndex((item) => deepEqual(item.data, data));
+  const idKey = options?.id ?? "id";
+  for (const _data of items) {
+    const data = _data;
+    const id = _data[idKey];
+    delete data[idKey];
+    const index = map.findIndex((item) => {
+      return deepEqual(item.data, data);
+    });
     if (index === -1) {
-      map.push({ ids: [id2], data });
+      map.push({ ids: [id], data });
     } else {
-      map[index].ids.push(id2);
+      map[index].ids.push(id);
     }
   }
   return map.map(({ ids, data }) => {
@@ -624,7 +629,7 @@ function optimizeBatchPatch(items, options) {
       data,
       {
         query: {
-          [id]: { $in: ids }
+          [idKey]: { $in: ids }
         }
       }
     ];
@@ -713,37 +718,35 @@ function checkMulti() {
   };
 }
 
-function createRelated({
-  service,
-  multi = true,
-  data,
-  createItemsInDataArraySeparately = true
-}) {
-  if (!service || !data) {
-    throw "initialize hook 'createRelated' completely!";
-  }
+function createRelated(options) {
   return async (context) => {
     if (shouldSkip("createRelated", context)) {
       return context;
     }
     checkContext(context, "after", void 0, "createRelated");
     const { items } = getItemsIsArray(context);
-    let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter((x) => !!x);
-    if (createItemsInDataArraySeparately) {
-      dataToCreate = dataToCreate.flat();
-    }
-    if (!dataToCreate || dataToCreate.length <= 0) {
-      return context;
-    }
-    if (multi) {
-      await context.app.service(service).create(dataToCreate);
-    } else {
-      await Promise.all(
-        dataToCreate.map(
-          async (item) => context.app.service(service).create(item)
-        )
-      );
-    }
+    const entries = Array.isArray(options) ? options : [options];
+    await Promise.all(
+      entries.map(async (entry) => {
+        const { data, service, createItemsInDataArraySeparately, multi } = entry;
+        let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter((x) => !!x);
+        if (createItemsInDataArraySeparately) {
+          dataToCreate = dataToCreate.flat();
+        }
+        if (!dataToCreate || dataToCreate.length <= 0) {
+          return context;
+        }
+        if (multi) {
+          await context.app.service(service).create(dataToCreate);
+        } else {
+          await Promise.all(
+            dataToCreate.map(
+              async (item) => context.app.service(service).create(item)
+            )
+          );
+        }
+      })
+    );
     return context;
   };
 }
@@ -781,46 +784,44 @@ const forEach = (actionPerItem, options) => {
   };
 };
 
-function onDelete(service, {
-  keyThere,
-  keyHere = "id",
-  onDelete: onDelete2 = "cascade",
-  blocking = true
-}) {
-  if (!service || !keyThere) {
-    throw "initialize hook 'removeRelated' completely!";
-  }
-  if (!["cascade", "set null"].includes(onDelete2)) {
-    throw "onDelete must be 'cascade' or 'set null'";
-  }
+function onDelete(options) {
   return async (context) => {
     if (shouldSkip("onDelete", context)) {
       return context;
     }
     checkContext(context, "after", "remove", "onDelete");
     const { items } = getItemsIsArray(context);
-    let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
-    ids = [...new Set(ids)];
-    if (!ids || ids.length <= 0) {
-      return context;
-    }
-    const params = {
-      query: {
-        [keyThere]: {
-          $in: ids
+    const entries = Array.isArray(options) ? options : [options];
+    const promises = [];
+    entries.forEach(
+      async ({ keyHere, keyThere, onDelete: onDelete2, service, blocking }) => {
+        let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
+        ids = [...new Set(ids)];
+        if (!ids || ids.length <= 0) {
+          return context;
         }
-      },
-      paginate: false
-    };
-    let promise;
-    if (onDelete2 === "cascade") {
-      promise = context.app.service(service).remove(null, params);
-    } else if (onDelete2 === "set null") {
-      const data = { [keyThere]: null };
-      promise = context.app.service(service).patch(null, data, params);
-    }
-    if (blocking) {
-      await promise;
+        const params = {
+          query: {
+            [keyThere]: {
+              $in: ids
+            }
+          },
+          paginate: false
+        };
+        let promise = void 0;
+        if (onDelete2 === "cascade") {
+          promise = context.app.service(service).remove(null, params);
+        } else if (onDelete2 === "set null") {
+          const data = { [keyThere]: null };
+          promise = context.app.service(service).patch(null, data, params);
+        }
+        if (blocking) {
+          promises.push(promise);
+        }
+      }
+    );
+    if (promises.length) {
+      await Promise.all(promises);
     }
     return context;
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "5.2.0",
+  "version": "7.0.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -30,43 +30,43 @@
     "lib/**",
     "dist/**"
   ],
-  "scripts": {
-    "build": "unbuild",
-    "version": "npm run build",
-    "release": "np",
-    "test": "vitest run",
-    "vitest": "vitest",
-    "coverage": "vitest run --coverage",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
-  },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^5.0.13",
-    "@feathersjs/errors": "^5.0.13",
-    "@feathersjs/feathers": "^5.0.13",
+    "@feathersjs/adapter-commons": "^5.0.31",
+    "@feathersjs/errors": "^5.0.31",
+    "@feathersjs/feathers": "^5.0.31",
     "fast-equals": "^5.0.1",
-    "feathers-hooks-common": "^8.1.1",
+    "feathers-hooks-common": "^8.2.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@feathersjs/memory": "^5.0.13",
-    "@types/lodash": "^4.14.202",
-    "@types/node": "^20.10.6",
+    "@feathersjs/memory": "^5.0.31",
+    "@types/lodash": "^4.17.13",
+    "@types/node": "^22.10.1",
     "@typescript-eslint/eslint-plugin": "^6.16.0",
     "@typescript-eslint/parser": "^6.16.0",
-    "@vitest/coverage-v8": "^1.1.0",
+    "@vitest/coverage-v8": "^2.1.8",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-prettier": "^5.1.2",
-    "np": "^9.2.0",
-    "prettier": "^3.1.1",
+    "np": "^10.1.0",
+    "prettier": "^3.4.1",
     "shx": "^0.3.4",
-    "typescript": "^5.3.3",
+    "typescript": "^5.7.2",
     "unbuild": "^2.0.0",
-    "vitest": "^1.1.0"
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "@feathersjs/feathers": "^5.0.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "version": "npm run build",
+    "release": "np",
+    "test": "vitest run",
+    "vitest": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   }
-}
+}

package/src/hooks/createRelated.ts

@@ -1,6 +1,6 @@
 import type { HookContext } from "@feathersjs/feathers";
 import { checkContext } from "feathers-hooks-common";
-import type { Promisable } from "../typesInternal";
+import type { MaybeArray, Promisable } from "../typesInternal";
 import { getItemsIsArray, shouldSkip } from "../utils";
 
 export interface CreateRelatedOptions<S = Record<string, any>> {
@@ -16,15 +16,7 @@ export interface CreateRelatedOptions<S = Record<string, any>> {
 export function createRelated<
   S = Record<string, any>,
   H extends HookContext = HookContext,
->({
-  service,
-  multi = true,
-  data,
-  createItemsInDataArraySeparately = true,
-}: CreateRelatedOptions<S>) {
-  if (!service || !data) {
-    throw "initialize hook 'createRelated' completely!";
-  }
+>(options: MaybeArray<CreateRelatedOptions<S>>) {
   return async (context: H) => {
     if (shouldSkip("createRelated", context)) {
       return context;
@@ -34,27 +26,36 @@ export function createRelated<
 
     const { items } = getItemsIsArray(context);
 
-    let dataToCreate = (
-      await Promise.all(items.map(async (item) => data(item, context)))
-    ).filter((x) => !!x);
-
-    if (createItemsInDataArraySeparately) {
-      dataToCreate = dataToCreate.flat();
-    }
-
-    if (!dataToCreate || dataToCreate.length <= 0) {
-      return context;
-    }
-
-    if (multi) {
-      await context.app.service(service as string).create(dataToCreate);
-    } else {
-      await Promise.all(
-        dataToCreate.map(async (item) =>
-          context.app.service(service as string).create(item),
-        ),
-      );
-    }
+    const entries = Array.isArray(options) ? options : [options];
+
+    await Promise.all(
+      entries.map(async (entry) => {
+        const { data, service, createItemsInDataArraySeparately, multi } =
+          entry;
+
+        let dataToCreate = (
+          await Promise.all(items.map(async (item) => data(item, context)))
+        ).filter((x) => !!x);
+
+        if (createItemsInDataArraySeparately) {
+          dataToCreate = dataToCreate.flat();
+        }
+
+        if (!dataToCreate || dataToCreate.length <= 0) {
+          return context;
+        }
+
+        if (multi) {
+          await context.app.service(service as string).create(dataToCreate);
+        } else {
+          await Promise.all(
+            dataToCreate.map(async (item) =>
+              context.app.service(service as string).create(item),
+            ),
+          );
+        }
+      }),
+    );
 
     return context;
   };

package/src/hooks/onDelete.ts

@@ -1,10 +1,12 @@
 import type { HookContext } from "@feathersjs/feathers";
 import { checkContext } from "feathers-hooks-common";
 import { getItemsIsArray, shouldSkip } from "../utils";
+import type { KeyOf, MaybeArray } from "../typesInternal";
 
 export type OnDeleteAction = "cascade" | "set null";
 
-export interface OnDeleteOptions {
+export interface OnDeleteOptions<Path extends string = string> {
+  service: Path;
   keyThere: string;
   keyHere: string;
   onDelete: OnDeleteAction;
@@ -17,22 +19,7 @@ export interface OnDeleteOptions {
 export function onDelete<
   S = Record<string, any>,
   H extends HookContext = HookContext,
->(
-  service: keyof S,
-  {
-    keyThere,
-    keyHere = "id",
-    onDelete = "cascade",
-    blocking = true,
-  }: OnDeleteOptions,
-) {
-  if (!service || !keyThere) {
-    throw "initialize hook 'removeRelated' completely!";
-  }
-  if (!["cascade", "set null"].includes(onDelete)) {
-    throw "onDelete must be 'cascade' or 'set null'";
-  }
-
+>(options: MaybeArray<OnDeleteOptions<KeyOf<S>>>) {
   return async (context: H) => {
     if (shouldSkip("onDelete", context)) {
       return context;
@@ -42,35 +29,47 @@ export function onDelete<
 
     const { items } = getItemsIsArray(context);
 
-    let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
-    ids = [...new Set(ids)];
+    const entries = Array.isArray(options) ? options : [options];
 
-    if (!ids || ids.length <= 0) {
-      return context;
-    }
+    const promises: Promise<any>[] = [];
 
-    const params = {
-      query: {
-        [keyThere]: {
-          $in: ids,
-        },
-      },
-      paginate: false,
-    };
+    entries.forEach(
+      async ({ keyHere, keyThere, onDelete, service, blocking }) => {
+        let ids = items.map((x) => x[keyHere]).filter((x) => !!x);
+        ids = [...new Set(ids)];
 
-    let promise;
+        if (!ids || ids.length <= 0) {
+          return context;
+        }
 
-    if (onDelete === "cascade") {
-      promise = context.app.service(service as string).remove(null, params);
-    } else if (onDelete === "set null") {
-      const data = { [keyThere]: null };
-      promise = context.app
-        .service(service as string)
-        .patch(null, data, params);
-    }
+        const params = {
+          query: {
+            [keyThere]: {
+              $in: ids,
+            },
+          },
+          paginate: false,
+        };
+
+        let promise: Promise<any> | undefined = undefined;
+
+        if (onDelete === "cascade") {
+          promise = context.app.service(service as string).remove(null, params);
+        } else if (onDelete === "set null") {
+          const data = { [keyThere]: null };
+          promise = context.app
+            .service(service as string)
+            .patch(null, data, params);
+        }
+
+        if (blocking) {
+          promises.push(promise);
+        }
+      },
+    );
 
-    if (blocking) {
-      await promise;
+    if (promises.length) {
+      await Promise.all(promises);
     }
 
     return context;

package/src/hooks/removeRelated.ts

@@ -11,6 +11,8 @@ export interface RemoveRelatedOptions<S = Record<string, any>> {
 
 /**
  * hook to remove related items
+ *
+ * @deprecated use 'onDelete' instead
  */
 export function removeRelated<
   S = Record<string, any>,

package/src/typesInternal.ts

@@ -22,3 +22,5 @@ export type ReturnSyncHook<H extends HookContext = HookContext> = (
 export type ReturnAsyncHook<H extends HookContext = HookContext> = (
   context: H,
 ) => Promise<H>;
+
+export type KeyOf<T> = Extract<keyof T, string>;

package/src/utils/optimizeBatchPatch.ts

@@ -1,8 +1,10 @@
 import type { Id, Params } from "@feathersjs/feathers";
 import { deepEqual } from "fast-equals";
+import type { KeyOf } from "../typesInternal";
 
-export type OptimizeBatchPatchOptions = {
-  id?: string;
+export type OptimizeBatchPatchOptions<IdKey extends string> = {
+  /** the key of the id property */
+  id?: IdKey;
 };
 
 export type OptimizeBatchPatchResultItem<
@@ -11,18 +13,26 @@ export type OptimizeBatchPatchResultItem<
 > = [Id, T, P | undefined];
 
 export function optimizeBatchPatch<
-  T extends Record<string, unknown>,
+  T extends Record<string, any>,
+  IdKey extends KeyOf<T>,
   P extends Params,
+  R extends Omit<T, IdKey> = Omit<T, IdKey>,
 >(
-  items: Map<Id, T>,
-  options?: OptimizeBatchPatchOptions,
-): OptimizeBatchPatchResultItem<T, P>[] {
-  const map: { ids: Id[]; data: T }[] = [];
+  items: T[],
+  options?: OptimizeBatchPatchOptions<IdKey>,
+): OptimizeBatchPatchResultItem<R, P>[] {
+  const map: { ids: Id[]; data: R }[] = [];
 
-  const id = options?.id ?? "id";
+  const idKey = options?.id ?? "id";
 
-  for (const [id, data] of items) {
-    const index = map.findIndex((item) => deepEqual(item.data, data));
+  for (const _data of items) {
+    const data = _data as unknown as R;
+    const id = _data[idKey];
+    delete data[idKey as any];
+
+    const index = map.findIndex((item) => {
+      return deepEqual(item.data, data);
+    });
 
     if (index === -1) {
       map.push({ ids: [id], data });
@@ -33,34 +43,56 @@ export function optimizeBatchPatch<
 
   return map.map(({ ids, data }) => {
     return ids.length === 1
-      ? ([ids[0], data, undefined] as OptimizeBatchPatchResultItem<T, P>)
+      ? ([ids[0], data, undefined] as OptimizeBatchPatchResultItem<R, P>)
       : ([
           null,
           data,
           {
             query: {
-              [id]: { $in: ids },
+              [idKey]: { $in: ids },
             },
           },
-        ] as OptimizeBatchPatchResultItem<T, P>);
+        ] as OptimizeBatchPatchResultItem<R, P>);
   });
 }
 
 if (import.meta.vitest) {
   const { it, expect } = import.meta.vitest;
   it("optimizeBatchPatch", () => {
-    const items = new Map<Id, Record<string, unknown>>([
-      ["1", { name: "John" }],
-      ["2", { name: "Jane" }],
-      ["3", { name: "John" }],
-      ["4", { name: "Jane" }],
-      [5, { name: "Jack" }],
-    ]);
-
-    expect(optimizeBatchPatch(items)).toEqual([
+    expect(
+      optimizeBatchPatch(
+        [
+          { id: "1", name: "John" },
+          { id: "2", name: "Jane" },
+          { id: "3", name: "John" },
+          { id: "4", name: "Jane" },
+          { id: 5, name: "Jack" },
+        ],
+        { id: "id" },
+      ),
+    ).toEqual([
       [null, { name: "John" }, { query: { id: { $in: ["1", "3"] } } }],
       [null, { name: "Jane" }, { query: { id: { $in: ["2", "4"] } } }],
       [5, { name: "Jack" }, undefined],
     ]);
   });
+
+  it("optimizeBatchPatch with _id", () => {
+    expect(
+      optimizeBatchPatch(
+        [
+          { _id: "1", name: "John" },
+          { _id: "2", name: "Jane" },
+          { _id: "3", name: "John" },
+          { _id: "4", name: "Jane" },
+          { _id: 5, name: "Jack" },
+        ],
+        { id: "_id" },
+      ),
+    ).toEqual([
+      [null, { name: "John" }, { query: { _id: { $in: ["1", "3"] } } }],
+      [null, { name: "Jane" }, { query: { _id: { $in: ["2", "4"] } } }],
+      [5, { name: "Jack" }, undefined],
+    ]);
+  });
 }