feathers-utils 5.0.2 → 5.2.0

package/README.md

@@ -25,6 +25,8 @@ npm i feathers-utils
 - `createRelated`: simply create related items from a hook.
 - `forEach`
 - `onDelete`: simply remove/set null related items from a hook.
+- `paramsForServer`
+- `paramsFromClient`
 - `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`.
@@ -38,6 +40,8 @@ npm i feathers-utils
 
 - `defineHooks`
 - `filterQuery`
+- `flattenQuery`
+- `deflattenQuery`
 - `getItemsIsArray(context)`: returns `{ items: any[], isArray: boolean }`
 - `getPaginate`
 - `isMulti(context) => Boolean`: returns true, if `find`, `create/patch/remove`: multi

package/dist/index.cjs

@@ -1,30 +1,23 @@
 'use strict';
 
 const errors = require('@feathersjs/errors');
-const _isEqual = require('lodash/isEqual.js');
+const fastEquals = require('fast-equals');
 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 _has = require('lodash/has.js');
 const _uniqWith = require('lodash/uniqWith.js');
-const fastEquals = require('fast-equals');
-const commons = require('@feathersjs/commons');
 const feathersHooksCommon = require('feathers-hooks-common');
 const _debounce = require('lodash/debounce.js');
-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 _has__default = /*#__PURE__*/_interopDefaultCompat(_has);
 const _uniqWith__default = /*#__PURE__*/_interopDefaultCompat(_uniqWith);
 const _debounce__default = /*#__PURE__*/_interopDefaultCompat(_debounce);
-const _isObject__default = /*#__PURE__*/_interopDefaultCompat(_isObject);
 
 function defineHooks(hooks) {
   return hooks;
@@ -48,6 +41,23 @@ function filterQuery(providedQuery) {
   }
   return result;
 }
+function reassembleQuery(query) {
+  const { $select, $limit, $skip, $sort, query: rest } = query;
+  const result = rest;
+  if ($select !== void 0) {
+    result.$select = $select;
+  }
+  if ($limit !== void 0) {
+    result.$limit = $limit;
+  }
+  if ($skip !== void 0) {
+    result.$skip = $skip;
+  }
+  if ($sort !== void 0) {
+    result.$sort = $sort;
+  }
+  return result;
+}
 
 const getItemsIsArray = (context, options) => {
   const { from = "automatic" } = options || {};
@@ -72,7 +82,9 @@ const getItemsIsArray = (context, options) => {
 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 isObject = (item) => !!item && typeof item === "object" && !Array.isArray(item);
+const isPlainObject = (value) => isObject(value) && value.constructor === {}.constructor;
+const isEmpty = (obj) => [Object, Array].includes((obj || {}).constructor) && !Object.keys(obj || {}).length;
 
 const getPaginate = (context) => {
   if (hasOwnProperty(context.params, "paginate")) {
@@ -120,7 +132,7 @@ const pushSet = (obj, path, val, options) => {
     _set__default(obj, path, arr);
     return arr;
   } else {
-    if (options.unique && arr.some((x) => _isEqual__default(x, val))) {
+    if (options.unique && arr.some((x) => fastEquals.deepEqual(x, val))) {
       return arr;
     }
     arr.push(val);
@@ -403,7 +415,7 @@ function cleanOr(target) {
   if (!target || !Array.isArray(target) || target.length <= 0) {
     return target;
   }
-  if (target.some((x) => _isEmpty__default(x))) {
+  if (target.some((x) => isEmpty(x))) {
     return void 0;
   } else {
     return arrayWithoutDuplicates(target);
@@ -413,10 +425,10 @@ function cleanAnd(target) {
   if (!target || !Array.isArray(target) || target.length <= 0) {
     return target;
   }
-  if (target.every((x) => _isEmpty__default(x))) {
+  if (target.every((x) => isEmpty(x))) {
     return void 0;
   } else {
-    target = target.filter((x) => !_isEmpty__default(x));
+    target = target.filter((x) => !isEmpty(x));
     return arrayWithoutDuplicates(target);
   }
 }
@@ -482,7 +494,7 @@ function mergeQuery(target, source, _options) {
       ...sourceQuery
     };
   }
-  if (options.useLogicalConjunction && (options.defaultHandle === "combine" || options.defaultHandle === "intersect") && !_isEmpty__default(targetQuery)) {
+  if (options.useLogicalConjunction && (options.defaultHandle === "combine" || options.defaultHandle === "intersect") && !isEmpty(targetQuery)) {
     const logicalOp = options.defaultHandle === "combine" ? "$or" : "$and";
     if (hasOwnProperty(sourceQuery, logicalOp)) {
       const andOr = sourceQuery[logicalOp];
@@ -523,7 +535,7 @@ const setQueryKeySafely = (params, key, value, operator = "$eq", options) => {
     }
     return params;
   }
-  if (isPlainObject$1(params.query[key]) && !(operator in 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 = []);
@@ -588,9 +600,8 @@ const toJSON = (context) => {
   return context;
 };
 
-const isPlainObject = (value) => commons._.isObject(value) && value.constructor === {}.constructor;
 const validateQueryProperty = (query, operators = []) => {
-  if (!isPlainObject(query)) {
+  if (!isObject(query)) {
     return query;
   }
   for (const key of Object.keys(query)) {
@@ -598,7 +609,7 @@ const validateQueryProperty = (query, operators = []) => {
       throw new errors.BadRequest(`Invalid query parameter ${key}`, query);
     }
     const value = query[key];
-    if (isPlainObject(value)) {
+    if (isObject(value)) {
       query[key] = validateQueryProperty(value, operators);
     }
   }
@@ -631,6 +642,72 @@ function optimizeBatchPatch(items, options) {
   });
 }
 
+function flattenQuery(q) {
+  if (Array.isArray(q)) {
+    return q.map(flattenQuery);
+  }
+  if (!isObject(q)) {
+    return q;
+  }
+  const { query, $limit, $select, $skip, $sort } = filterQuery(q);
+  const res = {};
+  function step(object, options) {
+    const { prev = [], result = res } = options ?? {};
+    Object.keys(object).forEach((key) => {
+      const value = object[key];
+      if (Array.isArray(value)) {
+        const newValues = value.map(
+          (v) => step(v, {
+            result: {}
+          })
+        );
+        _set__default(result, [...prev, key], newValues);
+        return;
+      }
+      if (key.startsWith("$")) {
+        _set__default(result, [...prev, key], value);
+        return;
+      }
+      const newKey = !prev.length ? [key] : [...prev.slice(0, -1), `${prev[prev.length - 1]}.${key}`];
+      if (!isObject(value)) {
+        _set__default(result, newKey, value);
+        return;
+      } else {
+        step(value, {
+          prev: newKey,
+          result
+        });
+        return;
+      }
+    });
+    return result;
+  }
+  return reassembleQuery({
+    $limit,
+    $select,
+    $skip,
+    $sort,
+    query: step(query)
+  });
+}
+
+function deflattenQuery(query) {
+  const result = {};
+  Object.keys(query).forEach((key) => {
+    const value = query[key];
+    if (Array.isArray(value)) {
+      _set__default(result, key, value.map(deflattenQuery));
+      return;
+    }
+    if (isObject(value)) {
+      _set__default(result, key, deflattenQuery(value));
+      return;
+    }
+    _set__default(result, key, query[key]);
+  });
+  return result;
+}
+
 function checkMulti() {
   return (context) => {
     if (shouldSkip("checkMulti", context)) {
@@ -877,12 +954,77 @@ 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 FROM_CLIENT_FOR_SERVER_DEFAULT_KEY = "_$client";
+
+function defineParamsForServer(keyToHide) {
+  return function paramsForServer2(...whitelist) {
+    return (context) => {
+      let clonedParams;
+      Object.keys(context.params).forEach((key) => {
+        if (key === "query") {
+          return;
+        }
+        if (whitelist.includes(key)) {
+          if (!clonedParams) {
+            clonedParams = {
+              ...context.params,
+              query: {
+                ...context.params.query
+              }
+            };
+          }
+          if (!clonedParams.query[keyToHide]) {
+            clonedParams.query[keyToHide] = {};
+          }
+          clonedParams.query[keyToHide][key] = clonedParams[key];
+          delete clonedParams[key];
+        }
+      });
+      if (clonedParams) {
+        context.params = clonedParams;
+      }
+      return context;
+    };
+  };
+}
+const paramsForServer = defineParamsForServer(
+  FROM_CLIENT_FOR_SERVER_DEFAULT_KEY
+);
+
+function defineParamsFromClient(keyToHide) {
+  return function paramsFromClient2(...whitelist) {
+    return (context) => {
+      if (!context.params?.query?.[keyToHide] || typeof context.params.query[keyToHide] !== "object") {
+        return context;
+      }
+      const params = {
+        ...context.params,
+        query: {
+          ...context.params.query,
+          [keyToHide]: {
+            ...context.params.query[keyToHide]
+          }
+        }
+      };
+      const client = params.query[keyToHide];
+      whitelist.forEach((key) => {
+        if (key in client) {
+          params[key] = client[key];
+          delete client[key];
+        }
+      });
+      if (Object.keys(client).length === 0) {
+        delete params.query[keyToHide];
+      }
+      context.params = params;
+      return context;
+    };
+  };
+}
+const paramsFromClient = defineParamsFromClient(
+  FROM_CLIENT_FOR_SERVER_DEFAULT_KEY
+);
+
 const makeDefaultOptions = () => {
   return {
     leading: false,
@@ -891,6 +1033,13 @@ const makeDefaultOptions = () => {
     wait: 100
   };
 };
+
+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;
+};
 class DebouncedStore {
   constructor(app, options) {
     __publicField(this, "_app");
@@ -983,7 +1132,7 @@ const filterArray = (...keys) => {
 };
 
 const filterQueryObject = (key) => (obj, { operators }) => {
-  if (obj && !_isObject__default(obj)) {
+  if (obj && !isObject(obj)) {
     throw new Error(
       `Invalid query parameter: '${key}'. It has to be an object`
     );
@@ -1003,22 +1152,28 @@ exports.checkMulti = checkMulti;
 exports.createRelated = createRelated;
 exports.debounceMixin = debounceMixin;
 exports.defineHooks = defineHooks;
+exports.defineParamsForServer = defineParamsForServer;
+exports.defineParamsFromClient = defineParamsFromClient;
+exports.deflattenQuery = deflattenQuery;
 exports.filterArray = filterArray;
 exports.filterObject = filterObject;
 exports.filterQuery = filterQuery;
+exports.flattenQuery = flattenQuery;
 exports.forEach = forEach;
 exports.getItemsIsArray = getItemsIsArray;
 exports.getPaginate = getPaginate;
 exports.isMulti = isMulti;
 exports.isPaginated = isPaginated;
-exports.makeDefaultOptions = makeDefaultOptions;
 exports.markHookForSkip = markHookForSkip;
 exports.mergeArrays = mergeArrays;
 exports.mergeQuery = mergeQuery;
 exports.onDelete = onDelete;
 exports.optimizeBatchPatch = optimizeBatchPatch;
+exports.paramsForServer = paramsForServer;
+exports.paramsFromClient = paramsFromClient;
 exports.parseFields = parseFields;
 exports.pushSet = pushSet;
+exports.reassembleQuery = reassembleQuery;
 exports.removeRelated = removeRelated;
 exports.runPerItem = runPerItem;
 exports.setData = setData;

package/dist/index.d.cts

@@ -102,6 +102,18 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+/**
+ * a hook to move params to query._$client
+ * the server only receives 'query' from params. All other params are ignored.
+ * So, to use `$populateParams` on the server, we need to move the params to query._$client
+ * the server will move them back to params
+ */
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+
+declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
+declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
+
 interface InitDebounceMixinOptions {
     default: Partial<DebouncedStoreOptions>;
     blacklist: string[];
@@ -115,7 +127,6 @@ interface DebouncedStoreOptions {
     wait: number;
 }
 
-declare const makeDefaultOptions: () => DebouncedStoreOptions;
 type DebouncedService<T = any> = T & {
     debouncedStore: DebouncedStore;
 };
@@ -142,7 +153,7 @@ declare function defineHooks<A extends Application = Application, S = {
     remove: any;
 }, Options = HookOptions<A, S>>(hooks: Options): Options;
 
-type FilterQueryResult<Q extends Query> = {
+type FilterQueryResult<Q extends Query = Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
     $limit: Q["$limit"] extends any ? Q["$limit"] : never;
     $skip: Q["$skip"] extends any ? Q["$skip"] : never;
@@ -156,6 +167,7 @@ type FilterQueryResult<Q extends Query> = {
  * @returns
  */
 declare function filterQuery<Q extends Query>(providedQuery?: Q): FilterQueryResult<Q>;
+declare function reassembleQuery(query: FilterQueryResult): Query;
 
 /**
  * util to get paginate options from context
@@ -187,7 +199,6 @@ 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;
@@ -220,7 +231,7 @@ declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val:
 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;
+declare const setQueryKeySafely: (params: Params, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => Params;
 
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
@@ -248,6 +259,10 @@ type OptimizeBatchPatchOptions = {
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
 declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
 
+declare function flattenQuery(q: Query): any;
+
+declare function deflattenQuery(query: Query): Query;
+
 declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
 declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
@@ -298,4 +313,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 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 };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, 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, defineParamsForServer, defineParamsFromClient, deflattenQuery, filterArray, filterObject, filterQuery, flattenQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, reassembleQuery, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.d.mts

@@ -102,6 +102,18 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+/**
+ * a hook to move params to query._$client
+ * the server only receives 'query' from params. All other params are ignored.
+ * So, to use `$populateParams` on the server, we need to move the params to query._$client
+ * the server will move them back to params
+ */
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+
+declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
+declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
+
 interface InitDebounceMixinOptions {
     default: Partial<DebouncedStoreOptions>;
     blacklist: string[];
@@ -115,7 +127,6 @@ interface DebouncedStoreOptions {
     wait: number;
 }
 
-declare const makeDefaultOptions: () => DebouncedStoreOptions;
 type DebouncedService<T = any> = T & {
     debouncedStore: DebouncedStore;
 };
@@ -142,7 +153,7 @@ declare function defineHooks<A extends Application = Application, S = {
     remove: any;
 }, Options = HookOptions<A, S>>(hooks: Options): Options;
 
-type FilterQueryResult<Q extends Query> = {
+type FilterQueryResult<Q extends Query = Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
     $limit: Q["$limit"] extends any ? Q["$limit"] : never;
     $skip: Q["$skip"] extends any ? Q["$skip"] : never;
@@ -156,6 +167,7 @@ type FilterQueryResult<Q extends Query> = {
  * @returns
  */
 declare function filterQuery<Q extends Query>(providedQuery?: Q): FilterQueryResult<Q>;
+declare function reassembleQuery(query: FilterQueryResult): Query;
 
 /**
  * util to get paginate options from context
@@ -187,7 +199,6 @@ 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;
@@ -220,7 +231,7 @@ declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val:
 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;
+declare const setQueryKeySafely: (params: Params, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => Params;
 
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
@@ -248,6 +259,10 @@ type OptimizeBatchPatchOptions = {
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
 declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
 
+declare function flattenQuery(q: Query): any;
+
+declare function deflattenQuery(query: Query): Query;
+
 declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
 declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
@@ -298,4 +313,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 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 };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, 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, defineParamsForServer, defineParamsFromClient, deflattenQuery, filterArray, filterObject, filterQuery, flattenQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, reassembleQuery, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.d.ts

@@ -102,6 +102,18 @@ interface HookSetDataOptions {
  */
 declare function setData<H extends HookContext = HookContext>(from: PropertyPath, to: PropertyPath, _options?: HookSetDataOptions): (context: H) => H;
 
+declare function defineParamsForServer(keyToHide: string): (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+/**
+ * a hook to move params to query._$client
+ * the server only receives 'query' from params. All other params are ignored.
+ * So, to use `$populateParams` on the server, we need to move the params to query._$client
+ * the server will move them back to params
+ */
+declare const paramsForServer: (...whitelist: string[]) => <H extends HookContext<_feathersjs_feathers.Application<any, any>, any>>(context: H) => H;
+
+declare function defineParamsFromClient(keyToHide: string): (...whitelist: string[]) => (context: HookContext) => HookContext;
+declare const paramsFromClient: (...whitelist: string[]) => (context: HookContext) => HookContext;
+
 interface InitDebounceMixinOptions {
     default: Partial<DebouncedStoreOptions>;
     blacklist: string[];
@@ -115,7 +127,6 @@ interface DebouncedStoreOptions {
     wait: number;
 }
 
-declare const makeDefaultOptions: () => DebouncedStoreOptions;
 type DebouncedService<T = any> = T & {
     debouncedStore: DebouncedStore;
 };
@@ -142,7 +153,7 @@ declare function defineHooks<A extends Application = Application, S = {
     remove: any;
 }, Options = HookOptions<A, S>>(hooks: Options): Options;
 
-type FilterQueryResult<Q extends Query> = {
+type FilterQueryResult<Q extends Query = Query> = {
     $select: Q["$select"] extends any ? Q["$select"] : never;
     $limit: Q["$limit"] extends any ? Q["$limit"] : never;
     $skip: Q["$skip"] extends any ? Q["$skip"] : never;
@@ -156,6 +167,7 @@ type FilterQueryResult<Q extends Query> = {
  * @returns
  */
 declare function filterQuery<Q extends Query>(providedQuery?: Q): FilterQueryResult<Q>;
+declare function reassembleQuery(query: FilterQueryResult): Query;
 
 /**
  * util to get paginate options from context
@@ -187,7 +199,6 @@ 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;
@@ -220,7 +231,7 @@ declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val:
 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;
+declare const setQueryKeySafely: (params: Params, key: string, value: any, operator?: string, options?: SetQueryKeySafelyOptions) => Params;
 
 /**
  * util to set `context.result` to an empty array or object, depending on the hook type
@@ -248,6 +259,10 @@ type OptimizeBatchPatchOptions = {
 type OptimizeBatchPatchResultItem<T = Record<string, unknown>, P = Params> = [Id, T, P | undefined];
 declare function optimizeBatchPatch<T extends Record<string, unknown>, P extends Params>(items: Map<Id, T>, options?: OptimizeBatchPatchOptions): OptimizeBatchPatchResultItem<T, P>[];
 
+declare function flattenQuery(q: Query): any;
+
+declare function deflattenQuery(query: Query): Query;
+
 declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
 
 declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };
@@ -298,4 +313,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 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 };
+export { type ActionOnEmptyIntersect, type CreateRelatedOptions, type DebouncedFunctionApp, type DebouncedService, DebouncedStore, type DebouncedStoreOptions, 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, defineParamsForServer, defineParamsFromClient, deflattenQuery, filterArray, filterObject, filterQuery, flattenQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, reassembleQuery, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };