feathers-utils 2.0.0-9 → 2.1.0

package/dist/utils/mergeQuery/utils.js

@@ -1,287 +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.arrayWithoutDuplicates = exports.cleanAnd = exports.cleanOr = exports.getParentProp = exports.moveProperty = exports.makeDefaultOptions = exports.handleCircular = exports.handleArray = exports.hasOwnProperty = void 0;
-const errors_1 = require("@feathersjs/errors");
-const get_js_1 = __importDefault(require("lodash/get.js"));
-const has_js_1 = __importDefault(require("lodash/has.js"));
-const isEmpty_js_1 = __importDefault(require("lodash/isEmpty.js"));
-const isEqual_js_1 = __importDefault(require("lodash/isEqual.js"));
-const set_js_1 = __importDefault(require("lodash/set.js"));
-const uniqWith_js_1 = __importDefault(require("lodash/uniqWith.js"));
-const mergeArrays_1 = require("./mergeArrays");
-const hasOwnProperty = (obj, key) => {
-    return Object.prototype.hasOwnProperty.call(obj, key);
-};
-exports.hasOwnProperty = hasOwnProperty;
-function handleArray(target, source, key, options) {
-    const targetVal = (0, get_js_1.default)(target, key);
-    const sourceVal = (0, get_js_1.default)(source, key);
-    if (!sourceVal && !targetVal) {
-        return;
-    }
-    const handle = (0, get_js_1.default)(options, ["handle", ...key], options.defaultHandle);
-    const arr = (0, mergeArrays_1.mergeArrays)(targetVal, sourceVal, handle, key, options.actionOnEmptyIntersect);
-    (0, set_js_1.default)(target, key, arr);
-}
-exports.handleArray = handleArray;
-function handleCircular(target, source, prependKey, options) {
-    if (target === null || target === void 0 ? void 0 : target.$or) {
-        target.$or = cleanOr(target.$or);
-        if (!target.$or) {
-            delete target.$or;
-        }
-    }
-    if (source === null || source === void 0 ? void 0 : source.$or) {
-        source.$or = cleanOr(source.$or);
-        if (!source.$or) {
-            delete source.$or;
-        }
-    }
-    if (target === null || target === void 0 ? void 0 : target.$and) {
-        target.$and = cleanAnd(target.$and);
-        if (!target.$and) {
-            delete target.$and;
-        }
-    }
-    if (source === null || source === void 0 ? void 0 : source.$and) {
-        source.$and = cleanAnd(source.$and);
-        if (!source.$and) {
-            delete source.$and;
-        }
-    }
-    if (!(0, has_js_1.default)(source, prependKey)) {
-        return;
-    }
-    if (!(0, has_js_1.default)(target, prependKey)) {
-        (0, set_js_1.default)(target, prependKey, (0, get_js_1.default)(source, prependKey));
-        return;
-    }
-    const { defaultHandle, actionOnEmptyIntersect } = options;
-    if (defaultHandle === "target") {
-        return;
-    }
-    const getTargetVal = () => {
-        return prependKey.length > 0 ? (0, get_js_1.default)(target, prependKey) : target;
-    };
-    const getSourceVal = () => {
-        return prependKey.length > 0 ? (0, get_js_1.default)(source, prependKey) : source;
-    };
-    const targetVal = getTargetVal();
-    const sourceVal = getSourceVal();
-    if ((0, isEqual_js_1.default)(targetVal, sourceVal)) {
-        return;
-    }
-    if (defaultHandle === "source") {
-        (0, set_js_1.default)(target, prependKey, sourceVal);
-        return;
-    }
-    if (targetVal === null || sourceVal === null) {
-        (0, set_js_1.default)(target, prependKey, sourceVal);
-        return;
-    }
-    const typeOfTargetVal = typeof targetVal;
-    if (["boolean"].includes(typeOfTargetVal)) {
-        if (defaultHandle === "intersect") {
-            actionOnEmptyIntersect(target, source, prependKey);
-        }
-        (0, set_js_1.default)(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") {
-                (0, set_js_1.default)(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 ((0, exports.hasOwnProperty)(targetVal, "$in") ||
-            (0, exports.hasOwnProperty)(sourceVal, "$in")) {
-            const targetHasIn = (0, exports.hasOwnProperty)(targetVal, "$in");
-            const $in = targetHasIn ? targetVal["$in"] : sourceVal["$in"];
-            const otherVal = isTargetSimple ? targetVal : sourceVal;
-            if ($in.length === 1 && (0, isEqual_js_1.default)($in[0], otherVal)) {
-                (0, set_js_1.default)(target, prependKey, otherVal);
-                return;
-            }
-            else if (defaultHandle === "combine") {
-                if (!$in.some((x) => (0, isEqual_js_1.default)(x, otherVal))) {
-                    $in.push(otherVal);
-                }
-                (0, set_js_1.default)(target, `${prependKey}.$in`, $in);
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                if ($in.some((x) => (0, isEqual_js_1.default)(x, otherVal))) {
-                    (0, set_js_1.default)(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) => (0, isEqual_js_1.default)(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) => (0, isEqual_js_1.default)(x, y)));
-                targetVal.push(...newVals);
-                return;
-            }
-        }
-        else if (key === "$in") {
-            if (defaultHandle === "combine") {
-                let $in = targetVal.concat(sourceVal);
-                $in = [...new Set($in)];
-                (0, set_js_1.default)(target, prependKey, $in);
-                return;
-            }
-            else if (defaultHandle === "intersect") {
-                const $in = targetVal.filter((x) => sourceVal.some((y) => (0, isEqual_js_1.default)(x, y)));
-                if ($in.length === 0) {
-                    actionOnEmptyIntersect(target, source, prependKey);
-                }
-                else if ($in.length === 1) {
-                    (0, set_js_1.default)(target, prependKey.slice(0, -1), $in[0]);
-                    return;
-                }
-                else {
-                    (0, set_js_1.default)(target, prependKey, $in);
-                }
-            }
-            return;
-        }
-        (0, set_js_1.default)(target, prependKey, sourceVal);
-        return;
-    }
-    if (typeOfTargetVal !== "object" || typeOfSourceVal !== "object") {
-        (0, set_js_1.default)(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);
-    }
-}
-exports.handleCircular = handleCircular;
-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 errors_1.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;
-}
-exports.makeDefaultOptions = makeDefaultOptions;
-function moveProperty(source, target, key) {
-    if (!Object.prototype.hasOwnProperty.call(source, key)) {
-        return;
-    }
-    target[key] = source[key];
-    delete source[key];
-}
-exports.moveProperty = moveProperty;
-function getParentProp(target, path) {
-    if (path.length <= 1) {
-        return target;
-    }
-    const pathOneUp = path.slice(0, -1);
-    return (0, get_js_1.default)(target, pathOneUp);
-}
-exports.getParentProp = getParentProp;
-function cleanOr(target) {
-    if (!target || !Array.isArray(target) || target.length <= 0) {
-        return target;
-    }
-    if (target.some((x) => (0, isEmpty_js_1.default)(x))) {
-        return undefined;
-    }
-    else {
-        return arrayWithoutDuplicates(target);
-    }
-}
-exports.cleanOr = cleanOr;
-function cleanAnd(target) {
-    if (!target || !Array.isArray(target) || target.length <= 0) {
-        return target;
-    }
-    if (target.every((x) => (0, isEmpty_js_1.default)(x))) {
-        return undefined;
-    }
-    else {
-        target = target.filter((x) => !(0, isEmpty_js_1.default)(x));
-        return arrayWithoutDuplicates(target);
-    }
-}
-exports.cleanAnd = cleanAnd;
-function arrayWithoutDuplicates(target) {
-    if (!target || !Array.isArray(target)) {
-        return target;
-    }
-    return (0, uniqWith_js_1.default)(target, isEqual_js_1.default);
-}
-exports.arrayWithoutDuplicates = arrayWithoutDuplicates;

package/dist/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/utils/pushSet.js

@@ -1,29 +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.pushSet = void 0;
-const isEqual_js_1 = __importDefault(require("lodash/isEqual.js"));
-const get_js_1 = __importDefault(require("lodash/get.js"));
-const set_js_1 = __importDefault(require("lodash/set.js"));
-/**
- * util to push a value to an array at a given path in an object
- */
-const pushSet = (obj, path, val, options) => {
-    options = options || {};
-    let arr = (0, get_js_1.default)(obj, path);
-    if (!arr || !Array.isArray(arr)) {
-        arr = [val];
-        (0, set_js_1.default)(obj, path, arr);
-        return arr;
-    }
-    else {
-        if (options.unique && arr.some((x) => (0, isEqual_js_1.default)(x, val))) {
-            return arr;
-        }
-        arr.push(val);
-        return arr;
-    }
-};
-exports.pushSet = pushSet;

package/dist/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/utils/setResultEmpty.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setResultEmpty = void 0;
-const isMulti_1 = require("./isMulti");
-const isPaginated_1 = require("./isPaginated");
-/**
- * util to set `context.result` to an empty array or object, depending on the hook type
- */
-const setResultEmpty = (context) => {
-    if (context.result) {
-        return context;
-    }
-    const multi = (0, isMulti_1.isMulti)(context);
-    if (multi) {
-        if (context.method === "find" && (0, isPaginated_1.isPaginated)(context)) {
-            context.result = {
-                total: 0,
-                skip: 0,
-                limit: 0,
-                data: [],
-            };
-        }
-        else {
-            context.result = [];
-        }
-    }
-    else {
-        context.result = null;
-    }
-    return context;
-};
-exports.setResultEmpty = setResultEmpty;

package/dist/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/utils/shouldSkip.js

@@ -1,33 +0,0 @@
-"use strict";
-// 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
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shouldSkip = void 0;
-const errors_1 = require("@feathersjs/errors");
-/**
- * util to detect if a hook should be skipped
- */
-const shouldSkip = (hookName, context, options) => {
-    if (!context.params || !context.params.skipHooks || (options === null || options === void 0 ? void 0 : options.notSkippable)) {
-        return false;
-    }
-    const { skipHooks } = context.params;
-    if (!Array.isArray(skipHooks)) {
-        throw new errors_1.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;
-};
-exports.shouldSkip = shouldSkip;

package/dist/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/utils/validateQueryProperty.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateQueryProperty = void 0;
-const commons_1 = require("@feathersjs/commons");
-const errors_1 = require("@feathersjs/errors");
-const isPlainObject = (value) => commons_1._.isObject(value) && value.constructor === {}.constructor;
-/**
- * util to validate a query for operators
- */
-const validateQueryProperty = (query, operators = []) => {
-    if (!isPlainObject(query)) {
-        return query;
-    }
-    for (const key of Object.keys(query)) {
-        if (key.startsWith("$") && !operators.includes(key)) {
-            throw new errors_1.BadRequest(`Invalid query parameter ${key}`, query);
-        }
-        const value = query[key];
-        if (isPlainObject(value)) {
-            query[key] = (0, exports.validateQueryProperty)(value, operators);
-        }
-    }
-    return Object.assign({}, query);
-};
-exports.validateQueryProperty = validateQueryProperty;