feathers-utils 3.1.0 → 3.1.2

package/README.md

@@ -23,7 +23,9 @@ npm i feathers-utils
 
 - `checkMulti`: throws if the request is **multi** data, but the services `allowsMulti(method)` returns `false`
 - `createRelated`: simply create related items from a hook.
+- `forEach`
 - `onDelete`: simply remove/set null related items from a hook.
+- `parseFields`
 - `removeRelated`: simple remove related items from a hook. Basically `cascade` at feathers level.
 - `runPerItem`: run a function for every item. Meant for `multi:true`.
 - `setData`: map properties from `context` to `data`. Something like `userId: context.params.user.id`
@@ -43,5 +45,6 @@ npm i feathers-utils
 - `mergeQuery`: deeply merges queries
 - `mergeArrays`: merges arrays with intersection options
 - `pushSet`: if existing array: *push*, else *set*
+- `setQueryKeySafely`
 - `setResultEmpty`
 - `shouldSkip`: checks `context.params.skipHooks` for `'all' | '${hookName}' | '${type}:${hookName}'` - also see `markHookForSkip`

package/dist/index.cjs

@@ -69,6 +69,7 @@ function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyInte
 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);
@@ -580,9 +581,9 @@ const shouldSkip = (hookName, context, options) => {
   return false;
 };
 
-const isPlainObject$1 = (value) => commons._.isObject(value) && value.constructor === {}.constructor;
+const isPlainObject = (value) => commons._.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
-  if (!isPlainObject$1(query)) {
+  if (!isPlainObject(query)) {
     return query;
   }
   for (const key of Object.keys(query)) {
@@ -590,7 +591,7 @@ const validateQueryProperty = (query, operators = []) => {
       throw new errors.BadRequest(`Invalid query parameter ${key}`, query);
     }
     const value = query[key];
-    if (isPlainObject$1(value)) {
+    if (isPlainObject(value)) {
       query[key] = validateQueryProperty(value, operators);
     }
   }
@@ -606,7 +607,6 @@ const toJSON = (context) => {
   return context;
 };
 
-const isPlainObject = (value) => value && [void 0, Object].includes(value.constructor);
 const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
   var _a;
   const { mutate = false } = options || {};
@@ -626,12 +626,7 @@ const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
     }
     return params;
   }
-  console.log(
-    "params.query[key]",
-    params.query[key],
-    isPlainObject(params.query[key])
-  );
-  if (isPlainObject(params.query[key]) && !(operator in params.query[key])) {
+  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
     params.query[key][operator] = value;
   } else {
     (_a = params.query).$and ?? (_a.$and = []);

package/dist/index.d.cts

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

package/dist/index.d.mts

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

package/dist/index.d.ts

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

package/dist/index.mjs

@@ -55,6 +55,7 @@ function mergeArrays(targetArr, sourceArr, handle, prependKey, actionOnEmptyInte
 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);
@@ -566,9 +567,9 @@ const shouldSkip = (hookName, context, options) => {
   return false;
 };
 
-const isPlainObject$1 = (value) => _.isObject(value) && value.constructor === {}.constructor;
+const isPlainObject = (value) => _.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
-  if (!isPlainObject$1(query)) {
+  if (!isPlainObject(query)) {
     return query;
   }
   for (const key of Object.keys(query)) {
@@ -576,7 +577,7 @@ const validateQueryProperty = (query, operators = []) => {
       throw new BadRequest(`Invalid query parameter ${key}`, query);
     }
     const value = query[key];
-    if (isPlainObject$1(value)) {
+    if (isPlainObject(value)) {
       query[key] = validateQueryProperty(value, operators);
     }
   }
@@ -592,7 +593,6 @@ const toJSON = (context) => {
   return context;
 };
 
-const isPlainObject = (value) => value && [void 0, Object].includes(value.constructor);
 const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
   var _a;
   const { mutate = false } = options || {};
@@ -612,12 +612,7 @@ const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
     }
     return params;
   }
-  console.log(
-    "params.query[key]",
-    params.query[key],
-    isPlainObject(params.query[key])
-  );
-  if (isPlainObject(params.query[key]) && !(operator in params.query[key])) {
+  if (isPlainObject$1(params.query[key]) && !(operator in params.query[key])) {
     params.query[key][operator] = value;
   } else {
     (_a = params.query).$and ?? (_a.$and = []);

package/package.json

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

package/src/hooks/forEach.ts

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

package/src/hooks/runPerItem.ts

@@ -21,9 +21,9 @@ const makeOptions = (
  * hook to run a hook for each item in the context
  * uses `context.result` if it is existent. otherwise uses context.data
  */
-export const runPerItem = <H extends HookContext = HookContext>(
+export const runPerItem = <H extends HookContext = HookContext, T = any>(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  actionPerItem: (item: any, context: H) => Promisable<any>,
+  actionPerItem: (item: T, context: H) => Promisable<any>,
   _options?: HookRunPerItemOptions,
 ) => {
   const options = makeOptions(_options);
@@ -34,7 +34,7 @@ export const runPerItem = <H extends HookContext = HookContext>(
 
     const { items } = getItemsIsArray(context);
 
-    const promises = items.map(async (item: unknown) => {
+    const promises = items.map(async (item: T) => {
       await actionPerItem(item, context);
     });
 

package/src/typesInternal.ts

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

package/src/utility-types/index.ts

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

package/src/utils/internal.utils.ts

@@ -4,3 +4,6 @@ export const hasOwnProperty = (
 ): boolean => {
   return keys.some((x) => Object.prototype.hasOwnProperty.call(obj, x));
 };
+
+export const isPlainObject = (value) =>
+  value && [undefined, Object].includes(value.constructor);

package/src/utils/setQueryKeySafely.ts

@@ -1,19 +1,17 @@
+import { isPlainObject } from "./internal.utils";
 import type { Params } from "@feathersjs/feathers";
 
-type SetQueryKeySafelyOptions = {
+export type SetQueryKeySafelyOptions = {
   mutate?: boolean;
 };
 
-const isPlainObject = (value) =>
-  value && [undefined, Object].includes(value.constructor);
-
-export const setQueryKeySafely = (
-  params: Params,
+export const setQueryKeySafely = <P extends Params = Params>(
+  params: P,
   key: string,
   value: any,
   operator = "$eq",
   options?: SetQueryKeySafelyOptions,
-) => {
+): P => {
   const { mutate = false } = options || {};
 
   // TODO: mutate params
@@ -38,12 +36,6 @@ export const setQueryKeySafely = (
     return params;
   }
 
-  console.log(
-    "params.query[key]",
-    params.query[key],
-    isPlainObject(params.query[key]),
-  );
-
   if (isPlainObject(params.query[key]) && !(operator in params.query[key])) {
     params.query[key][operator] = value;
   } else {