feathers-utils 3.0.2 → 3.1.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _feathersjs_feathers from '@feathersjs/feathers';
-import { HookContext, Application, Id, Query } from '@feathersjs/feathers';
+import { HookContext, Application, Id, Query, Params } from '@feathersjs/feathers';
 import { HookContext as HookContext$1, Application as Application$1 } from '@feathersjs/feathers/lib';
 import { PropertyPath, DebouncedFunc } from 'lodash';
 import { AdapterBase, FilterQueryOptions as FilterQueryOptions$1, PaginationOptions } from '@feathersjs/adapter-commons';
@@ -211,6 +211,11 @@ declare const validateQueryProperty: (query: any, operators?: string[]) => Query
 
 declare const toJSON: (context: HookContext) => HookContext<_feathersjs_feathers.Application<any, any>, any>;
 
+type SetQueryKeySafelyOptions = {
+    mutate?: boolean;
+};
+declare const setQueryKeySafely: (params: Params, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => Params<_feathersjs_feathers.Query>;
+
 declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
 
 declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions$1) => any; };
@@ -261,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 { ActionOnEmptyIntersect, CreateRelatedOptions, DebouncedFunctionApp, DebouncedService, DebouncedStore, DebouncedStoreOptions, FilterQueryOptions, FirstLast, GetItemsIsArrayOptions, GetItemsIsArrayResult, GetService, Handle, HookForEachOptions, HookRunPerItemOptions, HookSetDataOptions, InferCreateData, InferCreateDataFromPath, InferCreateDataSingle, InferCreateDataSingleFromPath, InferCreateResult, InferCreateResultFromPath, InferCreateResultSingle, InferCreateResultSingleFromPath, InferDataFromPath, InferFindResult, InferFindResultFromPath, InferGetResult, InferGetResultFromPath, InferPatchData, InferPatchDataFromPath, InferPatchResult, InferPatchResultFromPath, InferRemoveResult, InferRemoveResultFromPath, InferResultFromPath, InferUpdateData, InferUpdateDataFromPath, InferUpdateResult, InferUpdateResultFromPath, InitDebounceMixinOptions, MergeQueryOptions, OnDeleteAction, OnDeleteOptions, Predicate, PredicateWithContext, PushSetOptions, RemoveRelatedOptions, ShouldSkipOptions, checkMulti, createRelated, debounceMixin, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, parseFields, pushSet, removeRelated, runPerItem, setData, 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 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

@@ -440,9 +440,7 @@ function mergeQuery(target, source, _options) {
 }
 
 const getItemsIsArray = (context, options) => {
-  const {
-    from = "automatic"
-  } = options || {};
+  const { from = "automatic" } = options || {};
   let itemOrItems;
   if (from === "automatic") {
     itemOrItems = context.type === "before" ? context.data : context.result;
@@ -568,9 +566,9 @@ const shouldSkip = (hookName, context, options) => {
   return false;
 };
 
-const isPlainObject = (value) => _.isObject(value) && value.constructor === {}.constructor;
+const isPlainObject$1 = (value) => _.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
-  if (!isPlainObject(query)) {
+  if (!isPlainObject$1(query)) {
     return query;
   }
   for (const key of Object.keys(query)) {
@@ -578,7 +576,7 @@ const validateQueryProperty = (query, operators = []) => {
       throw new BadRequest(`Invalid query parameter ${key}`, query);
     }
     const value = query[key];
-    if (isPlainObject(value)) {
+    if (isPlainObject$1(value)) {
       query[key] = validateQueryProperty(value, operators);
     }
   }
@@ -594,6 +592,46 @@ 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 || {};
+  if (!mutate) {
+    params = structuredClone(params);
+  }
+  if (!params.query) {
+    params.query = {};
+  }
+  if (!(key in params.query)) {
+    if (operator === "$eq") {
+      params.query[key] = value;
+    } else {
+      params.query[key] = {
+        [operator]: value
+      };
+    }
+    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 {
+    (_a = params.query).$and ?? (_a.$and = []);
+    params.query.$and.push(
+      operator === "$eq" ? { [key]: value } : {
+        [key]: {
+          [operator]: value
+        }
+      }
+    );
+  }
+  return params;
+};
+
 function checkMulti() {
   return (context) => {
     if (shouldSkip("checkMulti", context)) {
@@ -807,7 +845,8 @@ function setData(from, to, _options) {
       return context;
     }
     const { items } = getItemsIsArray(context);
-    if (!_has(context, from)) {
+    const contextJson = toJSON(context);
+    if (!_has(contextJson, from)) {
       if (!context.params?.provider || options.allowUndefined === true) {
         return context;
       }
@@ -816,7 +855,7 @@ function setData(from, to, _options) {
       }
       throw new Forbidden(`Expected field ${from.toString()} not available`);
     }
-    const val = _get(toJSON(context), from);
+    const val = _get(contextJson, from);
     items.forEach((item) => {
       let overwrite;
       if (typeof options.overwrite === "function") {
@@ -833,6 +872,12 @@ function setData(from, to, _options) {
   };
 }
 
+var __defProp = Object.defineProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __publicField = (obj, key, value) => {
+  __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+  return value;
+};
 const makeDefaultOptions = () => {
   return {
     leading: false,
@@ -843,6 +888,12 @@ const makeDefaultOptions = () => {
 };
 class DebouncedStore {
   constructor(app, options) {
+    __publicField(this, "_app");
+    __publicField(this, "_options");
+    __publicField(this, "_isRunningById");
+    __publicField(this, "_queueById");
+    //_waitingById: Record<string, WaitingObject>;
+    __publicField(this, "add");
     this._app = app;
     this._options = Object.assign(makeDefaultOptions(), options);
     this._queueById = {};
@@ -942,4 +993,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, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "3.0.2",
+  "version": "3.1.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "https://github.com/fratzinger/feathers-utils"
   },
   "engines": {
-    "node": ">= 16"
+    "node": ">= 18"
   },
   "homepage": "https://github.com/fratzinger/feathers-utils",
   "license": "MIT",
@@ -40,37 +40,33 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^5.0.5",
-    "@feathersjs/commons": "^5.0.5",
-    "@feathersjs/errors": "^5.0.5",
+    "@feathersjs/adapter-commons": "^5.0.10",
+    "@feathersjs/commons": "^5.0.10",
+    "@feathersjs/errors": "^5.0.10",
     "fast-equals": "^5.0.1",
-    "feathers-hooks-common": "^7.0.3",
+    "feathers-hooks-common": "^8.1.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@feathersjs/feathers": "^5.0.5",
-    "@feathersjs/memory": "^5.0.5",
-    "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/lodash": "^4.14.195",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^20.2.5",
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
-    "@vitest/coverage-c8": "^0.31.4",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.41.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-import-resolver-typescript": "^3.5.5",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
+    "@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",
+    "@vitest/coverage-v8": "^0.34.6",
+    "eslint": "^8.51.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-security": "^1.7.1",
-    "np": "^8.0.2",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.8",
+    "np": "^8.0.4",
+    "prettier": "^3.0.3",
     "shx": "^0.3.4",
-    "typescript": "^5.1.3",
-    "unbuild": "^1.2.1",
-    "vitest": "^0.31.4"
+    "typescript": "^5.2.2",
+    "unbuild": "^2.0.0",
+    "vitest": "^0.34.6"
   },
   "peerDependencies": {
     "@feathersjs/feathers": "^5.0.0"

package/src/filters/array.ts

@@ -6,7 +6,7 @@ const filterQueryArray =
   (arr: any, { operators }: FilterQueryOptions) => {
     if (arr && !Array.isArray(arr)) {
       throw new Error(
-        `Invalid query parameter '${key}'. It has to be an array`
+        `Invalid query parameter '${key}'. It has to be an array`,
       );
     }
 

package/src/filters/object.ts

@@ -7,7 +7,7 @@ const filterQueryObject =
   (obj: any, { operators }: FilterQueryOptions) => {
     if (obj && !_isObject(obj)) {
       throw new Error(
-        `Invalid query parameter: '${key}'. It has to be an object`
+        `Invalid query parameter: '${key}'. It has to be an object`,
       );
     }
 

package/src/hooks/createRelated.ts

@@ -15,7 +15,7 @@ export interface CreateRelatedOptions<S = Record<string, any>> {
  */
 export function createRelated<
   S = Record<string, any>,
-  H extends HookContext = HookContext
+  H extends HookContext = HookContext,
 >({
   service,
   multi = true,
@@ -51,8 +51,8 @@ export function createRelated<
     } else {
       await Promise.all(
         dataToCreate.map(async (item) =>
-          context.app.service(service as string).create(item)
-        )
+          context.app.service(service as string).create(item),
+        ),
       );
     }
 

package/src/hooks/forEach.ts

@@ -6,25 +6,27 @@ import type { GetItemsIsArrayOptions } from "../utils/getItemsIsArray";
 import { getItemsIsArray } from "../utils/getItemsIsArray";
 
 export interface HookForEachOptions {
-  wait?: "sequential" | "parallel" | false
-  items?: GetItemsIsArrayOptions["from"]
+  wait?: "sequential" | "parallel" | false;
+  items?: GetItemsIsArrayOptions["from"];
 }
 
 export const forEach = (
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  actionPerItem: (item: any, context: HookContext) => Promisable<any>, 
-  _options?: HookForEachOptions
+  actionPerItem: (item: any, context: HookContext) => Promisable<any>,
+  _options?: HookForEachOptions,
 ): ReturnAsyncHook => {
   const options: Required<HookForEachOptions> = {
     wait: "parallel",
     items: "automatic",
-    ..._options
+    ..._options,
   };
 
   return async (context: HookContext): Promise<HookContext> => {
-    if (shouldSkip("runForItems", context)) { return context; }
+    if (shouldSkip("runForItems", context)) {
+      return context;
+    }
 
-    const { items } =  getItemsIsArray(context, { from: options.items });
+    const { items } = getItemsIsArray(context, { from: options.items });
 
     const promises: Promise<any>[] = [];
 
@@ -44,4 +46,4 @@ export const forEach = (
 
     return context;
   };
-};
+};

package/src/hooks/index.ts

@@ -6,4 +6,3 @@ export * from "./parseFields";
 export * from "./removeRelated";
 export * from "./runPerItem";
 export * from "./setData";
-

package/src/hooks/onDelete.ts

@@ -16,7 +16,7 @@ export interface OnDeleteOptions {
  */
 export function onDelete<
   S = Record<string, any>,
-  H extends HookContext = HookContext
+  H extends HookContext = HookContext,
 >(
   service: keyof S,
   {
@@ -24,7 +24,7 @@ export function onDelete<
     keyHere = "id",
     onDelete = "cascade",
     blocking = true,
-  }: OnDeleteOptions
+  }: OnDeleteOptions,
 ) {
   if (!service || !keyThere) {
     throw "initialize hook 'removeRelated' completely!";

package/src/hooks/parseFields.ts

@@ -5,23 +5,25 @@ import { getItemsIsArray } from "../utils/getItemsIsArray";
  * Parse fields to date or number
  * skips undefined fields
  */
-export const parseFields = (type: "date" | "number", options: { fields: string[] }) => (context: HookContext) => {
-  const { items } = getItemsIsArray(context);
-  
-  items.forEach(item => {
-    options.fields.forEach(field => {
-      // ignore undefined fields
-      if (!(field in item)) {
-        return;
-      }
-  
-      if (type === "date") {
-        item[field] = new Date(item[field]);
-      } else if (type === "number") {
-        item[field] = Number(item[field]);
-      }
+export const parseFields =
+  (type: "date" | "number", options: { fields: string[] }) =>
+  (context: HookContext) => {
+    const { items } = getItemsIsArray(context);
+
+    items.forEach((item) => {
+      options.fields.forEach((field) => {
+        // ignore undefined fields
+        if (!(field in item)) {
+          return;
+        }
+
+        if (type === "date") {
+          item[field] = new Date(item[field]);
+        } else if (type === "number") {
+          item[field] = Number(item[field]);
+        }
+      });
     });
-  });
 
-  return context;
-};
+    return context;
+  };

package/src/hooks/removeRelated.ts

@@ -14,7 +14,7 @@ export interface RemoveRelatedOptions<S = Record<string, any>> {
  */
 export function removeRelated<
   S = Record<string, any>,
-  H extends HookContext = HookContext
+  H extends HookContext = HookContext,
 >({
   service,
   keyThere,

package/src/hooks/runPerItem.ts

@@ -8,7 +8,7 @@ export interface HookRunPerItemOptions {
 }
 
 const makeOptions = (
-  options?: HookRunPerItemOptions
+  options?: HookRunPerItemOptions,
 ): Required<HookRunPerItemOptions> => {
   options = options || {};
   return {
@@ -24,7 +24,7 @@ const makeOptions = (
 export const runPerItem = <H extends HookContext = HookContext>(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   actionPerItem: (item: any, context: H) => Promisable<any>,
-  _options?: HookRunPerItemOptions
+  _options?: HookRunPerItemOptions,
 ) => {
   const options = makeOptions(_options);
   return async (context: H) => {

package/src/hooks/setData.ts

@@ -26,7 +26,7 @@ const defaultOptions: Required<HookSetDataOptions> = {
 export function setData<H extends HookContext = HookContext>(
   from: PropertyPath,
   to: PropertyPath,
-  _options?: HookSetDataOptions
+  _options?: HookSetDataOptions,
 ) {
   const options: Required<HookSetDataOptions> = {
     ...defaultOptions,
@@ -39,7 +39,9 @@ export function setData<H extends HookContext = HookContext>(
 
     const { items } = getItemsIsArray(context);
 
-    if (!_has(context, from)) {
+    const contextJson = toJSON(context);
+
+    if (!_has(contextJson, from)) {
       if (!context.params?.provider || options.allowUndefined === true) {
         return context;
       }
@@ -54,7 +56,7 @@ export function setData<H extends HookContext = HookContext>(
       throw new Forbidden(`Expected field ${from.toString()} not available`);
     }
 
-    const val = _get(toJSON(context), from);
+    const val = _get(contextJson, from);
 
     items.forEach((item: Record<string, unknown>) => {
       let overwrite: boolean;

package/src/mixins/debounce-mixin/DebouncedStore.ts

@@ -56,7 +56,7 @@ export class DebouncedStore {
   private debounceById(
     func: (id: Id, action: DebouncedFunctionApp) => Promise<void>,
     wait: number,
-    options?: Partial<DebouncedStoreOptions>
+    options?: Partial<DebouncedStoreOptions>,
   ) {
     return (id: Id, action: (app?: Application) => void | Promise<void>) => {
       if (typeof this._queueById[id] === "function") {
@@ -68,7 +68,7 @@ export class DebouncedStore {
           this.unbounced(id, action);
         },
         wait,
-        { ...options, leading: false }
+        { ...options, leading: false },
       ); // leading required for return promise
       return this._queueById[id](id, action);
     };

package/src/mixins/debounce-mixin/debounceMixin.ts

@@ -3,13 +3,13 @@ import { DebouncedStore, makeDefaultOptions } from "./DebouncedStore";
 import type { DebouncedStoreOptions, InitDebounceMixinOptions } from "./types";
 
 export function debounceMixin(
-  options?: Partial<InitDebounceMixinOptions>
+  options?: Partial<InitDebounceMixinOptions>,
 ): (app: Application) => void {
   return (app: Application): void => {
     options = options || {};
     const defaultOptions = Object.assign(
       makeDefaultOptions(),
-      options?.default
+      options?.default,
     );
 
     app.mixins.push((service: any, path) => {
@@ -18,7 +18,7 @@ export function debounceMixin(
       // if service already has registered something on `debouncedStore`
       if (service.debouncedStore) {
         console.warn(
-          `[feathers-utils] service: '${path}' already has a property 'debouncedStore'. Mixin will skip creating a new debouncedStore`
+          `[feathers-utils] service: '${path}' already has a property 'debouncedStore'. Mixin will skip creating a new debouncedStore`,
         );
         return;
       }
@@ -26,7 +26,7 @@ export function debounceMixin(
       const serviceOptions = Object.assign({}, defaultOptions, options?.[path]);
       service.debouncedStore = new DebouncedStore(
         app,
-        serviceOptions as DebouncedStoreOptions
+        serviceOptions as DebouncedStoreOptions,
       );
     });
   };

package/src/types.ts

@@ -5,5 +5,5 @@ export type Predicate<T = any> = (item: T) => boolean;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type PredicateWithContext<T = any> = (
   item: T,
-  context: HookContext
+  context: HookContext,
 ) => boolean;

package/src/typesInternal.ts

@@ -1,13 +1,19 @@
 // here are types that are not meant to be exported!
 // just for internal use of this package
 
-import { HookContext } from "@feathersjs/feathers/lib";
+import type { HookContext } from "@feathersjs/feathers/lib";
 
 export type MaybeArray<T> = T | T[];
 export type Promisable<T> = T | Promise<T>;
 export type Path = Array<string | number>;
 
 export type HookType = "before" | "after" | "error";
-export type ServiceMethodName = "find" | "get" | "create" | "update" | "patch" | "remove";
-export type ReturnSyncHook = (context: HookContext) => HookContext
-export type ReturnAsyncHook = (context: HookContext) => Promise<HookContext>
+export type ServiceMethodName =
+  | "find"
+  | "get"
+  | "create"
+  | "update"
+  | "patch"
+  | "remove";
+export type ReturnSyncHook = (context: HookContext) => HookContext;
+export type ReturnAsyncHook = (context: HookContext) => Promise<HookContext>;