feathers-utils 3.1.0 → 3.1.1

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

@@ -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

@@ -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

@@ -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.1",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {

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 {