@augment-vir/common 21.6.1 → 22.0.0

package/dist/cjs/augments/json.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.areJsonEqual = exports.stringifyJson = exports.parseJson = void 0;
+const run_time_assertions_1 = require("run-time-assertions");
 const error_1 = require("./error");
 const matches_object_shape_1 = require("./object/matches-object-shape");
 const object_1 = require("./object/object");
-const runtime_type_of_1 = require("./runtime-type-of");
 function parseJson({ jsonString, errorHandler, shapeMatcher, }) {
     try {
         const parsedJson = JSON.parse(jsonString);
         if (shapeMatcher != undefined) {
-            if ((0, runtime_type_of_1.isRuntimeTypeOf)(shapeMatcher, 'object')) {
+            if ((0, run_time_assertions_1.isRunTimeType)(shapeMatcher, 'object')) {
                 (0, matches_object_shape_1.assertMatchesObjectShape)(parsedJson, shapeMatcher);
             }
             else {
-                (0, runtime_type_of_1.assertRuntimeTypeOf)(parsedJson, (0, runtime_type_of_1.getRuntimeTypeOf)(shapeMatcher), 'parsedJson');
+                (0, run_time_assertions_1.assertRunTimeType)(parsedJson, (0, run_time_assertions_1.getRunTimeType)(shapeMatcher), 'parsedJson');
             }
         }
         return parsedJson;

package/dist/cjs/augments/object/merge-deep.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeDeep = void 0;
-const runtime_type_of_1 = require("../runtime-type-of");
+const run_time_assertions_1 = require("run-time-assertions");
 const tuple_1 = require("../tuple");
 const object_1 = require("./object");
 /**
- * Accepts multiple objects and merges their key-value pairs recursively.
+ * Accepts multiple objects and merges their key-value pairs recursively. Any values set to
+ * undefined will be removed.
  *
  * Note that order matters! Each input object will overwrite the properties of the previous objects.
  */
@@ -28,22 +29,13 @@ function mergeDeep(...inputs) {
                 return;
             }
             Object.entries(individualInput).forEach(([key, value,]) => {
-                const mergePropsArray = mergeProps[key] || [];
                 if (!mergeProps[key]) {
-                    mergeProps[key] = mergePropsArray;
+                    mergeProps[key] = [];
                 }
-                mergePropsArray.push(value);
+                mergeProps[key].push(value);
             });
-            if (result) {
-                if ((0, runtime_type_of_1.isRuntimeTypeOf)(result, 'object')) {
-                    result = {
-                        ...result,
-                        ...individualInput,
-                    };
-                }
-            }
-            else {
-                if ((0, runtime_type_of_1.isRuntimeTypeOf)(individualInput, 'array')) {
+            if (!result) {
+                if ((0, run_time_assertions_1.isRunTimeType)(individualInput, 'array')) {
                     result = [...individualInput];
                 }
                 else {
@@ -56,8 +48,17 @@ function mergeDeep(...inputs) {
         }
     });
     Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
-        result[key] = mergeDeep(...mergeValues);
+        const newValue = mergeDeep(...mergeValues);
+        if (newValue === undefined && key in result) {
+            delete result[key];
+        }
+        else if (newValue !== undefined) {
+            result[key] = newValue;
+        }
     });
+    if ((0, run_time_assertions_1.isRunTimeType)(result, 'array')) {
+        result = result.filter((entry) => entry !== undefined);
+    }
     return result;
 }
 exports.mergeDeep = mergeDeep;

package/dist/cjs/augments/object/nested-keys.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getValueFromNestedKeys = exports.setValueWithNestedKeys = void 0;
-const runtime_type_of_1 = require("../runtime-type-of");
+const run_time_assertions_1 = require("run-time-assertions");
 const object_1 = require("./object");
 const typed_has_property_1 = require("./typed-has-property");
 function setValueWithNestedKeys(originalObject, nestedKeys, value) {
@@ -12,7 +12,7 @@ function setValueWithNestedKeys(originalObject, nestedKeys, value) {
      */
     const nestedKeysInput = nestedKeys;
     const inputObject = originalObject;
-    if ((0, runtime_type_of_1.isRuntimeTypeOf)(inputObject, 'array')) {
+    if ((0, run_time_assertions_1.isRunTimeType)(inputObject, 'array')) {
         inputObject.forEach((entry) => {
             if ((0, object_1.isObject)(entry)) {
                 setValueWithNestedKeys(entry, nestedKeysInput, value);
@@ -44,7 +44,7 @@ function getValueFromNestedKeys(originalObject, nestedKeys) {
      */
     const nestedKeysInput = nestedKeys;
     const inputObject = originalObject;
-    if ((0, runtime_type_of_1.isRuntimeTypeOf)(inputObject, 'array')) {
+    if ((0, run_time_assertions_1.isRunTimeType)(inputObject, 'array')) {
         return inputObject.map((entry) => getValueFromNestedKeys(entry, nestedKeys));
     }
     const keyToAccess = nestedKeysInput[0];

package/dist/cjs/augments/string/search-params.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.urlToSearchParamsObject = exports.objectToSearchParamsString = void 0;
+const run_time_assertions_1 = require("run-time-assertions");
 const boolean_1 = require("../boolean");
 const common_string_1 = require("../common-string");
 const matches_object_shape_1 = require("../object/matches-object-shape");
-const runtime_type_of_1 = require("../runtime-type-of");
 const prefixes_1 = require("./prefixes");
 function objectToSearchParamsString(inputObject) {
     const valueStrings = Object.entries(inputObject)
@@ -41,7 +41,7 @@ function splitSearchString(searchString) {
     return paramEntries;
 }
 function urlToSearchParamsObject(inputUrl, verifyShape) {
-    const ensuredUrl = (0, runtime_type_of_1.isRuntimeTypeOf)(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
+    const ensuredUrl = (0, run_time_assertions_1.isRunTimeType)(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
     const searchEntries = splitSearchString(ensuredUrl.search);
     const paramsObject = Object.fromEntries(searchEntries);
     if (verifyShape) {

package/dist/cjs/index.js

@@ -44,7 +44,6 @@ __exportStar(require("./augments/promise/promise"), exports);
 __exportStar(require("./augments/promise/wait"), exports);
 __exportStar(require("./augments/random"), exports);
 __exportStar(require("./augments/regexp"), exports);
-__exportStar(require("./augments/runtime-type-of"), exports);
 __exportStar(require("./augments/string/prefixes"), exports);
 __exportStar(require("./augments/string/search-params"), exports);
 __exportStar(require("./augments/string/suffixes"), exports);

package/dist/esm/augments/json.js

@@ -1,16 +1,16 @@
+import { assertRunTimeType, getRunTimeType, isRunTimeType } from 'run-time-assertions';
 import { ensureError } from './error';
 import { assertMatchesObjectShape } from './object/matches-object-shape';
 import { isObject } from './object/object';
-import { assertRuntimeTypeOf, getRuntimeTypeOf, isRuntimeTypeOf } from './runtime-type-of';
 export function parseJson({ jsonString, errorHandler, shapeMatcher, }) {
     try {
         const parsedJson = JSON.parse(jsonString);
         if (shapeMatcher != undefined) {
-            if (isRuntimeTypeOf(shapeMatcher, 'object')) {
+            if (isRunTimeType(shapeMatcher, 'object')) {
                 assertMatchesObjectShape(parsedJson, shapeMatcher);
             }
             else {
-                assertRuntimeTypeOf(parsedJson, getRuntimeTypeOf(shapeMatcher), 'parsedJson');
+                assertRunTimeType(parsedJson, getRunTimeType(shapeMatcher), 'parsedJson');
             }
         }
         return parsedJson;

package/dist/esm/augments/object/merge-deep.js

@@ -1,8 +1,9 @@
-import { isRuntimeTypeOf } from '../runtime-type-of';
+import { isRunTimeType } from 'run-time-assertions';
 import { isLengthAtLeast } from '../tuple';
 import { isObject } from './object';
 /**
- * Accepts multiple objects and merges their key-value pairs recursively.
+ * Accepts multiple objects and merges their key-value pairs recursively. Any values set to
+ * undefined will be removed.
  *
  * Note that order matters! Each input object will overwrite the properties of the previous objects.
  */
@@ -25,22 +26,13 @@ export function mergeDeep(...inputs) {
                 return;
             }
             Object.entries(individualInput).forEach(([key, value,]) => {
-                const mergePropsArray = mergeProps[key] || [];
                 if (!mergeProps[key]) {
-                    mergeProps[key] = mergePropsArray;
+                    mergeProps[key] = [];
                 }
-                mergePropsArray.push(value);
+                mergeProps[key].push(value);
             });
-            if (result) {
-                if (isRuntimeTypeOf(result, 'object')) {
-                    result = {
-                        ...result,
-                        ...individualInput,
-                    };
-                }
-            }
-            else {
-                if (isRuntimeTypeOf(individualInput, 'array')) {
+            if (!result) {
+                if (isRunTimeType(individualInput, 'array')) {
                     result = [...individualInput];
                 }
                 else {
@@ -53,7 +45,16 @@ export function mergeDeep(...inputs) {
         }
     });
     Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
-        result[key] = mergeDeep(...mergeValues);
+        const newValue = mergeDeep(...mergeValues);
+        if (newValue === undefined && key in result) {
+            delete result[key];
+        }
+        else if (newValue !== undefined) {
+            result[key] = newValue;
+        }
     });
+    if (isRunTimeType(result, 'array')) {
+        result = result.filter((entry) => entry !== undefined);
+    }
     return result;
 }

package/dist/esm/augments/object/nested-keys.js

@@ -1,4 +1,4 @@
-import { isRuntimeTypeOf } from '../runtime-type-of';
+import { isRunTimeType } from 'run-time-assertions';
 import { isObject } from './object';
 import { typedHasProperty } from './typed-has-property';
 export function setValueWithNestedKeys(originalObject, nestedKeys, value) {
@@ -9,7 +9,7 @@ export function setValueWithNestedKeys(originalObject, nestedKeys, value) {
      */
     const nestedKeysInput = nestedKeys;
     const inputObject = originalObject;
-    if (isRuntimeTypeOf(inputObject, 'array')) {
+    if (isRunTimeType(inputObject, 'array')) {
         inputObject.forEach((entry) => {
             if (isObject(entry)) {
                 setValueWithNestedKeys(entry, nestedKeysInput, value);
@@ -40,7 +40,7 @@ export function getValueFromNestedKeys(originalObject, nestedKeys) {
      */
     const nestedKeysInput = nestedKeys;
     const inputObject = originalObject;
-    if (isRuntimeTypeOf(inputObject, 'array')) {
+    if (isRunTimeType(inputObject, 'array')) {
         return inputObject.map((entry) => getValueFromNestedKeys(entry, nestedKeys));
     }
     const keyToAccess = nestedKeysInput[0];

package/dist/esm/augments/string/search-params.js

@@ -1,7 +1,7 @@
+import { isRunTimeType } from 'run-time-assertions';
 import { isTruthy } from '../boolean';
 import { typedSplit } from '../common-string';
 import { assertMatchesObjectShape } from '../object/matches-object-shape';
-import { isRuntimeTypeOf } from '../runtime-type-of';
 import { removePrefix } from './prefixes';
 export function objectToSearchParamsString(inputObject) {
     const valueStrings = Object.entries(inputObject)
@@ -37,7 +37,7 @@ function splitSearchString(searchString) {
     return paramEntries;
 }
 export function urlToSearchParamsObject(inputUrl, verifyShape) {
-    const ensuredUrl = isRuntimeTypeOf(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
+    const ensuredUrl = isRunTimeType(inputUrl, 'string') ? new URL(inputUrl) : inputUrl;
     const searchEntries = splitSearchString(ensuredUrl.search);
     const paramsObject = Object.fromEntries(searchEntries);
     if (verifyShape) {

package/dist/esm/index.js

@@ -28,7 +28,6 @@ export * from './augments/promise/promise';
 export * from './augments/promise/wait';
 export * from './augments/random';
 export * from './augments/regexp';
-export * from './augments/runtime-type-of';
 export * from './augments/string/prefixes';
 export * from './augments/string/search-params';
 export * from './augments/string/suffixes';

package/dist/types/augments/object/merge-deep.d.ts

@@ -1,6 +1,7 @@
 import { PartialDeep } from 'type-fest';
 /**
- * Accepts multiple objects and merges their key-value pairs recursively.
+ * Accepts multiple objects and merges their key-value pairs recursively. Any values set to
+ * undefined will be removed.
  *
  * Note that order matters! Each input object will overwrite the properties of the previous objects.
  */

package/dist/types/index.d.ts

@@ -28,7 +28,6 @@ export * from './augments/promise/promise';
 export * from './augments/promise/wait';
 export * from './augments/random';
 export * from './augments/regexp';
-export * from './augments/runtime-type-of';
 export * from './augments/string/prefixes';
 export * from './augments/string/search-params';
 export * from './augments/string/suffixes';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "21.6.1",
+    "version": "22.0.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -25,7 +25,8 @@
     },
     "dependencies": {
         "browser-or-node": "^2.1.1",
-        "type-fest": "^4.7.1"
+        "run-time-assertions": "^0.2.0",
+        "type-fest": "^4.8.1"
     },
     "devDependencies": {
         "typescript": "^5.2.2"

package/dist/cjs/augments/runtime-type-of.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertRuntimeTypeOf = exports.isRuntimeTypeOf = exports.getRuntimeTypeOf = void 0;
-// this function is not used at run time, it's only here for types
-// istanbul ignore next
-function rawGetTypeOf(x) {
-    return typeof x;
-}
-function getRuntimeTypeOf(input) {
-    return Array.isArray(input) ? 'array' : typeof input;
-}
-exports.getRuntimeTypeOf = getRuntimeTypeOf;
-function isRuntimeTypeOf(input, testType) {
-    const inputType = getRuntimeTypeOf(input);
-    return inputType === testType;
-}
-exports.isRuntimeTypeOf = isRuntimeTypeOf;
-function assertRuntimeTypeOf(input, testType, inputName) {
-    if (!isRuntimeTypeOf(input, testType)) {
-        throw new TypeError(`'${inputName}' is of type '${getRuntimeTypeOf(input)}' but type '${testType}' was expected.`);
-    }
-}
-exports.assertRuntimeTypeOf = assertRuntimeTypeOf;

package/dist/esm/augments/runtime-type-of.js

@@ -1,17 +0,0 @@
-// this function is not used at run time, it's only here for types
-// istanbul ignore next
-function rawGetTypeOf(x) {
-    return typeof x;
-}
-export function getRuntimeTypeOf(input) {
-    return Array.isArray(input) ? 'array' : typeof input;
-}
-export function isRuntimeTypeOf(input, testType) {
-    const inputType = getRuntimeTypeOf(input);
-    return inputType === testType;
-}
-export function assertRuntimeTypeOf(input, testType, inputName) {
-    if (!isRuntimeTypeOf(input, testType)) {
-        throw new TypeError(`'${inputName}' is of type '${getRuntimeTypeOf(input)}' but type '${testType}' was expected.`);
-    }
-}

package/dist/types/augments/runtime-type-of.d.ts

@@ -1,19 +0,0 @@
-import { AnyFunction } from './function';
-declare function rawGetTypeOf(x: any): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function";
-type RawTypeOf = ReturnType<typeof rawGetTypeOf>;
-export type RuntimeTypeOf = RawTypeOf | 'array';
-export type RuntimeTypeOfMapping = {
-    array: any[] | ReadonlyArray<any>;
-    bigint: bigint;
-    boolean: boolean;
-    function: AnyFunction | Readonly<AnyFunction>;
-    number: number;
-    object: Record<PropertyKey, unknown> | Readonly<Record<PropertyKey, unknown>>;
-    string: string;
-    symbol: symbol;
-    undefined: undefined;
-};
-export declare function getRuntimeTypeOf(input: unknown): RuntimeTypeOf;
-export declare function isRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T): input is RuntimeTypeOfMapping[T];
-export declare function assertRuntimeTypeOf<T extends RuntimeTypeOf>(input: unknown, testType: T, inputName: string): asserts input is RuntimeTypeOfMapping[T];
-export {};