@augment-vir/common 15.4.2 → 15.6.0

package/dist/cjs/augments/boolean.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ifTruthy = exports.isFalsy = exports.isTruthy = void 0;
+function isTruthy(input) {
+    return !!input;
+}
+exports.isTruthy = isTruthy;
+function isFalsy(input) {
+    return !input;
+}
+exports.isFalsy = isFalsy;
+function ifTruthy(checkThis, ifTruthyCallback, ifFalsyCallback) {
+    if (isTruthy(checkThis)) {
+        return ifTruthyCallback(checkThis);
+    }
+    else {
+        return ifFalsyCallback(checkThis);
+    }
+}
+exports.ifTruthy = ifTruthy;

package/dist/cjs/augments/function.js

@@ -1,7 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTruthy = void 0;
-function isTruthy(input) {
-    return !!input;
-}
-exports.isTruthy = isTruthy;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.filterToEnumValues = exports.isEnumValue = exports.getEnumTypedValues = exports.getEnumTypedKeys = void 0;
+exports.filterToEnumValues = exports.ensureEnum = exports.isEnumValue = exports.getEnumTypedValues = exports.getEnumTypedKeys = void 0;
 const object_entries_1 = require("./object-entries");
 function getEnumTypedKeys(input) {
     // enum keys are always strings
@@ -12,10 +12,22 @@ function getEnumTypedValues(input) {
     return keys.map((key) => input[key]);
 }
 exports.getEnumTypedValues = getEnumTypedValues;
+/** Check if the given value is within the given enum. */
 function isEnumValue(input, checkEnum) {
     return getEnumTypedValues(checkEnum).includes(input);
 }
 exports.isEnumValue = isEnumValue;
+/** 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(',')}`);
+    }
+}
+exports.ensureEnum = ensureEnum;
 function filterToEnumValues(inputs, checkEnum, caseInsensitive = false) {
     if (caseInsensitive) {
         return inputs.reduce((accum, currentInput) => {

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

@@ -1,8 +1,8 @@
 "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 function_1 = require("../function");
 const object_1 = require("./object");
 const object_entries_1 = require("./object-entries");
 const typed_has_property_1 = require("./typed-has-property");
@@ -104,7 +104,7 @@ function compareInnerValue(testValue, matchValue, throwKeyError, allowExtraProps
                     return new Error(`entry at index "${index}" did not match expected shape: ${(0, error_1.extractErrorMessage)(error)}`);
                 }
             })
-                .filter(function_1.isTruthy);
+                .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(', ')}"`);
             }

package/dist/cjs/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./augments/ansi"), exports);
 __exportStar(require("./augments/array"), exports);
 __exportStar(require("./augments/async"), exports);
+__exportStar(require("./augments/boolean"), exports);
 __exportStar(require("./augments/common-number"), exports);
 __exportStar(require("./augments/common-string"), exports);
 __exportStar(require("./augments/environment"), exports);

package/dist/esm/augments/boolean.js

@@ -0,0 +1,14 @@
+export function isTruthy(input) {
+    return !!input;
+}
+export function isFalsy(input) {
+    return !input;
+}
+export function ifTruthy(checkThis, ifTruthyCallback, ifFalsyCallback) {
+    if (isTruthy(checkThis)) {
+        return ifTruthyCallback(checkThis);
+    }
+    else {
+        return ifFalsyCallback(checkThis);
+    }
+}

package/dist/esm/augments/function.js

@@ -1,3 +1 @@
-export function isTruthy(input) {
-    return !!input;
-}
+export {};

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

@@ -7,9 +7,20 @@ export function getEnumTypedValues(input) {
     const keys = getEnumTypedKeys(input);
     return keys.map((key) => input[key]);
 }
+/** Check if the given value is within the given enum. */
 export function isEnumValue(input, checkEnum) {
     return getEnumTypedValues(checkEnum).includes(input);
 }
+/** Interpret a primitive as an enum value with type safety. */
+export 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(',')}`);
+    }
+}
 export function filterToEnumValues(inputs, checkEnum, caseInsensitive = false) {
     if (caseInsensitive) {
         return inputs.reduce((accum, currentInput) => {

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

@@ -1,5 +1,5 @@
+import { isTruthy } from '../boolean';
 import { extractErrorMessage } from '../error';
-import { isTruthy } from '../function';
 import { isObject } from './object';
 import { getObjectTypedKeys } from './object-entries';
 import { typedHasProperty } from './typed-has-property';

package/dist/esm/index.js

@@ -1,6 +1,7 @@
 export * from './augments/ansi';
 export * from './augments/array';
 export * from './augments/async';
+export * from './augments/boolean';
 export * from './augments/common-number';
 export * from './augments/common-string';
 export * from './augments/environment';

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

@@ -0,0 +1,6 @@
+export type FalsyTypes = undefined | null | false | 0 | '' | -0 | 0n;
+export type Truthy<T> = Exclude<T, FalsyTypes>;
+export type Falsy<T> = Extract<T, FalsyTypes>;
+export declare function isTruthy<T>(input: T): input is Truthy<T>;
+export declare function isFalsy<T>(input: T): input is Falsy<T>;
+export declare function ifTruthy<const InputType, IfTruthyType, IfFalsyType>(checkThis: InputType, ifTruthyCallback: (truthyInput: Truthy<InputType>) => IfTruthyType, ifFalsyCallback: (truthyInput: Falsy<InputType>) => IfFalsyType): IfTruthyType | IfFalsyType;

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

@@ -23,4 +23,3 @@ export type NoInputsFunction<ReturnGeneric = any> = () => ReturnGeneric;
  *     TypedFunction<[string | undefined], number>; // (input1: string|undefined) => number
  */
 export type TypedFunction<Arguments, Return> = Arguments extends readonly any[] ? number extends Arguments['length'] ? (...args: ArrayElement<Arguments>[]) => Return : (...args: Arguments) => Return : void extends Arguments ? () => Return : (arg: Arguments) => Return;
-export declare function isTruthy<T>(input: T): input is Exclude<T, undefined | null | false | 0 | '' | -0 | 0n>;

package/dist/types/augments/object/enum.d.ts

@@ -1,4 +1,7 @@
 export declare function getEnumTypedKeys<T extends object>(input: T): (keyof T)[];
 export declare function getEnumTypedValues<T extends object>(input: T): T[keyof T][];
+/** Check if the given value is within the given enum. */
 export declare function isEnumValue<T extends object>(input: unknown, checkEnum: T): input is T[keyof T];
+/** Interpret a primitive as an enum value with type safety. */
+export declare function ensureEnum<const ValueType extends `${EnumType[keyof EnumType]}`, const EnumType extends object>(value: ValueType, checkEnum: EnumType): EnumType;
 export declare function filterToEnumValues<T extends object>(inputs: ReadonlyArray<unknown>, checkEnum: T, caseInsensitive?: boolean): T[keyof T][];

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from './augments/ansi';
 export * from './augments/array';
 export * from './augments/async';
+export * from './augments/boolean';
 export * from './augments/common-number';
 export * from './augments/common-string';
 export * from './augments/environment';

package/package.json

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