@augment-vir/common 29.2.0 → 30.0.0

package/dist/cjs/augments/error.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.combineErrors = combineErrors;
-exports.combineErrorMessages = combineErrorMessages;
-exports.extractErrorMessage = extractErrorMessage;
-exports.ensureError = ensureError;
-exports.ensureErrorAndPrependMessage = ensureErrorAndPrependMessage;
-const boolean_1 = require("./boolean");
-const typed_has_property_1 = require("./object/typed-has-property");
-function combineErrors(errors) {
-    if (!errors || errors.length === 0) {
-        return undefined;
-    }
-    const firstError = errors[0];
-    if (errors.length === 1 && firstError) {
-        return firstError;
-    }
-    return new Error(errors.map((error) => extractErrorMessage(error).trim()).join('\n'));
-}
-function combineErrorMessages(errors) {
-    if (!errors) {
-        return '';
-    }
-    return errors.map(extractErrorMessage).filter(boolean_1.isTruthy).join('\n');
-}
-function extractErrorMessage(maybeError) {
-    if (!maybeError) {
-        return '';
-    }
-    if (maybeError instanceof Error) {
-        return maybeError.message;
-    }
-    else if ((0, typed_has_property_1.typedHasProperty)(maybeError, 'message')) {
-        return String(maybeError.message);
-    }
-    else {
-        return String(maybeError);
-    }
-}
-function ensureError(maybeError) {
-    if (maybeError instanceof Error) {
-        return maybeError;
-    }
-    else {
-        return new Error(extractErrorMessage(maybeError));
-    }
-}
-function ensureErrorAndPrependMessage(maybeError, prependMessage) {
-    const error = ensureError(maybeError);
-    error.message = `${prependMessage}: ${error.message}`;
-    return error;
-}

package/dist/cjs/augments/esm-path.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEsmPath = getEsmPath;
-function getEsmPath(importMeta) {
-    const filePath = new URL('', importMeta.url).pathname;
-    const dirPath = new URL('.', importMeta.url).pathname;
-    return {
-        filePath,
-        dirPath,
-    };
-}

package/dist/cjs/augments/function.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/json-compatible.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/json.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseJson = parseJson;
-exports.stringifyJson = stringifyJson;
-const wrap_in_try_1 = require("./wrap-in-try");
-function parseJson({ jsonString, errorHandler, }) {
-    try {
-        const parsedJson = JSON.parse(jsonString);
-        return parsedJson;
-    }
-    catch (error) {
-        if (errorHandler) {
-            return errorHandler(error);
-        }
-        else {
-            throw error;
-        }
-    }
-}
-function stringifyJson(jsonValue, { whitespace, ...tryOptions } = {}) {
-    const result = (0, wrap_in_try_1.wrapInTry)(() => JSON.stringify(jsonValue, undefined, whitespace), tryOptions);
-    if (result instanceof Error) {
-        throw result;
-    }
-    else {
-        return result;
-    }
-}

package/dist/cjs/augments/object/any-object.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/object/enum.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEnumTypedKeys = getEnumTypedKeys;
-exports.getEnumTypedValues = getEnumTypedValues;
-exports.isEnumValue = isEnumValue;
-exports.ensureEnum = ensureEnum;
-exports.filterToEnumValues = filterToEnumValues;
-const object_entries_1 = require("./object-entries");
-function getEnumTypedKeys(input) {
-    // enum keys are always strings
-    return (0, object_entries_1.getObjectTypedKeys)(input).filter((key) => isNaN(Number(key)));
-}
-function getEnumTypedValues(input) {
-    const keys = getEnumTypedKeys(input);
-    return keys.map((key) => input[key]);
-}
-/** Check if the given value is within the given enum. */
-function isEnumValue(input, checkEnum) {
-    return getEnumTypedValues(checkEnum).includes(input);
-}
-/** Interpret a primitive as an enum value with type safety. */
-function ensureEnum(value, checkEnum) {
-    if (isEnumValue(value, checkEnum)) {
-        return value;
-    }
-    else {
-        const enumValues = getEnumTypedValues(checkEnum);
-        throw new Error(`Given value '${value}' does not match given enum. Possible enum values: ${enumValues.join(',')}`);
-    }
-}
-function filterToEnumValues(inputs, checkEnum, caseInsensitive = false) {
-    if (caseInsensitive) {
-        return inputs.reduce((accum, currentInput) => {
-            const matchedEnumValue = getEnumTypedValues(checkEnum).find((actualEnumValue) => {
-                return String(actualEnumValue).toUpperCase() === String(currentInput).toUpperCase();
-            });
-            if (matchedEnumValue) {
-                return accum.concat(matchedEnumValue);
-            }
-            else {
-                return accum;
-            }
-        }, []);
-    }
-    else {
-        return inputs.filter((input) => isEnumValue(input, checkEnum));
-    }
-}

package/dist/cjs/augments/object/filter-object.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterObject = filterObject;
-exports.omitObjectKeys = omitObjectKeys;
-exports.pickObjectKeys = pickObjectKeys;
-const object_entries_1 = require("./object-entries");
-function filterObject(inputObject, callback) {
-    const filteredKeys = (0, object_entries_1.getObjectTypedKeys)(inputObject).filter((key) => {
-        const value = inputObject[key];
-        return callback(key, value, inputObject);
-    });
-    return filteredKeys.reduce((accum, key) => {
-        accum[key] = inputObject[key];
-        return accum;
-    }, {});
-}
-function omitObjectKeys(inputObject, omitTheseKeys) {
-    return filterObject(inputObject, (currentKey) => {
-        return !omitTheseKeys.includes(currentKey);
-    });
-}
-function pickObjectKeys(inputObject, pickTheseKeys) {
-    return filterObject(inputObject, (currentKey) => {
-        return pickTheseKeys.includes(currentKey);
-    });
-}

package/dist/cjs/augments/object/get-or-set.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrSetFromMap = getOrSetFromMap;
-exports.getOrSet = getOrSet;
-const run_time_assertions_1 = require("run-time-assertions");
-function getOrSetFromMap(map, key, createNewValueCallback) {
-    const mapKey = key;
-    if (map.has(mapKey)) {
-        return map.get(mapKey);
-    }
-    else {
-        const newValue = createNewValueCallback();
-        map.set(mapKey, newValue);
-        return newValue;
-    }
-}
-function getOrSet(originalObject, key, createCallback) {
-    if (key in originalObject) {
-        return originalObject[key];
-    }
-    else {
-        const createdValue = createCallback();
-        if ((0, run_time_assertions_1.isPromise)(createdValue)) {
-            return new Promise(async (resolve, reject) => {
-                try {
-                    const awaitedValue = await createdValue;
-                    originalObject[key] = awaitedValue;
-                    resolve(awaitedValue);
-                }
-                catch (error) {
-                    reject(error);
-                }
-            });
-        }
-        else {
-            originalObject[key] = createdValue;
-            return createdValue;
-        }
-    }
-}

package/dist/cjs/augments/object/has-key.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasKey = hasKey;
-function hasKey(parent, property) {
-    return property in parent;
-}

package/dist/cjs/augments/object/jsonify.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonify = jsonify;
-function jsonify(input) {
-    return JSON.parse(JSON.stringify(input));
-}

package/dist/cjs/augments/object/key-count.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/object/map-object.js

@@ -1,61 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapObjectValuesSync = mapObjectValuesSync;
-exports.mapObjectValues = mapObjectValues;
-const object_entries_1 = require("./object-entries");
-/**
- * Map an object's keys to new values synchronously. This is different from plain mapObjectValues in
- * that this will not wrap the return value in a promise if any of the new object values are
- * promises. This function also requires currying in order to get the types correct. This allows you
- * to explicitly state the return type.
- *
- * @example
- *     mapObjectValuesSync({objectToIterateOver: 'initial value'})(callback);
- */
-function mapObjectValuesSync(inputObject) {
-    function innerMap(mapCallback) {
-        const mappedObject = (0, object_entries_1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
-            const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
-            return {
-                ...accum,
-                [currentKey]: mappedValue,
-            };
-        }, {});
-        return mappedObject;
-    }
-    return innerMap;
-}
-/**
- * Creates a new object with the same properties as the input object, but with values set to the
- * result of mapCallback for each property.
- */
-function mapObjectValues(inputObject, mapCallback) {
-    let gotAPromise = false;
-    const mappedObject = (0, object_entries_1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
-        const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
-        if (mappedValue instanceof Promise) {
-            gotAPromise = true;
-        }
-        return {
-            ...accum,
-            [currentKey]: mappedValue,
-        };
-    }, {});
-    if (gotAPromise) {
-        return new Promise(async (resolve, reject) => {
-            try {
-                await Promise.all((0, object_entries_1.getObjectTypedKeys)(mappedObject).map(async (key) => {
-                    const value = await mappedObject[key];
-                    mappedObject[key] = value;
-                }));
-                resolve(mappedObject);
-            }
-            catch (error) {
-                reject(error);
-            }
-        });
-    }
-    else {
-        return mappedObject;
-    }
-}

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

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeDeep = mergeDeep;
-const run_time_assertions_1 = require("run-time-assertions");
-const tuple_1 = require("../tuple");
-/**
- * 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.
- */
-function mergeDeep(...inputs) {
-    if (!(0, tuple_1.isLengthAtLeast)(inputs, 1)) {
-        // nothing to merge if no inputs
-        return {};
-    }
-    if (inputs.length === 1) {
-        // nothing to merge if only one input
-        return inputs[0];
-    }
-    let result = undefined;
-    const mergeProps = {};
-    inputs.forEach((individualInput) => {
-        if (!(0, run_time_assertions_1.isRunTimeType)(individualInput, 'object')) {
-            /** If not an object, we can't merge. So overwrite instead. */
-            result = individualInput;
-            return;
-        }
-        else if (!(0, run_time_assertions_1.isRunTimeType)(result, 'object')) {
-            /** If result isn't an object then we need to make it into one. */
-            result = { ...individualInput };
-        }
-        Object.entries(individualInput).forEach(([key, value,]) => {
-            if (!mergeProps[key]) {
-                mergeProps[key] = [];
-            }
-            mergeProps[key].push(value);
-        });
-    });
-    if ((0, run_time_assertions_1.isRunTimeType)(result, 'object')) {
-        Object.entries(mergeProps).forEach(([key, mergeValues,]) => {
-            const newValue = mergeDeep(...mergeValues);
-            if (newValue === undefined && key in result) {
-                delete result[key];
-            }
-            else if (newValue !== undefined) {
-                result[key] = newValue;
-            }
-        });
-    }
-    return result;
-}

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

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergePropertyArrays = mergePropertyArrays;
-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;
-}

package/dist/cjs/augments/object/object-entries.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isKeyof = isKeyof;
-exports.getObjectTypedKeys = getObjectTypedKeys;
-exports.getObjectTypedValues = getObjectTypedValues;
-exports.getObjectTypedEntries = getObjectTypedEntries;
-exports.getEntriesSortedByKey = getEntriesSortedByKey;
-exports.typedObjectFromEntries = typedObjectFromEntries;
-const typed_has_property_1 = require("./typed-has-property");
-/** @deprecated This is the same as hasKey */
-function isKeyof(key, object) {
-    return (0, typed_has_property_1.typedHasProperty)(object, key);
-}
-function getObjectTypedKeys(input) {
-    let reflectKeys;
-    try {
-        reflectKeys = Reflect.ownKeys(input);
-    }
-    catch (error) { }
-    return (reflectKeys ??
-        [
-            ...Object.keys(input),
-            ...Object.getOwnPropertySymbols(input),
-        ]);
-}
-function getObjectTypedValues(input) {
-    return getObjectTypedKeys(input).map((key) => input[key]);
-}
-function getObjectTypedEntries(input) {
-    return getObjectTypedKeys(input).map((key) => [
-        key,
-        input[key],
-    ]);
-}
-function getEntriesSortedByKey(input) {
-    return Object.entries(input).sort((tupleA, tupleB) => tupleA[0].localeCompare(tupleB[0]));
-}
-function typedObjectFromEntries(entries) {
-    return Object.fromEntries(entries);
-}

package/dist/cjs/augments/object/object.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isObject = isObject;
-exports.copyThroughJson = copyThroughJson;
-/** Checks if the input is non-null and an object. Includes arrays. */
-function isObject(input) {
-    return !!input && typeof input === 'object';
-}
-/** The input here must be serializable otherwise JSON parsing errors will be thrown */
-function copyThroughJson(input) {
-    try {
-        return JSON.parse(JSON.stringify(input));
-    }
-    catch (error) {
-        console.error(`Failed to JSON copy for`, input);
-        throw error;
-    }
-}

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

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/augments/object/selection-set.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.selectFrom = selectFrom;
-exports.selectCollapsedFrom = selectCollapsedFrom;
-const run_time_assertions_1 = require("run-time-assertions");
-const tuple_1 = require("../tuple");
-const filter_object_1 = require("./filter-object");
-const map_object_1 = require("./map-object");
-const object_1 = require("./object");
-function shouldPreserve(input) {
-    return (0, run_time_assertions_1.isPrimitive)(input) || input instanceof RegExp || input instanceof Promise;
-}
-function selectFrom(originalObject, selectionSet) {
-    if (Array.isArray(originalObject)) {
-        return originalObject.map((originalEntry) => selectFrom(originalEntry, selectionSet));
-    }
-    const keysToRemove = [];
-    return (0, filter_object_1.omitObjectKeys)((0, map_object_1.mapObjectValues)(originalObject, (key, value) => {
-        const selection = selectionSet[key];
-        if (selection === true) {
-            return value;
-        }
-        else if (!selection) {
-            keysToRemove.push(key);
-            return undefined;
-        }
-        else if (shouldPreserve(value)) {
-            return value;
-        }
-        else {
-            return selectFrom(value, selection);
-        }
-    }), keysToRemove);
-}
-function selectCollapsedFrom(originalObject, selectionSet) {
-    const selected = selectFrom(originalObject, selectionSet);
-    return collapseObject(selected, selectionSet);
-}
-function collapseObject(input, selectionSet) {
-    if (shouldPreserve(input)) {
-        return input;
-    }
-    const keys = Object.keys(input);
-    if (Array.isArray(input)) {
-        return input.map((innerInput) => collapseObject(innerInput, selectionSet));
-    }
-    else if ((0, tuple_1.isLengthAtLeast)(keys, 2)) {
-        return input;
-    }
-    else if ((0, tuple_1.isLengthAtLeast)(keys, 1) && (0, object_1.isObject)(selectionSet)) {
-        return collapseObject(input[keys[0]], selectionSet[keys[0]]);
-    }
-    else {
-        return input;
-    }
-}

package/dist/cjs/augments/object/typed-has-property.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.typedHasProperty = typedHasProperty;
-exports.typedHasProperties = typedHasProperties;
-const hasPropertyAttempts = [
-    (object, key) => {
-        return key in object;
-    },
-    (object, key) => {
-        /** This handles cases where the input object can't use `in` directly, like string literals */
-        return key in object.constructor.prototype;
-    },
-];
-function typedHasProperty(inputObject, inputKey) {
-    if (!inputObject) {
-        return false;
-    }
-    return hasPropertyAttempts.some((attemptCallback) => {
-        try {
-            return attemptCallback(inputObject, inputKey);
-        }
-        catch (error) {
-            return false;
-        }
-    });
-}
-function typedHasProperties(inputObject, inputKeys) {
-    return inputObject && inputKeys.every((key) => typedHasProperty(inputObject, key));
-}

package/dist/cjs/augments/promise/deferred-promise.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDeferredPromiseWrapper = createDeferredPromiseWrapper;
-function createDeferredPromiseWrapper() {
-    let resolve;
-    let reject;
-    let settled = false;
-    const promise = new Promise((resolveCallback, rejectCallback) => {
-        resolve = (value) => {
-            settled = true;
-            return resolveCallback(value);
-        };
-        reject = (reason) => {
-            settled = true;
-            rejectCallback(reason);
-        };
-    });
-    // no way to test this edge case
-    // istanbul ignore next
-    if (!resolve || !reject) {
-        throw new Error(`Reject and resolve callbacks were not set by the promise constructor for ${createDeferredPromiseWrapper.name}.`);
-    }
-    return {
-        promise,
-        resolve,
-        reject,
-        isSettled() {
-            return settled;
-        },
-    };
-}

package/dist/cjs/augments/promise/promise.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PromiseTimeoutError = void 0;
-exports.isPromiseLike = isPromiseLike;
-exports.wrapPromiseInTimeout = wrapPromiseInTimeout;
-exports.callAsynchronously = callAsynchronously;
-exports.executeWithRetries = executeWithRetries;
-const typed_has_property_1 = require("../object/typed-has-property");
-function isPromiseLike(input) {
-    if ((0, typed_has_property_1.typedHasProperty)(input, 'then') && typeof input.then === 'function') {
-        return true;
-    }
-    else {
-        return false;
-    }
-}
-class PromiseTimeoutError extends Error {
-    constructor(durationMs, message = `Promised timed out after ${durationMs} ms.`) {
-        super(message);
-        Object.defineProperty(this, "durationMs", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: durationMs
-        });
-        Object.defineProperty(this, "message", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: message
-        });
-        Object.defineProperty(this, "name", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 'PromiseTimeoutError'
-        });
-    }
-}
-exports.PromiseTimeoutError = PromiseTimeoutError;
-function wrapPromiseInTimeout(durationMs, originalPromise) {
-    return new Promise(async (resolve, reject) => {
-        const timeoutId = durationMs === Infinity
-            ? undefined
-            : setTimeout(() => {
-                reject(new PromiseTimeoutError(durationMs));
-            }, durationMs);
-        try {
-            const result = await originalPromise;
-            resolve(result);
-        }
-        catch (error) {
-            reject(error);
-        }
-        finally {
-            clearTimeout(timeoutId);
-        }
-    });
-}
-/**
- * Call a function asynchronously without interrupting current synchronous execution, even if the
- * function was originally synchronous.
- */
-async function callAsynchronously(callback) {
-    return await Promise.resolve().then(() => callback());
-}
-async function executeWithRetries(retryCount, callback) {
-    let currentRetry = 0;
-    while (currentRetry < retryCount) {
-        try {
-            const result = await callback();
-            return result;
-        }
-        catch (error) {
-            currentRetry++;
-        }
-    }
-    throw new Error('Retry max reached.');
-}