@augment-vir/common 29.3.0 → 30.0.1

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.');
-}

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

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultWaitUntilDefinedOptions = void 0;
-exports.wait = wait;
-exports.waitValue = waitValue;
-exports.waitUntilTruthy = waitUntilTruthy;
-const error_1 = require("../error");
-const deferred_promise_1 = require("./deferred-promise");
-function wait(delayMs) {
-    const deferredPromiseWrapper = (0, deferred_promise_1.createDeferredPromiseWrapper)();
-    if (delayMs !== Infinity) {
-        setTimeout(() => {
-            deferredPromiseWrapper.resolve();
-        }, delayMs <= 0 ? 0 : delayMs);
-    }
-    return deferredPromiseWrapper.promise;
-}
-async function waitValue(delayMs, returnValue) {
-    return wait(delayMs).then(() => returnValue);
-}
-exports.defaultWaitUntilDefinedOptions = {
-    interval: {
-        milliseconds: 100,
-    },
-    timeout: {
-        milliseconds: 10_000,
-    },
-};
-/**
- * Runs the predicate until it returns a truthy value, then returns that value. Use the options
- * input to modify the timeout and interval durations. Automatically catches errors and handles
- * async predicates.
- */
-async function waitUntilTruthy(predicate, failureMessage, optionsInput = {}) {
-    const options = {
-        ...exports.defaultWaitUntilDefinedOptions,
-        ...optionsInput,
-    };
-    let lastValue = undefined;
-    let lastError;
-    async function checkCondition() {
-        try {
-            lastValue = await predicate();
-        }
-        catch (error) {
-            lastValue = undefined;
-            lastError = error;
-        }
-    }
-    const startTime = Date.now();
-    while (!lastValue) {
-        await checkCondition();
-        await wait(options.interval.milliseconds);
-        if (Date.now() - startTime >= options.timeout.milliseconds) {
-            const message = failureMessage ? `${failureMessage}: ` : '';
-            const preMessage = `${message}Timeout of "${options.timeout.milliseconds}" exceeded waiting for value to be defined`;
-            if (lastError) {
-                throw (0, error_1.ensureErrorAndPrependMessage)(lastError, preMessage);
-            }
-            else {
-                throw new Error(preMessage);
-            }
-        }
-    }
-    return lastValue;
-}

package/dist/cjs/augments/random.js

@@ -1,118 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.randomInteger = randomInteger;
-exports.randomBoolean = randomBoolean;
-exports.randomString = randomString;
-const common_number_1 = require("./common-number");
-function accessCrypto() {
-    if (globalThis.crypto) {
-        return globalThis.crypto;
-    }
-    else {
-        return require('crypto').webcrypto;
-    }
-}
-const crypto = accessCrypto();
-/**
- * Creates a random integer (decimal points are all cut off) between the given min and max
- * (inclusive).
- *
- * This function uses cryptographically secure randomness.
- */
-function randomInteger({ min: rawMin, max: rawMax }) {
-    const { min, max } = (0, common_number_1.ensureMinAndMax)({ min: Math.floor(rawMin), max: Math.floor(rawMax) });
-    const range = max - min + 1;
-    const neededByteCount = Math.ceil(Math.log2(range) / 8);
-    const cutoff = Math.floor(256 ** neededByteCount / range) * range;
-    const currentBytes = new Uint8Array(neededByteCount);
-    let value;
-    do {
-        crypto.getRandomValues(currentBytes);
-        value = currentBytes.reduce((accum, byte, index) => {
-            return accum + byte * 256 ** index;
-        }, 0);
-    } while (value >= cutoff);
-    return min + (value % range);
-}
-/**
- * Returns true at rate of the percentLikelyToBeTrue input. Inputs should be whole numbers which
- * will be treated like percents. Anything outside of 0-100 inclusively will be clamped. An input 0
- * will always return true. An input of 100 will always return true. Decimals on the input will be
- * chopped off, use whole numbers.
- *
- * This function uses cryptographically secure randomness.
- *
- * @example
- *     randomBoolean(50); // 50% chance to return true
- *
- * @example
- *     randomBoolean(0); // always false, 0% chance of being true
- *
- * @example
- *     randomBoolean(100); // always true, 100% chance of being true
- *
- * @example
- *     randomBoolean(59.67; // 59% chance of being true
- */
-function randomBoolean(percentLikelyToBeTrue = 50) {
-    return (randomInteger({ min: 0, max: 99 }) <
-        (0, common_number_1.clamp)({
-            value: Math.floor(percentLikelyToBeTrue),
-            min: 0,
-            max: 100,
-        }));
-}
-const validStringCharacters = [
-    'a',
-    'b',
-    'c',
-    'd',
-    'e',
-    'f',
-    'g',
-    'h',
-    'i',
-    'j',
-    'k',
-    'l',
-    'm',
-    'n',
-    'o',
-    'p',
-    'q',
-    'r',
-    's',
-    't',
-    'u',
-    'v',
-    'w',
-    'x',
-    'y',
-    'z',
-    0,
-    1,
-    2,
-    3,
-    4,
-    5,
-    6,
-    7,
-    8,
-    9,
-];
-/**
- * Creates a random string (including letters and numbers) of a given length.
- *
- * This function uses cryptographically secure randomness.
- */
-function randomString(inputLength = 16) {
-    let stringBuilder = '';
-    for (let i = 0; i < inputLength; i++) {
-        const index = randomInteger({
-            min: 0,
-            max: validStringCharacters.length - 1,
-        });
-        stringBuilder += validStringCharacters[index];
-    }
-    return stringBuilder;
-}

package/dist/cjs/augments/regexp.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deDupeRegExFlags = deDupeRegExFlags;
-exports.addRegExpFlags = addRegExpFlags;
-exports.safeMatch = safeMatch;
-function deDupeRegExFlags(flags) {
-    const deDuped = new Set(Array.from(flags.toLowerCase()));
-    return Array.from(deDuped).join('');
-}
-function addRegExpFlags(originalRegExp, flags) {
-    return new RegExp(originalRegExp.source, deDupeRegExFlags([
-        originalRegExp.flags,
-        flags,
-    ].join('')));
-}
-function safeMatch(input, regExp) {
-    const match = input.match(regExp);
-    return match ?? [];
-}

package/dist/cjs/augments/string/prefixes.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.addPrefix = addPrefix;
-exports.removePrefix = removePrefix;
-function addPrefix({ value, prefix, }) {
-    if (String(value).startsWith(prefix)) {
-        return String(value);
-    }
-    else {
-        return `${prefix}${String(value)}`;
-    }
-}
-function removePrefix({ value, prefix, }) {
-    if (value.startsWith(prefix)) {
-        return value.substring(prefix.length);
-    }
-    else {
-        return value;
-    }
-}

package/dist/cjs/augments/string/suffixes.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pxSuffix = exports.percentSuffix = void 0;
-exports.addPx = addPx;
-exports.removePx = removePx;
-exports.addPercent = addPercent;
-exports.removePercent = removePercent;
-exports.addSuffix = addSuffix;
-exports.removeSuffix = removeSuffix;
-const common_number_1 = require("../common-number");
-exports.percentSuffix = '%';
-exports.pxSuffix = 'px';
-function addPx(input) {
-    return addSuffix({ value: input, suffix: exports.pxSuffix });
-}
-function removePx(input) {
-    return (0, common_number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.pxSuffix }));
-}
-function addPercent(input) {
-    return addSuffix({ value: input, suffix: exports.percentSuffix });
-}
-function removePercent(input) {
-    return (0, common_number_1.toEnsuredNumber)(removeSuffix({ value: input, suffix: exports.percentSuffix }));
-}
-function addSuffix({ value, suffix, }) {
-    if (String(value).endsWith(suffix)) {
-        return String(value);
-    }
-    else {
-        return `${String(value)}${suffix}`;
-    }
-}
-function removeSuffix({ value, suffix, }) {
-    if (value.endsWith(suffix)) {
-        return value.substring(0, value.length - suffix.length);
-    }
-    else {
-        return value;
-    }
-}

package/dist/cjs/augments/string/uuid.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUuid = isUuid;
-exports.createUuid = createUuid;
-const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
-/** Checks if the input string is a valid v4 UUID. */
-function isUuid(maybeUuid) {
-    return !!maybeUuid.match(uuidRegExp);
-}
-/** Creates a cryptographically secure v4 UUID using `crypto.randomUUID`. */
-function createUuid() {
-    return crypto.randomUUID();
-}

package/dist/cjs/augments/time.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.measureCallbackDuration = void 0;
-exports.timeCallback = timeCallback;
-/**
- * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
- * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
- * purely synchronous).
- */
-function timeCallback(callback) {
-    const startTime = Date.now();
-    const result = callback();
-    if (result instanceof Promise) {
-        return new Promise(async (resolve, reject) => {
-            try {
-                await result;
-                const endTime = Date.now();
-                resolve(endTime - startTime);
-            }
-            catch (caught) {
-                reject(caught);
-            }
-        });
-    }
-    const endTime = Date.now();
-    return (endTime - startTime);
-}
-/**
- * Measures how long (in milliseconds) the given callback takes to run to completion. Automatically
- * switches to async mode and awaits callbacks if they return a promise (otherwise this function is
- * purely synchronous).
- *
- * Alias of timeCallback.
- */
-exports.measureCallbackDuration = timeCallback;