@aidc-toolkit/utility 0.9.0 → 0.9.2

package/.idea/runConfigurations/build_dev.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="build-dev" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="build-dev" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/eslint.config.js

@@ -1,15 +1,13 @@
 import tseslint from "typescript-eslint";
-import js from "@eslint/js";
 import stylistic from "@stylistic/eslint-plugin";
 import jsdoc from "eslint-plugin-jsdoc";
 import esLintConfigLove from "eslint-config-love";
 import { esLintConfigAIDCToolkit } from "@aidc-toolkit/dev";
 
 export default tseslint.config(
-    js.configs.recommended,
     ...tseslint.configs.strictTypeChecked,
     stylistic.configs["recommended-flat"],
     jsdoc.configs["flat/recommended-typescript"],
     esLintConfigLove,
-    esLintConfigAIDCToolkit
+    ...esLintConfigAIDCToolkit
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/utility",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "Foundational utilities for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -20,23 +20,23 @@
   },
   "scripts": {
     "eslint": "eslint .",
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsup src/index.ts --clean --format cjs,esm --dts",
+    "build-dev": "npm run build && tsc src/index.ts --outDir dist --target esnext --moduleResolution nodenext --module nodenext --emitDeclarationOnly --declaration --declarationMap",
     "test": "vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "^0.9.0",
-    "@eslint/js": "^9.10.0",
-    "@stylistic/eslint-plugin": "^2.7.2",
-    "eslint-config-love": "^64.0.0",
-    "eslint-plugin-jsdoc": "^50.2.2",
+    "@aidc-toolkit/dev": "^0.9.2",
+    "@stylistic/eslint-plugin": "^2.10.1",
+    "eslint-config-love": "^98.0.2",
+    "eslint-plugin-jsdoc": "^50.5.0",
     "ts-node": "^10.9.2",
-    "tsup": "^8.2.4",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.4.0",
-    "vitest": "^2.0.5"
+    "tsup": "^8.3.5",
+    "typescript": "^5.6.3",
+    "typescript-eslint": "^8.14.0",
+    "vitest": "^2.1.4"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "^0.9.0",
-    "i18next": "^23.14.0"
+    "@aidc-toolkit/core": "^0.9.2",
+    "i18next": "^23.16.5"
   }
 }

package/src/character_set.ts

@@ -1,8 +1,7 @@
-import { IterationHelper, type IterationSource } from "./iteration.js";
 import i18next, { utilityNS } from "./locale/i18n.js";
 import { RegExpValidator } from "./reg_exp.js";
 import type { StringValidation, StringValidator } from "./string.js";
-import { type TransformationCallback, Transformer } from "./transformer.js";
+import { Transformer } from "./transformer.js";
 
 /**
  * Exclusion options for validating and creating strings based on character sets.
@@ -29,29 +28,29 @@ export enum Exclusion {
  */
 export interface CharacterSetValidation extends StringValidation {
     /**
-     * Minimum length. If defined and the string is less than this length, an exception is thrown.
+     * 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 exception is thrown.
+     * 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 exception is thrown.
+     * 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 exception notes the proper position in the string.
+     * 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
-     * exception notes the component that triggered it. Value may be a string or a callback that returns a string, 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;
@@ -60,8 +59,17 @@ export interface CharacterSetValidation extends StringValidation {
 /**
  * Character set validator. Validates a string against a specified character set.
  */
-export class CharacterSetValidator implements StringValidator {
+export class CharacterSetValidator implements StringValidator<CharacterSetValidation> {
     private static readonly NOT_ALL_NUMERIC_VALIDATOR = new class extends RegExpValidator {
+        /**
+         * Create an error message for an all-numeric string.
+         *
+         * @param _s
+         * String.
+         *
+         * @returns
+         * Error message.
+         */
         protected override createErrorMessage(_s: string): string {
             return i18next.t("CharacterSetValidator.stringMustNotBeAllNumeric", {
                 ns: utilityNS
@@ -78,7 +86,7 @@ export class CharacterSetValidator implements StringValidator {
      * Character set map, mapping each character in the character set to its index such that
      * `_characterSetMap.get(_characterSet[index]) === index`.
      */
-    private readonly _characterSetMap: Map<string, number>;
+    private readonly _characterSetMap: ReadonlyMap<string, number>;
 
     /**
      * Exclusions supported by the character set.
@@ -98,7 +106,13 @@ export class CharacterSetValidator implements StringValidator {
     constructor(characterSet: readonly string[], ...exclusionSupport: readonly Exclusion[]) {
         this._characterSet = characterSet;
 
-        this._characterSetMap = new Map(characterSet.map((c, index) => [c, index]));
+        const characterSetMap = new Map<string, number>();
+
+        characterSet.forEach((c, index) => {
+            characterSetMap.set(c, index);
+        });
+
+        this._characterSetMap = characterSetMap;
 
         this._exclusionSupport = exclusionSupport;
     }
@@ -174,16 +188,14 @@ export class CharacterSetValidator implements StringValidator {
      * Component as a string or undefined.
      */
     private static componentToString(component: string | (() => string) | undefined): string | undefined {
-        return component === undefined || typeof component === "string" ? component : component();
+        return typeof component === "function" ? component() : component;
     }
 
     /**
-     * Validate that an exclusion is supported. If not, an exception is thrown.
+     * Validate that an exclusion is supported. If not, an error is thrown.
      *
      * @param exclusion
      * Exclusion.
-     *
-     * @throws RangeError
      */
     protected validateExclusion(exclusion: Exclusion): void {
         if (exclusion !== Exclusion.None && !this._exclusionSupport.includes(exclusion)) {
@@ -196,15 +208,13 @@ export class CharacterSetValidator implements StringValidator {
 
     /**
      * Validate a string. If the string violates the character set or any of the character set validation parameters, an
-     * exception is thrown.
+     * error is thrown.
      *
      * @param s
      * String.
      *
      * @param validation
      * Character set validation parameters.
-     *
-     * @throws RangeError
      */
     validate(s: string, validation?: CharacterSetValidation): void {
         const length = s.length;
@@ -259,6 +269,9 @@ export class CharacterSetValidator implements StringValidator {
             this.validateExclusion(validation.exclusion);
 
             switch (validation.exclusion) {
+                case Exclusion.None:
+                    break;
+
                 case Exclusion.FirstZero:
                     if (s.startsWith("0")) {
                         throw new RangeError(i18next.t(validation.component === undefined ? "CharacterSetValidator.invalidCharacterAtPosition" : "CharacterSetValidator.invalidCharacterAtPositionOfComponent", {
@@ -353,12 +366,12 @@ export class CharacterSetCreator extends CharacterSetValidator {
     /**
      * Domains for every length for every supported {@link Exclusion}.
      */
-    private readonly _exclusionDomains: ReadonlyArray<readonly bigint[] | undefined>;
+    private readonly _exclusionDomains: ReadonlyArray<readonly bigint[]>;
 
     /**
      * Values that would generate all zeros in the created string.
      */
-    private readonly _allZerosValues: readonly bigint[] | undefined;
+    private readonly _allZerosValues: readonly bigint[];
 
     /**
      * Constructor.
@@ -376,12 +389,20 @@ export class CharacterSetCreator extends CharacterSetValidator {
         this._characterSetSizeN = BigInt(this.characterSetSize);
         this._characterSetSizeMinusOneN = BigInt(this.characterSetSize - 1);
 
+        const exclusionDomains: Array<readonly bigint[]> = [];
+
         const exclusionNoneDomains = CharacterSetCreator.createPowersOf(this.characterSetSize);
 
-        let exclusionFirstZeroDomains: bigint[] | undefined;
+        exclusionDomains[Exclusion.None] = exclusionNoneDomains;
 
         if (exclusionSupport.includes(Exclusion.FirstZero)) {
-            exclusionFirstZeroDomains = new Array<bigint>(CharacterSetCreator.MAXIMUM_STRING_LENGTH + 1);
+            if (characterSet[0] !== "0") {
+                throw new RangeError(i18next.t("CharacterSetValidator.firstZeroFirstCharacter", {
+                    ns: utilityNS
+                }));
+            }
+
+            const exclusionFirstZeroDomains = new Array<bigint>(CharacterSetCreator.MAXIMUM_STRING_LENGTH + 1);
 
             // Exclusion of first zero mathematically prohibits length of 0.
             exclusionFirstZeroDomains[0] = 0n;
@@ -390,16 +411,30 @@ export class CharacterSetCreator extends CharacterSetValidator {
                 // Domain excludes zero as the first character and so works with previous exclusion none domain.
                 exclusionFirstZeroDomains[index] = this._characterSetSizeMinusOneN * exclusionNoneDomains[index - 1];
             }
-        }
 
-        let exclusionAllNumericDomains: bigint[] | undefined;
+            exclusionDomains[Exclusion.FirstZero] = exclusionFirstZeroDomains;
+        }
 
         if (exclusionSupport.includes(Exclusion.AllNumeric)) {
-            exclusionAllNumericDomains = new Array<bigint>(CharacterSetCreator.MAXIMUM_STRING_LENGTH + 1);
+            const exclusionAllNumericDomains = new Array<bigint>(CharacterSetCreator.MAXIMUM_STRING_LENGTH + 1);
+
+            const numberIndexes = this.characterIndexes("0123456789");
+
+            let expectedNumberIndex = numberIndexes[0];
+
+            // Make sure that all numeric characters are present and in sequence.
+            for (const numberIndex of numberIndexes) {
+                if (numberIndex === undefined || numberIndex !== expectedNumberIndex) {
+                    throw new RangeError(i18next.t("CharacterSetValidator.allNumericAllNumericCharacters", {
+                        ns: utilityNS
+                    }));
+                }
+
+                expectedNumberIndex = numberIndex + 1;
+            }
 
             // Zero index is the all-zero value for a single-character string.
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const zeroIndex = BigInt(this.characterIndex("0")!);
+            const zeroIndex = BigInt((numberIndexes as number[])[0]);
 
             const allZerosValues = new Array<bigint>(CharacterSetCreator.MAXIMUM_STRING_LENGTH + 1);
             let allZerosValue = 0n;
@@ -415,13 +450,14 @@ export class CharacterSetCreator extends CharacterSetValidator {
             }
 
             this._allZerosValues = allZerosValues;
+
+            exclusionDomains[Exclusion.AllNumeric] = exclusionAllNumericDomains;
+        } else {
+            // Empty array obviates need for non-null assertion while still forcing error if indexed due to a bug.
+            this._allZerosValues = [];
         }
 
-        this._exclusionDomains = [
-            exclusionNoneDomains,
-            exclusionFirstZeroDomains,
-            exclusionAllNumericDomains
-        ];
+        this._exclusionDomains = exclusionDomains;
     }
 
     /**
@@ -434,8 +470,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * `characterSetSize**power`.
      */
     private powerOfSize(power: number): bigint {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this._exclusionDomains[Exclusion.None]![power];
+        return this._exclusionDomains[Exclusion.None][power];
     }
 
     /**
@@ -452,8 +487,6 @@ export class CharacterSetCreator extends CharacterSetValidator {
      *
      * @returns
      * Shift required to skip all all-numeric strings.
-     *
-     * @throws RangeError
      */
     private allNumericShift(shiftForward: boolean, length: number, value: bigint): bigint {
         let shift: bigint;
@@ -491,14 +524,20 @@ export class CharacterSetCreator extends CharacterSetValidator {
     }
 
     /**
-     * Validate that a length is less than or equal to {@link MAXIMUM_STRING_LENGTH}. If not, an exception is thrown.
+     * Validate that a length is less than or equal to {@link MAXIMUM_STRING_LENGTH}. If not, an error is thrown.
      *
      * @param length
      * Length.
-     *
-     * @throws RangeError
      */
     private validateLength(length: number): void {
+        if (length < 0) {
+            throw new RangeError(i18next.t("CharacterSetValidator.lengthMustBeGreaterThanOrEqualTo", {
+                ns: utilityNS,
+                length,
+                minimumLength: 0
+            }));
+        }
+
         if (length > CharacterSetCreator.MAXIMUM_STRING_LENGTH) {
             throw new RangeError(i18next.t("CharacterSetValidator.lengthMustBeLessThanOrEqualTo", {
                 ns: utilityNS,
@@ -508,73 +547,6 @@ export class CharacterSetCreator extends CharacterSetValidator {
         }
     }
 
-    /**
-     * Do the work for the creation methods. Undocumented parameters are as defined in the public methods.
-     *
-     * @template T
-     * Type defined by creation callback to do the work of creation (string or string[]).
-     *
-     * @param length
-     * See public methods.
-     *
-     * @param exclusion
-     * See public methods.
-     *
-     * @param tweak
-     * See public methods.
-     *
-     * @param creationCallback
-     * See public methods.
-     *
-     * @param createCallback
-     * Callback to do the work of creation, whether for a single value or a sequence. Called with the appropriate
-     * transformer and a transformation callback method to map individual transformed values to strings.
-     *
-     * @returns
-     * Created string or iterable iterator over created strings.
-     */
-    private doCreate<T>(length: number, exclusion: Exclusion, tweak: number | bigint | undefined, creationCallback: CreationCallback | undefined, createCallback: (transformer: Transformer, transformationCallback: TransformationCallback<string>) => T): T {
-        this.validateLength(length);
-        this.validateExclusion(exclusion);
-
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const allZerosValue = exclusion === Exclusion.AllNumeric ? this._allZerosValues![length] : undefined;
-
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const transformer = Transformer.get(this._exclusionDomains[exclusion]![length], tweak);
-
-        return createCallback(transformer, (transformedValue, index) => {
-            let s = "";
-
-            // Empty string is valid.
-            if (length !== 0) {
-                let convertValue = transformedValue;
-
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                if (exclusion === Exclusion.AllNumeric && convertValue >= allZerosValue!) {
-                    // Value to convert is shifted by the number of all-numeric strings that occur at or prior to it.
-                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                    convertValue = convertValue + this.allNumericShift(true, length, convertValue - allZerosValue!);
-                }
-
-                // Build string from right to left excluding the first character.
-                for (let position = length - 1; position > 0; position--) {
-                    const nextConvertValue = convertValue / this._characterSetSizeN;
-
-                    // First step is effectively a modulus calculation.
-                    s = this.character(Number(convertValue - nextConvertValue * this._characterSetSizeN)) + s;
-
-                    convertValue = nextConvertValue;
-                }
-
-                // Zero is first in the character set for those that support excluding first zero.
-                s = this.character(exclusion === Exclusion.FirstZero ? Number(convertValue % this._characterSetSizeMinusOneN) + 1 : Number(convertValue % this._characterSetSizeN)) + s;
-            }
-
-            return creationCallback !== undefined ? creationCallback(s, index) : s;
-        });
-    }
-
     /**
      * Create a string by mapping a value to the equivalent characters in the character set across the length of the
      * string.
@@ -598,68 +570,89 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * @returns
      * String created from the value.
      */
-    create(length: number, value: number | bigint, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint, creationCallback?: CreationCallback): string {
-        return this.doCreate(length, exclusion, tweak, creationCallback, (transformer, transformationCallback) => transformer.forward(BigInt(value), transformationCallback));
-    }
+    create(length: number, value: number | bigint, exclusion?: Exclusion, tweak?: number | bigint, creationCallback?: CreationCallback): string;
 
     /**
-     * Create a sequence of strings by mapping each value to the equivalent characters in the character set across the
-     * length of the string. Equivalent to calling {@link create} for `value = startValue + n` where `n` ranges from `0`
-     * to `count - 1`.
-     *
-     * The implementation uses {@link Transformer.forwardSequence}, so the values are created only as needed.
+     * Create multiple strings by mapping each value to the equivalent characters in the character set across the length
+     * of the string. Equivalent to calling this method for each individual value.
      *
      * @param length
-     * See {@link create}.
-     *
-     * @param startValue
-     * Numeric value of the first string. Strings are created from `startValue` to `startValue + count - 1`.
+     * Required string length.
      *
-     * @param count
-     * The number of strings to create.
+     * @param values
+     * Numeric values of the strings.
      *
      * @param exclusion
-     * See {@link create}.
+     * Strings to be excluded from the range of outputs. See {@link Exclusion} for possible values and their meaning.
      *
      * @param tweak
-     * See {@link create}.
+     * If provided, the numerical value of the strings are "tweaked" using an {@link EncryptionTransformer | encryption
+     * transformer}.
      *
      * @param creationCallback
-     * See {@link create}.
+     * If provided, called after each string is constructed to create the final value.
      *
      * @returns
-     * Iterable iterator over created strings.
+     * Iterable iterator over strings created from the values.
      */
-    createSequence(length: number, startValue: number | bigint, count: number, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint, creationCallback?: CreationCallback): IterableIterator<string> {
-        return this.doCreate(length, exclusion, tweak, creationCallback, (transformer, transformationCallback) => transformer.forwardSequence(BigInt(startValue), count, transformationCallback));
-    }
+    create(length: number, values: Iterable<number | bigint>, exclusion?: Exclusion, tweak?: number | bigint, creationCallback?: CreationCallback): IterableIterator<string>;
 
     /**
-     * Create multiple strings by mapping each value to the equivalent characters in the character set across the length
-     * of the string. Equivalent to calling {@link create} for each value in the values source.
-     *
-     * The implementation uses {@link Transformer.forwardMultiple}, so the values are created only as needed.
+     * Create a string or multiple strings. This signature exists to allow similar overloaded methods in other classes
+     * to call this method correctly.
      *
      * @param length
-     * See {@link create}.
      *
-     * @param valuesSource
-     * Source of values.
+     * @param valueOrValues
      *
      * @param exclusion
-     * See {@link create}.
      *
      * @param tweak
-     * See {@link create}.
      *
      * @param creationCallback
-     * See {@link create}.
      *
      * @returns
-     * Iterable iterator over created strings.
      */
-    createMultiple(length: number, valuesSource: IterationSource<number | bigint>, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint, creationCallback?: CreationCallback): IterableIterator<string> {
-        return this.doCreate(length, exclusion, tweak, creationCallback, (transformer, transformationCallback) => transformer.forwardMultiple(IterationHelper.from(valuesSource).map(value => BigInt(value)), transformationCallback));
+    create(length: number, valueOrValues: number | bigint | Iterable<number | bigint>, exclusion?: Exclusion, tweak?: number | bigint, creationCallback?: CreationCallback): string | IterableIterator<string>;
+
+    // eslint-disable-next-line jsdoc/require-jsdoc -- Implementation of overloaded signatures.
+    create(length: number, valueOrValues: number | bigint | Iterable<number | bigint>, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint, creationCallback?: CreationCallback): string | IterableIterator<string> {
+        this.validateLength(length);
+        this.validateExclusion(exclusion);
+
+        // Zero value obviates need for non-null assertion.
+        const allZerosValue = exclusion === Exclusion.AllNumeric ? this._allZerosValues[length] : 0n;
+
+        const transformer = Transformer.get(this._exclusionDomains[exclusion][length], tweak);
+
+        return transformer.forward(valueOrValues, (transformedValue, index) => {
+            let s = "";
+
+            // Empty string is valid.
+            if (length !== 0) {
+                let convertValue = transformedValue;
+
+                if (exclusion === Exclusion.AllNumeric && convertValue >= allZerosValue) {
+                    // Value to convert is shifted by the number of all-numeric strings that occur at or prior to it.
+                    convertValue = convertValue + this.allNumericShift(true, length, convertValue - allZerosValue);
+                }
+
+                // Build string from right to left excluding the first character.
+                for (let position = length - 1; position > 0; position--) {
+                    const nextConvertValue = convertValue / this._characterSetSizeN;
+
+                    // First step is effectively a modulus calculation.
+                    s = this.character(Number(convertValue - nextConvertValue * this._characterSetSizeN)) + s;
+
+                    convertValue = nextConvertValue;
+                }
+
+                // Zero is first in the character set for those that support excluding first zero.
+                s = this.character(exclusion === Exclusion.FirstZero ? Number(convertValue % this._characterSetSizeMinusOneN) + 1 : Number(convertValue % this._characterSetSizeN)) + s;
+            }
+
+            return creationCallback !== undefined ? creationCallback(s, index) : s;
+        });
     }
 
     /**
@@ -678,7 +671,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * @returns
      * Numeric value of the string.
      */
-    value(s: string, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint): bigint {
+    valueFor(s: string, exclusion: Exclusion = Exclusion.None, tweak?: number | bigint): bigint {
         const length = s.length;
 
         this.validateLength(length);
@@ -717,8 +710,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
         }, 0n);
 
         if (exclusion === Exclusion.AllNumeric) {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            const allZerosValue = this._allZerosValues![length];
+            const allZerosValue = this._allZerosValues[length];
 
             if (value >= allZerosValue) {
                 // Call will ensure that string is not all-numeric.
@@ -726,8 +718,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
             }
         }
 
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return Transformer.get(this._exclusionDomains[exclusion]![length], tweak).reverse(value);
+        return Transformer.get(this._exclusionDomains[exclusion][length], tweak).reverse(value);
     }
 }
 

package/src/index.ts

@@ -1,6 +1,6 @@
-export * from "./iteration.js";
+export * from "./sequencer.js";
 export * from "./transformer.js";
-export * from "./string.js";
+export type * from "./string.js";
 export * from "./reg_exp.js";
 export * from "./record.js";
 export * from "./character_set.js";

package/src/locale/en/locale_strings.ts

@@ -2,15 +2,17 @@ export const localeStrings = {
     Transformer: {
         domainMustBeGreaterThanZero: "Domain {{domain}} must be greater than 0",
         tweakMustBeGreaterThanOrEqualToZero: "Tweak {{tweak}} must be greater than or equal to 0",
-        valueMustBeGreaterThanOrEqualToZero: "Value {{startValue}} must be greater than or equal to 0",
-        startValueMustBeGreaterThanOrEqualToZero: "Start value {{startValue}} must be greater than or equal to 0",
-        valueMustBeLessThan: "Value {{endValue}} must be less than {{domain}}",
-        endValueMustBeLessThan: "End value (start value + count - 1) {{endValue}} must be less than {{domain}}"
+        valueMustBeGreaterThanOrEqualToZero: "Value {{value}} must be greater than or equal to 0",
+        valueMustBeLessThan: "Value {{value}} must be less than {{domain}}",
+        minValueMustBeGreaterThanOrEqualToZero: "Minimum value {{minValue}} must be greater than or equal to 0",
+        maxValueMustBeLessThan: "Maximum value {{maxValue}} must be less than {{domain}}"
     },
     RegExpValidator: {
         stringDoesNotMatchPattern: "String {{s}} does not match pattern"
     },
     CharacterSetValidator: {
+        firstZeroFirstCharacter: "Character set must support zero as first character",
+        allNumericAllNumericCharacters: "Character set must support all numeric characters in sequence",
         stringMustNotBeAllNumeric: "String must not be all numeric",
         lengthMustBeGreaterThanOrEqualTo: "Length {{length}} must be greater than or equal to {{minimumLength}}",
         lengthMustBeLessThanOrEqualTo: "Length {{length}} must be less than or equal to {{maximumLength}}",

package/src/locale/i18next.d.ts

@@ -1,6 +1,12 @@
 import type { localeStrings } from "./en/locale_strings.js";
 
+/**
+ * Internationalization module.
+ */
 declare module "i18next" {
+    /**
+     * Custom type options for this package.
+     */
     interface CustomTypeOptions {
         resources: {
             // Extract the type from the English locale strings object.

package/src/record.ts

@@ -2,8 +2,8 @@ import i18next, { utilityNS } from "./locale/i18n.js";
 import type { StringValidator } from "./string.js";
 
 /**
- * Record validator. Validation is performed against a record with a string key type and throws an exception if the key
- * is not found.
+ * Record validator. Validation is performed against a record with a string key type and throws an error if the key is
+ * not found.
  */
 export class RecordValidator<T> implements StringValidator {
     /**
@@ -49,8 +49,6 @@ export class RecordValidator<T> implements StringValidator {
      *
      * @param key
      * Record key.
-     *
-     * @throws RangeError
      */
     validate(key: string): void {
         if (this.record[key] === undefined) {

package/src/reg_exp.ts

@@ -50,6 +50,9 @@ export class RegExpValidator implements StringValidator {
         });
     }
 
+    /**
+     * @inheritDoc
+     */
     validate(s: string): void {
         if (!this._regExp.test(s)) {
             throw new RangeError(this.createErrorMessage(s));