@dereekb/util 7.0.1 → 7.3.0

package/src/lib/object/object.filter.pojo.js

@@ -0,0 +1,235 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.forEachKeyValueOnPOJOFunction = exports.valuesFromPOJOFunction = exports.valuesFromPOJO = exports.assignValuesToPOJOFunction = exports.assignValuesToPOJO = exports.defaultFilterFromPOJOFunctionNoCopy = exports.filterFromPOJOFunction = exports.filterFromPOJO = exports.countPOJOKeysFunction = exports.countPOJOKeys = exports.findPOJOKeysFunction = exports.findPOJOKeys = exports.allMaybeSoKeys = exports.allNonUndefinedKeys = exports.filterNullAndUndefinedValues = exports.filterOnlyUndefinedValues = exports.filterUndefinedValues = exports.mergeObjectsFunction = exports.mergeObjects = exports.overrideInObjectFunctionFactory = exports.overrideInObject = void 0;
+const array_value_1 = require("../array/array.value");
+const object_filter_tuple_1 = require("./object.filter.tuple");
+const getter_1 = require("../getter");
+const object_1 = require("./object");
+// MARK: Object Merging/Overriding
+/**
+ * Assigns all undefined values from one or more objects into the target object.
+ *
+ * @param object
+ */
+function overrideInObject(target, { copy = false, from, filter }) {
+    return overrideInObjectFunctionFactory({
+        copy,
+        filter,
+        dynamic: true // using only once, so no need to use the cache
+    })(from)(target);
+}
+exports.overrideInObject = overrideInObject;
+function overrideInObjectFunctionFactory({ filter, copy, dynamic = false }) {
+    const filterToRelevantValuesObject = filter != null ? filterFromPOJOFunction({ filter, copy: false }) : exports.defaultFilterFromPOJOFunctionNoCopy;
+    return (from) => {
+        const rebuildTemplate = () => {
+            const template = {};
+            from.forEach((x) => {
+                const relevantValues = filterToRelevantValuesObject(Object.assign({}, x));
+                Object.assign(template, relevantValues);
+            });
+            return template;
+        };
+        const templateGetter = dynamic ? rebuildTemplate : (0, getter_1.cachedGetter)(rebuildTemplate);
+        return (target) => {
+            const template = templateGetter();
+            if (copy) {
+                target = (0, object_1.copyObject)(target);
+            }
+            Object.assign(target, template);
+            return target;
+        };
+    };
+}
+exports.overrideInObjectFunctionFactory = overrideInObjectFunctionFactory;
+/**
+ * Merges all input objects into one. The order of overrides is kept, so the right-most item in the array will have priority over all objects before it.
+ *
+ * @param objects
+ */
+function mergeObjects(objects, filter) {
+    return mergeObjectsFunction(filter)(objects);
+}
+exports.mergeObjects = mergeObjects;
+function mergeObjectsFunction(filter) {
+    const overrideFn = overrideInObjectFunctionFactory({
+        filter,
+        copy: false,
+        dynamic: true // no need to use cache, as cache won't be used.
+    });
+    return (objects) => overrideFn((0, array_value_1.filterMaybeValues)(objects))({});
+}
+exports.mergeObjectsFunction = mergeObjectsFunction;
+// MARK: POJO
+/**
+ * Returns a copy of the input object with all undefined (and null values if filterNull=true) values filtered/removed from it.
+ *
+ * @param obj
+ * @returns
+ */
+function filterUndefinedValues(obj, filterNull = false) {
+    const filterFn = filterNull ? exports.filterNullAndUndefinedValues : exports.filterOnlyUndefinedValues;
+    return filterFn(obj);
+}
+exports.filterUndefinedValues = filterUndefinedValues;
+/**
+ * Returns a copy of the input object with all undefined values filtered from it.
+ *
+ * @param obj
+ * @returns
+ */
+exports.filterOnlyUndefinedValues = filterFromPOJOFunction({ copy: true, filter: { valueFilter: object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED } });
+/**
+ * Returns a copy of the input object with all null and undefined values filtered from it.
+ *
+ * @param obj
+ * @returns
+ */
+exports.filterNullAndUndefinedValues = filterFromPOJOFunction({ copy: true, filter: { valueFilter: object_filter_tuple_1.KeyValueTypleValueFilter.NULL } });
+/**
+ * Returns all keys that are not associated with an undefined value.
+ *
+ * @param obj
+ * @returns
+ */
+exports.allNonUndefinedKeys = findPOJOKeysFunction({ valueFilter: object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED });
+/**
+ * Returns all keys that are not associated with a null/undefined value.
+ *
+ * @param obj
+ * @returns
+ */
+exports.allMaybeSoKeys = findPOJOKeysFunction({ valueFilter: object_filter_tuple_1.KeyValueTypleValueFilter.NULL });
+// MARK: FindPOJOKeys
+/**
+ * Finds keys from the POJO that meet the filter.
+ *
+ * @param obj
+ * @param filter
+ * @returns
+ */
+function findPOJOKeys(obj, filter) {
+    return findPOJOKeysFunction(filter)(obj);
+}
+exports.findPOJOKeys = findPOJOKeys;
+function findPOJOKeysFunction(filter) {
+    const findEachMatchingKeyOnTarget = forEachKeyValueOnPOJOFunction({
+        filter,
+        forEach: ([key], i, obj, context) => {
+            context.keys.push(key);
+        }
+    });
+    return (obj) => {
+        const context = { keys: [] };
+        findEachMatchingKeyOnTarget(obj, context);
+        return context.keys;
+    };
+}
+exports.findPOJOKeysFunction = findPOJOKeysFunction;
+// MARK: CountPOJOKeys
+/**
+ * Finds and counts the number of keys from the POJO that meet the filter.
+ *
+ * @param obj
+ * @param filter
+ * @returns
+ */
+function countPOJOKeys(obj, filter = object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED) {
+    return countPOJOKeysFunction(filter)(obj);
+}
+exports.countPOJOKeys = countPOJOKeys;
+function countPOJOKeysFunction(filter = object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED) {
+    const countEachMatchingKeyOnTarget = forEachKeyValueOnPOJOFunction({
+        filter,
+        forEach: (x, i, obj, context) => {
+            context.count += 1;
+        }
+    });
+    return (obj) => {
+        const context = { count: 0 };
+        countEachMatchingKeyOnTarget(obj, context);
+        return context.count;
+    };
+}
+exports.countPOJOKeysFunction = countPOJOKeysFunction;
+/**
+ * Removes values, per the the filter config, from the input object.
+ *
+ * @param obj POJO to remove undefined values from.
+ * @param copy Whether or not to return a copy of the input object. Default is true.
+ */
+function filterFromPOJO(obj, config = {}) {
+    return filterFromPOJOFunction(config)(obj);
+}
+exports.filterFromPOJO = filterFromPOJO;
+function filterFromPOJOFunction({ copy = false, filter: inputFilter = { valueFilter: object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED } } = {}) {
+    const filter = (0, object_filter_tuple_1.filterKeyValueTuplesInputToFilter)(inputFilter);
+    filter.invertFilter = !filter.invertFilter; // use the inversion of the filter to retain values
+    const forEachFn = forEachKeyValueOnPOJOFunction({
+        filter,
+        forEach: ([key], i, object) => {
+            delete object[key];
+        }
+    });
+    return (obj) => {
+        if (copy) {
+            obj = Object.assign({}, obj);
+        }
+        forEachFn(obj);
+        return obj;
+    };
+}
+exports.filterFromPOJOFunction = filterFromPOJOFunction;
+/**
+ * Convenience function from filterFromPOJOFunction with copy set to false and using the default filter.
+ */
+exports.defaultFilterFromPOJOFunctionNoCopy = filterFromPOJOFunction({ copy: false });
+// MARK: AssignValuesToPOJO
+function assignValuesToPOJO(target, obj, filter) {
+    return assignValuesToPOJOFunction(filter)(target, obj);
+}
+exports.assignValuesToPOJO = assignValuesToPOJO;
+function assignValuesToPOJOFunction(filter = object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED) {
+    const assignEachValueToTarget = forEachKeyValueOnPOJOFunction({
+        filter,
+        forEach: ([key, value], i, object, target) => {
+            target[key] = value;
+        }
+    });
+    return (target, obj) => {
+        assignEachValueToTarget(obj, target);
+        return obj;
+    };
+}
+exports.assignValuesToPOJOFunction = assignValuesToPOJOFunction;
+// MARK: ValuesFromPOJO
+/**
+ * Reads values from matching keys based on the filter and puts them into an array.
+ */
+function valuesFromPOJO(target, filter = object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED) {
+    return valuesFromPOJOFunction(filter)(target);
+}
+exports.valuesFromPOJO = valuesFromPOJO;
+function valuesFromPOJOFunction(filter = object_filter_tuple_1.KeyValueTypleValueFilter.UNDEFINED) {
+    const addValuesFromObjectToContext = forEachKeyValueOnPOJOFunction({
+        filter,
+        forEach: ([, value], i, obj, context) => {
+            context.values.push(value);
+        }
+    });
+    return (obj) => {
+        const context = { values: [] };
+        addValuesFromObjectToContext(obj, context);
+        return context.values;
+    };
+}
+exports.valuesFromPOJOFunction = valuesFromPOJOFunction;
+function forEachKeyValueOnPOJOFunction({ forEach, filter }) {
+    const filterKeyValues = (0, object_filter_tuple_1.filterKeyValueTuplesFunction)(filter);
+    return ((obj, context) => {
+        const keyValues = filterKeyValues(obj);
+        keyValues.forEach((x, i) => forEach(x, i, obj, context));
+    });
+}
+exports.forEachKeyValueOnPOJOFunction = forEachKeyValueOnPOJOFunction;
+//# sourceMappingURL=object.filter.pojo.js.map

package/src/lib/object/object.filter.pojo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.filter.pojo.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/object/object.filter.pojo.ts"],"names":[],"mappings":";;;AACA,sDAAyD;AACzD,+DAAiM;AACjM,sCAAiD;AACjD,qCAAsC;AAEtC,kCAAkC;AAClC;;;;GAIG;AACH,SAAgB,gBAAgB,CAAmB,MAAkB,EAAE,EAAE,IAAI,GAAG,KAAK,EAAE,IAAI,EAAE,MAAM,EAA2E;IAC5K,OAAO,+BAA+B,CAAC;QACrC,IAAI;QACJ,MAAM;QACN,OAAO,EAAE,IAAI,CAAC,+CAA+C;KAC9D,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;AACnB,CAAC;AAND,4CAMC;AAyBD,SAAgB,+BAA+B,CAAmB,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,KAAK,EAA4C;IAC3I,MAAM,4BAA4B,GAAG,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,2CAAmC,CAAC;IAE5I,OAAO,CAAC,IAAkB,EAAE,EAAE;QAC5B,MAAM,eAAe,GAAuB,GAAG,EAAE;YAC/C,MAAM,QAAQ,GAAG,EAAE,CAAC;YAEpB,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACjB,MAAM,cAAc,GAAG,4BAA4B,CAAC,kBAAK,CAAC,CAAO,CAAC,CAAC;gBACnE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,MAAM,cAAc,GAAuB,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,IAAA,qBAAY,EAAC,eAAe,CAAC,CAAC;QAErG,OAAO,CAAC,MAAkB,EAAE,EAAE;YAC5B,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;YAElC,IAAI,IAAI,EAAE;gBACR,MAAM,GAAG,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAC;aAC7B;YAED,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChC,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA5BD,0EA4BC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAmB,OAA4B,EAAE,MAA+B;IAC1G,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC;AAC/C,CAAC;AAFD,oCAEC;AASD,SAAgB,oBAAoB,CAAmB,MAA+B;IACpF,MAAM,UAAU,GAAG,+BAA+B,CAAC;QACjD,MAAM;QACN,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,IAAI,CAAC,gDAAgD;KAC/D,CAAC,CAAC;IAEH,OAAO,CAAC,OAA4B,EAAE,EAAE,CAAC,UAAU,CAAC,IAAA,+BAAiB,EAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;AACtF,CAAC;AARD,oDAQC;AAED,aAAa;AACb;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAmB,GAAM,EAAE,UAAU,GAAG,KAAK;IAChF,MAAM,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,oCAA4B,CAAC,CAAC,CAAC,iCAAyB,CAAC;IACvF,OAAO,QAAQ,CAAC,GAAG,CAAM,CAAC;AAC5B,CAAC;AAHD,sDAGC;AAED;;;;;GAKG;AACU,QAAA,yBAAyB,GAAkC,sBAAsB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,8CAAwB,CAAC,SAAS,EAAE,EAAE,CAAkC,CAAC;AAE7M;;;;;GAKG;AACU,QAAA,4BAA4B,GAAkC,sBAAsB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,WAAW,EAAE,8CAAwB,CAAC,IAAI,EAAE,EAAE,CAAkC,CAAC;AAE3M;;;;;GAKG;AACU,QAAA,mBAAmB,GAAgC,oBAAoB,CAAC,EAAE,WAAW,EAAE,8CAAwB,CAAC,SAAS,EAAE,CAAC,CAAC;AAE1I;;;;;GAKG;AACU,QAAA,cAAc,GAAgC,oBAAoB,CAAC,EAAE,WAAW,EAAE,8CAAwB,CAAC,IAAI,EAAE,CAAC,CAAC;AAEhI,qBAAqB;AACrB;;;;;;GAMG;AACH,SAAgB,YAAY,CAAmB,GAAM,EAAE,MAAoC;IACzF,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AAC3C,CAAC;AAFD,oCAEC;AAUD,SAAgB,oBAAoB,CAAmB,MAAoC;IACzF,MAAM,2BAA2B,GAAG,6BAA6B,CAA4B;QAC3F,MAAM;QACN,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAA+B,EAAE,EAAE;YAC1D,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,GAAM,EAAE,EAAE;QAChB,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;QAC7B,2BAA2B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC1C,OAAO,OAAO,CAAC,IAAI,CAAC;IACtB,CAAC,CAAC;AACJ,CAAC;AAbD,oDAaC;AAED,sBAAsB;AACtB;;;;;;GAMG;AACH,SAAgB,aAAa,CAAmB,GAAM,EAAE,SAAuC,8CAAwB,CAAC,SAAS;IAC/H,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AAC5C,CAAC;AAFD,sCAEC;AASD,SAAgB,qBAAqB,CAAmB,SAAuC,8CAAwB,CAAC,SAAS;IAC/H,MAAM,4BAA4B,GAAG,6BAA6B,CAA0B;QAC1F,MAAM;QACN,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAA6B,EAAE,EAAE;YACpD,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;QACrB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,GAAM,EAAE,EAAE;QAChB,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAC7B,4BAA4B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC,KAAK,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC;AAbD,sDAaC;AAQD;;;;;GAKG;AACH,SAAgB,cAAc,CAAmB,GAAM,EAAE,SAA4B,EAAE;IACrF,OAAO,sBAAsB,CAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AAChD,CAAC;AAFD,wCAEC;AAWD,SAAgB,sBAAsB,CAAmB,EAAE,IAAI,GAAG,KAAK,EAAE,MAAM,EAAE,WAAW,GAAG,EAAE,WAAW,EAAE,8CAAwB,CAAC,SAAS,EAAE,KAAwB,EAAE;IAC1K,MAAM,MAAM,GAAG,IAAA,uDAAiC,EAAI,WAAW,CAAC,CAAC;IACjE,MAAM,CAAC,YAAY,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,mDAAmD;IAE/F,MAAM,SAAS,GAAG,6BAA6B,CAAU;QACvD,MAAM;QACN,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAS,EAAE,MAAS,EAAE,EAAE;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,GAAM,EAAE,EAAE;QAChB,IAAI,IAAI,EAAE;YACR,GAAG,qBACE,GAAG,CACP,CAAC;SACH;QAED,SAAS,CAAC,GAAG,CAAC,CAAC;QAEf,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;AACJ,CAAC;AAtBD,wDAsBC;AAED;;GAEG;AACU,QAAA,mCAAmC,GAAmC,sBAAsB,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;AAE3H,2BAA2B;AAC3B,SAAgB,kBAAkB,CAAmB,MAAS,EAAE,GAAM,EAAE,MAAqC;IAC3G,OAAO,0BAA0B,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AACzD,CAAC;AAFD,gDAEC;AAID,SAAgB,0BAA0B,CAAmB,SAAuC,8CAAwB,CAAC,SAAS;IACpI,MAAM,uBAAuB,GAAG,6BAA6B,CAAO;QAClE,MAAM;QACN,OAAO,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,MAAS,EAAE,MAAS,EAAE,EAAE;YACjD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACtB,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,MAAS,EAAE,GAAM,EAAE,EAAE;QAC3B,uBAAuB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACrC,OAAO,GAAG,CAAC;IACb,CAAC,CAAC;AACJ,CAAC;AAZD,gEAYC;AAED,uBAAuB;AACvB;;GAEG;AACH,SAAgB,cAAc,CAAyC,MAAS,EAAE,SAAuC,8CAAwB,CAAC,SAAS;IACzJ,OAAO,sBAAsB,CAAO,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AACtD,CAAC;AAFD,wCAEC;AASD,SAAgB,sBAAsB,CAAyC,SAAuC,8CAAwB,CAAC,SAAS;IACtJ,MAAM,4BAA4B,GAAG,6BAA6B,CAAsC;QACtG,MAAM;QACN,OAAO,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAsC,EAAE,EAAE;YACrE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;KACF,CAAC,CAAC;IAEH,OAAO,CAAC,GAAM,EAAE,EAAE;QAChB,MAAM,OAAO,GAAqC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACjE,4BAA4B,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC,MAAM,CAAC;IACxB,CAAC,CAAC;AACJ,CAAC;AAbD,wDAaC;AAYD,SAAgB,6BAA6B,CAA6D,EAAE,OAAO,EAAE,MAAM,EAAwC;IACjK,MAAM,eAAe,GAAG,IAAA,kDAA4B,EAAO,MAAM,CAAC,CAAC;IAEnE,OAAO,CAAC,CAAC,GAAM,EAAE,OAAU,EAAE,EAAE;QAC7B,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;QACvC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAwC,CAAC;AAC5C,CAAC;AAPD,sEAOC"}

package/src/lib/object/object.filter.tuple.d.ts

@@ -0,0 +1,64 @@
+import { FilterFunction } from '../filter/filter';
+export declare type ForEachKeyValueTupleFunction<T extends object = object, K extends keyof T = keyof T> = (tuple: KeyValueTuple<T, K>, index: number) => void;
+export interface ForEachKeyValue<T extends object = object, K extends keyof T = keyof T> {
+    filter?: FilterKeyValueTuplesInput<T, K>;
+    forEach: ForEachKeyValueTupleFunction<T, K>;
+}
+export declare function forEachKeyValue<T extends object = object, K extends keyof T = keyof T>(obj: T, { forEach, filter }: ForEachKeyValue<T, K>): void;
+export declare function filterKeyValueTuples<T extends object = object, K extends keyof T = keyof T>(obj: T, filter?: FilterKeyValueTuplesInput<T, K>): KeyValueTuple<T, K>[];
+/**
+ * A Key-Value pair within an Tuple array value.
+ */
+export declare type KeyValueTuple<T extends object = object, K extends keyof T = keyof T> = [K, T[K]];
+export declare type FilterKeyValueTuplesFunction<T extends object = object, K extends keyof T = keyof T> = (obj: T) => KeyValueTuple<T, K>[];
+export declare function filterKeyValueTuplesFunction<T extends object = object, K extends keyof T = keyof T>(filter?: FilterKeyValueTuplesInput<T, K>): FilterKeyValueTuplesFunction<T, K>;
+export declare function allKeyValueTuples<T extends object = object, K extends keyof T = keyof T>(obj: T): KeyValueTuple<T, K>[];
+export declare type FilterKeyValueTuplesInput<T extends object = object, K extends keyof T = keyof T> = KeyValueTypleValueFilter | KeyValueTupleFilter<T, K>;
+export declare enum KeyValueTypleValueFilter {
+    /**
+     * No filter
+     */
+    NONE = 0,
+    /**
+     * Only undefined values.
+     */
+    UNDEFINED = 1,
+    /**
+     * All values that are null or undefined.
+     */
+    NULL = 2,
+    /**
+     * All values that are falsy.
+     */
+    FALSY = 3,
+    /**
+     * All values that are empty.
+     */
+    EMPTY = 4,
+    /**
+     * All values that are empty. Objects that have no keys are considered empty too.
+     */
+    EMPTY_STRICT = 5,
+    /**
+     * All values that are falsy or empty.
+     */
+    FALSY_AND_EMPTY = 6,
+    /**
+     * All values that are falsy or empty or an empty objects.
+     */
+    FALSY_AND_EMPTY_STRICT = 7
+}
+export interface KeyValueTupleFilter<T extends object = object, K extends keyof T = keyof T> {
+    valueFilter?: KeyValueTypleValueFilter;
+    invertFilter?: boolean;
+    keysFilter?: K[];
+}
+/**
+ * Converts an input FilterKeyValueTuplesInput to a KeyValueTupleFilter.
+ *
+ * @param input
+ * @returns
+ */
+export declare function filterKeyValueTuplesInputToFilter<T extends object = object, K extends keyof T = keyof T>(input: FilterKeyValueTuplesInput<T, K>): KeyValueTupleFilter<T, K>;
+export declare type FilterKeyValueTupleFunction<T extends object = object, K extends keyof T = keyof T> = FilterFunction<KeyValueTuple<T, K>>;
+export declare function filterKeyValueTupleFunction<T extends object = object, K extends keyof T = keyof T>(inputFilter: FilterKeyValueTuplesInput<T, K>): FilterKeyValueTupleFunction<T, K>;

package/src/lib/object/object.filter.tuple.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterKeyValueTupleFunction = exports.filterKeyValueTuplesInputToFilter = exports.KeyValueTypleValueFilter = exports.allKeyValueTuples = exports.filterKeyValueTuplesFunction = exports.filterKeyValueTuples = exports.forEachKeyValue = void 0;
+const filter_1 = require("../filter/filter");
+const maybe_1 = require("../value/maybe");
+function forEachKeyValue(obj, { forEach, filter }) {
+    const keyValues = filterKeyValueTuples(obj, filter);
+    keyValues.forEach(forEach);
+}
+exports.forEachKeyValue = forEachKeyValue;
+function filterKeyValueTuples(obj, filter) {
+    return filterKeyValueTuplesFunction(filter)(obj);
+}
+exports.filterKeyValueTuples = filterKeyValueTuples;
+function filterKeyValueTuplesFunction(filter) {
+    if (filter != null) {
+        const filterFn = filterKeyValueTupleFunction(filter);
+        return (obj) => {
+            return allKeyValueTuples(obj).filter(filterFn);
+        };
+    }
+    else {
+        return allKeyValueTuples;
+    }
+}
+exports.filterKeyValueTuplesFunction = filterKeyValueTuplesFunction;
+function allKeyValueTuples(obj) {
+    return Object.entries(obj);
+}
+exports.allKeyValueTuples = allKeyValueTuples;
+var KeyValueTypleValueFilter;
+(function (KeyValueTypleValueFilter) {
+    /**
+     * No filter
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["NONE"] = 0] = "NONE";
+    /**
+     * Only undefined values.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["UNDEFINED"] = 1] = "UNDEFINED";
+    /**
+     * All values that are null or undefined.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["NULL"] = 2] = "NULL";
+    /**
+     * All values that are falsy.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["FALSY"] = 3] = "FALSY";
+    /**
+     * All values that are empty.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["EMPTY"] = 4] = "EMPTY";
+    /**
+     * All values that are empty. Objects that have no keys are considered empty too.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["EMPTY_STRICT"] = 5] = "EMPTY_STRICT";
+    /**
+     * All values that are falsy or empty.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["FALSY_AND_EMPTY"] = 6] = "FALSY_AND_EMPTY";
+    /**
+     * All values that are falsy or empty or an empty objects.
+     */
+    KeyValueTypleValueFilter[KeyValueTypleValueFilter["FALSY_AND_EMPTY_STRICT"] = 7] = "FALSY_AND_EMPTY_STRICT";
+})(KeyValueTypleValueFilter = exports.KeyValueTypleValueFilter || (exports.KeyValueTypleValueFilter = {}));
+/**
+ * Converts an input FilterKeyValueTuplesInput to a KeyValueTupleFilter.
+ *
+ * @param input
+ * @returns
+ */
+function filterKeyValueTuplesInputToFilter(input) {
+    if (typeof input === 'object') {
+        return input;
+    }
+    else {
+        return { valueFilter: input };
+    }
+}
+exports.filterKeyValueTuplesInputToFilter = filterKeyValueTuplesInputToFilter;
+function filterKeyValueTupleFunction(inputFilter) {
+    const filter = filterKeyValueTuplesInputToFilter(inputFilter);
+    const { valueFilter: type, invertFilter: inverseFilter = false, keysFilter } = filter;
+    let filterFn;
+    switch (type) {
+        case KeyValueTypleValueFilter.UNDEFINED:
+            filterFn = ([, x]) => x !== undefined;
+            break;
+        case KeyValueTypleValueFilter.NULL:
+            filterFn = ([, x]) => x != null;
+            break;
+        case KeyValueTypleValueFilter.FALSY:
+            filterFn = ([, x]) => Boolean(x);
+            break;
+        case KeyValueTypleValueFilter.EMPTY:
+            filterFn = ([, x]) => (0, maybe_1.hasValueOrNotEmpty)(x);
+            break;
+        case KeyValueTypleValueFilter.EMPTY_STRICT:
+            filterFn = ([, x]) => (0, maybe_1.hasValueOrNotEmptyObject)(x);
+            break;
+        case KeyValueTypleValueFilter.FALSY_AND_EMPTY:
+            filterFn = ([, x]) => Boolean(x) && (0, maybe_1.hasValueOrNotEmpty)(x);
+            break;
+        case KeyValueTypleValueFilter.FALSY_AND_EMPTY_STRICT:
+            filterFn = ([, x]) => Boolean(x) && (0, maybe_1.hasValueOrNotEmptyObject)(x);
+            break;
+        case KeyValueTypleValueFilter.NONE:
+        default:
+            filterFn = () => true;
+            break;
+    }
+    if (keysFilter) {
+        const filterByTypeFn = filterFn;
+        const keysSet = new Set(keysFilter);
+        filterFn = (x, i) => filterByTypeFn(x, i) && keysSet.has(x[0]);
+    }
+    return (0, filter_1.invertFilter)(filterFn, inverseFilter);
+}
+exports.filterKeyValueTupleFunction = filterKeyValueTupleFunction;
+//# sourceMappingURL=object.filter.tuple.js.map

package/src/lib/object/object.filter.tuple.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.filter.tuple.js","sourceRoot":"","sources":["../../../../../../packages/util/src/lib/object/object.filter.tuple.ts"],"names":[],"mappings":";;;AAAA,6CAAgE;AAChE,0CAA8E;AAU9E,SAAgB,eAAe,CAAyD,GAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAyB;IACxI,MAAM,SAAS,GAAG,oBAAoB,CAAO,GAAG,EAAE,MAAM,CAAC,CAAC;IAC1D,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC7B,CAAC;AAHD,0CAGC;AAED,SAAgB,oBAAoB,CAAyD,GAAM,EAAE,MAAwC;IAC3I,OAAO,4BAA4B,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC;AAFD,oDAEC;AAUD,SAAgB,4BAA4B,CAAyD,MAAwC;IAC3I,IAAI,MAAM,IAAI,IAAI,EAAE;QAClB,MAAM,QAAQ,GAAG,2BAA2B,CAAO,MAAM,CAAC,CAAC;QAE3D,OAAO,CAAC,GAAM,EAAE,EAAE;YAChB,OAAQ,iBAAiB,CAAC,GAAG,CAA2B,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC5E,CAAC,CAAC;KACH;SAAM;QACL,OAAO,iBAAiB,CAAC;KAC1B;AACH,CAAC;AAVD,oEAUC;AAED,SAAgB,iBAAiB,CAAyD,GAAM;IAC9F,OAAO,MAAM,CAAC,OAAO,CAAC,GAAG,CAA0B,CAAC;AACtD,CAAC;AAFD,8CAEC;AAID,IAAY,wBAiCX;AAjCD,WAAY,wBAAwB;IAClC;;OAEG;IACH,uEAAQ,CAAA;IACR;;OAEG;IACH,iFAAa,CAAA;IACb;;OAEG;IACH,uEAAQ,CAAA;IACR;;OAEG;IACH,yEAAS,CAAA;IACT;;OAEG;IACH,yEAAS,CAAA;IACT;;OAEG;IACH,uFAAgB,CAAA;IAChB;;OAEG;IACH,6FAAmB,CAAA;IACnB;;OAEG;IACH,2GAA0B,CAAA;AAC5B,CAAC,EAjCW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAiCnC;AAQD;;;;;GAKG;AACH,SAAgB,iCAAiC,CAAyD,KAAsC;IAC9I,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAO,KAAK,CAAC;KACd;SAAM;QACL,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;KAC/B;AACH,CAAC;AAND,8EAMC;AAID,SAAgB,2BAA2B,CAAyD,WAA4C;IAC9I,MAAM,MAAM,GAAG,iCAAiC,CAAC,WAAW,CAAC,CAAC;IAC9D,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE,aAAa,GAAG,KAAK,EAAE,UAAU,EAAE,GAA8B,MAAM,CAAC;IAEjH,IAAI,QAA2C,CAAC;IAEhD,QAAQ,IAAI,EAAE;QACZ,KAAK,wBAAwB,CAAC,SAAS;YACrC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;YACtC,MAAM;QACR,KAAK,wBAAwB,CAAC,IAAI;YAChC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC;YAChC,MAAM;QACR,KAAK,wBAAwB,CAAC,KAAK;YACjC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YACjC,MAAM;QACR,KAAK,wBAAwB,CAAC,KAAK;YACjC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,0BAAkB,EAAC,CAAC,CAAC,CAAC;YAC5C,MAAM;QACR,KAAK,wBAAwB,CAAC,YAAY;YACxC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,gCAAwB,EAAC,CAAC,CAAC,CAAC;YAClD,MAAM;QACR,KAAK,wBAAwB,CAAC,eAAe;YAC3C,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAA,0BAAkB,EAAC,CAAC,CAAC,CAAC;YAC1D,MAAM;QACR,KAAK,wBAAwB,CAAC,sBAAsB;YAClD,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,IAAA,gCAAwB,EAAC,CAAC,CAAC,CAAC;YAChE,MAAM;QACR,KAAK,wBAAwB,CAAC,IAAI,CAAC;QACnC;YACE,QAAQ,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC;YACtB,MAAM;KACT;IAED,IAAI,UAAU,EAAE;QACd,MAAM,cAAc,GAAG,QAA6C,CAAC;QACrE,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;QACpC,QAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;KAChE;IAED,OAAO,IAAA,qBAAY,EAAyD,QAAQ,EAAE,aAAa,CAAC,CAAC;AACvG,CAAC;AAzCD,kEAyCC"}

package/src/lib/object/object.js

@@ -1,9 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.overrideInObject = exports.mergeObjects = exports.objectIsEmpty = exports.filterKeyValueTupleFunction = exports.filterKeyValueTuples = exports.forEachKeyValue = exports.KeyValueTypleValueFilter = exports.allKeyValueTuples = exports.valuesFromPOJO = exports.assignValuesToPOJO = exports.filterFromPOJO = exports.countPOJOKeys = exports.findPOJOKeys = exports.allMaybeSoKeys = exports.allNonUndefinedKeys = exports.filterUndefinedValues = exports.filterNullAndUndefinedValues = exports.mapToObject = exports.applyToMultipleFields = exports.objectHasKey = exports.objectHasNoKeys = void 0;
-const maybe_1 = require("../value/maybe");
-const array_value_1 = require("../array/array.value");
-const filter_1 = require("../filter/filter");
+exports.copyObject = exports.mapToObject = exports.applyToMultipleFields = exports.objectHasKey = exports.objectHasNoKeys = void 0;
 function objectHasNoKeys(obj) {
     return Object.keys(obj).length === 0;
 }
@@ -29,228 +26,13 @@ function mapToObject(map) {
 }
 exports.mapToObject = mapToObject;
 /**
- * Returns a copy of the input object with all null and undefined values filtered from it.
+ * Creates a shallow copy of an object using the spread operator.
  *
- * @param obj
+ * @param input
  * @returns
  */
-function filterNullAndUndefinedValues(obj) {
-    return filterUndefinedValues(obj, true);
+function copyObject(input) {
+    return Object.assign({}, input);
 }
-exports.filterNullAndUndefinedValues = filterNullAndUndefinedValues;
-/**
- * Returns a copy of the input object with all undefined values filtered from it.
- *
- * @param obj
- * @returns
- */
-function filterUndefinedValues(obj, filterNull = false) {
-    return filterFromPOJO(obj, { copy: true, filter: { valueFilter: filterNull ? KeyValueTypleValueFilter.NULL : KeyValueTypleValueFilter.UNDEFINED } });
-}
-exports.filterUndefinedValues = filterUndefinedValues;
-/**
- * Returns all keys that are not associated with an undefined value.
- *
- * @param obj
- * @returns
- */
-function allNonUndefinedKeys(obj) {
-    return findPOJOKeys(obj, { valueFilter: KeyValueTypleValueFilter.UNDEFINED });
-}
-exports.allNonUndefinedKeys = allNonUndefinedKeys;
-function allMaybeSoKeys(obj) {
-    return findPOJOKeys(obj, { valueFilter: KeyValueTypleValueFilter.NULL });
-}
-exports.allMaybeSoKeys = allMaybeSoKeys;
-/**
- * Finds keys from the POJO that meet the filter.
- *
- * @param obj
- * @param filter
- * @returns
- */
-function findPOJOKeys(obj, filter) {
-    const keys = [];
-    forEachKeyValue(obj, {
-        filter,
-        forEach: ([key]) => {
-            keys.push(key);
-        }
-    });
-    return keys;
-}
-exports.findPOJOKeys = findPOJOKeys;
-/**
- * Finds and counts the number of keys from the POJO that meet the filter.
- *
- * @param obj
- * @param filter
- * @returns
- */
-function countPOJOKeys(obj, filter = KeyValueTypleValueFilter.UNDEFINED) {
-    let count = 0;
-    forEachKeyValue(obj, {
-        filter,
-        forEach: () => (count += 1)
-    });
-    return count;
-}
-exports.countPOJOKeys = countPOJOKeys;
-/**
- * Removes values, per the the filter config, from the input object.
- *
- * @param obj POJO to remove undefined values from.
- * @param copy Whether or not to return a copy of the input object. Default is true.
- */
-function filterFromPOJO(obj, { copy = false, filter = { valueFilter: KeyValueTypleValueFilter.UNDEFINED } } = {}) {
-    if (copy) {
-        obj = Object.assign({}, obj);
-    }
-    forEachKeyValue(obj, {
-        filter: Object.assign(Object.assign({}, filter), { invertFilter: !filter.invertFilter }),
-        forEach: ([key]) => {
-            delete obj[key];
-        }
-    });
-    return obj;
-}
-exports.filterFromPOJO = filterFromPOJO;
-function assignValuesToPOJO(target, obj, filter = KeyValueTypleValueFilter.UNDEFINED) {
-    forEachKeyValue(obj, {
-        filter,
-        forEach: ([key, value]) => {
-            target[key] = value;
-        }
-    });
-    return obj;
-}
-exports.assignValuesToPOJO = assignValuesToPOJO;
-/**
- * Reads all values from the pojo based on the filter and puts them into an array.
- *
- * @param target
- * @param filter
- * @returns
- */
-function valuesFromPOJO(target, filter = KeyValueTypleValueFilter.UNDEFINED) {
-    const values = [];
-    forEachKeyValue(target, {
-        filter,
-        forEach: ([, value]) => {
-            values.push(value);
-        }
-    });
-    return values;
-}
-exports.valuesFromPOJO = valuesFromPOJO;
-function allKeyValueTuples(obj) {
-    return Object.entries(obj);
-}
-exports.allKeyValueTuples = allKeyValueTuples;
-var KeyValueTypleValueFilter;
-(function (KeyValueTypleValueFilter) {
-    /**
-     * No filter
-     */
-    KeyValueTypleValueFilter[KeyValueTypleValueFilter["NONE"] = 0] = "NONE";
-    /**
-     * Only undefined values.
-     */
-    KeyValueTypleValueFilter[KeyValueTypleValueFilter["UNDEFINED"] = 1] = "UNDEFINED";
-    /**
-     * All values that are null or undefined.
-     */
-    KeyValueTypleValueFilter[KeyValueTypleValueFilter["NULL"] = 2] = "NULL";
-    /**
-     * All values that are falsy.
-     */
-    KeyValueTypleValueFilter[KeyValueTypleValueFilter["FALSY"] = 3] = "FALSY";
-})(KeyValueTypleValueFilter = exports.KeyValueTypleValueFilter || (exports.KeyValueTypleValueFilter = {}));
-function forEachKeyValue(obj, { forEach, filter }) {
-    const keyValues = filterKeyValueTuples(obj, filter);
-    keyValues.forEach(forEach);
-}
-exports.forEachKeyValue = forEachKeyValue;
-function filterKeyValueTuples(obj, filter) {
-    let pairs = allKeyValueTuples(obj);
-    if (filter) {
-        const filterFn = filterKeyValueTupleFunction(filter);
-        pairs = pairs.filter(filterFn);
-    }
-    return pairs;
-}
-exports.filterKeyValueTuples = filterKeyValueTuples;
-function filterKeyValueTupleFunction(input) {
-    const filter = typeof input === 'object' ? input : { valueFilter: input };
-    const { valueFilter: type, invertFilter: inverseFilter = false, keysFilter } = filter;
-    let filterFn;
-    switch (type) {
-        case KeyValueTypleValueFilter.UNDEFINED:
-            filterFn = ([, x]) => x !== undefined;
-            break;
-        case KeyValueTypleValueFilter.NULL:
-            filterFn = ([, x]) => x != null;
-            break;
-        case KeyValueTypleValueFilter.FALSY:
-            filterFn = ([, x]) => Boolean(x);
-            break;
-        case KeyValueTypleValueFilter.NONE:
-        default:
-            filterFn = () => true;
-            break;
-    }
-    if (keysFilter) {
-        const filterByTypeFn = filterFn;
-        const keysSet = new Set(keysFilter);
-        filterFn = (x, i) => filterByTypeFn(x, i) && keysSet.has(x[0]);
-    }
-    return (0, filter_1.invertFilter)(filterFn, inverseFilter);
-}
-exports.filterKeyValueTupleFunction = filterKeyValueTupleFunction;
-/**
- * Recursively function that returns true if the input is not an object or if every key on the object is empty.
- *
- * @param obj
- */
-function objectIsEmpty(obj) {
-    if (obj != null && typeof obj === 'object') {
-        const keys = Object.keys(obj);
-        if (keys.length > 0) {
-            for (let i = 0; i < keys.length; i += 1) {
-                const key = keys[i];
-                const value = obj[key];
-                const isEmpty = typeof obj === 'object' ? objectIsEmpty(value) : !(0, maybe_1.hasValueOrNotEmpty)(value);
-                if (!isEmpty) {
-                    return false;
-                }
-            }
-        }
-    }
-    return true;
-}
-exports.objectIsEmpty = objectIsEmpty;
-/**
- * Merges all input objects into one. The order of overrides is kept, so the right-most item in the array will have priority over all objects before it.
- *
- * @param objects
- */
-function mergeObjects(objects, filter) {
-    const object = {};
-    overrideInObject(object, { from: (0, array_value_1.filterMaybeValues)(objects), filter });
-    return object;
-}
-exports.mergeObjects = mergeObjects;
-/**
- * Assigns all undefined valeus from one or more objects into the target object.
- *
- * @param object
- */
-function overrideInObject(target, { from, filter }) {
-    from.forEach((x) => {
-        const relevantValues = filterFromPOJO(Object.assign({}, x), { filter, copy: false });
-        Object.assign(target, relevantValues);
-    });
-    return target;
-}
-exports.overrideInObject = overrideInObject;
+exports.copyObject = copyObject;
 //# sourceMappingURL=object.js.map