feathers-utils 4.0.0 → 4.2.0

package/README.md

@@ -36,6 +36,7 @@ npm i feathers-utils
 
 ### Utils
 
+- `defineHooks`
 - `filterQuery`
 - `getItemsIsArray(context)`: returns `{ items: any[], isArray: boolean }`
 - `getPaginate`

package/dist/index.cjs

@@ -1,14 +1,14 @@
 'use strict';
 
 const errors = require('@feathersjs/errors');
+const _isEqual = require('lodash/isEqual.js');
+const _get = require('lodash/get.js');
+const _set = require('lodash/set.js');
 const _merge = require('lodash/merge.js');
 const _isEmpty = require('lodash/isEmpty.js');
-const _get = require('lodash/get.js');
 const _has = require('lodash/has.js');
-const _set = require('lodash/set.js');
 const _uniqWith = require('lodash/uniqWith.js');
 const fastEquals = require('fast-equals');
-const _isEqual = require('lodash/isEqual.js');
 const commons = require('@feathersjs/commons');
 const feathersHooksCommon = require('feathers-hooks-common');
 const _debounce = require('lodash/debounce.js');
@@ -16,16 +16,130 @@ const _isObject = require('lodash/isObject.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
 
+const _isEqual__default = /*#__PURE__*/_interopDefaultCompat(_isEqual);
+const _get__default = /*#__PURE__*/_interopDefaultCompat(_get);
+const _set__default = /*#__PURE__*/_interopDefaultCompat(_set);
 const _merge__default = /*#__PURE__*/_interopDefaultCompat(_merge);
 const _isEmpty__default = /*#__PURE__*/_interopDefaultCompat(_isEmpty);
-const _get__default = /*#__PURE__*/_interopDefaultCompat(_get);
 const _has__default = /*#__PURE__*/_interopDefaultCompat(_has);
-const _set__default = /*#__PURE__*/_interopDefaultCompat(_set);
 const _uniqWith__default = /*#__PURE__*/_interopDefaultCompat(_uniqWith);
-const _isEqual__default = /*#__PURE__*/_interopDefaultCompat(_isEqual);
 const _debounce__default = /*#__PURE__*/_interopDefaultCompat(_debounce);
 const _isObject__default = /*#__PURE__*/_interopDefaultCompat(_isObject);
 
+function defineHooks(hooks) {
+  return hooks;
+}
+
+function filterQuery(providedQuery) {
+  providedQuery ?? (providedQuery = {});
+  const { $select, $limit, $skip, $sort, ...query } = providedQuery;
+  const result = { query };
+  if ("$select" in providedQuery) {
+    result.$select = $select;
+  }
+  if ("$limit" in providedQuery) {
+    result.$limit = $limit;
+  }
+  if ("$skip" in providedQuery) {
+    result.$skip = $skip;
+  }
+  if ("$sort" in providedQuery) {
+    result.$sort = $sort;
+  }
+  return result;
+}
+
+const getItemsIsArray = (context, options) => {
+  const { from = "automatic" } = options || {};
+  let itemOrItems;
+  if (from === "automatic") {
+    itemOrItems = context.type === "before" ? context.data : context.result;
+  } else if (from === "data") {
+    itemOrItems = context.data;
+  } else if (from === "result") {
+    itemOrItems = context.result;
+  }
+  if ((from === "automatic" || from === "result") && context.type === "after") {
+    itemOrItems = itemOrItems && context.method === "find" ? itemOrItems.data || itemOrItems : itemOrItems;
+  }
+  const isArray = Array.isArray(itemOrItems);
+  return {
+    items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
+    isArray
+  };
+};
+
+const hasOwnProperty = (obj, ...keys) => {
+  return keys.some((x) => Object.prototype.hasOwnProperty.call(obj, x));
+};
+const isPlainObject$1 = (value) => value && [void 0, Object].includes(value.constructor);
+
+const getPaginate = (context) => {
+  if (hasOwnProperty(context.params, "paginate")) {
+    return context.params.paginate || void 0;
+  }
+  if (context.params.paginate === false) {
+    return void 0;
+  }
+  let options = context.service?.options || {};
+  options = {
+    ...options,
+    ...context.params.adapter
+  };
+  return options.paginate || void 0;
+};
+
+const isMulti = (context) => {
+  const { method } = context;
+  if (method === "find") {
+    return true;
+  } else if (["patch", "remove"].includes(method)) {
+    return context.id == null;
+  } else if (method === "create") {
+    const items = context.type === "before" ? context.data : context.result;
+    return Array.isArray(items);
+  } else if (["get", "update"].includes(method)) {
+    return false;
+  }
+  return false;
+};
+
+const isPaginated = (context) => {
+  if (context.params.paginate === false || context.method !== "find") {
+    return false;
+  }
+  const paginate = getPaginate(context);
+  return !!paginate;
+};
+
+const pushSet = (obj, path, val, options) => {
+  options = options || {};
+  let arr = _get__default(obj, path);
+  if (!arr || !Array.isArray(arr)) {
+    arr = [val];
+    _set__default(obj, path, arr);
+    return arr;
+  } else {
+    if (options.unique && arr.some((x) => _isEqual__default(x, val))) {
+      return arr;
+    }
+    arr.push(val);
+    return arr;
+  }
+};
+
+function markHookForSkip(hookName, type, context) {
+  context = context || {};
+  const params = context.params || {};
+  const types = Array.isArray(type) ? type : [type];
+  types.forEach((t) => {
+    const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
+    pushSet(params, ["skipHooks"], combinedName, { unique: true });
+  });
+  context.params = params;
+  return context;
+}
+
 function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyIntersect) {
   if (!sourceArr && !targetArr) {
     return;
@@ -65,11 +179,6 @@ function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyInte
   return void 0;
 }
 
-const hasOwnProperty = (obj, ...keys) => {
-  return keys.some((x) => Object.prototype.hasOwnProperty.call(obj, x));
-};
-const isPlainObject$1 = (value) => value && [void 0, Object].includes(value.constructor);
-
 function handleArray(target, source, key, options) {
   const targetVal = _get__default(target, key);
   const sourceVal = _get__default(source, key);
@@ -352,25 +461,6 @@ function areQueriesOverlapping(target, source) {
   return false;
 }
 
-function filterQuery(providedQuery) {
-  providedQuery ?? (providedQuery = {});
-  const { $select, $limit, $skip, $sort, ...query } = providedQuery;
-  const result = { query };
-  if ("$select" in providedQuery) {
-    result.$select = $select;
-  }
-  if ("$limit" in providedQuery) {
-    result.$limit = $limit;
-  }
-  if ("$skip" in providedQuery) {
-    result.$skip = $skip;
-  }
-  if ("$sort" in providedQuery) {
-    result.$sort = $sort;
-  }
-  return result;
-}
-
 function mergeQuery(target, source, _options) {
   const options = makeDefaultOptions$1(_options);
   const { query: targetQuery, ...targetFilters } = filterQuery(target);
@@ -414,92 +504,40 @@ function mergeQuery(target, source, _options) {
   };
 }
 
-const getItemsIsArray = (context, options) => {
-  const { from = "automatic" } = options || {};
-  let itemOrItems;
-  if (from === "automatic") {
-    itemOrItems = context.type === "before" ? context.data : context.result;
-  } else if (from === "data") {
-    itemOrItems = context.data;
-  } else if (from === "result") {
-    itemOrItems = context.result;
-  }
-  if ((from === "automatic" || from === "result") && context.type === "after") {
-    itemOrItems = itemOrItems && context.method === "find" ? itemOrItems.data || itemOrItems : itemOrItems;
-  }
-  const isArray = Array.isArray(itemOrItems);
-  return {
-    items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
-    isArray
-  };
-};
-
-const getPaginate = (context) => {
-  if (hasOwnProperty(context.params, "paginate")) {
-    return context.params.paginate || void 0;
-  }
-  if (context.params.paginate === false) {
-    return void 0;
+const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
+  var _a;
+  const { mutate = false } = options || {};
+  if (!mutate) {
+    params = structuredClone(params);
   }
-  let options = context.service?.options || {};
-  options = {
-    ...options,
-    ...context.params.adapter
-  };
-  return options.paginate || void 0;
-};
-
-const isMulti = (context) => {
-  const { method } = context;
-  if (method === "find") {
-    return true;
-  } else if (["patch", "remove"].includes(method)) {
-    return context.id == null;
-  } else if (method === "create") {
-    const items = context.type === "before" ? context.data : context.result;
-    return Array.isArray(items);
-  } else if (["get", "update"].includes(method)) {
-    return false;
+  if (!params.query) {
+    params.query = {};
   }
-  return false;
-};
-
-const isPaginated = (context) => {
-  if (context.params.paginate === false || context.method !== "find") {
-    return false;
+  if (!(key in params.query)) {
+    if (operator === "$eq") {
+      params.query[key] = value;
+    } else {
+      params.query[key] = {
+        [operator]: value
+      };
+    }
+    return params;
   }
-  const paginate = getPaginate(context);
-  return !!paginate;
-};
-
-const pushSet = (obj, path, val, options) => {
-  options = options || {};
-  let arr = _get__default(obj, path);
-  if (!arr || !Array.isArray(arr)) {
-    arr = [val];
-    _set__default(obj, path, arr);
-    return arr;
+  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
+    params.query[key][operator] = value;
   } else {
-    if (options.unique && arr.some((x) => _isEqual__default(x, val))) {
-      return arr;
-    }
-    arr.push(val);
-    return arr;
+    (_a = params.query).$and ?? (_a.$and = []);
+    params.query.$and.push(
+      operator === "$eq" ? { [key]: value } : {
+        [key]: {
+          [operator]: value
+        }
+      }
+    );
   }
+  return params;
 };
 
-function markHookForSkip(hookName, type, context) {
-  context = context || {};
-  const params = context.params || {};
-  const types = Array.isArray(type) ? type : [type];
-  types.forEach((t) => {
-    const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
-    pushSet(params, ["skipHooks"], combinedName, { unique: true });
-  });
-  context.params = params;
-  return context;
-}
-
 const setResultEmpty = (context) => {
   if (context.result) {
     return context;
@@ -543,6 +581,13 @@ const shouldSkip = (hookName, context, options) => {
   return false;
 };
 
+const toJSON = (context) => {
+  if (context.toJSON) {
+    return context.toJSON();
+  }
+  return context;
+};
+
 const isPlainObject = (value) => commons._.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
   if (!isPlainObject(query)) {
@@ -562,46 +607,29 @@ const validateQueryProperty = (query, operators = []) => {
   };
 };
 
-const toJSON = (context) => {
-  if (context.toJSON) {
-    return context.toJSON();
-  }
-  return context;
-};
-
-const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
-  var _a;
-  const { mutate = false } = options || {};
-  if (!mutate) {
-    params = structuredClone(params);
-  }
-  if (!params.query) {
-    params.query = {};
-  }
-  if (!(key in params.query)) {
-    if (operator === "$eq") {
-      params.query[key] = value;
+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));
+    if (index === -1) {
+      map.push({ ids: [id2], data });
     } else {
-      params.query[key] = {
-        [operator]: value
-      };
+      map[index].ids.push(id2);
     }
-    return params;
   }
-  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
-    params.query[key][operator] = value;
-  } else {
-    (_a = params.query).$and ?? (_a.$and = []);
-    params.query.$and.push(
-      operator === "$eq" ? { [key]: value } : {
-        [key]: {
-          [operator]: value
+  return map.map(({ ids, data }) => {
+    return ids.length === 1 ? [ids[0], data, void 0] : [
+      null,
+      data,
+      {
+        query: {
+          [id]: { $in: ids }
         }
       }
-    );
-  }
-  return params;
-};
+    ];
+  });
+}
 
 function checkMulti() {
   return (context) => {
@@ -968,6 +996,7 @@ exports.DebouncedStore = DebouncedStore;
 exports.checkMulti = checkMulti;
 exports.createRelated = createRelated;
 exports.debounceMixin = debounceMixin;
+exports.defineHooks = defineHooks;
 exports.filterArray = filterArray;
 exports.filterObject = filterObject;
 exports.filterQuery = filterQuery;
@@ -981,6 +1010,7 @@ exports.markHookForSkip = markHookForSkip;
 exports.mergeArrays = mergeArrays;
 exports.mergeQuery = mergeQuery;
 exports.onDelete = onDelete;
+exports.optimizeBatchPatch = optimizeBatchPatch;
 exports.parseFields = parseFields;
 exports.pushSet = pushSet;
 exports.removeRelated = removeRelated;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
+import { HookContext, Application, Id, HookOptions, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
 import { PaginationOptions, FilterQueryOptions } from '@feathersjs/adapter-commons';
@@ -125,28 +125,14 @@ declare class DebouncedStore {
 
 declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application$1) => void;
 
-type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-type FirstLast = "first" | "last";
-type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-interface MergeQueryOptions {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-
-declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
-
-/**
- * Merges two queries into one.
- * @param target Query to be merged into
- * @param source Query to be merged from
- * @param _options
- * @returns Query
- */
-declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+declare function defineHooks<A extends Application = Application, S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+}, Options = HookOptions<A, S>>(hooks: Options): Options;
 
 type FilterQueryResult<Q extends Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
@@ -192,6 +178,29 @@ declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Applicati
  */
 declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H;
 
+type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+type FirstLast = "first" | "last";
+type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+interface MergeQueryOptions {
+    defaultHandle: Handle;
+    actionOnEmptyIntersect: ActionOnEmptyIntersect;
+    useLogicalConjunction: boolean;
+    handle?: {
+        [key: string]: Handle;
+    };
+}
+
+declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
+
+/**
+ * Merges two queries into one.
+ * @param target Query to be merged into
+ * @param source Query to be merged from
+ * @param _options
+ * @returns Query
+ */
+declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+
 interface PushSetOptions {
     unique?: boolean;
 }
@@ -200,6 +209,11 @@ interface PushSetOptions {
  */
 declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
@@ -213,17 +227,18 @@ type ShouldSkipOptions = {
  */
 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 toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
+
 /**
  * util to validate a query for operators
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
-
-type SetQueryKeySafelyOptions = {
-    mutate?: boolean;
+type OptimizeBatchPatchOptions = {
+    id?: string;
 };
-declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+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 const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
@@ -275,4 +290,4 @@ type InferRemoveResultFromPath<App extends Application, Path extends string, IdO
 type InferDataFromPath<App extends Application, Path extends string, Method extends "create" | "update" | "patch"> = Method extends "create" ? InferCreateDataFromPath<App, Path> : Method extends "update" ? InferUpdateDataFromPath<App, Path> : Method extends "patch" ? InferPatchDataFromPath<App, Path> : never;
 type InferResultFromPath<App extends Application, Path extends string, Method extends "get" | "find" | "create" | "update" | "patch" | "remove"> = 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;
 
-export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type OptimizeBatchPatchOptions, type OptimizeBatchPatchResultItem, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
+import { HookContext, Application, Id, HookOptions, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
 import { PaginationOptions, FilterQueryOptions } from '@feathersjs/adapter-commons';
@@ -125,28 +125,14 @@ declare class DebouncedStore {
 
 declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application$1) => void;
 
-type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-type FirstLast = "first" | "last";
-type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-interface MergeQueryOptions {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-
-declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
-
-/**
- * Merges two queries into one.
- * @param target Query to be merged into
- * @param source Query to be merged from
- * @param _options
- * @returns Query
- */
-declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+declare function defineHooks<A extends Application = Application, S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+}, Options = HookOptions<A, S>>(hooks: Options): Options;
 
 type FilterQueryResult<Q extends Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
@@ -192,6 +178,29 @@ declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Applicati
  */
 declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H;
 
+type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+type FirstLast = "first" | "last";
+type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+interface MergeQueryOptions {
+    defaultHandle: Handle;
+    actionOnEmptyIntersect: ActionOnEmptyIntersect;
+    useLogicalConjunction: boolean;
+    handle?: {
+        [key: string]: Handle;
+    };
+}
+
+declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
+
+/**
+ * Merges two queries into one.
+ * @param target Query to be merged into
+ * @param source Query to be merged from
+ * @param _options
+ * @returns Query
+ */
+declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+
 interface PushSetOptions {
     unique?: boolean;
 }
@@ -200,6 +209,11 @@ interface PushSetOptions {
  */
 declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
@@ -213,17 +227,18 @@ type ShouldSkipOptions = {
  */
 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 toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
+
 /**
  * util to validate a query for operators
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
-
-type SetQueryKeySafelyOptions = {
-    mutate?: boolean;
+type OptimizeBatchPatchOptions = {
+    id?: string;
 };
-declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+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 const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
@@ -275,4 +290,4 @@ type InferRemoveResultFromPath<App extends Application, Path extends string, IdO
 type InferDataFromPath<App extends Application, Path extends string, Method extends "create" | "update" | "patch"> = Method extends "create" ? InferCreateDataFromPath<App, Path> : Method extends "update" ? InferUpdateDataFromPath<App, Path> : Method extends "patch" ? InferPatchDataFromPath<App, Path> : never;
 type InferResultFromPath<App extends Application, Path extends string, Method extends "get" | "find" | "create" | "update" | "patch" | "remove"> = 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;
 
-export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type OptimizeBatchPatchOptions, type OptimizeBatchPatchResultItem, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
+import { HookContext, Application, Id, HookOptions, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
 import { PaginationOptions, FilterQueryOptions } from '@feathersjs/adapter-commons';
@@ -125,28 +125,14 @@ declare class DebouncedStore {
 
 declare function debounceMixin(options?: Partial<InitDebounceMixinOptions>): (app: Application$1) => void;
 
-type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
-type FirstLast = "first" | "last";
-type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
-interface MergeQueryOptions {
-    defaultHandle: Handle;
-    actionOnEmptyIntersect: ActionOnEmptyIntersect;
-    useLogicalConjunction: boolean;
-    handle?: {
-        [key: string]: Handle;
-    };
-}
-
-declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
-
-/**
- * Merges two queries into one.
- * @param target Query to be merged into
- * @param source Query to be merged from
- * @param _options
- * @returns Query
- */
-declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+declare function defineHooks<A extends Application = Application, S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+}, Options = HookOptions<A, S>>(hooks: Options): Options;
 
 type FilterQueryResult<Q extends Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
@@ -192,6 +178,29 @@ declare const isPaginated: <H extends HookContext<_feathersjs_feathers.Applicati
  */
 declare function markHookForSkip<H extends HookContext = HookContext>(hookName: string, type: "all" | MaybeArray<HookType>, context?: H): H;
 
+type Handle = "target" | "source" | "combine" | "intersect" | "intersectOrFull";
+type FirstLast = "first" | "last";
+type ActionOnEmptyIntersect = (target: unknown, source: unknown, prependKey: Path) => void;
+interface MergeQueryOptions {
+    defaultHandle: Handle;
+    actionOnEmptyIntersect: ActionOnEmptyIntersect;
+    useLogicalConjunction: boolean;
+    handle?: {
+        [key: string]: Handle;
+    };
+}
+
+declare function mergeArrays<T>(targetArr: T[] | undefined, sourceArr: T[] | undefined, handle: Handle, prependKey?: Path, actionOnEmptyIntersect?: ActionOnEmptyIntersect): T[] | undefined;
+
+/**
+ * Merges two queries into one.
+ * @param target Query to be merged into
+ * @param source Query to be merged from
+ * @param _options
+ * @returns Query
+ */
+declare function mergeQuery(target: Query, source: Query, _options?: Partial<MergeQueryOptions>): Query;
+
 interface PushSetOptions {
     unique?: boolean;
 }
@@ -200,6 +209,11 @@ interface PushSetOptions {
  */
 declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
  */
@@ -213,17 +227,18 @@ type ShouldSkipOptions = {
  */
 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 toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
+
 /**
  * util to validate a query for operators
  */
 declare const validateQueryProperty: (query: any, operators?: string[]) => Query;
 
-declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
-
-type SetQueryKeySafelyOptions = {
-    mutate?: boolean;
+type OptimizeBatchPatchOptions = {
+    id?: string;
 };
-declare const setQueryKeySafely: <P extends Params<_feathersjs_feathers.Query> = Params<_feathersjs_feathers.Query>>(params: P, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => P;
+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 const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
@@ -275,4 +290,4 @@ type InferRemoveResultFromPath<App extends Application, Path extends string, IdO
 type InferDataFromPath<App extends Application, Path extends string, Method extends "create" | "update" | "patch"> = Method extends "create" ? InferCreateDataFromPath<App, Path> : Method extends "update" ? InferUpdateDataFromPath<App, Path> : Method extends "patch" ? InferPatchDataFromPath<App, Path> : never;
 type InferResultFromPath<App extends Application, Path extends string, Method extends "get" | "find" | "create" | "update" | "patch" | "remove"> = 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;
 
-export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, type FirstLast, type GetItemsIsArrayFrom, type GetItemsIsArrayOptions, type GetItemsIsArrayResult, type GetService, type Handle, type HookForEachOptions, type HookRunPerItemOptions, type HookSetDataOptions, type InferCreateData, type InferCreateDataFromPath, type InferCreateDataSingle, type InferCreateDataSingleFromPath, type InferCreateResult, type InferCreateResultFromPath, type InferCreateResultSingle, type InferCreateResultSingleFromPath, type InferDataFromPath, type InferFindResult, type InferFindResultFromPath, type InferGetResult, type InferGetResultFromPath, type InferPatchData, type InferPatchDataFromPath, type InferPatchResult, type InferPatchResultFromPath, type InferRemoveResult, type InferRemoveResultFromPath, type InferResultFromPath, type InferUpdateData, type InferUpdateDataFromPath, type InferUpdateResult, type InferUpdateResultFromPath, type InitDebounceMixinOptions, type MergeQueryOptions, type OnDeleteAction, type OnDeleteOptions, type OptimizeBatchPatchOptions, type OptimizeBatchPatchResultItem, type Predicate, type PredicateWithContext, type PushSetOptions, type RemoveRelatedOptions, type SetQueryKeySafelyOptions, type ShouldSkipOptions, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.mjs

@@ -1,17 +1,131 @@
 import { Forbidden, GeneralError, BadRequest, MethodNotAllowed } from '@feathersjs/errors';
+import _isEqual from 'lodash/isEqual.js';
+import _get from 'lodash/get.js';
+import _set from 'lodash/set.js';
 import _merge from 'lodash/merge.js';
 import _isEmpty from 'lodash/isEmpty.js';
-import _get from 'lodash/get.js';
 import _has from 'lodash/has.js';
-import _set from 'lodash/set.js';
 import _uniqWith from 'lodash/uniqWith.js';
 import { deepEqual } from 'fast-equals';
-import _isEqual from 'lodash/isEqual.js';
 import { _ } from '@feathersjs/commons';
 import { checkContext } from 'feathers-hooks-common';
 import _debounce from 'lodash/debounce.js';
 import _isObject from 'lodash/isObject.js';
 
+function defineHooks(hooks) {
+  return hooks;
+}
+
+function filterQuery(providedQuery) {
+  providedQuery ?? (providedQuery = {});
+  const { $select, $limit, $skip, $sort, ...query } = providedQuery;
+  const result = { query };
+  if ("$select" in providedQuery) {
+    result.$select = $select;
+  }
+  if ("$limit" in providedQuery) {
+    result.$limit = $limit;
+  }
+  if ("$skip" in providedQuery) {
+    result.$skip = $skip;
+  }
+  if ("$sort" in providedQuery) {
+    result.$sort = $sort;
+  }
+  return result;
+}
+
+const getItemsIsArray = (context, options) => {
+  const { from = "automatic" } = options || {};
+  let itemOrItems;
+  if (from === "automatic") {
+    itemOrItems = context.type === "before" ? context.data : context.result;
+  } else if (from === "data") {
+    itemOrItems = context.data;
+  } else if (from === "result") {
+    itemOrItems = context.result;
+  }
+  if ((from === "automatic" || from === "result") && context.type === "after") {
+    itemOrItems = itemOrItems && context.method === "find" ? itemOrItems.data || itemOrItems : itemOrItems;
+  }
+  const isArray = Array.isArray(itemOrItems);
+  return {
+    items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
+    isArray
+  };
+};
+
+const hasOwnProperty = (obj, ...keys) => {
+  return keys.some((x) => Object.prototype.hasOwnProperty.call(obj, x));
+};
+const isPlainObject$1 = (value) => value && [void 0, Object].includes(value.constructor);
+
+const getPaginate = (context) => {
+  if (hasOwnProperty(context.params, "paginate")) {
+    return context.params.paginate || void 0;
+  }
+  if (context.params.paginate === false) {
+    return void 0;
+  }
+  let options = context.service?.options || {};
+  options = {
+    ...options,
+    ...context.params.adapter
+  };
+  return options.paginate || void 0;
+};
+
+const isMulti = (context) => {
+  const { method } = context;
+  if (method === "find") {
+    return true;
+  } else if (["patch", "remove"].includes(method)) {
+    return context.id == null;
+  } else if (method === "create") {
+    const items = context.type === "before" ? context.data : context.result;
+    return Array.isArray(items);
+  } else if (["get", "update"].includes(method)) {
+    return false;
+  }
+  return false;
+};
+
+const isPaginated = (context) => {
+  if (context.params.paginate === false || context.method !== "find") {
+    return false;
+  }
+  const paginate = getPaginate(context);
+  return !!paginate;
+};
+
+const pushSet = (obj, path, val, options) => {
+  options = options || {};
+  let arr = _get(obj, path);
+  if (!arr || !Array.isArray(arr)) {
+    arr = [val];
+    _set(obj, path, arr);
+    return arr;
+  } else {
+    if (options.unique && arr.some((x) => _isEqual(x, val))) {
+      return arr;
+    }
+    arr.push(val);
+    return arr;
+  }
+};
+
+function markHookForSkip(hookName, type, context) {
+  context = context || {};
+  const params = context.params || {};
+  const types = Array.isArray(type) ? type : [type];
+  types.forEach((t) => {
+    const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
+    pushSet(params, ["skipHooks"], combinedName, { unique: true });
+  });
+  context.params = params;
+  return context;
+}
+
 function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyIntersect) {
   if (!sourceArr && !targetArr) {
     return;
@@ -51,11 +165,6 @@ function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyInte
   return void 0;
 }
 
-const hasOwnProperty = (obj, ...keys) => {
-  return keys.some((x) => Object.prototype.hasOwnProperty.call(obj, x));
-};
-const isPlainObject$1 = (value) => value && [void 0, Object].includes(value.constructor);
-
 function handleArray(target, source, key, options) {
   const targetVal = _get(target, key);
   const sourceVal = _get(source, key);
@@ -338,25 +447,6 @@ function areQueriesOverlapping(target, source) {
   return false;
 }
 
-function filterQuery(providedQuery) {
-  providedQuery ?? (providedQuery = {});
-  const { $select, $limit, $skip, $sort, ...query } = providedQuery;
-  const result = { query };
-  if ("$select" in providedQuery) {
-    result.$select = $select;
-  }
-  if ("$limit" in providedQuery) {
-    result.$limit = $limit;
-  }
-  if ("$skip" in providedQuery) {
-    result.$skip = $skip;
-  }
-  if ("$sort" in providedQuery) {
-    result.$sort = $sort;
-  }
-  return result;
-}
-
 function mergeQuery(target, source, _options) {
   const options = makeDefaultOptions$1(_options);
   const { query: targetQuery, ...targetFilters } = filterQuery(target);
@@ -400,92 +490,40 @@ function mergeQuery(target, source, _options) {
   };
 }
 
-const getItemsIsArray = (context, options) => {
-  const { from = "automatic" } = options || {};
-  let itemOrItems;
-  if (from === "automatic") {
-    itemOrItems = context.type === "before" ? context.data : context.result;
-  } else if (from === "data") {
-    itemOrItems = context.data;
-  } else if (from === "result") {
-    itemOrItems = context.result;
-  }
-  if ((from === "automatic" || from === "result") && context.type === "after") {
-    itemOrItems = itemOrItems && context.method === "find" ? itemOrItems.data || itemOrItems : itemOrItems;
-  }
-  const isArray = Array.isArray(itemOrItems);
-  return {
-    items: isArray ? itemOrItems : itemOrItems != null ? [itemOrItems] : [],
-    isArray
-  };
-};
-
-const getPaginate = (context) => {
-  if (hasOwnProperty(context.params, "paginate")) {
-    return context.params.paginate || void 0;
-  }
-  if (context.params.paginate === false) {
-    return void 0;
+const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
+  var _a;
+  const { mutate = false } = options || {};
+  if (!mutate) {
+    params = structuredClone(params);
   }
-  let options = context.service?.options || {};
-  options = {
-    ...options,
-    ...context.params.adapter
-  };
-  return options.paginate || void 0;
-};
-
-const isMulti = (context) => {
-  const { method } = context;
-  if (method === "find") {
-    return true;
-  } else if (["patch", "remove"].includes(method)) {
-    return context.id == null;
-  } else if (method === "create") {
-    const items = context.type === "before" ? context.data : context.result;
-    return Array.isArray(items);
-  } else if (["get", "update"].includes(method)) {
-    return false;
+  if (!params.query) {
+    params.query = {};
   }
-  return false;
-};
-
-const isPaginated = (context) => {
-  if (context.params.paginate === false || context.method !== "find") {
-    return false;
+  if (!(key in params.query)) {
+    if (operator === "$eq") {
+      params.query[key] = value;
+    } else {
+      params.query[key] = {
+        [operator]: value
+      };
+    }
+    return params;
   }
-  const paginate = getPaginate(context);
-  return !!paginate;
-};
-
-const pushSet = (obj, path, val, options) => {
-  options = options || {};
-  let arr = _get(obj, path);
-  if (!arr || !Array.isArray(arr)) {
-    arr = [val];
-    _set(obj, path, arr);
-    return arr;
+  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
+    params.query[key][operator] = value;
   } else {
-    if (options.unique && arr.some((x) => _isEqual(x, val))) {
-      return arr;
-    }
-    arr.push(val);
-    return arr;
+    (_a = params.query).$and ?? (_a.$and = []);
+    params.query.$and.push(
+      operator === "$eq" ? { [key]: value } : {
+        [key]: {
+          [operator]: value
+        }
+      }
+    );
   }
+  return params;
 };
 
-function markHookForSkip(hookName, type, context) {
-  context = context || {};
-  const params = context.params || {};
-  const types = Array.isArray(type) ? type : [type];
-  types.forEach((t) => {
-    const combinedName = t === "all" ? hookName : `${type}:${hookName}`;
-    pushSet(params, ["skipHooks"], combinedName, { unique: true });
-  });
-  context.params = params;
-  return context;
-}
-
 const setResultEmpty = (context) => {
   if (context.result) {
     return context;
@@ -529,6 +567,13 @@ const shouldSkip = (hookName, context, options) => {
   return false;
 };
 
+const toJSON = (context) => {
+  if (context.toJSON) {
+    return context.toJSON();
+  }
+  return context;
+};
+
 const isPlainObject = (value) => _.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
   if (!isPlainObject(query)) {
@@ -548,46 +593,29 @@ const validateQueryProperty = (query, operators = []) => {
   };
 };
 
-const toJSON = (context) => {
-  if (context.toJSON) {
-    return context.toJSON();
-  }
-  return context;
-};
-
-const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
-  var _a;
-  const { mutate = false } = options || {};
-  if (!mutate) {
-    params = structuredClone(params);
-  }
-  if (!params.query) {
-    params.query = {};
-  }
-  if (!(key in params.query)) {
-    if (operator === "$eq") {
-      params.query[key] = value;
+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));
+    if (index === -1) {
+      map.push({ ids: [id2], data });
     } else {
-      params.query[key] = {
-        [operator]: value
-      };
+      map[index].ids.push(id2);
     }
-    return params;
   }
-  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
-    params.query[key][operator] = value;
-  } else {
-    (_a = params.query).$and ?? (_a.$and = []);
-    params.query.$and.push(
-      operator === "$eq" ? { [key]: value } : {
-        [key]: {
-          [operator]: value
+  return map.map(({ ids, data }) => {
+    return ids.length === 1 ? [ids[0], data, void 0] : [
+      null,
+      data,
+      {
+        query: {
+          [id]: { $in: ids }
         }
       }
-    );
-  }
-  return params;
-};
+    ];
+  });
+}
 
 function checkMulti() {
   return (context) => {
@@ -950,4 +978,4 @@ const filterObject = (...keys) => {
   return result;
 };
 
-export { DebouncedStore, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { DebouncedStore, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "4.0.0",
+  "version": "4.2.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -40,6 +40,7 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
+    "@feathersjs/feathers": "^5.0.11",
     "@feathersjs/adapter-commons": "^5.0.11",
     "@feathersjs/commons": "^5.0.11",
     "@feathersjs/errors": "^5.0.11",
@@ -48,7 +49,6 @@
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@feathersjs/feathers": "^5.0.11",
     "@feathersjs/memory": "^5.0.11",
     "@types/lodash": "^4.14.201",
     "@types/node": "^20.9.0",

package/src/utils/defineHooks.ts

@@ -0,0 +1,16 @@
+import type { Application, HookOptions } from "@feathersjs/feathers";
+
+export function defineHooks<
+  A extends Application = Application,
+  S = {
+    find: any;
+    get: any;
+    create: any;
+    update: any;
+    patch: any;
+    remove: any;
+  },
+  Options = HookOptions<A, S>,
+>(hooks: Options): Options {
+  return hooks;
+}

package/src/utils/index.ts

@@ -1,13 +1,15 @@
-export * from "./mergeQuery";
+export * from "./defineHooks";
 export * from "./filterQuery";
 export * from "./getItemsIsArray";
 export * from "./getPaginate";
 export * from "./isMulti";
 export * from "./isPaginated";
 export * from "./markHookForSkip";
+export * from "./mergeQuery";
 export * from "./pushSet";
+export * from "./setQueryKeySafely";
 export * from "./setResultEmpty";
 export * from "./shouldSkip";
-export * from "./validateQueryProperty";
 export * from "./toJSON";
-export * from "./setQueryKeySafely";
+export * from "./validateQueryProperty";
+export * from "./optimizeBatchPatch";

package/src/utils/optimizeBatchPatch.ts

@@ -0,0 +1,66 @@
+import type { Id, Params } from "@feathersjs/feathers";
+import { deepEqual } from "fast-equals";
+
+export type OptimizeBatchPatchOptions = {
+  id?: string;
+};
+
+export type OptimizeBatchPatchResultItem<
+  T = Record<string, unknown>,
+  P = Params,
+> = [Id, T, P | undefined];
+
+export function optimizeBatchPatch<
+  T extends Record<string, unknown>,
+  P extends Params,
+>(
+  items: Map<Id, T>,
+  options?: OptimizeBatchPatchOptions,
+): OptimizeBatchPatchResultItem<T, P>[] {
+  const map: { ids: Id[]; data: T }[] = [];
+
+  const id = options?.id ?? "id";
+
+  for (const [id, data] of items) {
+    const index = map.findIndex((item) => deepEqual(item.data, data));
+
+    if (index === -1) {
+      map.push({ ids: [id], data });
+    } else {
+      map[index].ids.push(id);
+    }
+  }
+
+  return map.map(({ ids, data }) => {
+    return ids.length === 1
+      ? ([ids[0], data, undefined] as OptimizeBatchPatchResultItem<T, P>)
+      : ([
+          null,
+          data,
+          {
+            query: {
+              [id]: { $in: ids },
+            },
+          },
+        ] as OptimizeBatchPatchResultItem<T, 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([
+      [null, { name: "John" }, { query: { id: { $in: ["1", "3"] } } }],
+      [null, { name: "Jane" }, { query: { id: { $in: ["2", "4"] } } }],
+      [5, { name: "Jack" }, undefined],
+    ]);
+  });
+}