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

package/dist/index.d.cts

@@ -202,11 +202,12 @@ type TransformerOutput<TTransformerInput extends TransformerInput<TransformerPri
  * 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.
  */
 declare abstract class Transformer {
     /**
@@ -225,10 +226,10 @@ declare abstract class Transformer {
      */
     constructor(domain: number | bigint);
     /**
-     * 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.
@@ -237,7 +238,7 @@ declare 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;
     /**
@@ -294,7 +295,7 @@ declare 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
@@ -311,7 +312,7 @@ declare 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
@@ -358,9 +359,9 @@ declare 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
@@ -518,10 +519,10 @@ interface StringValidation {
 /**
  * String validator interface.
  *
- * @template V
+ * @template TStringValidation
  * String validation type.
  */
-interface StringValidator<V extends StringValidation = StringValidation> {
+interface StringValidator<TStringValidation extends StringValidation = StringValidation> {
     /**
      * Validate a string and throw an error if validation fails.
      *
@@ -531,17 +532,17 @@ interface StringValidator<V extends StringValidation = StringValidation> {
      * @param validation
      * String validation parameters.
      */
-    validate: (s: string, validation?: V) => void;
+    validate: (s: string, validation?: TStringValidation) => void;
 }
 
 /**
  * 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.
  */
 declare class RegExpValidator implements StringValidator {
     /**
@@ -636,10 +637,14 @@ declare const Exclusions: {
      */
     readonly AllNumeric: 2;
 };
+/**
+ * Exclusion key.
+ */
+type ExclusionKey = keyof typeof Exclusions;
 /**
  * Exclusion.
  */
-type Exclusion = typeof Exclusions[keyof typeof Exclusions];
+type Exclusion = typeof Exclusions[ExclusionKey];
 
 /**
  * Character set validation parameters.
@@ -695,7 +700,7 @@ declare class CharacterSetValidator implements StringValidator<CharacterSetValid
      * 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[]);
     /**
@@ -811,7 +816,7 @@ declare class CharacterSetCreator extends CharacterSetValidator {
      */
     private readonly _characterSetSizeMinusOneN;
     /**
-     * Domains for every length for every supported {@link Exclusions}.
+     * Domains for every length for every supported {@linkcode Exclusions}.
      */
     private readonly _exclusionDomains;
     /**
@@ -826,7 +831,7 @@ declare 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[]);
     /**
@@ -856,7 +861,7 @@ declare class CharacterSetCreator extends CharacterSetValidator {
      */
     private allNumericShift;
     /**
-     * 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.
@@ -876,7 +881,8 @@ declare 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 |
@@ -896,7 +902,7 @@ declare 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
@@ -908,20 +914,20 @@ declare class CharacterSetCreator extends CharacterSetValidator {
     valueFor(s: string, exclusion?: Exclusion, tweak?: number | bigint): bigint;
 }
 /**
- * Numeric creator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric creator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 declare const NUMERIC_CREATOR: CharacterSetCreator;
 /**
- * Numeric validator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric validator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 declare const NUMERIC_VALIDATOR: 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}.
  */
 declare const HEXADECIMAL_CREATOR: CharacterSetCreator;
 /**
- * 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}.
  */
 declare const HEXADECIMAL_VALIDATOR: CharacterSetValidator;
@@ -934,14 +940,14 @@ declare const ALPHABETIC_CREATOR: CharacterSetCreator;
  */
 declare const ALPHABETIC_VALIDATOR: 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}.
  */
 declare const ALPHANUMERIC_CREATOR: CharacterSetCreator;
 /**
- * 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}.
  */
 declare const ALPHANUMERIC_VALIDATOR: CharacterSetValidator;
 
-export { ALPHABETIC_CREATOR, ALPHABETIC_VALIDATOR, ALPHANUMERIC_CREATOR, ALPHANUMERIC_VALIDATOR, CharacterSetCreator, type CharacterSetValidation, CharacterSetValidator, EncryptionTransformer, type Exclusion, Exclusions, HEXADECIMAL_CREATOR, HEXADECIMAL_VALIDATOR, IdentityTransformer, type IndexedCallback, NUMERIC_CREATOR, NUMERIC_VALIDATOR, RecordValidator, RegExpValidator, Sequence, type StringValidation, type StringValidator, Transformer, type TransformerInput, type TransformerOutput, type TransformerPrimitive, type UtilityLocaleResources, i18nUtilityInit, i18nextUtility, mapIterable, utilityNS, utilityResources };
+export { ALPHABETIC_CREATOR, ALPHABETIC_VALIDATOR, ALPHANUMERIC_CREATOR, ALPHANUMERIC_VALIDATOR, CharacterSetCreator, type CharacterSetValidation, CharacterSetValidator, EncryptionTransformer, type Exclusion, type ExclusionKey, Exclusions, HEXADECIMAL_CREATOR, HEXADECIMAL_VALIDATOR, IdentityTransformer, type IndexedCallback, NUMERIC_CREATOR, NUMERIC_VALIDATOR, RecordValidator, RegExpValidator, Sequence, type StringValidation, type StringValidator, Transformer, type TransformerInput, type TransformerOutput, type TransformerPrimitive, type UtilityLocaleResources, i18nUtilityInit, i18nextUtility, mapIterable, utilityNS, utilityResources };

package/dist/index.d.ts

@@ -202,11 +202,12 @@ type TransformerOutput<TTransformerInput extends TransformerInput<TransformerPri
  * 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.
  */
 declare abstract class Transformer {
     /**
@@ -225,10 +226,10 @@ declare abstract class Transformer {
      */
     constructor(domain: number | bigint);
     /**
-     * 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.
@@ -237,7 +238,7 @@ declare 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;
     /**
@@ -294,7 +295,7 @@ declare 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
@@ -311,7 +312,7 @@ declare 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
@@ -358,9 +359,9 @@ declare 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
@@ -518,10 +519,10 @@ interface StringValidation {
 /**
  * String validator interface.
  *
- * @template V
+ * @template TStringValidation
  * String validation type.
  */
-interface StringValidator<V extends StringValidation = StringValidation> {
+interface StringValidator<TStringValidation extends StringValidation = StringValidation> {
     /**
      * Validate a string and throw an error if validation fails.
      *
@@ -531,17 +532,17 @@ interface StringValidator<V extends StringValidation = StringValidation> {
      * @param validation
      * String validation parameters.
      */
-    validate: (s: string, validation?: V) => void;
+    validate: (s: string, validation?: TStringValidation) => void;
 }
 
 /**
  * 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.
  */
 declare class RegExpValidator implements StringValidator {
     /**
@@ -636,10 +637,14 @@ declare const Exclusions: {
      */
     readonly AllNumeric: 2;
 };
+/**
+ * Exclusion key.
+ */
+type ExclusionKey = keyof typeof Exclusions;
 /**
  * Exclusion.
  */
-type Exclusion = typeof Exclusions[keyof typeof Exclusions];
+type Exclusion = typeof Exclusions[ExclusionKey];
 
 /**
  * Character set validation parameters.
@@ -695,7 +700,7 @@ declare class CharacterSetValidator implements StringValidator<CharacterSetValid
      * 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[]);
     /**
@@ -811,7 +816,7 @@ declare class CharacterSetCreator extends CharacterSetValidator {
      */
     private readonly _characterSetSizeMinusOneN;
     /**
-     * Domains for every length for every supported {@link Exclusions}.
+     * Domains for every length for every supported {@linkcode Exclusions}.
      */
     private readonly _exclusionDomains;
     /**
@@ -826,7 +831,7 @@ declare 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[]);
     /**
@@ -856,7 +861,7 @@ declare class CharacterSetCreator extends CharacterSetValidator {
      */
     private allNumericShift;
     /**
-     * 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.
@@ -876,7 +881,8 @@ declare 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 |
@@ -896,7 +902,7 @@ declare 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
@@ -908,20 +914,20 @@ declare class CharacterSetCreator extends CharacterSetValidator {
     valueFor(s: string, exclusion?: Exclusion, tweak?: number | bigint): bigint;
 }
 /**
- * Numeric creator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric creator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 declare const NUMERIC_CREATOR: CharacterSetCreator;
 /**
- * Numeric validator. Character set is 0-9. Supports {@link Exclusions.FirstZero}.
+ * Numeric validator. Character set is 0-9. Supports {@linkcode Exclusions.FirstZero}.
  */
 declare const NUMERIC_VALIDATOR: 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}.
  */
 declare const HEXADECIMAL_CREATOR: CharacterSetCreator;
 /**
- * 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}.
  */
 declare const HEXADECIMAL_VALIDATOR: CharacterSetValidator;
@@ -934,14 +940,14 @@ declare const ALPHABETIC_CREATOR: CharacterSetCreator;
  */
 declare const ALPHABETIC_VALIDATOR: 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}.
  */
 declare const ALPHANUMERIC_CREATOR: CharacterSetCreator;
 /**
- * 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}.
  */
 declare const ALPHANUMERIC_VALIDATOR: CharacterSetValidator;
 
-export { ALPHABETIC_CREATOR, ALPHABETIC_VALIDATOR, ALPHANUMERIC_CREATOR, ALPHANUMERIC_VALIDATOR, CharacterSetCreator, type CharacterSetValidation, CharacterSetValidator, EncryptionTransformer, type Exclusion, Exclusions, HEXADECIMAL_CREATOR, HEXADECIMAL_VALIDATOR, IdentityTransformer, type IndexedCallback, NUMERIC_CREATOR, NUMERIC_VALIDATOR, RecordValidator, RegExpValidator, Sequence, type StringValidation, type StringValidator, Transformer, type TransformerInput, type TransformerOutput, type TransformerPrimitive, type UtilityLocaleResources, i18nUtilityInit, i18nextUtility, mapIterable, utilityNS, utilityResources };
+export { ALPHABETIC_CREATOR, ALPHABETIC_VALIDATOR, ALPHANUMERIC_CREATOR, ALPHANUMERIC_VALIDATOR, CharacterSetCreator, type CharacterSetValidation, CharacterSetValidator, EncryptionTransformer, type Exclusion, type ExclusionKey, Exclusions, HEXADECIMAL_CREATOR, HEXADECIMAL_VALIDATOR, IdentityTransformer, type IndexedCallback, NUMERIC_CREATOR, NUMERIC_VALIDATOR, RecordValidator, RegExpValidator, Sequence, type StringValidation, type StringValidator, Transformer, type TransformerInput, type TransformerOutput, type TransformerPrimitive, type UtilityLocaleResources, i18nUtilityInit, i18nextUtility, mapIterable, utilityNS, utilityResources };

package/dist/index.js

@@ -430,7 +430,7 @@ var postProcessor = {
     return value;
   }
 };
-var PATH_KEY = Symbol("i18next/PATH_KEY");
+var PATH_KEY = /* @__PURE__ */ Symbol("i18next/PATH_KEY");
 function createProxy() {
   const state = [];
   const handler = /* @__PURE__ */ Object.create(null);
@@ -2415,10 +2415,10 @@ var Transformer = 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.
@@ -2427,7 +2427,7 @@ var Transformer = 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, tweak) {
     const domainN = BigInt(domain);
@@ -2943,7 +2943,7 @@ var CharacterSetValidator = class _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, ...exclusionSupport) {
     this._characterSet = characterSet;
@@ -3148,7 +3148,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
    */
   _characterSetSizeMinusOneN;
   /**
-   * Domains for every length for every supported {@link Exclusions}.
+   * Domains for every length for every supported {@linkcode Exclusions}.
    */
   _exclusionDomains;
   /**
@@ -3163,7 +3163,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
    * 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, ...exclusionSupport) {
     super(characterSet, ...exclusionSupport);
@@ -3260,7 +3260,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
     return shift;
   }
   /**
-   * 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.
@@ -3293,7 +3293,8 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
    * 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 |
@@ -3315,7 +3316,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
       if (length !== 0) {
         let convertValue = transformedValue;
         if (exclusion === Exclusions.AllNumeric && convertValue >= allZerosValue) {
-          convertValue = convertValue + this.allNumericShift(true, length, convertValue - allZerosValue);
+          convertValue += this.allNumericShift(true, length, convertValue - allZerosValue);
         }
         for (let position = length - 1; position > 0; position--) {
           const nextConvertValue = convertValue / this._characterSetSizeN;
@@ -3334,7 +3335,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
    * 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