@augment-vir/common 27.0.0 → 28.0.0

package/dist/cjs/augments/json.js

@@ -1,20 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stringifyJson = exports.parseJson = void 0;
-const run_time_assertions_1 = require("run-time-assertions");
-const matches_object_shape_1 = require("./object/matches-object-shape");
 const wrap_in_try_1 = require("./wrap-in-try");
-function parseJson({ jsonString, errorHandler, shapeMatcher, }) {
+function parseJson({ jsonString, errorHandler, }) {
     try {
         const parsedJson = JSON.parse(jsonString);
-        if (shapeMatcher != undefined) {
-            if ((0, run_time_assertions_1.isRunTimeType)(shapeMatcher, 'object')) {
-                (0, matches_object_shape_1.assertMatchesObjectShape)(parsedJson, shapeMatcher);
-            }
-            else {
-                (0, run_time_assertions_1.assertRunTimeType)(parsedJson, (0, run_time_assertions_1.getRunTimeType)(shapeMatcher), 'parsedJson');
-            }
-        }
         return parsedJson;
     }
     catch (error) {

package/dist/cjs/augments/object/merge-property-arrays.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergePropertyArrays = void 0;
+const get_or_set_1 = require("./get-or-set");
+function mergePropertyArrays(...inputs) {
+    const combined = {};
+    inputs.forEach((input) => {
+        Object.entries(input).forEach(([key, newArray,]) => {
+            const currentArray = (0, get_or_set_1.getOrSet)(combined, key, () => []);
+            currentArray.push(...newArray);
+        });
+    });
+    return combined;
+}
+exports.mergePropertyArrays = mergePropertyArrays;

package/dist/cjs/index.js

@@ -35,8 +35,8 @@ __exportStar(require("./augments/object/get-or-set"), exports);
 __exportStar(require("./augments/object/has-key"), exports);
 __exportStar(require("./augments/object/jsonify"), exports);
 __exportStar(require("./augments/object/map-object"), exports);
-__exportStar(require("./augments/object/matches-object-shape"), exports);
 __exportStar(require("./augments/object/merge-deep"), exports);
+__exportStar(require("./augments/object/merge-property-arrays"), exports);
 __exportStar(require("./augments/object/nested-keys"), exports);
 __exportStar(require("./augments/object/object"), exports);
 __exportStar(require("./augments/object/object-entries"), exports);

package/dist/esm/augments/json.js

@@ -1,17 +1,7 @@
-import { assertRunTimeType, getRunTimeType, isRunTimeType } from 'run-time-assertions';
-import { assertMatchesObjectShape } from './object/matches-object-shape';
 import { wrapInTry } from './wrap-in-try';
-export function parseJson({ jsonString, errorHandler, shapeMatcher, }) {
+export function parseJson({ jsonString, errorHandler, }) {
     try {
         const parsedJson = JSON.parse(jsonString);
-        if (shapeMatcher != undefined) {
-            if (isRunTimeType(shapeMatcher, 'object')) {
-                assertMatchesObjectShape(parsedJson, shapeMatcher);
-            }
-            else {
-                assertRunTimeType(parsedJson, getRunTimeType(shapeMatcher), 'parsedJson');
-            }
-        }
         return parsedJson;
     }
     catch (error) {

package/dist/esm/augments/object/merge-property-arrays.js

@@ -0,0 +1,11 @@
+import { getOrSet } from './get-or-set';
+export function mergePropertyArrays(...inputs) {
+    const combined = {};
+    inputs.forEach((input) => {
+        Object.entries(input).forEach(([key, newArray,]) => {
+            const currentArray = getOrSet(combined, key, () => []);
+            currentArray.push(...newArray);
+        });
+    });
+    return combined;
+}

package/dist/esm/index.js

@@ -19,8 +19,8 @@ export * from './augments/object/get-or-set';
 export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
-export * from './augments/object/matches-object-shape';
 export * from './augments/object/merge-deep';
+export * from './augments/object/merge-property-arrays';
 export * from './augments/object/nested-keys';
 export * from './augments/object/object';
 export * from './augments/object/object-entries';

package/dist/types/augments/json.d.ts

@@ -1,9 +1,8 @@
 import { JsonCompatibleValue } from './json-compatible';
 import { WrapInTryOptions } from './wrap-in-try';
-export declare function parseJson<ParsedJsonGeneric>({ jsonString, errorHandler, shapeMatcher, }: {
+export declare function parseJson<ParsedJsonGeneric>({ jsonString, errorHandler, }: {
     jsonString: string;
     errorHandler?: (error: unknown) => never | ParsedJsonGeneric;
-    shapeMatcher?: ParsedJsonGeneric;
 }): ParsedJsonGeneric;
 export declare function stringifyJson(jsonValue: JsonCompatibleValue, { whitespace, ...tryOptions }?: {
     whitespace?: number;

package/dist/types/augments/object/merge-property-arrays.d.ts

@@ -0,0 +1 @@
+export declare function mergePropertyArrays<T extends Record<PropertyKey, unknown[]>>(...inputs: ReadonlyArray<Readonly<T>>): T;

package/dist/types/index.d.ts

@@ -19,8 +19,8 @@ export * from './augments/object/get-or-set';
 export * from './augments/object/has-key';
 export * from './augments/object/jsonify';
 export * from './augments/object/map-object';
-export * from './augments/object/matches-object-shape';
 export * from './augments/object/merge-deep';
+export * from './augments/object/merge-property-arrays';
 export * from './augments/object/nested-keys';
 export * from './augments/object/object';
 export * from './augments/object/object-entries';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "27.0.0",
+    "version": "28.0.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"

package/dist/cjs/augments/object/matches-object-shape.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertMatchesObjectShape = exports.matchesObjectShape = void 0;
-const boolean_1 = require("../boolean");
-const error_1 = require("../error");
-const object_1 = require("./object");
-const object_entries_1 = require("./object-entries");
-const typed_has_property_1 = require("./typed-has-property");
-/**
- * Checks that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-function matchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, shouldLogWhy = false) {
-    try {
-        assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps);
-        return true;
-    }
-    catch (error) {
-        if (shouldLogWhy) {
-            console.error(error);
-        }
-        return false;
-    }
-}
-exports.matchesObjectShape = matchesObjectShape;
-/**
- * Asserts that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, noCheckInnerValueOfTheseKeys = {}) {
-    const testKeys = (0, object_entries_1.getObjectTypedKeys)(testThisOne);
-    const matchKeys = new Set((0, object_entries_1.getObjectTypedKeys)(compareToThisOne));
-    if (!allowExtraProps) {
-        const extraKeys = testKeys.filter((testKey) => !matchKeys.has(testKey));
-        if (extraKeys.length) {
-            throw new Error(`Test object has extra keys: ${extraKeys.join(', ')}`);
-        }
-    }
-    matchKeys.forEach((key) => {
-        if (!(0, typed_has_property_1.typedHasProperty)(testThisOne, key)) {
-            throw new Error(`test object does not have key "${String(key)}" from expected shape.`);
-        }
-        function throwKeyError(reason) {
-            throw new Error(`test object value at key "${String(key)}" did not match expected shape: ${reason}`);
-        }
-        const testValue = testThisOne[key];
-        const shouldMatch = compareToThisOne[key];
-        if (!noCheckInnerValueOfTheseKeys[key]) {
-            compareInnerValue(testValue, shouldMatch, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys[key] ?? {});
-        }
-    });
-}
-exports.assertMatchesObjectShape = assertMatchesObjectShape;
-function compareInnerValue(testValue, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys) {
-    const testType = typeof testValue;
-    const shouldMatchType = typeof matchValue;
-    if (testType !== shouldMatchType) {
-        throwKeyError(`type "${testType}" did not match expected type "${shouldMatchType}"`);
-    }
-    try {
-        if ((0, typed_has_property_1.typedHasProperty)(matchValue, 'constructor')) {
-            if (!(0, typed_has_property_1.typedHasProperty)(testValue, 'constructor') ||
-                testValue.constructor !== matchValue.constructor) {
-                throwKeyError(`constructor "${testValue?.constructor?.name}" did not match expected constructor "${matchValue.constructor}"`);
-            }
-        }
-    }
-    catch (error) {
-        // ignore errors from trying to find the constructor
-        if (error instanceof throwKeyError) {
-            throw error;
-        }
-    }
-    if (Array.isArray(matchValue)) {
-        if (!Array.isArray(testValue)) {
-            throwKeyError(`expected an array`);
-        }
-        testValue.forEach((testValueEntry, index) => {
-            const errors = matchValue
-                .map((matchValue) => {
-                try {
-                    compareInnerValue(testValueEntry, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys);
-                    return undefined;
-                }
-                catch (error) {
-                    return new Error(`entry at index "${index}" did not match expected shape: ${(0, error_1.extractErrorMessage)(error)}`);
-                }
-            })
-                .filter(boolean_1.isTruthy);
-            if (errors.length === matchValue.length) {
-                throw new Error(`entry at index "${index}" did not match any of the possible types from "${matchValue.join(', ')}"`);
-            }
-        });
-    }
-    else if ((0, object_1.isObject)(matchValue)) {
-        assertMatchesObjectShape(testValue, matchValue, allowExtraProps, noCheckInnerValueOfTheseKeys);
-    }
-}

package/dist/esm/augments/object/matches-object-shape.js

@@ -1,111 +0,0 @@
-import { isTruthy } from '../boolean';
-import { extractErrorMessage } from '../error';
-import { isObject } from './object';
-import { getObjectTypedKeys } from './object-entries';
-import { typedHasProperty } from './typed-has-property';
-/**
- * Checks that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-export function matchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, shouldLogWhy = false) {
-    try {
-        assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps);
-        return true;
-    }
-    catch (error) {
-        if (shouldLogWhy) {
-            console.error(error);
-        }
-        return false;
-    }
-}
-/**
- * Asserts that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-export function assertMatchesObjectShape(testThisOne, compareToThisOne, allowExtraProps = false, noCheckInnerValueOfTheseKeys = {}) {
-    const testKeys = getObjectTypedKeys(testThisOne);
-    const matchKeys = new Set(getObjectTypedKeys(compareToThisOne));
-    if (!allowExtraProps) {
-        const extraKeys = testKeys.filter((testKey) => !matchKeys.has(testKey));
-        if (extraKeys.length) {
-            throw new Error(`Test object has extra keys: ${extraKeys.join(', ')}`);
-        }
-    }
-    matchKeys.forEach((key) => {
-        if (!typedHasProperty(testThisOne, key)) {
-            throw new Error(`test object does not have key "${String(key)}" from expected shape.`);
-        }
-        function throwKeyError(reason) {
-            throw new Error(`test object value at key "${String(key)}" did not match expected shape: ${reason}`);
-        }
-        const testValue = testThisOne[key];
-        const shouldMatch = compareToThisOne[key];
-        if (!noCheckInnerValueOfTheseKeys[key]) {
-            compareInnerValue(testValue, shouldMatch, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys[key] ?? {});
-        }
-    });
-}
-function compareInnerValue(testValue, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys) {
-    const testType = typeof testValue;
-    const shouldMatchType = typeof matchValue;
-    if (testType !== shouldMatchType) {
-        throwKeyError(`type "${testType}" did not match expected type "${shouldMatchType}"`);
-    }
-    try {
-        if (typedHasProperty(matchValue, 'constructor')) {
-            if (!typedHasProperty(testValue, 'constructor') ||
-                testValue.constructor !== matchValue.constructor) {
-                throwKeyError(`constructor "${testValue?.constructor?.name}" did not match expected constructor "${matchValue.constructor}"`);
-            }
-        }
-    }
-    catch (error) {
-        // ignore errors from trying to find the constructor
-        if (error instanceof throwKeyError) {
-            throw error;
-        }
-    }
-    if (Array.isArray(matchValue)) {
-        if (!Array.isArray(testValue)) {
-            throwKeyError(`expected an array`);
-        }
-        testValue.forEach((testValueEntry, index) => {
-            const errors = matchValue
-                .map((matchValue) => {
-                try {
-                    compareInnerValue(testValueEntry, matchValue, throwKeyError, allowExtraProps, noCheckInnerValueOfTheseKeys);
-                    return undefined;
-                }
-                catch (error) {
-                    return new Error(`entry at index "${index}" did not match expected shape: ${extractErrorMessage(error)}`);
-                }
-            })
-                .filter(isTruthy);
-            if (errors.length === matchValue.length) {
-                throw new Error(`entry at index "${index}" did not match any of the possible types from "${matchValue.join(', ')}"`);
-            }
-        });
-    }
-    else if (isObject(matchValue)) {
-        assertMatchesObjectShape(testValue, matchValue, allowExtraProps, noCheckInnerValueOfTheseKeys);
-    }
-}

package/dist/types/augments/object/matches-object-shape.d.ts

@@ -1,36 +0,0 @@
-import { AtLeastOneEntryArray } from '../array/array';
-import { NoInfer } from '../type';
-/**
- * Checks that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-export declare function matchesObjectShape<MatchThisGeneric extends object>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean, shouldLogWhy?: boolean): testThisOne is MatchThisGeneric;
-export type ObjectWithAtLeastSingleEntryArrays<BaseObject extends object> = {
-    [Prop in keyof BaseObject]: BaseObject[Prop] extends ReadonlyArray<any> ? AtLeastOneEntryArray<BaseObject[Prop]> : BaseObject[Prop] extends object ? ObjectWithAtLeastSingleEntryArrays<BaseObject[Prop]> : BaseObject[Prop];
-};
-export type NestedBoolean<MatchObject extends object> = Partial<{
-    [Prop in keyof MatchObject]: MatchObject[Prop] extends object ? NestedBoolean<MatchObject[Prop]> | boolean : boolean;
-}>;
-/**
- * Asserts that the first input, testThisOne, matches the object shape of the second input,
- * compareToThisOne. Does not compare exact values of properties, only types.
- *
- * To allow the test input, the first input, to have additional keys that the compare input, the
- * second input, does not have, pass in a third argument set to true.
- *
- * This function REQUIRES a generic to be assigned to it: it cannot infer it from the inputs.
- *
- * The compare input, the second input, is required to have at least one entry in every array value
- * that exists. If more array values are present, they will be considered other possible types for
- * entries in that array.
- */
-export declare function assertMatchesObjectShape<MatchThisGeneric extends object = never>(testThisOne: unknown, compareToThisOne: NoInfer<ObjectWithAtLeastSingleEntryArrays<MatchThisGeneric>>, allowExtraProps?: boolean, noCheckInnerValueOfTheseKeys?: NestedBoolean<typeof compareToThisOne>): asserts testThisOne is MatchThisGeneric;