feathers-utils 2.0.0-9 → 2.0.0

package/dist/esm/utils/mergeQuery/utils.js

@@ -1,272 +0,0 @@
-import { Forbidden } from "@feathersjs/errors";
-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 _set from "lodash/set.js";
-import _uniqWith from "lodash/uniqWith.js";
-import { mergeArrays } from "./mergeArrays";
-export const hasOwnProperty = (obj, key) => {
-    return Object.prototype.hasOwnProperty.call(obj, key);
-};
-export function handleArray(target, source, key, options) {
-    const targetVal = _get(target, key);
-    const sourceVal = _get(source, key);
-    if (!sourceVal && !targetVal) {
-        return;
-    }
-    const handle = _get(options, ["handle", ...key], options.defaultHandle);
-    const arr = mergeArrays(targetVal, sourceVal, handle, key, options.actionOnEmptyIntersect);
-    _set(target, key, arr);
-}
-export function handleCircular(target, source, prependKey, options) {
-    if (target?.$or) {
-        target.$or = cleanOr(target.$or);
-        if (!target.$or) {
-            delete target.$or;
-        }
-    }
-    if (source?.$or) {
-        source.$or = cleanOr(source.$or);
-        if (!source.$or) {
-            delete source.$or;
-        }
-    }
-    if (target?.$and) {
-        target.$and = cleanAnd(target.$and);
-        if (!target.$and) {
-            delete target.$and;
-        }
-    }
-    if (source?.$and) {
-        source.$and = cleanAnd(source.$and);
-        if (!source.$and) {
-            delete source.$and;
-        }
-    }
-    if (!_has(source, prependKey)) {
-        return;
-    }
-    if (!_has(target, prependKey)) {
-        _set(target, prependKey, _get(source, prependKey));
-        return;
-    }
-    const { defaultHandle, actionOnEmptyIntersect } = options;
-    if (defaultHandle === "target") {
-        return;
-    }
-    const getTargetVal = () => {
-        return prependKey.length > 0 ? _get(target, prependKey) : target;
-    };
-    const getSourceVal = () => {
-        return prependKey.length > 0 ? _get(source, prependKey) : source;
-    };
-    const targetVal = getTargetVal();
-    const sourceVal = getSourceVal();
-    if (_isEqual(targetVal, sourceVal)) {
-        return;
-    }
-    if (defaultHandle === "source") {
-        _set(target, prependKey, sourceVal);
-        return;
-    }
-    if (targetVal === null || sourceVal === null) {
-        _set(target, prependKey, sourceVal);
-        return;
-    }
-    const typeOfTargetVal = typeof targetVal;
-    if (["boolean"].includes(typeOfTargetVal)) {
-        if (defaultHandle === "intersect") {
-            actionOnEmptyIntersect(target, source, prependKey);
-        }
-        _set(target, prependKey, sourceVal);
-        return;
-    }
-    const typeOfSourceVal = typeof sourceVal;
-    const isTargetSimple = ["string", "number"].includes(typeOfTargetVal);
-    const isSourceSimple = ["string", "number"].includes(typeOfSourceVal);
-    if (isTargetSimple || isSourceSimple) {
-        if (isTargetSimple && isSourceSimple) {
-            if (defaultHandle === "combine") {
-                _set(target, prependKey, { $in: [...new Set([targetVal, sourceVal])] });
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                actionOnEmptyIntersect(target, source, prependKey);
-            }
-            else {
-                throw new Error("should not reach here");
-            }
-        }
-        else if (hasOwnProperty(targetVal, "$in") ||
-            hasOwnProperty(sourceVal, "$in")) {
-            const targetHasIn = hasOwnProperty(targetVal, "$in");
-            const $in = targetHasIn ? targetVal["$in"] : sourceVal["$in"];
-            const otherVal = isTargetSimple ? targetVal : sourceVal;
-            if ($in.length === 1 && _isEqual($in[0], otherVal)) {
-                _set(target, prependKey, otherVal);
-                return;
-            }
-            else if (defaultHandle === "combine") {
-                if (!$in.some((x) => _isEqual(x, otherVal))) {
-                    $in.push(otherVal);
-                }
-                _set(target, `${prependKey}.$in`, $in);
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                if ($in.some((x) => _isEqual(x, otherVal))) {
-                    _set(target, prependKey, otherVal);
-                }
-                else {
-                    actionOnEmptyIntersect(target, source, prependKey);
-                }
-                return;
-            }
-            return;
-        }
-    }
-    const isTargetArray = Array.isArray(targetVal);
-    const isSourceArray = Array.isArray(sourceVal);
-    if (isTargetArray && isSourceArray) {
-        const key = prependKey[prependKey.length - 1];
-        if (key === "$or") {
-            if (defaultHandle === "combine") {
-                const newVals = sourceVal.filter((x) => !targetVal.some((y) => _isEqual(x, y)));
-                targetVal.push(...newVals);
-            }
-            else if (defaultHandle === "intersect") {
-                // combine into "$and"
-                const targetParent = getParentProp(target, prependKey);
-                const sourceParent = getParentProp(source, prependKey);
-                targetParent.$and = targetParent.$and || [];
-                targetParent.$and.push({ $or: targetVal }, { $or: sourceVal });
-                targetParent.$and = cleanAnd(targetParent.$and);
-                if (!targetParent.$and) {
-                    delete targetParent.$and;
-                }
-                delete targetParent.$or;
-                delete sourceParent.$or;
-                handleCircular(target, source, [...prependKey, "$and"], options);
-                return;
-            }
-            return;
-        }
-        else if (key === "$and") {
-            if (defaultHandle === "combine") {
-                // combine into "$or"
-                const targetParent = getParentProp(target, prependKey);
-                const sourceParent = getParentProp(source, prependKey);
-                targetParent.$or = targetParent.$or || [];
-                targetParent.$or.push({ $and: targetVal }, { $and: sourceVal });
-                targetParent.$or = cleanOr(targetParent.$or);
-                if (!targetParent.$or) {
-                    delete targetParent.$or;
-                }
-                delete targetParent.$and;
-                delete sourceParent.$and;
-                handleCircular(target, source, [...prependKey, "$or"], options);
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                const newVals = sourceVal.filter((x) => !targetVal.some((y) => _isEqual(x, y)));
-                targetVal.push(...newVals);
-                return;
-            }
-        }
-        else if (key === "$in") {
-            if (defaultHandle === "combine") {
-                let $in = targetVal.concat(sourceVal);
-                $in = [...new Set($in)];
-                _set(target, prependKey, $in);
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                const $in = targetVal.filter((x) => sourceVal.some((y) => _isEqual(x, y)));
-                if ($in.length === 0) {
-                    actionOnEmptyIntersect(target, source, prependKey);
-                }
-                else if ($in.length === 1) {
-                    _set(target, prependKey.slice(0, -1), $in[0]);
-                    return;
-                }
-                else {
-                    _set(target, prependKey, $in);
-                }
-            }
-            return;
-        }
-        _set(target, prependKey, sourceVal);
-        return;
-    }
-    if (typeOfTargetVal !== "object" || typeOfSourceVal !== "object") {
-        _set(target, prependKey, sourceVal);
-        return;
-    }
-    // both are objects
-    const sourceKeys = Object.keys(sourceVal);
-    for (let i = 0, n = sourceKeys.length; i < n; i++) {
-        const key = sourceKeys[i];
-        handleCircular(target, source, [...prependKey, key], options);
-    }
-}
-export function makeDefaultOptions(options) {
-    options = options || {};
-    options.defaultHandle = options.defaultHandle || "combine";
-    options.useLogicalConjunction = Object.prototype.hasOwnProperty.call(options, "useLogicalConjunction")
-        ? options.useLogicalConjunction
-        : false;
-    options.actionOnEmptyIntersect =
-        options.actionOnEmptyIntersect ||
-            (() => {
-                throw new Forbidden("You're not allowed to make this request");
-            });
-    options.handle = options.handle || {};
-    if (options.defaultHandle === "intersect") {
-        options.handle.$select = options.handle.$select || "intersectOrFull";
-    }
-    return options;
-}
-export function moveProperty(source, target, key) {
-    if (!Object.prototype.hasOwnProperty.call(source, key)) {
-        return;
-    }
-    target[key] = source[key];
-    delete source[key];
-}
-export function getParentProp(target, path) {
-    if (path.length <= 1) {
-        return target;
-    }
-    const pathOneUp = path.slice(0, -1);
-    return _get(target, pathOneUp);
-}
-export function cleanOr(target) {
-    if (!target || !Array.isArray(target) || target.length <= 0) {
-        return target;
-    }
-    if (target.some((x) => _isEmpty(x))) {
-        return undefined;
-    }
-    else {
-        return arrayWithoutDuplicates(target);
-    }
-}
-export function cleanAnd(target) {
-    if (!target || !Array.isArray(target) || target.length <= 0) {
-        return target;
-    }
-    if (target.every((x) => _isEmpty(x))) {
-        return undefined;
-    }
-    else {
-        target = target.filter((x) => !_isEmpty(x));
-        return arrayWithoutDuplicates(target);
-    }
-}
-export function arrayWithoutDuplicates(target) {
-    if (!target || !Array.isArray(target)) {
-        return target;
-    }
-    return _uniqWith(target, _isEqual);
-}

package/dist/esm/utils/pushSet.d.ts

@@ -1,8 +0,0 @@
-import type { Path } from "../typesInternal";
-export interface PushSetOptions {
-    unique?: boolean;
-}
-/**
- * util to push a value to an array at a given path in an object
- */
-export declare const pushSet: (obj: Record<string, unknown>, path: string | Path, val: unknown, options?: PushSetOptions) => unknown[];

package/dist/esm/utils/pushSet.js

@@ -1,22 +0,0 @@
-import _isEqual from "lodash/isEqual.js";
-import _get from "lodash/get.js";
-import _set from "lodash/set.js";
-/**
- * util to push a value to an array at a given path in an object
- */
-export const pushSet = (obj, path, val, options) => {
-    options = options || {};
-    let arr = _get(obj, path);
-    if (!arr || !Array.isArray(arr)) {
-        arr = [val];
-        _set(obj, path, arr);
-        return arr;
-    }
-    else {
-        if (options.unique && arr.some((x) => _isEqual(x, val))) {
-            return arr;
-        }
-        arr.push(val);
-        return arr;
-    }
-};

package/dist/esm/utils/setResultEmpty.d.ts

@@ -1,5 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * util to set `context.result` to an empty array or object, depending on the hook type
- */
-export declare const setResultEmpty: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>>(context: H) => H;

package/dist/esm/utils/setResultEmpty.js

@@ -1,28 +0,0 @@
-import { isMulti } from "./isMulti";
-import { isPaginated } from "./isPaginated";
-/**
- * util to set `context.result` to an empty array or object, depending on the hook type
- */
-export const setResultEmpty = (context) => {
-    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/dist/esm/utils/shouldSkip.d.ts

@@ -1,8 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export type ShouldSkipOptions = {
-    notSkippable?: boolean;
-};
-/**
- * util to detect if a hook should be skipped
- */
-export declare const shouldSkip: <H extends HookContext<import("@feathersjs/feathers").Application<any, any>, any> = HookContext<import("@feathersjs/feathers").Application<any, any>, any>, O extends ShouldSkipOptions = ShouldSkipOptions>(hookName: string, context: H, options?: O | undefined) => boolean;

package/dist/esm/utils/shouldSkip.js

@@ -1,29 +0,0 @@
-// Kudos to @DaddyWarbucks! This is a cheeky copy of his awesome library: 'feathers-fletching'.
-// Definitely check it out! https://daddywarbucks.github.io/feathers-fletching/overview.html
-import { GeneralError } from "@feathersjs/errors";
-/**
- * util to detect if a hook should be skipped
- */
-export const shouldSkip = (hookName, context, options) => {
-    if (!context.params || !context.params.skipHooks || options?.notSkippable) {
-        return false;
-    }
-    const { skipHooks } = context.params;
-    if (!Array.isArray(skipHooks)) {
-        throw new GeneralError("The `skipHooks` param must be an Array of Strings");
-    }
-    const { type } = context;
-    if (skipHooks.includes(hookName)) {
-        return true;
-    }
-    else if (skipHooks.includes("all")) {
-        return true;
-    }
-    else if (skipHooks.includes(type)) {
-        return true;
-    }
-    else if (skipHooks.includes(`${type}:${hookName}`)) {
-        return true;
-    }
-    return false;
-};

package/dist/esm/utils/validateQueryProperty.d.ts

@@ -1,5 +0,0 @@
-import type { Query } from "@feathersjs/feathers";
-/**
- * util to validate a query for operators
- */
-export declare const validateQueryProperty: (query: any, operators?: string[]) => Query;

package/dist/esm/utils/validateQueryProperty.js

@@ -1,23 +0,0 @@
-import { _ } from "@feathersjs/commons";
-import { BadRequest } from "@feathersjs/errors";
-const isPlainObject = (value) => _.isObject(value) && value.constructor === {}.constructor;
-/**
- * util to validate a query for operators
- */
-export const validateQueryProperty = (query, operators = []) => {
-    if (!isPlainObject(query)) {
-        return query;
-    }
-    for (const key of Object.keys(query)) {
-        if (key.startsWith("$") && !operators.includes(key)) {
-            throw new BadRequest(`Invalid query parameter ${key}`, query);
-        }
-        const value = query[key];
-        if (isPlainObject(value)) {
-            query[key] = validateQueryProperty(value, operators);
-        }
-    }
-    return {
-        ...query,
-    };
-};

package/dist/filters/array.d.ts

@@ -1,2 +0,0 @@
-import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterArray: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };

package/dist/filters/array.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterArray = void 0;
-const validateQueryProperty_1 = require("../utils/validateQueryProperty");
-const filterQueryArray = (key) => (arr, { operators }) => {
-    if (arr && !Array.isArray(arr)) {
-        throw new Error(`Invalid query parameter '${key}'. It has to be an array`);
-    }
-    if (Array.isArray(arr)) {
-        return arr.map((current) => (0, validateQueryProperty_1.validateQueryProperty)(current, operators));
-    }
-    return arr;
-};
-const filterArray = (...keys) => {
-    const result = {};
-    for (const key of keys) {
-        result[key] = filterQueryArray(key);
-    }
-    return result;
-};
-exports.filterArray = filterArray;

package/dist/filters/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./array";
-export * from "./object";

package/dist/filters/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-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 });
-__exportStar(require("./array"), exports);
-__exportStar(require("./object"), exports);

package/dist/filters/object.d.ts

@@ -1,2 +0,0 @@
-import type { FilterQueryOptions } from "@feathersjs/adapter-commons";
-export declare const filterObject: <T extends string[]>(...keys: T) => { [key in T[number]]: (value: any, options: FilterQueryOptions) => any; };

package/dist/filters/object.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterObject = void 0;
-const validateQueryProperty_1 = require("../utils/validateQueryProperty");
-const isObject_1 = __importDefault(require("lodash/isObject"));
-const filterQueryObject = (key) => (obj, { operators }) => {
-    if (obj && !(0, isObject_1.default)(obj)) {
-        throw new Error(`Invalid query parameter: '${key}'. It has to be an object`);
-    }
-    return (0, validateQueryProperty_1.validateQueryProperty)(obj, operators);
-};
-const filterObject = (...keys) => {
-    const result = {};
-    for (const key of keys) {
-        result[key] = filterQueryObject(key);
-    }
-    return result;
-};
-exports.filterObject = filterObject;

package/dist/hooks/checkMulti.d.ts

@@ -1,5 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-/**
- * hook to check if context is multi patch/remove and if the service allows it
- */
-export declare function checkMulti<H extends HookContext = HookContext>(): (context: H) => H;

package/dist/hooks/checkMulti.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkMulti = void 0;
-const errors_1 = require("@feathersjs/errors");
-const utils_1 = require("../utils");
-/**
- * hook to check if context is multi patch/remove and if the service allows it
- */
-function checkMulti() {
-    return (context) => {
-        if ((0, utils_1.shouldSkip)("checkMulti", context)) {
-            return context;
-        }
-        const { service, method } = context;
-        if (!service.allowsMulti || !(0, utils_1.isMulti)(context) || method === "find") {
-            return context;
-        }
-        if (!service.allowsMulti(method)) {
-            throw new errors_1.MethodNotAllowed(`Can not ${method} multiple entries`);
-        }
-        return context;
-    };
-}
-exports.checkMulti = checkMulti;

package/dist/hooks/createRelated.d.ts

@@ -1,12 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-import type { Promisable } from "../typesInternal";
-export interface CreateRelatedOptions<S = Record<string, any>> {
-    service: keyof S;
-    multi?: boolean;
-    data: (item: any, context: HookContext) => Promisable<Record<string, any>>;
-    createItemsInDataArraySeparately?: boolean;
-}
-/**
- * hook to create related items
- */
-export declare function createRelated<S = Record<string, any>, H extends HookContext = HookContext>({ service, multi, data, createItemsInDataArraySeparately, }: CreateRelatedOptions<S>): (context: H) => Promise<H>;

package/dist/hooks/createRelated.js

@@ -1,44 +0,0 @@
-"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 utils_1 = require("../utils");
-/**
- * hook to create related items
- */
-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* () {
-        if ((0, utils_1.shouldSkip)("createRelated", context)) {
-            return context;
-        }
-        (0, feathers_hooks_common_1.checkContext)(context, "after", undefined, "createRelated");
-        const { items } = (0, utils_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/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./checkMulti";
-export * from "./createRelated";
-export * from "./onDelete";
-export * from "./removeRelated";
-export * from "./runPerItem";
-export * from "./setData";

package/dist/hooks/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-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 });
-__exportStar(require("./checkMulti"), exports);
-__exportStar(require("./createRelated"), exports);
-__exportStar(require("./onDelete"), exports);
-__exportStar(require("./removeRelated"), exports);
-__exportStar(require("./runPerItem"), exports);
-__exportStar(require("./setData"), exports);

package/dist/hooks/onDelete.d.ts

@@ -1,12 +0,0 @@
-import type { HookContext } from "@feathersjs/feathers";
-export type OnDeleteAction = "cascade" | "set null";
-export interface OnDeleteOptions {
-    keyThere: string;
-    keyHere: string;
-    onDelete: OnDeleteAction;
-    blocking?: boolean;
-}
-/**
- * hook to manipulate related items on delete
- */
-export declare function onDelete<S = Record<string, any>, H extends HookContext = HookContext>(service: keyof S, { keyThere, keyHere, onDelete, blocking, }: OnDeleteOptions): (context: H) => Promise<H>;