feat: new hooks paramsFromClient/paramsForServer (#24)

Author: fratzinger

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`.

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

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

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

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

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,
+          },
+        },
+      },
+    });
+  });
+}

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,
+        },
+      },
+    });
+  });
+}

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";