feathers-utils 1.6.1 → 2.0.0-0

package/src/utils/setResultEmpty.ts

@@ -0,0 +1,28 @@
+import { HookContext } from "@feathersjs/feathers";
+import { isMulti } from "..";
+import { isPaginated } from "./isPaginated";
+
+export const setResultEmpty = (
+  context: HookContext
+): HookContext => {
+  if (context.result) { return context; }
+
+  const multi = isMulti(context);
+
+  if (multi) {
+    if (context.method === "find" && isPaginated(context)) {
+      context.result = {
+        total: 0,
+        skip: 0,
+        limit: 0,
+        data: []
+      };
+    } else {
+      context.result = [];
+    }
+  } else {
+    context.result = null;
+  }
+
+  return context;
+};

package/tsconfig-esm.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "moduleResolution": "node",
+    "target": "ES2020",
+    "module": "ESNext"
+  }
+}

package/.github/workflows/node.js.yml

@@ -1,45 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Node.js CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [12.x, 14.x, 16.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run test
-
-  coverage:
-    needs: [ test ]
-    name: coverage
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - uses: actions/setup-node@master
-      with:
-        node-version: '14'
-    - run: npm ci
-    - uses: paambaati/codeclimate-action@v2.7.5
-      env:
-        CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
-      with:
-        coverageCommand: npm run coverage

package/.vscode/launch.json

@@ -1,28 +0,0 @@
-{
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "type": "node",
-      "request": "launch",
-      "name": "Mocha Tests",
-      "program": "${workspaceFolder}/node_modules/mocha/bin/mocha",
-      "args": [
-        "--require",
-        "ts-node/register",
-        "--timeout",
-        "999999",
-        "--colors",
-        "--recursive",
-      ],
-      "internalConsoleOptions": "openOnSessionStart",
-      "env": {
-        "NODE_ENV": "test",
-        "TS_NODE_PROJECT": "tsconfig.test.json"
-      },
-      "outputCapture": "std",
-      "skipFiles": [
-        "<node_internals>/**"
-      ]
-    }
-  ]
-}

package/.vscode/settings.json

@@ -1,14 +0,0 @@
-// Place your settings in this file to overwrite default and user settings.
-{
-    "search.exclude": {
-      "**/node_modules": true,
-      "**/public": true,
-      "**/package-lock.json": true
-    },
-    "workbench.colorCustomizations": {
-      "activityBar.background": "#525252",
-      "titleBar.activeBackground": "#525252",
-      "titleBar.activeForeground": "#FAFBF4"
-    }
-  }
-  

package/dist/utils/addHook.d.ts

@@ -1,3 +0,0 @@
-import type { Application } from "@feathersjs/feathers";
-import type { AddHookOptions } from "../types";
-export declare const addHook: (app: Application, hook: unknown, options: AddHookOptions) => void;

package/dist/utils/addHook.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addHook = void 0;
-const defaultOptions = () => {
-    return {
-        whitelist: ["*"],
-        blacklist: []
-    };
-};
-const addHook = (app, hook, options) => {
-    options = Object.assign(defaultOptions(), options);
-    const { types, methods, whitelist, blacklist, orderByType } = options;
-    if (types.some(x => !(Object.keys(orderByType).includes(x)))) {
-        throw new Error("'feathers-utils/addHook': some types in 'orderByType' are undefined");
-    }
-    if (Object.keys(orderByType).some(type => !((["first", "last"]).includes(orderByType[type])))) {
-        throw new Error("'feathers-utils/addHook': only allowed values for 'orderByType' are 'first' or 'last'");
-    }
-    const allServices = app.services;
-    for (const servicePath in allServices) {
-        if (!Object.prototype.hasOwnProperty.call(allServices, servicePath)) {
-            continue;
-        }
-        const service = app.service(servicePath);
-        if (blacklist && blacklist.includes(servicePath)) {
-            continue;
-        }
-        if (whitelist && !whitelist.includes("*") && !whitelist.includes(servicePath)) {
-            continue;
-        }
-        types.forEach(type => {
-            const order = orderByType[type];
-            const unshiftOrPush = (order === "first") ? "unshift" : "push";
-            methods.forEach(method => {
-                service.__hooks[type][method][unshiftOrPush](hook);
-            });
-        });
-    }
-};
-exports.addHook = addHook;

package/src/utils/addHook.ts

@@ -1,49 +0,0 @@
-import type { Application } from "@feathersjs/feathers";
-import type { AddHookOptions, HookType } from "../types";
-
-const defaultOptions = (): Partial<AddHookOptions> => {
-  return {
-    whitelist: ["*"],
-    blacklist: []
-  };
-};
-
-export const addHook = (app: Application, hook: unknown, options: AddHookOptions): void => {
-  options = Object.assign(defaultOptions(), options);
-
-  const {
-    types,
-    methods,
-    whitelist,
-    blacklist,
-    orderByType
-  } = options;
-
-  if (types.some(
-    x => !(Object.keys(orderByType).includes(x)))
-  ) {
-    throw new Error("'feathers-utils/addHook': some types in 'orderByType' are undefined");
-  }
-  if (
-    (Object.keys(orderByType) as HookType[]).some(
-      type => !((["first", "last"]).includes(orderByType[type])))
-  ) {
-    throw new Error("'feathers-utils/addHook': only allowed values for 'orderByType' are 'first' or 'last'");
-  }
-
-  const allServices = app.services;
-
-  for (const servicePath in allServices) {
-    if(!Object.prototype.hasOwnProperty.call(allServices, servicePath)) { continue; }
-    const service = app.service(servicePath);
-    if (blacklist && blacklist.includes(servicePath)) { continue; }
-    if (whitelist && !whitelist.includes("*") && !whitelist.includes(servicePath)) { continue; }
-    types.forEach(type => {
-      const order = orderByType[type];
-      const unshiftOrPush = (order === "first") ? "unshift" : "push";
-      methods.forEach(method => {
-        service.__hooks[type][method][unshiftOrPush](hook);
-      });
-    });
-  }
-};

package/test/hooks/checkMulti.test.ts

@@ -1,121 +0,0 @@
-import assert from "assert";
-import { checkMulti } from "../../src";
-
-describe("hook - checkMulti", function() {
-  it("passes if 'allowsMulti' not defined", function() {
-    const makeContext = (type: string, method: string) => ({
-      service: {},
-      type,
-      method
-    });
-    ["before", "after"].forEach(type => {
-      ["find", "get", "create", "update", "patch", "remove"].forEach(method => {
-        const context = makeContext(type, method);
-        //@ts-ignore
-        assert.doesNotThrow(() => checkMulti()(context), `'${type}:${method}': does not throw`);
-      });
-    });
-  });
-
-  it("passes if 'allowsMulti' returns true", function() {
-    const makeContext = (type: string, method: string) => {
-      const context = {
-        service: {
-          allowsMulti: () => true
-        },
-        method,
-        type,
-      };
-      if (method === "create") {
-        (type === "before")
-        //@ts-ignore
-          ? context.data = []
-        //@ts-ignore
-          : context.result = [];
-      }
-      return context;
-    };
-    ["before", "after"].forEach(type => {
-      ["find", "get", "create", "update", "patch", "remove"].forEach(method => {
-        const context = makeContext(type, method);
-        //@ts-ignore
-        assert.doesNotThrow(() => checkMulti()(context), `'${type}:${method}': does not throw`);
-      });
-    });
-  });
-
-  it("passes for 'find', 'get' and 'update'", function() {
-    const makeContext = (type: string, method: string) => ({
-      service: {
-        allowsMulti: () => false
-      },
-      type,
-      method
-    });
-    ["before", "after"].forEach(type => {
-      ["find", "get", "update"].forEach(method => {
-        const context = makeContext(type, method);
-        //@ts-ignore
-        assert.doesNotThrow(() => checkMulti()(context), `'${type}:${method}': does not throw`);
-      });
-    });
-  });
-
-  it("passes if 'allowsMulti' returns false and is no multi data", function() {
-    const makeContext = (type: string, method: string) => {
-      const context = {
-        service: {
-          allowsMulti: (method: string) => method !== "find"
-        },
-        method,
-        type,
-      };
-      if (method === "create") {
-        (type === "before")
-        //@ts-ignore
-          ? context.data = {}
-        //@ts-ignore
-          : context.result = {};
-      }
-      if (["patch", "remove"].includes(method)) {
-        //@ts-ignore
-        context.id = 1;
-      }
-      return context;
-    };
-    ["before", "after"].forEach(type => {
-      ["create", "patch", "remove"].forEach(method => {
-        const context = makeContext(type, method);
-        //@ts-ignore
-        assert.doesNotThrow(() => checkMulti()(context), `'${type}:${method}': does not throw`);
-      });
-    });
-  });
-
-  it("throws if 'allowsMulti' returns false and multi data", function() {
-    const makeContext = (type: string, method: string) => {
-      const context = {
-        service: {
-          allowsMulti: () => false
-        },
-        method,
-        type,
-      };
-      if (method === "create") {
-        (type === "before") 
-        //@ts-ignore
-          ? context.data = []
-        //@ts-ignore
-          : context.result = [];
-      }
-      return context;
-    };
-    ["before", "after"].forEach(type => {
-      ["create", "patch", "remove"].forEach(method => {
-        const context = makeContext(type, method);
-        //@ts-ignore
-        assert.throws(() => checkMulti()(context), `'${type}:${method}': throws`);
-      });
-    });
-  });
-});

package/test/hooks/setData.test.ts

@@ -1,333 +0,0 @@
-import assert from "assert";
-import { setData } from "../../src";
-
-describe("hook - setData", function() {
-  it("sets userId for single item", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            user: {
-              id: 1
-            }
-          }
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = {};
-
-        //@ts-ignore
-        const result = setData("params.user.id", "userId")(context);
-        assert.strictEqual(result[dataOrResult].userId, 1, `'${type}/${method}': ${dataOrResult} has 'userId:1'`);
-      });
-    });
-  });
-
-  it("overwrites userId for single item", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            user: {
-              id: 1
-            }
-          }
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = { userId: 2 };
-
-        //@ts-ignore
-        const result = setData("params.user.id", "userId")(context);
-        assert.strictEqual(result[dataOrResult].userId, 1, `'${type}/${method}': ${dataOrResult} has 'userId:1'`);
-      });
-    });
-  });
-
-  it("sets userId for multiple items", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            user: {
-              id: 1
-            }
-          },
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = [{}, {}, {}];
-
-        //@ts-ignore
-        const result = setData("params.user.id", "userId")(context);
-        result[dataOrResult].forEach(item => {
-          assert.strictEqual(item.userId, 1, `'${type}/${method}': ${dataOrResult} has 'userId:1'`);
-        });
-      });
-    });
-  });
-
-  it("overwrites userId for multiple items", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            user: {
-              id: 1
-            }
-          }
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = [{ userId: 2 }, {}, { userId: "abc" }];
-
-        //@ts-ignore
-        const result = setData("params.user.id", "userId")(context);
-        result[dataOrResult].forEach(item => {
-          assert.strictEqual(item.userId, 1, `'${type}/${method}': ${dataOrResult} has 'userId:1'`);
-        });
-      });
-    });
-  });
-
-  it("does not change createdById if 'params.user.id' is not provided", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {}
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = { userId: 2 };
-
-        //@ts-ignore
-        const result = setData("params.user.id", "userId")(context);
-
-        assert.strictEqual(result[dataOrResult].userId, 2, `'${type}/${method}': ${dataOrResult} has 'userId:2'`);
-      });
-    });
-  });
-
-  it("throws if 'external' is set and context.user.id is undefined", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            provider: "socket.io"
-          }
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = {};
-
-        assert.throws(
-          //@ts-ignore
-          () => setData("params.user.id", "userId")(context),
-          err => err.name === "Forbidden",
-          `'${type}/${method}': throws 'Forbidden' error`
-        );
-      });
-    });
-  });
-
-  it("passes if 'external' and 'allowUndefined: true'", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          provider: "socket.io",
-          params: {},
-          data: {}
-        };
-
-        assert.doesNotThrow(
-          //@ts-ignore
-          () => setData("params.user.id", "userId", { allowUndefined: true })(context),
-          `'${type}/${method}': passes`
-        );
-      });
-    });
-  });
-
-  it("passes if 'external' is set and context.user.id is undefined but overwrite: false", function() {
-    const methodsByType = {
-      "before": ["create", "update", "patch", "remove"],
-      "after": ["find", "get", "create", "update", "patch", "remove"]
-    };
-    Object.keys(methodsByType).forEach(type => {
-      methodsByType[type].forEach(method => {
-        const context = {
-          method,
-          type,
-          params: {
-            provider: "socket.io"
-          }
-        };
-
-        const dataOrResult = (type === "before") ? "data" : "result";
-        context[dataOrResult] = { userId: 1 };
-
-        assert.doesNotThrow(
-          //@ts-ignore
-          () => setData("params.user.id", "userId", { overwrite: false })(context),
-          `'${type}/${method}': passes`
-        );
-      });
-    });
-  });
-
-  describe("overwrite: false", function() {
-    it("sets userId for single item", function() {
-      const methodsByType = {
-        "before": ["create", "update", "patch", "remove"],
-        "after": ["find", "get", "create", "update", "patch", "remove"]
-      };
-      Object.keys(methodsByType).forEach(type => {
-        methodsByType[type].forEach(method => {
-          const context = {
-            method,
-            type,
-            params: {
-              user: {
-                id: 1
-              }
-            }
-          };
-  
-          const dataOrResult = (type === "before") ? "data" : "result";
-          context[dataOrResult] = {};
-  
-          //@ts-ignore
-          const result = setData("params.user.id", "userId", { overwrite: false })(context);
-          assert.strictEqual(result[dataOrResult].userId, 1, `'${type}/${method}': ${dataOrResult} has 'userId:1'`);
-        });
-      });
-    });
-
-    it("does not overwrite userId for single item", function() {
-      const methodsByType = {
-        "before": ["create", "update", "patch", "remove"],
-        "after": ["find", "get", "create", "update", "patch", "remove"]
-      };
-      Object.keys(methodsByType).forEach(type => {
-        methodsByType[type].forEach(method => {
-          const context = {
-            method,
-            type,
-            params: {
-              user: {
-                id: 1
-              }
-            }
-          };
-  
-          const dataOrResult = (type === "before") ? "data" : "result";
-          context[dataOrResult] = { userId: 2 };
-  
-          //@ts-ignore
-          const result = setData("params.user.id", "userId", { overwrite: false })(context);
-          assert.strictEqual(result[dataOrResult].userId, 2, `'${type}/${method}': ${dataOrResult} has 'userId:2'`);
-        });
-      });
-    });
-  
-    it("sets userId for multiple items", function() {
-      const methodsByType = {
-        "before": ["create", "update", "patch", "remove"],
-        "after": ["find", "get", "create", "update", "patch", "remove"]
-      };
-      Object.keys(methodsByType).forEach(type => {
-        methodsByType[type].forEach(method => {
-          const context = {
-            method,
-            type,
-            params: {
-              user: {
-                id: 1
-              }
-            },
-          };
-  
-          const dataOrResult = (type === "before") ? "data" : "result";
-          context[dataOrResult] = [{}, {}, {}];
-  
-          //@ts-ignore
-          const result = setData("params.user.id", "userId", { overwrite: false })(context);
-          result[dataOrResult].forEach((item) => {
-            assert.strictEqual(item.userId, 1, `${type}/${method}': ${dataOrResult} has 'userId:1'`);
-          });
-        });
-      });
-    });
-  
-    it("overwrites userId for multiple items", function() {
-      const methodsByType = {
-        "before": ["create", "update", "patch", "remove"],
-        "after": ["find", "get", "create", "update", "patch", "remove"]
-      };
-      Object.keys(methodsByType).forEach(type => {
-        methodsByType[type].forEach(method => {
-          const context = {
-            method,
-            type,
-            params: {
-              user: {
-                id: 1
-              }
-            }
-          };
-  
-          const dataOrResult = (type === "before") ? "data" : "result";
-          context[dataOrResult] = [{ userId: 0 }, {}, { userId: 2 }];
-  
-          //@ts-ignore
-          const result = setData("params.user.id", "userId", { overwrite: false })(context);
-          result[dataOrResult].forEach((item, i) => {
-            assert.strictEqual(item.userId, i, `${type}/${method}': ${dataOrResult} has 'userId:${i}`);
-          });
-        });
-      });
-    });
-  });
-});