feathers-utils 1.9.4 → 1.10.0

package/README.md

@@ -19,9 +19,11 @@ npm i feathers-utils
 
 ### Hooks
 
-- `checkMulti()`: throws if the request is **multi** data, but the service has `allowsMulti(method)` returns `false`
-- `runPerItem`
-- `setData({ allowUndefined: Boolean })`
+- `checkMulti`: throws if the request is **multi** data, but the service has `allowsMulti(method)` returns `false`
+- `createRelated`: simply create related items from a hook.
+- `removeRelated`: simple remove related items from a hook. Basically `cascade` at feathers level.
+- `runPerItem`: run a function for every item. Meant for `multi:true`.
+- `setData`: map properties from `context` to `data`. Something like `userId: context.params.user.id`
 
 ### Mixins
 

package/dist/esm/hooks/createRelated.d.ts

@@ -0,0 +1,3 @@
+import type { HookContext } from "@feathersjs/feathers";
+import type { CreateRelatedOptions } from "../types";
+export declare function createRelated<S = Record<string, any>>({ service, multi, data, createItemsInDataArraySeparately }: CreateRelatedOptions<S>): (context: HookContext) => Promise<HookContext>;

package/dist/esm/hooks/createRelated.js

@@ -0,0 +1,25 @@
+import { checkContext } from "feathers-hooks-common";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
+export function createRelated({ service, multi = true, data, createItemsInDataArraySeparately = true }) {
+    if (!service || !data) {
+        throw "initialize hook 'createRelated' completely!";
+    }
+    return async (context) => {
+        checkContext(context, "after", undefined, "createRelated");
+        const { items } = getItemsIsArray(context);
+        let dataToCreate = (await Promise.all(items.map(async (item) => data(item, context)))).filter(x => !!x);
+        if (createItemsInDataArraySeparately) {
+            dataToCreate = dataToCreate.flat();
+        }
+        if (!dataToCreate || dataToCreate.length <= 0) {
+            return context;
+        }
+        if (multi) {
+            await context.app.service(service).create(dataToCreate);
+        }
+        else {
+            await Promise.all(dataToCreate.map(async (item) => context.app.service(service).create(item)));
+        }
+        return context;
+    };
+}

package/dist/esm/hooks/removeRelated.d.ts

@@ -0,0 +1,3 @@
+import type { HookContext } from "@feathersjs/feathers";
+import type { RemoveRelatedOptions } from "../types";
+export declare function removeRelated<S = Record<string, any>>({ service, keyThere, keyHere, blocking }: RemoveRelatedOptions<S>): (context: HookContext) => Promise<HookContext>;

package/dist/esm/hooks/removeRelated.js

@@ -0,0 +1,28 @@
+import { checkContext } from "feathers-hooks-common";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
+export function removeRelated({ service, keyThere, keyHere = "id", blocking = true }) {
+    if (!service || !keyThere) {
+        throw "initialize hook 'removeRelated' completely!";
+    }
+    return async (context) => {
+        checkContext(context, "after", "remove", "removeRelated");
+        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 promise = context.app.service(service).remove(null, {
+            query: {
+                [keyThere]: {
+                    $in: ids
+                }
+            },
+            paginate: false
+        });
+        if (blocking) {
+            await promise;
+        }
+        return context;
+    };
+}

package/dist/esm/hooks/runPerItem.d.ts

@@ -1,3 +1,3 @@
 import type { HookRunPerItemOptions, ReturnAsyncHook, Promisable } from "../types";
 import type { HookContext } from "@feathersjs/feathers";
-export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => ReturnAsyncHook;
+export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, _options?: HookRunPerItemOptions | undefined) => ReturnAsyncHook;

package/dist/esm/hooks/runPerItem.js

@@ -8,8 +8,8 @@ const makeOptions = (options) => {
 };
 export const runPerItem = (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-actionPerItem, options) => {
-    options = makeOptions(options);
+actionPerItem, _options) => {
+    const options = makeOptions(_options);
     return async (context) => {
         if (shouldSkip("runForItems", context)) {
             return context;

package/dist/esm/index.d.ts

@@ -4,10 +4,12 @@ import { runPerItem } from "./hooks/runPerItem";
 export declare const hooks: {
     checkMulti: typeof checkMulti;
     setData: typeof setData;
-    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => import("./types").ReturnAsyncHook;
+    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, _options?: import("./types").HookRunPerItemOptions | undefined) => import("./types").ReturnAsyncHook;
 };
 export { checkMulti };
+export { createRelated } from "./hooks/createRelated";
 export { setData };
+export { removeRelated } from "./hooks/removeRelated";
 export { runPerItem };
 import { debounceMixin, DebouncedStore } from "./mixins/debounce-mixin";
 export declare const mixins: {

package/dist/esm/index.js

@@ -8,7 +8,9 @@ export const hooks = {
     runPerItem
 };
 export { checkMulti };
+export { createRelated } from "./hooks/createRelated";
 export { setData };
+export { removeRelated } from "./hooks/removeRelated";
 export { runPerItem };
 import { debounceMixin, DebouncedStore } from "./mixins/debounce-mixin";
 export const mixins = {

package/dist/esm/types.d.ts

@@ -24,6 +24,18 @@ export interface AddHookOptions {
 export interface HookRunPerItemOptions {
     wait?: boolean;
 }
+export interface RemoveRelatedOptions<S = Record<string, any>> {
+    service: keyof S;
+    keyThere: string;
+    keyHere: string;
+    blocking?: boolean;
+}
+export interface CreateRelatedOptions<S = Record<string, any>> {
+    service: keyof S;
+    multi?: boolean;
+    data: (item: any, context: HookContext) => Promisable<Record<string, any>>;
+    createItemsInDataArraySeparately?: boolean;
+}
 export interface InitDebounceMixinOptions {
     default: Partial<DebouncedStoreOptions>;
     blacklist: string[];

package/dist/hooks/createRelated.d.ts

@@ -0,0 +1,3 @@
+import type { HookContext } from "@feathersjs/feathers";
+import type { CreateRelatedOptions } from "../types";
+export declare function createRelated<S = Record<string, any>>({ service, multi, data, createItemsInDataArraySeparately }: CreateRelatedOptions<S>): (context: HookContext) => Promise<HookContext>;

package/dist/hooks/createRelated.js

@@ -0,0 +1,38 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRelated = void 0;
+const feathers_hooks_common_1 = require("feathers-hooks-common");
+const getItemsIsArray_1 = require("../utils/getItemsIsArray");
+function createRelated({ service, multi = true, data, createItemsInDataArraySeparately = true }) {
+    if (!service || !data) {
+        throw "initialize hook 'createRelated' completely!";
+    }
+    return (context) => __awaiter(this, void 0, void 0, function* () {
+        (0, feathers_hooks_common_1.checkContext)(context, "after", undefined, "createRelated");
+        const { items } = (0, getItemsIsArray_1.getItemsIsArray)(context);
+        let dataToCreate = (yield Promise.all(items.map((item) => __awaiter(this, void 0, void 0, function* () { return data(item, context); })))).filter(x => !!x);
+        if (createItemsInDataArraySeparately) {
+            dataToCreate = dataToCreate.flat();
+        }
+        if (!dataToCreate || dataToCreate.length <= 0) {
+            return context;
+        }
+        if (multi) {
+            yield context.app.service(service).create(dataToCreate);
+        }
+        else {
+            yield Promise.all(dataToCreate.map((item) => __awaiter(this, void 0, void 0, function* () { return context.app.service(service).create(item); })));
+        }
+        return context;
+    });
+}
+exports.createRelated = createRelated;

package/dist/hooks/removeRelated.d.ts

@@ -0,0 +1,3 @@
+import type { HookContext } from "@feathersjs/feathers";
+import type { RemoveRelatedOptions } from "../types";
+export declare function removeRelated<S = Record<string, any>>({ service, keyThere, keyHere, blocking }: RemoveRelatedOptions<S>): (context: HookContext) => Promise<HookContext>;

package/dist/hooks/removeRelated.js

@@ -0,0 +1,41 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeRelated = void 0;
+const feathers_hooks_common_1 = require("feathers-hooks-common");
+const getItemsIsArray_1 = require("../utils/getItemsIsArray");
+function removeRelated({ service, keyThere, keyHere = "id", blocking = true }) {
+    if (!service || !keyThere) {
+        throw "initialize hook 'removeRelated' completely!";
+    }
+    return (context) => __awaiter(this, void 0, void 0, function* () {
+        (0, feathers_hooks_common_1.checkContext)(context, "after", "remove", "removeRelated");
+        const { items } = (0, getItemsIsArray_1.getItemsIsArray)(context);
+        let ids = items.map(x => x[keyHere]).filter(x => !!x);
+        ids = [...new Set(ids)];
+        if (!ids || ids.length <= 0) {
+            return context;
+        }
+        const promise = context.app.service(service).remove(null, {
+            query: {
+                [keyThere]: {
+                    $in: ids
+                }
+            },
+            paginate: false
+        });
+        if (blocking) {
+            yield promise;
+        }
+        return context;
+    });
+}
+exports.removeRelated = removeRelated;

package/dist/hooks/runPerItem.d.ts

@@ -1,3 +1,3 @@
 import type { HookRunPerItemOptions, ReturnAsyncHook, Promisable } from "../types";
 import type { HookContext } from "@feathersjs/feathers";
-export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, options: HookRunPerItemOptions) => ReturnAsyncHook;
+export declare const runPerItem: (actionPerItem: (item: any, context: HookContext) => Promisable<any>, _options?: HookRunPerItemOptions | undefined) => ReturnAsyncHook;

package/dist/hooks/runPerItem.js

@@ -20,8 +20,8 @@ const makeOptions = (options) => {
 };
 const runPerItem = (
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-actionPerItem, options) => {
-    options = makeOptions(options);
+actionPerItem, _options) => {
+    const options = makeOptions(_options);
     return (context) => __awaiter(void 0, void 0, void 0, function* () {
         if ((0, shouldSkip_1.shouldSkip)("runForItems", context)) {
             return context;

package/dist/index.d.ts

@@ -4,10 +4,12 @@ import { runPerItem } from "./hooks/runPerItem";
 export declare const hooks: {
     checkMulti: typeof checkMulti;
     setData: typeof setData;
-    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, options: import("./types").HookRunPerItemOptions) => import("./types").ReturnAsyncHook;
+    runPerItem: (actionPerItem: (item: any, context: import("@feathersjs/feathers").HookContext<any, import("@feathersjs/feathers").Service<any>>) => any, _options?: import("./types").HookRunPerItemOptions | undefined) => import("./types").ReturnAsyncHook;
 };
 export { checkMulti };
+export { createRelated } from "./hooks/createRelated";
 export { setData };
+export { removeRelated } from "./hooks/removeRelated";
 export { runPerItem };
 import { debounceMixin, DebouncedStore } from "./mixins/debounce-mixin";
 export declare const mixins: {

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -10,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldSkip = exports.getItemsIsArray = exports.filterQuery = exports.markHookForSkip = exports.setResultEmpty = exports.pushSet = exports.mergeArrays = exports.mergeQuery = exports.isPaginated = exports.isMulti = exports.getPaginate = exports.addHook = exports.DebouncedStore = exports.debounceMixin = exports.mixins = exports.runPerItem = exports.setData = exports.checkMulti = exports.hooks = void 0;
+exports.shouldSkip = exports.getItemsIsArray = exports.filterQuery = exports.markHookForSkip = exports.setResultEmpty = exports.pushSet = exports.mergeArrays = exports.mergeQuery = exports.isPaginated = exports.isMulti = exports.getPaginate = exports.addHook = exports.DebouncedStore = exports.debounceMixin = exports.mixins = exports.runPerItem = exports.removeRelated = exports.setData = exports.createRelated = exports.checkMulti = exports.hooks = void 0;
 // hooks
 const checkMulti_1 = require("./hooks/checkMulti");
 Object.defineProperty(exports, "checkMulti", { enumerable: true, get: function () { return checkMulti_1.checkMulti; } });
@@ -23,6 +27,10 @@ exports.hooks = {
     setData: setData_1.setData,
     runPerItem: runPerItem_1.runPerItem
 };
+var createRelated_1 = require("./hooks/createRelated");
+Object.defineProperty(exports, "createRelated", { enumerable: true, get: function () { return createRelated_1.createRelated; } });
+var removeRelated_1 = require("./hooks/removeRelated");
+Object.defineProperty(exports, "removeRelated", { enumerable: true, get: function () { return removeRelated_1.removeRelated; } });
 const debounce_mixin_1 = require("./mixins/debounce-mixin");
 Object.defineProperty(exports, "debounceMixin", { enumerable: true, get: function () { return debounce_mixin_1.debounceMixin; } });
 Object.defineProperty(exports, "DebouncedStore", { enumerable: true, get: function () { return debounce_mixin_1.DebouncedStore; } });

package/dist/types.d.ts

@@ -24,6 +24,18 @@ export interface AddHookOptions {
 export interface HookRunPerItemOptions {
     wait?: boolean;
 }
+export interface RemoveRelatedOptions<S = Record<string, any>> {
+    service: keyof S;
+    keyThere: string;
+    keyHere: string;
+    blocking?: boolean;
+}
+export interface CreateRelatedOptions<S = Record<string, any>> {
+    service: keyof S;
+    multi?: boolean;
+    data: (item: any, context: HookContext) => Promisable<Record<string, any>>;
+    createItemsInDataArraySeparately?: boolean;
+}
 export interface InitDebounceMixinOptions {
     default: Partial<DebouncedStoreOptions>;
     blacklist: string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feathers-utils",
-  "version": "1.9.4",
+  "version": "1.10.0",
   "description": "Some utils for projects using '@feathersjs/feathers'",
   "author": "fratzinger",
   "repository": {
@@ -42,17 +42,18 @@
     "@feathersjs/adapter-commons": "^4.5.12",
     "@feathersjs/errors": "^4.5.12",
     "@feathersjs/feathers": "^4.5.12",
+    "feathers-hooks-common": "^5.0.6",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
-    "@types/lodash": "^4.14.178",
+    "@types/lodash": "^4.14.179",
     "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.19",
-    "@typescript-eslint/eslint-plugin": "^5.12.0",
-    "@typescript-eslint/parser": "^5.12.0",
+    "@types/node": "^17.0.21",
+    "@typescript-eslint/eslint-plugin": "^5.13.0",
+    "@typescript-eslint/parser": "^5.13.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.9.0",
+    "eslint": "^8.10.0",
     "eslint-import-resolver-typescript": "^2.5.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-security": "^1.4.0",
@@ -62,6 +63,6 @@
     "nyc": "^15.1.0",
     "shx": "^0.3.4",
     "ts-node": "^10.5.0",
-    "typescript": "^4.5.5"
+    "typescript": "^4.6.2"
   }
 }

package/src/hooks/createRelated.ts

@@ -0,0 +1,44 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { checkContext } from "feathers-hooks-common";
+import type { CreateRelatedOptions } from "../types";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
+
+export function createRelated<S = Record<string, any>>({
+  service,
+  multi = true,
+  data,
+  createItemsInDataArraySeparately = true
+}: CreateRelatedOptions<S>) {
+  if (!service || !data) {
+    throw "initialize hook 'createRelated' completely!";
+  }
+  return async (context: HookContext): Promise<HookContext> => {
+    checkContext(context, "after", undefined, "createRelated");
+
+    const { items } = getItemsIsArray(context);
+
+    let dataToCreate = (await Promise.all(
+      items.map(async item => data(item, context))
+    )).filter(x => !!x);
+
+    if (createItemsInDataArraySeparately) {
+      dataToCreate = dataToCreate.flat();
+    }
+
+    if (!dataToCreate || dataToCreate.length <= 0) { 
+      return context; 
+    }
+
+    if (multi) {
+      await context.app.service(service as string).create(dataToCreate);
+    } else {
+      await Promise.all(
+        dataToCreate.map(async item => 
+          context.app.service(service as string).create(item)
+        )
+      );
+    }
+
+    return context;
+  };
+}

package/src/hooks/removeRelated.ts

@@ -0,0 +1,40 @@
+import type { HookContext } from "@feathersjs/feathers";
+import { checkContext } from "feathers-hooks-common";
+import type { RemoveRelatedOptions } from "../types";
+import { getItemsIsArray } from "../utils/getItemsIsArray";
+
+export function removeRelated<S = Record<string, any>>({
+  service,
+  keyThere,
+  keyHere = "id",
+  blocking = true
+}: RemoveRelatedOptions<S>) {
+  if (!service || !keyThere) {
+    throw "initialize hook 'removeRelated' completely!";
+  }
+  return async (context: HookContext): Promise<HookContext> => {
+    checkContext(context, "after", "remove", "removeRelated");
+
+    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 promise: Promise<any> = context.app.service(service as string).remove(null, {
+      query: {
+        [keyThere]: {
+          $in: ids
+        }
+      },
+      paginate: false
+    });
+
+    if (blocking) {
+      await promise;
+    }
+
+    return context;
+  };
+}

package/src/hooks/runPerItem.ts

@@ -5,7 +5,7 @@ import type { HookContext } from "@feathersjs/feathers";
 import { getItemsIsArray } from "../utils/getItemsIsArray";
 
 const makeOptions = (
-  options: HookRunPerItemOptions
+  options?: HookRunPerItemOptions
 ): Required<HookRunPerItemOptions> => {
   options = options || {};
   return Object.assign({
@@ -16,9 +16,9 @@ const makeOptions = (
 export const runPerItem = (
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   actionPerItem: (item: any, context: HookContext) => Promisable<any>, 
-  options: HookRunPerItemOptions
+  _options?: HookRunPerItemOptions
 ): ReturnAsyncHook => {
-  options = makeOptions(options);
+  const options = makeOptions(_options);
   return async (context: HookContext): Promise<HookContext> => {
     if (shouldSkip("runForItems", context)) { return context; }
     const { items } = getItemsIsArray(context);

package/src/index.ts

@@ -1,6 +1,7 @@
 // hooks
 import { checkMulti } from "./hooks/checkMulti";
 import { setData } from "./hooks/setData";
+
 import { runPerItem } from "./hooks/runPerItem";
 
 export const hooks = {
@@ -10,7 +11,9 @@ export const hooks = {
 };
 
 export { checkMulti };
+export { createRelated } from "./hooks/createRelated";
 export { setData };
+export { removeRelated } from "./hooks/removeRelated";
 export { runPerItem };
 
 import { debounceMixin, DebouncedStore } from "./mixins/debounce-mixin";

package/src/types.ts

@@ -36,6 +36,20 @@ export interface HookRunPerItemOptions {
   wait?: boolean
 }
 
+export interface RemoveRelatedOptions<S = Record<string, any>> {
+  service: keyof S
+  keyThere: string
+  keyHere: string
+  blocking?: boolean
+}
+
+export interface CreateRelatedOptions<S = Record<string, any>> {
+  service: keyof S
+  multi?: boolean
+  data: (item: any, context: HookContext) => Promisable<Record<string, any>>
+  createItemsInDataArraySeparately?: boolean
+}
+
 //#endregion
 
 //#region mixins