@augment-vir/common 12.13.0 → 13.0.0

package/dist/cjs/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

package/dist/cjs/augments/common-number.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.clamp = exports.addCommasToNumber = exports.NaNString = void 0;
+exports.ensureMinAndMax = exports.doesRequireScientificNotation = exports.convertIntoNumber = exports.clamp = exports.addCommasToNumber = exports.NaNString = void 0;
 const common_string_1 = require("./common-string");
 const regexp_1 = require("./regexp");
 exports.NaNString = String(NaN);
@@ -43,3 +43,16 @@ function doesRequireScientificNotation(input) {
     return String(input).includes('e');
 }
 exports.doesRequireScientificNotation = doesRequireScientificNotation;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+function ensureMinAndMax({ min, max }) {
+    if (min > max) {
+        return { min: max, max: min };
+    }
+    else {
+        return { min, max };
+    }
+}
+exports.ensureMinAndMax = ensureMinAndMax;

package/dist/cjs/augments/error.d.ts

@@ -1,6 +1,4 @@
-import { NoInputsFunction } from './function';
-import { AtLeastTuple } from './tuple';
-import { UnPromise } from './type';
+import { AtLeastTuple, NoInputsFunction, UnPromise } from '..';
 export declare function combineErrors(errors: AtLeastTuple<Error, 1>): Error;
 export declare function combineErrors(errors: ReadonlyArray<never>): undefined;
 export declare function combineErrors(errors: ReadonlyArray<Error>): Error | undefined;

package/dist/cjs/augments/error.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeAndReturnError = exports.ensureError = exports.extractErrorMessage = exports.combineErrorMessages = exports.combineErrors = void 0;
-const function_1 = require("./function");
-const promise_1 = require("./promise");
+const __1 = require("..");
 function combineErrors(errors) {
     if (!errors || errors.length === 0) {
         return undefined;
@@ -18,7 +17,7 @@ function combineErrorMessages(errors) {
     if (!errors) {
         return '';
     }
-    return errors.map(extractErrorMessage).filter(function_1.isTruthy).join('\n');
+    return errors.map(extractErrorMessage).filter(__1.isTruthy).join('\n');
 }
 exports.combineErrorMessages = combineErrorMessages;
 function extractErrorMessage(error) {
@@ -46,7 +45,7 @@ function executeAndReturnError(callback) {
     let caughtError;
     try {
         const result = callback();
-        if ((0, promise_1.isPromiseLike)(result)) {
+        if ((0, __1.isPromiseLike)(result)) {
             return new Promise(async (resolve) => {
                 try {
                     const output = await result;

package/dist/cjs/augments/object/map-object.d.ts

@@ -1,5 +1,4 @@
-import { UnPromise } from '../type';
-import { PropertyValueType } from './object';
+import { PropertyValueType, UnPromise } from '../..';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };

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

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapObjectValues = exports.mapObjectValuesSync = void 0;
-const object_entries_1 = require("./object-entries");
+const __1 = require("../..");
 /**
  * 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
@@ -17,7 +17,7 @@ const object_entries_1 = require("./object-entries");
  */
 function mapObjectValuesSync(inputObject) {
     function innerMap(mapCallback) {
-        const mappedObject = (0, object_entries_1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
+        const mappedObject = (0, __1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
             const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
             return {
                 ...accum,
@@ -35,7 +35,7 @@ exports.mapObjectValuesSync = mapObjectValuesSync;
  */
 function mapObjectValues(inputObject, mapCallback) {
     let gotAPromise = false;
-    const mappedObject = (0, object_entries_1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
+    const mappedObject = (0, __1.getObjectTypedKeys)(inputObject).reduce((accum, currentKey) => {
         const mappedValue = mapCallback(currentKey, inputObject[currentKey], inputObject);
         if (mappedValue instanceof Promise) {
             gotAPromise = true;
@@ -48,7 +48,7 @@ function mapObjectValues(inputObject, mapCallback) {
     if (gotAPromise) {
         return new Promise(async (resolve, reject) => {
             try {
-                await Promise.all((0, object_entries_1.getObjectTypedKeys)(mappedObject).map(async (key) => {
+                await Promise.all((0, __1.getObjectTypedKeys)(mappedObject).map(async (key) => {
                     const value = await mappedObject[key];
                     mappedObject[key] = value;
                 }));

package/dist/cjs/augments/promise.d.ts

@@ -1,6 +1,8 @@
 export declare function wait(delayMs: number): Promise<void>;
 export declare function waitValue<ResolutionValue>(delayMs: number, returnValue: ResolutionValue): Promise<ResolutionValue>;
 export declare function isPromiseLike<T>(input: T | unknown): input is T extends PromiseLike<infer ValueType> ? PromiseLike<ValueType> : PromiseLike<unknown>;
+export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
+export type MaybePromise<T> = Promise<UnPromise<T>> | UnPromise<T>;
 export declare class PromiseTimeoutError extends Error {
     readonly durationMs: number;
     readonly message: string;

package/dist/cjs/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUuid = void 0;
+const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
+function isUuid(maybeUuid) {
+    return !!maybeUuid.match(uuidRegExp);
+}
+exports.isUuid = isUuid;

package/dist/cjs/augments/type.d.ts

@@ -34,7 +34,6 @@ export type RequiredAndNotNullBy<T, K extends keyof T> = Omit<T, K> & Required<{
 }>;
 /** If type T = type U, then type Y. Else type N. */
 export type IfEquals<T, U, Y = unknown, N = never> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? Y : N;
-export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
 /**
  * This function returns another function that simply returns whatever input it's given. However, it
  * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while

package/dist/cjs/index.d.ts

@@ -23,6 +23,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/cjs/index.js

@@ -39,6 +39,7 @@ __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/runtime-type-of"), exports);
 __exportStar(require("./augments/string/url"), exports);
+__exportStar(require("./augments/string/uuid"), exports);
 __exportStar(require("./augments/truncate-number"), exports);
 __exportStar(require("./augments/tuple"), exports);
 __exportStar(require("./augments/type"), exports);

package/dist/esm/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

package/dist/esm/augments/common-number.js

@@ -36,3 +36,15 @@ export function convertIntoNumber(input) {
 export function doesRequireScientificNotation(input) {
     return String(input).includes('e');
 }
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export function ensureMinAndMax({ min, max }) {
+    if (min > max) {
+        return { min: max, max: min };
+    }
+    else {
+        return { min, max };
+    }
+}

package/dist/esm/augments/error.d.ts

@@ -1,6 +1,4 @@
-import { NoInputsFunction } from './function';
-import { AtLeastTuple } from './tuple';
-import { UnPromise } from './type';
+import { AtLeastTuple, NoInputsFunction, UnPromise } from '..';
 export declare function combineErrors(errors: AtLeastTuple<Error, 1>): Error;
 export declare function combineErrors(errors: ReadonlyArray<never>): undefined;
 export declare function combineErrors(errors: ReadonlyArray<Error>): Error | undefined;

package/dist/esm/augments/error.js

@@ -1,5 +1,4 @@
-import { isTruthy } from './function';
-import { isPromiseLike } from './promise';
+import { isPromiseLike, isTruthy } from '..';
 export function combineErrors(errors) {
     if (!errors || errors.length === 0) {
         return undefined;

package/dist/esm/augments/object/map-object.d.ts

@@ -1,5 +1,4 @@
-import { UnPromise } from '../type';
-import { PropertyValueType } from './object';
+import { PropertyValueType, UnPromise } from '../..';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };

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

@@ -1,4 +1,4 @@
-import { getObjectTypedKeys } from './object-entries';
+import { getObjectTypedKeys } from '../..';
 /**
  * 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

package/dist/esm/augments/promise.d.ts

@@ -1,6 +1,8 @@
 export declare function wait(delayMs: number): Promise<void>;
 export declare function waitValue<ResolutionValue>(delayMs: number, returnValue: ResolutionValue): Promise<ResolutionValue>;
 export declare function isPromiseLike<T>(input: T | unknown): input is T extends PromiseLike<infer ValueType> ? PromiseLike<ValueType> : PromiseLike<unknown>;
+export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
+export type MaybePromise<T> = Promise<UnPromise<T>> | UnPromise<T>;
 export declare class PromiseTimeoutError extends Error {
     readonly durationMs: number;
     readonly message: string;

package/dist/esm/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

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

@@ -0,0 +1,4 @@
+const uuidRegExp = /[\d\w]{8}-[\d\w]{4}-[\d\w]{4}-[\d\w]{4}-[\d\w]{12}/;
+export function isUuid(maybeUuid) {
+    return !!maybeUuid.match(uuidRegExp);
+}

package/dist/esm/augments/type.d.ts

@@ -34,7 +34,6 @@ export type RequiredAndNotNullBy<T, K extends keyof T> = Omit<T, K> & Required<{
 }>;
 /** If type T = type U, then type Y. Else type N. */
 export type IfEquals<T, U, Y = unknown, N = never> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? Y : N;
-export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
 /**
  * This function returns another function that simply returns whatever input it's given. However, it
  * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while

package/dist/esm/index.d.ts

@@ -23,6 +23,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/esm/index.js

@@ -23,6 +23,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/dist/types/augments/common-number.d.ts

@@ -12,4 +12,15 @@ export declare function clamp(
 }): number;
 export declare function convertIntoNumber(input: unknown): number;
 export declare function doesRequireScientificNotation(input: number): boolean;
+/**
+ * Given a min and max, ensures that they are in correct order. Meaning, min is less than max. If
+ * that is not the case, the returned value is the given min and max values swapped.
+ */
+export declare function ensureMinAndMax({ min, max }: {
+    min: number;
+    max: number;
+}): {
+    min: number;
+    max: number;
+};
 //# sourceMappingURL=common-number.d.ts.map

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

@@ -1,6 +1,4 @@
-import { NoInputsFunction } from './function';
-import { AtLeastTuple } from './tuple';
-import { UnPromise } from './type';
+import { AtLeastTuple, NoInputsFunction, UnPromise } from '..';
 export declare function combineErrors(errors: AtLeastTuple<Error, 1>): Error;
 export declare function combineErrors(errors: ReadonlyArray<never>): undefined;
 export declare function combineErrors(errors: ReadonlyArray<Error>): Error | undefined;

package/dist/types/augments/object/map-object.d.ts

@@ -1,5 +1,4 @@
-import { UnPromise } from '../type';
-import { PropertyValueType } from './object';
+import { PropertyValueType, UnPromise } from '../..';
 export type InnerMappedValues<EntireInputGeneric extends object, MappedValueGeneric> = {
     [MappedProp in keyof EntireInputGeneric]: MappedValueGeneric;
 };

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

@@ -1,6 +1,8 @@
 export declare function wait(delayMs: number): Promise<void>;
 export declare function waitValue<ResolutionValue>(delayMs: number, returnValue: ResolutionValue): Promise<ResolutionValue>;
 export declare function isPromiseLike<T>(input: T | unknown): input is T extends PromiseLike<infer ValueType> ? PromiseLike<ValueType> : PromiseLike<unknown>;
+export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
+export type MaybePromise<T> = Promise<UnPromise<T>> | UnPromise<T>;
 export declare class PromiseTimeoutError extends Error {
     readonly durationMs: number;
     readonly message: string;

package/dist/types/augments/string/uuid.d.ts

@@ -0,0 +1,2 @@
+export declare function isUuid(maybeUuid: string): boolean;
+//# sourceMappingURL=uuid.d.ts.map

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

@@ -34,7 +34,6 @@ export type RequiredAndNotNullBy<T, K extends keyof T> = Omit<T, K> & Required<{
 }>;
 /** If type T = type U, then type Y. Else type N. */
 export type IfEquals<T, U, Y = unknown, N = never> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U ? 1 : 2 ? Y : N;
-export type UnPromise<T> = T extends PromiseLike<infer PromiseType> ? Awaited<PromiseType> : T;
 /**
  * This function returns another function that simply returns whatever input it's given. However, it
  * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while

package/dist/types/index.d.ts

@@ -23,6 +23,7 @@ export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
 export * from './augments/string/url';
+export * from './augments/string/uuid';
 export * from './augments/truncate-number';
 export * from './augments/tuple';
 export * from './augments/type';

package/package.json

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