@augment-vir/common 16.3.0 → 16.4.1

package/dist/cjs/augments/number.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toEnsuredNumber = void 0;
+function toEnsuredNumber(input) {
+    const numeric = Number(input);
+    if (isNaN(numeric)) {
+        throw new Error(`Cannot convert given input to a number: ${input}`);
+    }
+    else {
+        return numeric;
+    }
+}
+exports.toEnsuredNumber = toEnsuredNumber;

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

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

package/dist/cjs/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./augments/function"), exports);
 __exportStar(require("./augments/json"), exports);
 __exportStar(require("./augments/json-compatible"), exports);
 __exportStar(require("./augments/map"), exports);
+__exportStar(require("./augments/number"), exports);
 __exportStar(require("./augments/object/enum"), exports);
 __exportStar(require("./augments/object/filter-object"), exports);
 __exportStar(require("./augments/object/has-key"), exports);
@@ -37,10 +38,10 @@ __exportStar(require("./augments/object/object"), exports);
 __exportStar(require("./augments/object/object-entries"), exports);
 __exportStar(require("./augments/object/pick-deep"), exports);
 __exportStar(require("./augments/object/typed-has-property"), exports);
-__exportStar(require("./augments/pixel"), exports);
 __exportStar(require("./augments/promise"), exports);
 __exportStar(require("./augments/regexp"), exports);
 __exportStar(require("./augments/runtime-type-of"), exports);
+__exportStar(require("./augments/string/suffixes"), exports);
 __exportStar(require("./augments/string/url"), exports);
 __exportStar(require("./augments/string/uuid"), exports);
 __exportStar(require("./augments/time"), exports);

package/dist/esm/augments/number.js

@@ -0,0 +1,9 @@
+export function toEnsuredNumber(input) {
+    const numeric = Number(input);
+    if (isNaN(numeric)) {
+        throw new Error(`Cannot convert given input to a number: ${input}`);
+    }
+    else {
+        return numeric;
+    }
+}

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

@@ -0,0 +1,31 @@
+import { toEnsuredNumber } from '../number';
+export const percentSuffix = '%';
+export const pxSuffix = 'px';
+export function addPx(input) {
+    return addSuffix(input, pxSuffix);
+}
+export function removePx(input) {
+    return toEnsuredNumber(input.replace(/px$/, ''));
+}
+export function addPercent(input) {
+    return addSuffix(input, percentSuffix);
+}
+export function removePercent(input) {
+    return toEnsuredNumber(removeSuffix(input, percentSuffix));
+}
+export function addSuffix(input, suffix) {
+    if (String(input).endsWith(suffix)) {
+        return String(input);
+    }
+    else {
+        return `${String(input)}${suffix}`;
+    }
+}
+export function removeSuffix(input, suffix) {
+    if (input.endsWith(suffix)) {
+        return input.substring(0, input.length - suffix.length);
+    }
+    else {
+        return input;
+    }
+}

package/dist/esm/index.js

@@ -10,6 +10,7 @@ export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/map';
+export * from './augments/number';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';
@@ -21,10 +22,10 @@ export * from './augments/object/object';
 export * from './augments/object/object-entries';
 export * from './augments/object/pick-deep';
 export * from './augments/object/typed-has-property';
-export * from './augments/pixel';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/suffixes';
 export * from './augments/string/url';
 export * from './augments/string/uuid';
 export * from './augments/time';

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

@@ -0,0 +1 @@
+export declare function toEnsuredNumber(input: any): number;

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

@@ -1,7 +1,8 @@
-export declare function getEnumTypedKeys<T extends object>(input: T): (keyof T)[];
-export declare function getEnumTypedValues<T extends object>(input: T): T[keyof T][];
+export type EnumBaseType = Record<string, number | string>;
+export declare function getEnumTypedKeys<T extends EnumBaseType>(input: T): (keyof T)[];
+export declare function getEnumTypedValues<T extends EnumBaseType>(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];
+export declare function isEnumValue<T extends EnumBaseType>(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[keyof EnumType];
-export declare function filterToEnumValues<T extends object>(inputs: ReadonlyArray<unknown>, checkEnum: T, caseInsensitive?: boolean): T[keyof T][];
+export declare function ensureEnum<const ValueType extends `${EnumType[keyof EnumType]}`, const EnumType extends EnumBaseType>(value: ValueType, checkEnum: EnumType): EnumType[keyof EnumType];
+export declare function filterToEnumValues<T extends EnumBaseType>(inputs: ReadonlyArray<unknown>, checkEnum: T, caseInsensitive?: boolean): T[keyof T][];

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

@@ -0,0 +1,11 @@
+export type WithSuffix<Suffix extends string> = `${string}${Suffix}`;
+export declare const percentSuffix: "%";
+export declare const pxSuffix: "px";
+export type WithPx = WithSuffix<typeof pxSuffix>;
+export type WithPercent = WithSuffix<typeof percentSuffix>;
+export declare function addPx(input: number | string): WithPx;
+export declare function removePx(input: string): number;
+export declare function addPercent(input: number | string): WithPercent;
+export declare function removePercent(input: string): number;
+export declare function addSuffix<const Suffix extends string>(input: unknown, suffix: Suffix): WithSuffix<Suffix>;
+export declare function removeSuffix<const Suffix extends string>(input: WithSuffix<Suffix> | string, suffix: Suffix): string;

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

@@ -2,7 +2,7 @@ export type Tuple<ArrayElementGeneric, LengthGeneric extends number> = LengthGen
 type _TupleOf<ArrayElementGeneric, LengthGeneric extends number, FullArrayGeneric extends unknown[]> = FullArrayGeneric['length'] extends LengthGeneric ? FullArrayGeneric : _TupleOf<ArrayElementGeneric, LengthGeneric, [ArrayElementGeneric, ...FullArrayGeneric]>;
 export type AtLeastTuple<ArrayElementGeneric, LengthGeneric extends number> = readonly [
     ...Tuple<ArrayElementGeneric, LengthGeneric>,
-    ...(ArrayElementGeneric | undefined)[]
+    ...ArrayElementGeneric[]
 ];
 export declare function isLengthAtLeast<ArrayElementGeneric, LengthGeneric extends number>(array: ReadonlyArray<ArrayElementGeneric | undefined>, length: LengthGeneric): array is AtLeastTuple<ArrayElementGeneric, LengthGeneric>;
 export declare function assertLengthAtLeast<ArrayElementGeneric, LengthGeneric extends number>(array: ReadonlyArray<ArrayElementGeneric | undefined>, length: LengthGeneric, arrayName?: string): asserts array is AtLeastTuple<ArrayElementGeneric, LengthGeneric>;

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './augments/function';
 export * from './augments/json';
 export * from './augments/json-compatible';
 export * from './augments/map';
+export * from './augments/number';
 export * from './augments/object/enum';
 export * from './augments/object/filter-object';
 export * from './augments/object/has-key';
@@ -21,10 +22,10 @@ export * from './augments/object/object';
 export * from './augments/object/object-entries';
 export * from './augments/object/pick-deep';
 export * from './augments/object/typed-has-property';
-export * from './augments/pixel';
 export * from './augments/promise';
 export * from './augments/regexp';
 export * from './augments/runtime-type-of';
+export * from './augments/string/suffixes';
 export * from './augments/string/url';
 export * from './augments/string/uuid';
 export * from './augments/time';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "16.3.0",
+    "version": "16.4.1",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"
@@ -24,10 +24,10 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "type-fest": "^4.0.0"
+        "type-fest": "^4.3.1"
     },
     "devDependencies": {
-        "typescript": "^5.1.6"
+        "typescript": "^5.2.2"
     },
     "publishConfig": {
         "access": "public"