@aidc-toolkit/utility 0.9.13-beta → 0.9.15-beta

package/dist/character-set.d.ts

@@ -0,0 +1,301 @@
+import type { StringValidation, StringValidator } from "./string.js";
+import { type TransformerCallback, type TransformerInput, type TransformerOutput } from "./transformer.js";
+/**
+ * Exclusion options for validating and creating strings based on character sets.
+ */
+export declare enum Exclusion {
+    /**
+     * No strings excluded.
+     */
+    None = 0,
+    /**
+     * Strings that start with zero ('0') excluded.
+     */
+    FirstZero = 1,
+    /**
+     * Strings that are all-numeric (e.g., "123456") excluded.
+     */
+    AllNumeric = 2
+}
+/**
+ * Character set validation parameters.
+ */
+export interface CharacterSetValidation extends StringValidation {
+    /**
+     * Minimum length. If defined and the string is less than this length, an error is thrown.
+     */
+    minimumLength?: number | undefined;
+    /**
+     * Maximum length. If defined and the string is greater than this length, an error is thrown.
+     */
+    maximumLength?: number | undefined;
+    /**
+     * Exclusion from the string. If defined and the string is within the exclusion range, an error is thrown.
+     */
+    exclusion?: Exclusion | undefined;
+    /**
+     * Position offset within a larger string. Strings are sometimes composed of multiple substrings; this parameter
+     * ensures that the error notes the proper position in the string.
+     */
+    positionOffset?: number | undefined;
+    /**
+     * Name of component, typically but not exclusively within a larger string. This parameter ensure that the
+     * error notes the component that triggered it. Value may be a string or a callback that returns a string, the
+     * latter allowing for localization changes.
+     */
+    component?: string | (() => string) | undefined;
+}
+/**
+ * Character set validator. Validates a string against a specified character set.
+ */
+export declare class CharacterSetValidator implements StringValidator<CharacterSetValidation> {
+    private static readonly NOT_ALL_NUMERIC_VALIDATOR;
+    /**
+     * Character set.
+     */
+    private readonly _characterSet;
+    /**
+     * Character set map, mapping each character in the character set to its index such that
+     * `_characterSetMap.get(_characterSet[index]) === index`.
+     */
+    private readonly _characterSetMap;
+    /**
+     * Exclusions supported by the character set.
+     */
+    private readonly _exclusionSupport;
+    /**
+     * Constructor.
+     *
+     * @param characterSet
+     * Character set. Each element is a single-character string, unique within the array, that defines the character
+     * set.
+     *
+     * @param exclusionSupport
+     * Exclusions supported by the character set. All character sets implicitly support {@link Exclusion.None}.
+     */
+    constructor(characterSet: readonly string[], ...exclusionSupport: readonly Exclusion[]);
+    /**
+     * Get the character set.
+     */
+    get characterSet(): readonly string[];
+    /**
+     * Get the character set size.
+     */
+    get characterSetSize(): number;
+    /**
+     * Get the exclusions supported by the character set.
+     */
+    get exclusionSupport(): readonly Exclusion[];
+    /**
+     * Get the character at an index.
+     *
+     * @param index
+     * Index into the character set.
+     *
+     * @returns
+     * Character at the index.
+     */
+    character(index: number): string;
+    /**
+     * Get the index for a character.
+     *
+     * @param c
+     * Character.
+     *
+     * @returns
+     * Index for the character or undefined if the character is not in the character set.
+     */
+    characterIndex(c: string): number | undefined;
+    /**
+     * Get the indexes for all characters in a string.
+     *
+     * @param s
+     * String.
+     *
+     * @returns
+     * Array of indexes for each character or undefined if the character is not in the character set.
+     */
+    characterIndexes(s: string): ReadonlyArray<number | undefined>;
+    /**
+     * Convert a component definition to a string or undefined. Checks the type of the component and makes the callback
+     * if required.
+     *
+     * @param component
+     * Component definition as a string, callback, or undefined.
+     *
+     * @returns
+     * Component as a string or undefined.
+     */
+    private static componentToString;
+    /**
+     * Validate that an exclusion is supported. If not, an error is thrown.
+     *
+     * @param exclusion
+     * Exclusion.
+     */
+    protected validateExclusion(exclusion: Exclusion): void;
+    /**
+     * Validate a string. If the string violates the character set or any of the character set validation parameters, an
+     * error is thrown.
+     *
+     * @param s
+     * String.
+     *
+     * @param validation
+     * Character set validation parameters.
+     */
+    validate(s: string, validation?: CharacterSetValidation): void;
+}
+/**
+ * Character set creator. Maps numeric values to strings using the character set as digits.
+ */
+export declare class CharacterSetCreator extends CharacterSetValidator {
+    /**
+     * Maximum string length supported.
+     */
+    static readonly MAXIMUM_STRING_LENGTH = 40;
+    /**
+     * Powers of 10 from 1 (`10**0`) to `10**MAXIMUM_STRING_LENGTH`.
+     */
+    private static readonly _powersOf10;
+    /**
+     * Create powers of a given base from 1 (`base**0`) to `base**MAXIMUM_STRING_LENGTH`.
+     *
+     * @param base
+     * Number base.
+     *
+     * @returns
+     * Array of powers of base.
+     */
+    private static createPowersOf;
+    /**
+     * Get a power of 10.
+     *
+     * @param power
+     * Power.
+     *
+     * @returns
+     * `10**power`.
+     */
+    static powerOf10(power: number): bigint;
+    /**
+     * Character set size as big integer, cached for performance purposes.
+     */
+    private readonly _characterSetSizeN;
+    /**
+     * Character set size minus 1 as big integer, cached for performance purposes.
+     */
+    private readonly _characterSetSizeMinusOneN;
+    /**
+     * Domains for every length for every supported {@link Exclusion}.
+     */
+    private readonly _exclusionDomains;
+    /**
+     * Values that would generate all zeros in the created string.
+     */
+    private readonly _allZerosValues;
+    /**
+     * Constructor.
+     *
+     * @param characterSet
+     * Character set. Each element is a single-character string, unique within the array, that defines the character
+     * set.
+     *
+     * @param exclusionSupport
+     * Exclusions supported by the character set. All character sets implicitly support {@link Exclusion.None}.
+     */
+    constructor(characterSet: readonly string[], ...exclusionSupport: readonly Exclusion[]);
+    /**
+     * Get a power of character set size.
+     *
+     * @param power
+     * Power.
+     *
+     * @returns
+     * `characterSetSize**power`.
+     */
+    private powerOfSize;
+    /**
+     * Determine the shift required to skip all all-numeric strings up to the value.
+     *
+     * @param shiftForward
+     * True to shift forward (value to string), false to shift backward (string to value).
+     *
+     * @param length
+     * Length of string for which to get the all-numeric shift.
+     *
+     * @param value
+     * Value for which to get the all-numeric shift.
+     *
+     * @returns
+     * Shift required to skip all all-numeric strings.
+     */
+    private allNumericShift;
+    /**
+     * Validate that a length is less than or equal to {@link MAXIMUM_STRING_LENGTH}. If not, an error is thrown.
+     *
+     * @param length
+     * Length.
+     */
+    private validateLength;
+    /**
+     * Create string(s) by mapping value(s) to the equivalent characters in the character set across the length of the
+     * string.
+     *
+     * @param length
+     * Required string length.
+     *
+     * @param valueOrValues
+     * Numeric value(s) of the string(s).
+     *
+     * @param exclusion
+     * String(s) to be excluded from the range of outputs. See {@link Exclusion} for possible values and their meaning.
+     *
+     * @param tweak
+     * If provided, the numerical value of the string(s) is/are "tweaked" using an {@link EncryptionTransformer |
+     * encryption transformer}.
+     *
+     * @param creatorCallback
+     * If provided, called after each string is constructed to create the final value.
+     *
+     * @returns
+     * String(s) created from the value(s).
+     */
+    create<TTransformerInput extends TransformerInput<number | bigint>>(length: number, valueOrValues: TTransformerInput, exclusion?: Exclusion, tweak?: number | bigint, creatorCallback?: TransformerCallback<string, string>): TransformerOutput<TTransformerInput, string>;
+    /**
+     * Determine the value for a string.
+     *
+     * @param s
+     * String.
+     *
+     * @param exclusion
+     * Strings excluded from the range of inputs. See {@link Exclusion} for possible values and their meaning.
+     *
+     * @param tweak
+     * If provided, the numerical value of the string was "tweaked" using an {@link EncryptionTransformer | encryption
+     * transformer}.
+     *
+     * @returns
+     * Numeric value of the string.
+     */
+    valueFor(s: string, exclusion?: Exclusion, tweak?: number | bigint): bigint;
+}
+/**
+ * Numeric creator. Character set is 0-9. Supports {@link Exclusion.FirstZero}.
+ */
+export declare const NUMERIC_CREATOR: CharacterSetCreator;
+/**
+ * Hexadecimal creator. Character set is 0-9, A-F. Supports {@link Exclusion.FirstZero} and {@link
+ * Exclusion.AllNumeric}.
+ */
+export declare const HEXADECIMAL_CREATOR: CharacterSetCreator;
+/**
+ * Alphabetic creator. Character set is A-Z.
+ */
+export declare const ALPHABETIC_CREATOR: CharacterSetCreator;
+/**
+ * Alphanumeric creator. Character set is 0-9, A-Z. Supports {@link Exclusion.FirstZero} and {@link
+ * Exclusion.AllNumeric}.
+ */
+export declare const ALPHANUMERIC_CREATOR: CharacterSetCreator;
+//# sourceMappingURL=character-set.d.ts.map

package/dist/character-set.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"character-set.d.ts","sourceRoot":"","sources":["../src/character-set.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EAAe,KAAK,mBAAmB,EAAE,KAAK,gBAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAExH;;GAEG;AACH,oBAAY,SAAS;IACjB;;OAEG;IACH,IAAI,IAAA;IAEJ;;OAEG;IACH,SAAS,IAAA;IAET;;OAEG;IACH,UAAU,IAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;IAElC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;CACnD;AAED;;GAEG;AACH,qBAAa,qBAAsB,YAAW,eAAe,CAAC,sBAAsB,CAAC;IACjF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAazC;IAER;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAoB;IAElD;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA8B;IAE/D;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAuB;IAEzD;;;;;;;;;OASG;gBACS,YAAY,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,gBAAgB,EAAE,SAAS,SAAS,EAAE;IActF;;OAEG;IACH,IAAI,YAAY,IAAI,SAAS,MAAM,EAAE,CAEpC;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,SAAS,SAAS,EAAE,CAE3C;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIhC;;;;;;;;OAQG;IACH,cAAc,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAI7C;;;;;;;;OAQG;IACH,gBAAgB,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC,MAAM,GAAG,SAAS,CAAC;IAI9D;;;;;;;;;OASG;IACH,OAAO,CAAC,MAAM,CAAC,iBAAiB;IAIhC;;;;;OAKG;IACH,SAAS,CAAC,iBAAiB,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI;IAQvD;;;;;;;;;OASG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,sBAAsB,GAAG,IAAI;CAoEjE;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,qBAAqB;IAC1D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,MAAM;IAE3C;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAA6D;IAEhG;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAY7B;;;;;;;;OAQG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAIvC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAS;IAE5C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,0BAA0B,CAAS;IAEpD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAoB;IAEpD;;;;;;;;;OASG;gBACS,YAAY,EAAE,SAAS,MAAM,EAAE,EAAE,GAAG,gBAAgB,EAAE,SAAS,SAAS,EAAE;IAmFtF;;;;;;;;OAQG;IACH,OAAO,CAAC,WAAW;IAInB;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,eAAe;IAiCvB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAgBtB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,CAAC,iBAAiB,SAAS,gBAAgB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,iBAAiB,EAAE,SAAS,GAAE,SAA0B,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,eAAe,CAAC,EAAE,mBAAmB,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAuC1R;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,GAAE,SAA0B,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;CA+C9F;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,qBAEL,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,mBAAmB,qBAGa,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,qBAG7B,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,oBAAoB,qBAIY,CAAC"}