feathers-utils 5.0.2 → 5.1.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`.

package/dist/index.cjs

@@ -877,6 +877,77 @@ function setData(from, to, _options) {
   };
 }
 
+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
+);
+
 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) => {
@@ -1003,6 +1074,8 @@ exports.checkMulti = checkMulti;
 exports.createRelated = createRelated;
 exports.debounceMixin = debounceMixin;
 exports.defineHooks = defineHooks;
+exports.defineParamsForServer = defineParamsForServer;
+exports.defineParamsFromClient = defineParamsFromClient;
 exports.filterArray = filterArray;
 exports.filterObject = filterObject;
 exports.filterQuery = filterQuery;
@@ -1017,6 +1090,8 @@ 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.removeRelated = removeRelated;

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[];
@@ -298,4 +310,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 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, defineParamsForServer, defineParamsFromClient, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, 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[];
@@ -298,4 +310,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 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, defineParamsForServer, defineParamsFromClient, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, 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[];
@@ -298,4 +310,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 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, defineParamsForServer, defineParamsFromClient, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/dist/index.mjs

@@ -863,6 +863,77 @@ function setData(from, to, _options) {
   };
 }
 
+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
+);
+
 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) => {
@@ -984,4 +1055,4 @@ const filterObject = (...keys) => {
   return result;
 };
 
-export { DebouncedStore, checkMulti, createRelated, debounceMixin, defineHooks, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };
+export { DebouncedStore, checkMulti, createRelated, debounceMixin, defineHooks, defineParamsForServer, defineParamsFromClient, filterArray, filterObject, filterQuery, forEach, getItemsIsArray, getPaginate, isMulti, isPaginated, makeDefaultOptions, markHookForSkip, mergeArrays, mergeQuery, onDelete, optimizeBatchPatch, paramsForServer, paramsFromClient, parseFields, pushSet, removeRelated, runPerItem, setData, setQueryKeySafely, setResultEmpty, shouldSkip, toJSON, validateQueryProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {

package/src/hooks/from-client-for-server/common.ts

@@ -0,0 +1 @@
+export const FROM_CLIENT_FOR_SERVER_DEFAULT_KEY = "_$client" as const;

package/src/hooks/from-client-for-server/index.ts

@@ -0,0 +1,2 @@
+export * from "./paramsForServer";
+export * from "./paramsFromClient";

package/src/hooks/from-client-for-server/paramsForServer.ts

@@ -0,0 +1,100 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { FROM_CLIENT_FOR_SERVER_DEFAULT_KEY } from "./common";
+
+export function defineParamsForServer(keyToHide: string) {
+  return function paramsForServer(...whitelist: string[]) {
+    return <H extends HookContext>(context: H) => {
+      // clone params on demand
+      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;
+    };
+  };
+}
+
+/**
+ * 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
+ */
+export const paramsForServer = defineParamsForServer(
+  FROM_CLIENT_FOR_SERVER_DEFAULT_KEY,
+);
+
+if (import.meta.vitest) {
+  const { it, expect } = import.meta.vitest;
+
+  it("should move params to query._$client", () => {
+    expect(
+      paramsForServer(
+        "a",
+        "b",
+      )({
+        params: {
+          a: 1,
+          b: 2,
+          query: {},
+        },
+      } as HookContext),
+    ).toEqual({
+      params: {
+        query: {
+          _$client: {
+            a: 1,
+            b: 2,
+          },
+        },
+      },
+    });
+  });
+
+  it("should move params to query._$client and leave remaining", () => {
+    expect(
+      paramsForServer("a")({
+        params: {
+          a: 1,
+          b: 2,
+          query: {},
+        },
+      } as HookContext),
+    ).toEqual({
+      params: {
+        b: 2,
+        query: {
+          _$client: {
+            a: 1,
+          },
+        },
+      },
+    });
+  });
+}

package/src/hooks/from-client-for-server/paramsFromClient.ts

@@ -0,0 +1,105 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { FROM_CLIENT_FOR_SERVER_DEFAULT_KEY } from "./common";
+
+export function defineParamsFromClient(keyToHide: string) {
+  return function paramsFromClient(
+    ...whitelist: string[]
+  ): (context: HookContext) => HookContext {
+    return (context: HookContext): HookContext => {
+      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;
+    };
+  };
+}
+
+export const paramsFromClient = defineParamsFromClient(
+  FROM_CLIENT_FOR_SERVER_DEFAULT_KEY,
+);
+
+if (import.meta.vitest) {
+  const { it, expect } = import.meta.vitest;
+
+  it("should move params to query._$client", () => {
+    expect(
+      paramsFromClient(
+        "a",
+        "b",
+      )({
+        params: {
+          query: {
+            _$client: {
+              a: 1,
+              b: 2,
+            },
+            c: 3,
+          },
+        },
+      } as HookContext),
+    ).toEqual({
+      params: {
+        a: 1,
+        b: 2,
+        query: {
+          c: 3,
+        },
+      },
+    });
+  });
+
+  it("should move params to query._$client and leave remaining", () => {
+    expect(
+      paramsFromClient("a")({
+        params: {
+          query: {
+            _$client: {
+              a: 1,
+              b: 2,
+            },
+            c: 3,
+          },
+        },
+      } as HookContext),
+    ).toEqual({
+      params: {
+        a: 1,
+        query: {
+          _$client: {
+            b: 2,
+          },
+          c: 3,
+        },
+      },
+    });
+  });
+}

package/src/hooks/index.ts

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