@aidc-toolkit/utility 1.0.24-beta → 1.0.25-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/utility",
-  "version": "1.0.24-beta",
+  "version": "1.0.25-beta",
   "description": "Foundational utilities for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -23,10 +23,10 @@
     "test": "vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "beta",
-    "vitest": "^4.0.14"
+    "@aidc-toolkit/dev": "1.0.25-beta",
+    "vitest": "^4.0.15"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "beta"
+    "@aidc-toolkit/core": "1.0.25-beta"
   }
 }

package/src/character-set.ts

@@ -81,7 +81,7 @@ export class CharacterSetValidator implements StringValidator<CharacterSetValida
      * set.
      *
      * @param exclusionSupport
-     * Exclusions supported by the character set. All character sets implicitly support {@link Exclusions.None}.
+     * Exclusions supported by the character set. All character sets implicitly support {@linkcode Exclusions.None}.
      */
     constructor(characterSet: readonly string[], ...exclusionSupport: readonly Exclusion[]) {
         this._characterSet = characterSet;
@@ -324,7 +324,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
     private readonly _characterSetSizeMinusOneN: bigint;
 
     /**
-     * Domains for every length for every supported {@link Exclusions}.
+     * Domains for every length for every supported {@linkcode Exclusions}.
      */
     private readonly _exclusionDomains: ReadonlyArray<readonly bigint[]>;
 
@@ -341,7 +341,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * set.
      *
      * @param exclusionSupport
-     * Exclusions supported by the character set. All character sets implicitly support {@link Exclusions.None}.
+     * Exclusions supported by the character set. All character sets implicitly support {@linkcode Exclusions.None}.
      */
     constructor(characterSet: readonly string[], ...exclusionSupport: readonly Exclusion[]) {
         super(characterSet, ...exclusionSupport);
@@ -488,7 +488,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
     }
 
     /**
-     * Validate that a length is less than or equal to {@link MAXIMUM_STRING_LENGTH}. If not, an error is thrown.
+     * Validate that a length is less than or equal to {@linkcode MAXIMUM_STRING_LENGTH}. If not, an error is thrown.
      *
      * @param length
      * Length.
@@ -523,7 +523,8 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * Numeric value(s) of the string(s).
      *
      * @param exclusion
-     * String(s) to be excluded from the range of outputs. See {@link Exclusions} for possible values and their meaning.
+     * String(s) to be excluded from the range of outputs. See {@linkcode Exclusions} for possible values and their
+     * meaning.
      *
      * @param tweak
      * If provided, the numerical value of the string(s) is/are "tweaked" using an {@link EncryptionTransformer |
@@ -553,7 +554,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
 
                 if (exclusion === Exclusions.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);
+                    convertValue += this.allNumericShift(true, length, convertValue - allZerosValue);
                 }
 
                 // Build string from right to left excluding the first character.
@@ -581,7 +582,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
      * String.
      *
      * @param exclusion
-     * Strings excluded from the range of inputs. See {@link Exclusions} for possible values and their meaning.
+     * Strings excluded from the range of inputs. See {@linkcode Exclusions} for possible values and their meaning.
      *
      * @param tweak
      * If provided, the numerical value of the string was "tweaked" using an {@link EncryptionTransformer | encryption
@@ -640,19 +641,19 @@ export class CharacterSetCreator extends CharacterSetValidator {
 }
 
 /**
- * Numeric creator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric creator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 export const NUMERIC_CREATOR = new CharacterSetCreator([
     "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"
 ], Exclusions.FirstZero);
 
 /**
- * Numeric validator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric validator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 export const NUMERIC_VALIDATOR = NUMERIC_CREATOR as CharacterSetValidator;
 
 /**
- * Hexadecimal creator. Character set is 0-9, A-F. Supports {@link Exclusions.FirstZero} and {@link
+ * Hexadecimal creator. Character set is 0-9, A-F. Supports {@linkcode Exclusions.FirstZero} and {@linkcode
  * Exclusions.AllNumeric}.
  */
 export const HEXADECIMAL_CREATOR = new CharacterSetCreator([
@@ -661,7 +662,7 @@ export const HEXADECIMAL_CREATOR = new CharacterSetCreator([
 ], Exclusions.FirstZero, Exclusions.AllNumeric);
 
 /**
- * Hexadecimal validator. Character set is 0-9, A-F. Supports {@link Exclusions.FirstZero} and {@link
+ * Hexadecimal validator. Character set is 0-9, A-F. Supports {@linkcode Exclusions.FirstZero} and {@linkcode
  * Exclusions.AllNumeric}.
  */
 export const HEXADECIMAL_VALIDATOR = HEXADECIMAL_CREATOR as CharacterSetValidator;
@@ -680,7 +681,7 @@ export const ALPHABETIC_CREATOR = new CharacterSetCreator([
 export const ALPHABETIC_VALIDATOR = ALPHABETIC_CREATOR as CharacterSetValidator;
 
 /**
- * Alphanumeric creator. Character set is 0-9, A-Z. Supports {@link Exclusions.FirstZero} and {@link
+ * Alphanumeric creator. Character set is 0-9, A-Z. Supports {@linkcode Exclusions.FirstZero} and {@linkcode
  * Exclusions.AllNumeric}.
  */
 export const ALPHANUMERIC_CREATOR = new CharacterSetCreator([
@@ -690,7 +691,7 @@ export const ALPHANUMERIC_CREATOR = new CharacterSetCreator([
 ], Exclusions.FirstZero, Exclusions.AllNumeric);
 
 /**
- * Alphanumeric validator. Character set is 0-9, A-Z. Supports {@link Exclusions.FirstZero} and {@link
+ * Alphanumeric validator. Character set is 0-9, A-Z. Supports {@linkcode Exclusions.FirstZero} and {@linkcode
  * Exclusions.AllNumeric}.
  */
 export const ALPHANUMERIC_VALIDATOR = ALPHANUMERIC_CREATOR as CharacterSetValidator;

package/src/exclusion.ts

@@ -18,7 +18,12 @@ export const Exclusions = {
     AllNumeric: 2
 } as const;
 
+/**
+ * Exclusion key.
+ */
+export type ExclusionKey = keyof typeof Exclusions;
+
 /**
  * Exclusion.
  */
-export type Exclusion = typeof Exclusions[keyof typeof Exclusions];
+export type Exclusion = typeof Exclusions[ExclusionKey];

package/src/reg-exp.ts

@@ -3,12 +3,12 @@ import type { StringValidator } from "./string";
 
 /**
  * Regular expression validator. The regular expression applies to the full string only if constructed as such. For
- * example, <code>&#x2F;\d&#x2A;&#x2F;</code> (0 or more digits) matches every string, <code>&#x2F;\d+&#x2F;</code>
- * (1 or more digits) matches strings with at least one digit, <code>&#x2F;^\d&#x2A;$&#x2F;</code> matches strings that
- * are all digits or empty, and <code>&#x2F;^\d+$&#x2F;</code> matches strings that are all digits and not empty.
+ * example, <code>&#x2F;\d&#x2A;&#x2F;</code> (0 or more digits) matches every string, <code>&#x2F;\d+&#x2F;</code> (1
+ * or more digits) matches strings with at least one digit, <code>&#x2F;^\d&#x2A;$&#x2F;</code> matches strings that are
+ * all digits or empty, and <code>&#x2F;^\d+$&#x2F;</code> matches strings that are all digits and not empty.
  *
- * Clients of this class are recommended to override the {@link createErrorMessage} method create a more suitable error
- * message for their use case.
+ * Clients of this class are recommended to override the {@linkcode createErrorMessage | createErrorMessage()} method
+ * to create a more suitable error message for their use case.
  */
 export class RegExpValidator implements StringValidator {
     /**

package/src/string.ts

@@ -8,10 +8,10 @@ export interface StringValidation {
 /**
  * String validator interface.
  *
- * @template V
+ * @template TStringValidation
  * String validation type.
  */
-export interface StringValidator<V extends StringValidation = StringValidation> {
+export interface StringValidator<TStringValidation extends StringValidation = StringValidation> {
     /**
      * Validate a string and throw an error if validation fails.
      *
@@ -21,5 +21,5 @@ export interface StringValidator<V extends StringValidation = StringValidation>
      * @param validation
      * String validation parameters.
      */
-    validate: (s: string, validation?: V) => void;
+    validate: (s: string, validation?: TStringValidation) => void;
 }

package/src/transformer.ts

@@ -43,11 +43,12 @@ export type TransformerOutput<TTransformerInput extends TransformerInput<Transfo
  * into values in the same domain, typically for storage in a database where the data type and length are already fixed
  * and exfiltration of the data can have significant repercussions.
  *
- * Two subclasses are supported directly by this class: {@link IdentityTransformer} (which operates based on a domain
- * only) and {@link EncryptionTransformer} (which operates based on a domain and a tweak). If an application is expected
- * to make repeated use of a transformer with the same domain and (optional) tweak and can't manage the transformer
- * object, an in-memory cache is available via the {@link get} method. Properties in {@link IdentityTransformer} and
- * {@link EncryptionTransformer} are read-only once constructed, so there is no issue with their shared use.
+ * Two subclasses are supported directly by this class: {@linkcode IdentityTransformer} (which operates based on a
+ * domain only) and {@linkcode EncryptionTransformer} (which operates based on a domain and a tweak). If an application
+ * is expected to make repeated use of a transformer with the same domain and (optional) tweak and can't manage the
+ * transformer object, an in-memory cache is available via the {@linkcode get | get()} method. Properties in {@linkcode
+ * IdentityTransformer} and {@linkcode EncryptionTransformer} are read-only once constructed, so there is no issue with
+ * their shared use.
  */
 export abstract class Transformer {
     /**
@@ -77,10 +78,10 @@ export abstract class Transformer {
     }
 
     /**
-     * Get a transformer, constructing it if necessary. The type returned is {@link IdentityTransformer} if tweak is
-     * undefined, {@link EncryptionTransformer} if tweak is defined. Note that although an {@link EncryptionTransformer}
-     * with a zero tweak operates as an {@link IdentityTransformer}, {@link EncryptionTransformer} is still the type
-     * returned if a zero tweak is explicitly specified.
+     * Get a transformer, constructing it if necessary. The type returned is {@linkcode IdentityTransformer} if tweak is
+     * undefined, {@linkcode EncryptionTransformer} if tweak is defined. Note that although an {@linkcode
+     * EncryptionTransformer} with a zero tweak operates as an {@linkcode IdentityTransformer}, {@linkcode
+     * EncryptionTransformer} is still the type returned if a zero tweak is explicitly specified.
      *
      * @param domain
      * Domain.
@@ -89,7 +90,7 @@ export abstract class Transformer {
      * Tweak.
      *
      * @returns
-     * {@link IdentityTransformer} if tweak is undefined, {@link EncryptionTransformer} if tweak is defined.
+     * {@linkcode IdentityTransformer} if tweak is undefined, {@linkcode EncryptionTransformer} if tweak is defined.
      */
     static get(domain: number | bigint, tweak?: number | bigint): Transformer {
         const domainN = BigInt(domain);
@@ -195,7 +196,7 @@ export abstract class Transformer {
      * Value(s) input type.
      *
      * @param valueOrValues
-     * Value(s). If this is an instance of {@link Sequence}, the minimum and maximum values are validated prior to
+     * Value(s). If this is an instance of {@linkcode Sequence}, the minimum and maximum values are validated prior to
      * transformation. Otherwise, the individual value(s) is/are validated at the time of transformation.
      *
      * @returns
@@ -213,7 +214,7 @@ export abstract class Transformer {
      * Transformation callback output type.
      *
      * @param valueOrValues
-     * Value(s). If this is an instance of {@link Sequence}, the minimum and maximum values are validated prior to
+     * Value(s). If this is an instance of {@linkcode Sequence}, the minimum and maximum values are validated prior to
      * transformation. Otherwise, the individual value(s) is/are validated at the time of transformation.
      *
      * @param transformerCallback
@@ -305,9 +306,9 @@ export class IdentityTransformer extends Transformer {
 /**
  * Encryption transformer. Values are transformed using repeated shuffle and xor operations, similar to those found in
  * many cryptography algorithms, particularly AES. While sufficient for obfuscation of numeric sequences (e.g., serial
- * number generation, below), if true format-preserving encryption is required, a more robust algorithm such as
- * {@link https://doi.org/10.6028/NIST.SP.800-38Gr1-draft | FF1} is recommended. Furthermore, no work has been done to
- * mitigate {@link https://timing.attacks.cr.yp.to/index.html | timing attacks} for key detection.
+ * number generation, below), if true format-preserving encryption is required, a more robust algorithm such as {@link
+ * https://doi.org/10.6028/NIST.SP.800-38Gr1.2pd | FF1} is recommended. Furthermore, no work has been done to mitigate
+ * {@link https://timing.attacks.cr.yp.to/index.html | timing attacks} for key detection.
  *
  * The purpose of the encryption transformer is to generate pseudo-random values in a deterministic manner to obscure
  * the sequence of values generated over time. A typical example is for serial number generation, where knowledge of the

package/test/record.test.ts

@@ -9,7 +9,9 @@ describe("Record validator", () => {
         ValueD: "D"
     } as const;
 
-    type StringIndex = typeof StringIndexes[keyof typeof StringIndexes];
+    type StringIndexKey = keyof typeof StringIndexes;
+
+    type StringIndex = typeof StringIndexes[StringIndexKey];
 
     const stringRecord: Record<StringIndex, string> = {
         [StringIndexes.ValueA]: "This is for Value A",