feathers-utils 1.6.1 → 1.8.0

package/src/utils/isMulti.ts

@@ -4,13 +4,12 @@ export const isMulti = (context: HookContext): boolean => {
   const { method } = context;
   if (method === "find") {
     return true;
-  } else if (["patch", "remove"].includes(context.method)) {
+  } else if (["patch", "remove"].includes(method)) {
     return context.id == null;
   } else if (method === "create") {
     const items = context.type === "before" ? context.data : context.result;
-    items && context.method === "find" ? items.data || items : items;
     return Array.isArray(items);
-  } else if (method === "get" || method === "update") {
+  } else if (["get", "update"].includes(method)) {
     return false;
   }
   return false;

package/src/utils/isPaginated.ts

@@ -0,0 +1,12 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { getPaginate } from "./getPaginate";
+
+export const isPaginated = (
+  context: HookContext
+): boolean => {
+  if (context.params.paginate === false) { return false; }
+
+  const paginate = getPaginate(context);
+
+  return !!paginate;
+};

package/src/utils/setResultEmpty.ts

@@ -0,0 +1,28 @@
+import type { 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/.eslintignore

@@ -1,3 +0,0 @@
-node_modules
-dist
-coverage

package/.eslintrc.js

@@ -1,44 +0,0 @@
-module.exports = {
-  root: true,
-  env: {
-    node: true,
-    mocha: true
-  },
-  parser: "@typescript-eslint/parser",
-  plugins: [
-    "security",
-    "@typescript-eslint"
-  ],
-  extends: [
-    "eslint:recommended",
-    "plugin:security/recommended",
-    "plugin:@typescript-eslint/recommended"
-  ],
-  rules: {
-    "quotes": ["warn", "double", "avoid-escape"],
-    "indent": ["warn", 2, { "SwitchCase": 1 }],
-    "semi": ["warn", "always"],
-    "@typescript-eslint/no-unused-vars": "warn",
-    "no-console": "off",
-    "camelcase": "warn",
-    "require-atomic-updates": "off",
-    "prefer-destructuring": ["warn", {
-      "array": false,
-      "object": true
-    }, {
-      "enforceForRenamedProperties": false
-    }],
-    "security/detect-object-injection": "off",
-    "object-curly-spacing": ["warn", "always"],
-    "prefer-const": ["warn"]
-  },
-  overrides: [
-    {
-      "files": ["test/**/*.ts"],
-      "rules": {
-        "@typescript-eslint/ban-ts-comment": ["off"]
-      }
-    }
-  ]
-};
-  

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/.gitlab-ci.yml

@@ -1,11 +0,0 @@
-.feathers-utils:
-  only:
-    changes:
-      - packages/feathers-utils/**/*
-
-test:feathers-utils:
-  variables:
-    DIR: packages/feathers-utils
-  extends:
-    - .feathers-utils
-    - .test

package/.mocharc.js

@@ -1,11 +0,0 @@
-'use strict';
-const path = require("path");
-
-module.exports = {
-  extension: ["ts"],
-  package: path.join(__dirname, "./package.json"),
-  ui: "bdd",
-  spec: [
-    "./test/**/*.test.ts",
-  ]
-};

package/.nycrc.json

@@ -1,22 +0,0 @@
-{
-  "extends": "@istanbuljs/nyc-config-typescript",
-  "cache": false,
-  "check-coverage": false,
-  "include": [
-    "src/**/*.js",
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "src/types.ts",
-    "src/index.ts"
-  ],
-  "reporter": [
-    "html",
-    "text",
-    "text-summary",
-    "lcov"
-  ],
-  "sourceMap": true,
-  "all": true,
-  "instrument": true
-}

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/index.js

@@ -1,9 +0,0 @@
-exports.mergeQuery = require("./src/mergeQuery");
-exports.mergeArrays = require("./src/mergeQuery/mergeArrays");
-exports.shouldSkip = require("./src/shouldSkip");
-exports.pushSet = require("./src/pushSet");
-exports.isMulti = require("./src/isMulti");
-
-exports.hooks = {
-  checkMulti: require("./src/hooks/checkMulti")
-};

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`);
-      });
-    });
-  });
-});