Merge pull request #13 from fratzinger/feat/onDelete

feat: onDelete

Author: fratzinger

package-lock.json

@@ -39,30 +39,30 @@
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx"
   },
   "dependencies": {
-    "@feathersjs/adapter-commons": "^4.5.12",
-    "@feathersjs/errors": "^4.5.12",
-    "@feathersjs/feathers": "^4.5.12",
-    "feathers-hooks-common": "^5.0.6",
+    "@feathersjs/adapter-commons": "^4.5.15",
+    "@feathersjs/errors": "^4.5.15",
+    "@feathersjs/feathers": "^4.5.15",
+    "feathers-hooks-common": "^6.1.5",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/lodash": "^4.14.179",
-    "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.21",
-    "@typescript-eslint/eslint-plugin": "^5.13.0",
-    "@typescript-eslint/parser": "^5.13.0",
+    "@types/lodash": "^4.14.184",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.7.14",
+    "@typescript-eslint/eslint-plugin": "^5.36.0",
+    "@typescript-eslint/parser": "^5.36.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.10.0",
-    "eslint-import-resolver-typescript": "^2.5.0",
-    "eslint-plugin-import": "^2.25.4",
-    "eslint-plugin-security": "^1.4.0",
+    "eslint": "^8.23.0",
+    "eslint-import-resolver-typescript": "^3.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-security": "^1.5.0",
     "feathers-memory": "^4.1.0",
-    "mocha": "^9.2.1",
-    "np": "^7.6.0",
+    "mocha": "^10.0.0",
+    "np": "^7.6.2",
     "nyc": "^15.1.0",
     "shx": "^0.3.4",
-    "ts-node": "^10.5.0",
-    "typescript": "^4.6.2"
+    "ts-node": "^10.9.1",
+    "typescript": "^4.8.2"
   }
 }

package.json

@@ -0,0 +1,55 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { checkContext } from "feathers-hooks-common";
+import type { OnDeleteOptions } from "../types";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
+
+export function onDelete<S = Record<string, any>>(
+  service: keyof S,
+  {
+    keyThere,
+    keyHere = "id",
+    onDelete = "cascade",
+    blocking = true
+  }: OnDeleteOptions) {
+  if (!service || !keyThere) {
+    throw "initialize hook 'removeRelated' completely!";
+  }
+  if (!["cascade", "set null"].includes(onDelete)) {
+    throw "onDelete must be 'cascade' or 'set null'";
+  }
+
+  return async (context: HookContext): Promise<HookContext> => {
+    checkContext(context, "after", "remove", "onDelete");
+
+    const { items } = getItemsIsArray(context);
+
+    let ids = items.map(x => x[keyHere]).filter(x => !!x);
+    ids = [...new Set(ids)];
+
+    if (!ids || ids.length <= 0) { return context; }
+
+    const params = {
+      query: {
+        [keyThere]: {
+          $in: ids
+        }
+      },
+      paginate: false
+    };
+
+    let promise;
+
+    if (onDelete === "cascade") {
+      promise = context.app.service(service as string).remove(null, params);
+    } else if (onDelete === "set null") {
+      const data = { [keyThere]: null };
+      promise = context.app.service(service as string).patch(null, data, params);
+    }
+
+    if (blocking) {
+      await promise;
+    }
+
+    return context;
+  };
+}

src/hooks/onDelete.ts

@@ -1,6 +1,6 @@
-import _get from "lodash/get";
-import _set from "lodash/set";
-import _has from "lodash/has";
+import _get from "lodash/get.js";
+import _set from "lodash/set.js";
+import _has from "lodash/has.js";
 
 import { Forbidden } from "@feathersjs/errors";
 import { getItemsIsArray } from "../utils/getItemsIsArray";

src/hooks/setData.ts

@@ -38,6 +38,7 @@ export { setResultEmpty } from "./utils/setResultEmpty";
 export { markHookForSkip } from "./utils/markHookForSkip";
 export { filterQuery } from "./utils/filterQuery";
 export { getItemsIsArray } from "./utils/getItemsIsArray";
+export { onDelete } from "./hooks/onDelete";
 export { shouldSkip } from "./utils/shouldSkip";
 
 

src/index.ts

@@ -1,4 +1,4 @@
-import _debounce from "lodash/debounce";
+import _debounce from "lodash/debounce.js";
 
 import type { DebouncedFunc } from "lodash";
 import type { Application, Id } from "@feathersjs/feathers";

src/mixins/debounce-mixin/DebouncedStore.ts

@@ -50,6 +50,15 @@ export interface CreateRelatedOptions<S = Record<string, any>> {
   createItemsInDataArraySeparately?: boolean
 }
 
+export type OnDeleteAction = "cascade" | "set null";
+
+export interface OnDeleteOptions {
+    keyThere: string
+    keyHere: string
+    onDelete: OnDeleteAction
+    blocking?: boolean
+}
+
 //#endregion
 
 //#region mixins

src/types.ts

@@ -1,10 +1,10 @@
-import _get from "lodash/get";
-import _has from "lodash/has";
-import _isEmpty from "lodash/isEmpty";
-import _isEqual from "lodash/isEqual";
-import _merge from "lodash/merge";
-import _set from "lodash/set";
-import _uniqWith from "lodash/uniqWith";
+import _get from "lodash/get.js";
+import _has from "lodash/has.js";
+import _isEmpty from "lodash/isEmpty.js";
+import _isEqual from "lodash/isEqual.js";
+import _merge from "lodash/merge.js";
+import _set from "lodash/set.js";
+import _uniqWith from "lodash/uniqWith.js";
 
 import { mergeArrays } from "./mergeArrays";
 import { filterQuery } from "../filterQuery";

src/utils/mergeQuery/index.ts

@@ -1,6 +1,6 @@
-import _isEqual from "lodash/isEqual";
-import _get from "lodash/get";
-import _set from "lodash/set";
+import _isEqual from "lodash/isEqual.js";
+import _get from "lodash/get.js";
+import _set from "lodash/set.js";
 
 import type {
   Path,