@aidc-toolkit/utility 0.9.8-beta → 0.9.9-beta

package/dist/index.js

@@ -9,8 +9,8 @@ var localeStrings = {
     tweakMustBeGreaterThanOrEqualToZero: "Tweak {{tweak}} must be greater than or equal to 0",
     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}}"
+    minimumValueMustBeGreaterThanOrEqualToZero: "Minimum value {{minimumValue}} must be greater than or equal to 0",
+    maximumValueMustBeLessThan: "Maximum value {{maximumValue}} must be less than {{domain}}"
   },
   RegExpValidator: {
     stringDoesNotMatchPattern: "String {{s}} does not match pattern"
@@ -43,8 +43,8 @@ var localeStrings2 = {
     tweakMustBeGreaterThanOrEqualToZero: "Le r\xE9glage {{tweak}} doit \xEAtre sup\xE9rieur ou \xE9gal \xE0 0",
     valueMustBeGreaterThanOrEqualToZero: "La valeur {{value}} doit \xEAtre sup\xE9rieure ou \xE9gale \xE0 0",
     valueMustBeLessThan: "La valeur {{value}} doit \xEAtre inf\xE9rieure \xE0 {{domain}}",
-    minValueMustBeGreaterThanOrEqualToZero: "La valeur minimale {{minValue}} doit \xEAtre sup\xE9rieure ou \xE9gale \xE0 0",
-    maxValueMustBeLessThan: "La valeur maximale {{maxValue}} doit \xEAtre inf\xE9rieure \xE0 {{domain}}"
+    minimumValueMustBeGreaterThanOrEqualToZero: "La valeur minimale {{minimumValue}} doit \xEAtre sup\xE9rieure ou \xE9gale \xE0 0",
+    maximumValueMustBeLessThan: "La valeur maximale {{maximumValue}} doit \xEAtre inf\xE9rieure \xE0 {{domain}}"
   },
   RegExpValidator: {
     stringDoesNotMatchPattern: "La cha\xEEne {{s}} ne correspond pas au mod\xE8le"
@@ -86,8 +86,8 @@ async function i18nUtilityInit(environment, debug = false) {
   await i18nCoreInit(i18nextUtility, environment, debug, utilityNS, utilityResources);
 }
 
-// src/sequencer.ts
-var Sequencer = class {
+// src/sequence.ts
+var Sequence = class {
   /**
    * Start value (inclusive).
    */
@@ -107,11 +107,11 @@ var Sequencer = class {
   /**
    * Minimum value (inclusive).
    */
-  _minValue;
+  _minimumValue;
   /**
    * Maximum value (inclusive).
    */
-  _maxValue;
+  _maximumValue;
   /**
    * Constructor.
    *
@@ -128,12 +128,12 @@ var Sequencer = class {
     this._count = count;
     if (count >= 0) {
       this._nextDelta = 1n;
-      this._minValue = this._startValue;
-      this._maxValue = this._endValue - 1n;
+      this._minimumValue = this._startValue;
+      this._maximumValue = this._endValue - 1n;
     } else {
       this._nextDelta = -1n;
-      this._minValue = this._endValue + 1n;
-      this._maxValue = this._startValue;
+      this._minimumValue = this._endValue + 1n;
+      this._maximumValue = this._startValue;
     }
   }
   /**
@@ -157,14 +157,14 @@ var Sequencer = class {
   /**
    * Get the minimum value (inclusive).
    */
-  get minValue() {
-    return this._minValue;
+  get minimumValue() {
+    return this._minimumValue;
   }
   /**
    * Get the maximum value (inclusive).
    */
-  get maxValue() {
-    return this._maxValue;
+  get maximumValue() {
+    return this._maximumValue;
   }
   /**
    * Iterable implementation.
@@ -180,12 +180,18 @@ var Sequencer = class {
 };
 
 // src/transformer.ts
-function transformIterable(iterable, transformerCallback) {
+function transformIterable(values, transformerCallback) {
   return {
+    /**
+     * Iterable implementation.
+     *
+     * @yields
+     * Next output value.
+     */
     *[Symbol.iterator]() {
       let index = 0;
-      for (const input of iterable) {
-        yield transformerCallback(input, index++);
+      for (const value of values) {
+        yield transformerCallback(value, index++);
       }
     }
   };
@@ -268,45 +274,58 @@ var Transformer = class _Transformer {
       }));
     }
   }
+  /**
+   * Validate that a value is within the domain and do the work of transforming it forward.
+   *
+   * @param value
+   * Value.
+   *
+   * @returns
+   * Transformed value.
+   */
+  validateDoForward(value) {
+    const valueN = BigInt(value);
+    this.validate(valueN);
+    return this.doForward(valueN);
+  }
+  /**
+   * Validate that a value is within the domain, do the work of transforming it forward, and apply a callback.
+   *
+   * @param transformerCallback
+   * Called after each value is transformed to convert it to its final value.
+   *
+   * @param value
+   * Value.
+   *
+   * @param index
+   * Index in sequence (0 for single transformation).
+   *
+   * @returns
+   * Transformed value.
+   */
+  validateDoForwardCallback(transformerCallback, value, index) {
+    return transformerCallback(this.validateDoForward(value), index);
+  }
   // eslint-disable-next-line jsdoc/require-jsdoc -- Implementation of overloaded signatures.
   forward(valueOrValues, transformerCallback) {
     let result;
     if (typeof valueOrValues !== "object") {
-      const valueN = BigInt(valueOrValues);
-      this.validate(valueN);
-      const transformedValue = this.doForward(valueN);
-      result = transformerCallback === void 0 ? transformedValue : transformerCallback(transformedValue, 0);
-    } else if (valueOrValues instanceof Sequencer) {
-      if (valueOrValues.minValue < 0n) {
-        throw new RangeError(i18nextUtility.t("Transformer.minValueMustBeGreaterThanOrEqualToZero", {
-          minValue: valueOrValues.minValue
+      result = transformerCallback === void 0 ? this.validateDoForward(valueOrValues) : this.validateDoForwardCallback(transformerCallback, valueOrValues, 0);
+    } else if (valueOrValues instanceof Sequence) {
+      if (valueOrValues.minimumValue < 0n) {
+        throw new RangeError(i18nextUtility.t("Transformer.minimumValueMustBeGreaterThanOrEqualToZero", {
+          minimumValue: valueOrValues.minimumValue
         }));
       }
-      if (valueOrValues.maxValue >= this.domain) {
-        throw new RangeError(i18nextUtility.t("Transformer.maxValueMustBeLessThan", {
-          maxValue: valueOrValues.maxValue,
+      if (valueOrValues.maximumValue >= this.domain) {
+        throw new RangeError(i18nextUtility.t("Transformer.maximumValueMustBeLessThan", {
+          maximumValue: valueOrValues.maximumValue,
           domain: this.domain
         }));
       }
-      if (transformerCallback === void 0) {
-        result = transformIterable(valueOrValues, (value) => this.doForward(value));
-      } else {
-        result = transformIterable(valueOrValues, (value, index) => transformerCallback(this.doForward(value), index));
-      }
+      result = transformerCallback === void 0 ? transformIterable(valueOrValues, (value) => this.doForward(value)) : transformIterable(valueOrValues, (value, index) => transformerCallback(this.doForward(value), index));
     } else {
-      if (transformerCallback === void 0) {
-        result = transformIterable(valueOrValues, (value) => {
-          const valueN = BigInt(value);
-          this.validate(valueN);
-          return this.doForward(valueN);
-        });
-      } else {
-        result = transformIterable(valueOrValues, (value, index) => {
-          const valueN = BigInt(value);
-          this.validate(valueN);
-          return transformerCallback(this.doForward(valueN), index);
-        });
-      }
+      result = transformerCallback === void 0 ? transformIterable(valueOrValues, (value) => this.validateDoForward(value)) : transformIterable(valueOrValues, (value, index) => this.validateDoForwardCallback(transformerCallback, value, index));
     }
     return result;
   }
@@ -370,10 +389,6 @@ var EncryptionTransformer = class _EncryptionTransformer extends Transformer {
    * Number of bytes covered by the domain.
    */
   _domainBytes;
-  /**
-   * Tweak.
-   */
-  _tweak;
   /**
    * Xor bytes array generated from the domain and tweak.
    */
@@ -407,18 +422,16 @@ var EncryptionTransformer = class _EncryptionTransformer extends Transformer {
       }));
     }
     let domainBytes = 0;
-    for (let reducedDomainMinusOne = this.domain - 1n; reducedDomainMinusOne !== 0n; reducedDomainMinusOne = reducedDomainMinusOne >> 8n) {
+    for (let reducedDomainMinusOne = this.domain - 1n; reducedDomainMinusOne !== 0n; reducedDomainMinusOne >>= 8n) {
       domainBytes++;
     }
     this._domainBytes = domainBytes;
-    this._tweak = BigInt(tweak);
     const xorBytes = new Array();
     const bits = new Array();
     const inverseBits = new Array();
-    for (let reducedKey = this.domain * this.tweak * 603868999n; reducedKey !== 0n; reducedKey = reducedKey >> 8n) {
-      const keyByte = Number(reducedKey & 0xFFn);
-      xorBytes.unshift(keyByte);
-      const bitNumber = keyByte & 7;
+    for (let reducedKey = this.domain * BigInt(tweak) * 603868999n; reducedKey !== 0n; reducedKey >>= 8n) {
+      xorBytes.unshift(Number(BigInt.asUintN(8, reducedKey)));
+      const bitNumber = Number(BigInt.asUintN(3, reducedKey));
       bits.push(_EncryptionTransformer.BITS[bitNumber]);
       inverseBits.push(_EncryptionTransformer.INVERSE_BITS[bitNumber]);
     }
@@ -435,12 +448,6 @@ var EncryptionTransformer = class _EncryptionTransformer extends Transformer {
       this._rounds = xorBytes.length;
     }
   }
-  /**
-   * Get the tweak.
-   */
-  get tweak() {
-    return this._tweak;
-  }
   /**
    * Convert a value to a byte array big enough to handle the entire domain.
    *
@@ -452,10 +459,8 @@ var EncryptionTransformer = class _EncryptionTransformer extends Transformer {
    */
   valueToBytes(value) {
     const bytes = new Uint8Array(this._domainBytes);
-    let reducedValue = value;
-    for (let index = this._domainBytes - 1; index >= 0; index--) {
-      bytes[index] = Number(reducedValue & 0xFFn);
-      reducedValue = reducedValue >> 8n;
+    for (let index = this._domainBytes - 1, reducedValue = value; index >= 0 && reducedValue !== 0n; index--, reducedValue >>= 8n) {
+      bytes[index] = Number(BigInt.asUintN(8, reducedValue));
     }
     return bytes;
   }
@@ -1111,7 +1116,7 @@ var CharacterSetCreator = class _CharacterSetCreator extends CharacterSetValidat
         }
         s = this.character(exclusion === 1 /* FirstZero */ ? Number(convertValue % this._characterSetSizeMinusOneN) + 1 : Number(convertValue % this._characterSetSizeN)) + s;
       }
-      return creatorCallback !== void 0 ? creatorCallback(s, index) : s;
+      return creatorCallback === void 0 ? s : creatorCallback(s, index);
     });
   }
   /**
@@ -1273,7 +1278,7 @@ export {
   NUMERIC_CREATOR,
   RecordValidator,
   RegExpValidator,
-  Sequencer,
+  Sequence,
   Transformer,
   i18nUtilityInit,
   i18nextUtility,
@@ -1281,3 +1286,19 @@ export {
   utilityNS,
   utilityResources
 };
+/*!
+ * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/utility",
-  "version": "0.9.8-beta",
+  "version": "0.9.9-beta",
   "description": "Foundational utilities for AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -20,21 +20,21 @@
   },
   "scripts": {
     "lint": "eslint .",
-    "build": "tsup src/index.ts --clean --format cjs,esm --dts",
-    "build-doc": "npm run build && tsc src/index.ts --outDir dist --target esnext --moduleResolution nodenext --module nodenext --emitDeclarationOnly --declaration --declarationMap",
+    "build-dist": "tsup src/index.ts --clean --format cjs,esm --dts",
+    "build-doc": "npm run build-dist && tsc src/index.ts --outDir dist --target esnext --moduleResolution nodenext --module nodenext --emitDeclarationOnly --declaration --declarationMap",
     "test": "vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "^0.9.8-beta",
-    "eslint": "^9.16.0",
+    "@aidc-toolkit/dev": "^0.9.9-beta",
+    "eslint": "^9.17.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.5",
     "typescript": "^5.7.2",
     "vitest": "^2.1.8"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "^0.9.8-beta",
-    "@rollup/rollup-linux-x64-gnu": "^4.28.1",
-    "i18next": "^24.1.0"
+    "@aidc-toolkit/core": "^0.9.9-beta",
+    "@rollup/rollup-linux-x64-gnu": "^4.29.1",
+    "i18next": "^24.2.0"
   }
 }

package/src/character-set.ts

@@ -585,7 +585,7 @@ export class CharacterSetCreator extends CharacterSetValidator {
                 s = this.character(exclusion === Exclusion.FirstZero ? Number(convertValue % this._characterSetSizeMinusOneN) + 1 : Number(convertValue % this._characterSetSizeN)) + s;
             }
 
-            return creatorCallback !== undefined ? creatorCallback(s, index) : s;
+            return creatorCallback === undefined ? s : creatorCallback(s, index);
         });
     }
 

package/src/index.ts

@@ -1,5 +1,21 @@
+/*!
+ * Copyright © 2024-2025 Dolphin Data Development Ltd. and AIDC Toolkit
+ * contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export * from "./locale/i18n.js";
-export * from "./sequencer.js";
+export * from "./sequence.js";
 export * from "./transformer.js";
 export type * from "./string.js";
 export * from "./reg-exp.js";

package/src/locale/en/locale-strings.ts

@@ -4,8 +4,8 @@ export const localeStrings = {
         tweakMustBeGreaterThanOrEqualToZero: "Tweak {{tweak}} must be greater than or equal to 0",
         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}}"
+        minimumValueMustBeGreaterThanOrEqualToZero: "Minimum value {{minimumValue}} must be greater than or equal to 0",
+        maximumValueMustBeLessThan: "Maximum value {{maximumValue}} must be less than {{domain}}"
     },
     RegExpValidator: {
         stringDoesNotMatchPattern: "String {{s}} does not match pattern"

package/src/locale/fr/locale-strings.ts

@@ -4,8 +4,8 @@ export const localeStrings = {
         tweakMustBeGreaterThanOrEqualToZero: "Le réglage {{tweak}} doit être supérieur ou égal à 0",
         valueMustBeGreaterThanOrEqualToZero: "La valeur {{value}} doit être supérieure ou égale à 0",
         valueMustBeLessThan: "La valeur {{value}} doit être inférieure à {{domain}}",
-        minValueMustBeGreaterThanOrEqualToZero: "La valeur minimale {{minValue}} doit être supérieure ou égale à 0",
-        maxValueMustBeLessThan: "La valeur maximale {{maxValue}} doit être inférieure à {{domain}}"
+        minimumValueMustBeGreaterThanOrEqualToZero: "La valeur minimale {{minimumValue}} doit être supérieure ou égale à 0",
+        maximumValueMustBeLessThan: "La valeur maximale {{maximumValue}} doit être inférieure à {{domain}}"
     },
     RegExpValidator: {
         stringDoesNotMatchPattern: "La chaîne {{s}} ne correspond pas au modèle"

package/src/locale/i18n.ts

@@ -1,5 +1,5 @@
 import { i18nAssertValidResources, i18nCoreInit, type I18NEnvironment } from "@aidc-toolkit/core";
-import i18next, { type Resource } from "i18next";
+import i18next, { type i18n, type Resource } from "i18next";
 import { localeStrings as enLocaleStrings } from "./en/locale-strings.js";
 import { localeStrings as frLocaleStrings } from "./fr/locale-strings.js";
 
@@ -24,7 +24,8 @@ export const utilityResources: Resource = {
     }
 };
 
-export const i18nextUtility = i18next.createInstance();
+// Explicit type is necessary to work around bug in type discovery with linked packages.
+export const i18nextUtility: i18n = i18next.createInstance();
 
 /**
  * Initialize internationalization.

package/src/{sequencer.ts → sequence.ts}

@@ -1,7 +1,7 @@
 /**
- * Sequencer. Defines an ascending or descending sequence of big integers implemented as an iterable.
+ * Sequence. Defines an ascending or descending sequence of big integers implemented as an iterable.
  */
-export class Sequencer implements Iterable<bigint> {
+export class Sequence implements Iterable<bigint> {
     /**
      * Start value (inclusive).
      */
@@ -25,12 +25,12 @@ export class Sequencer implements Iterable<bigint> {
     /**
      * Minimum value (inclusive).
      */
-    private readonly _minValue: bigint;
+    private readonly _minimumValue: bigint;
 
     /**
      * Maximum value (inclusive).
      */
-    private readonly _maxValue: bigint;
+    private readonly _maximumValue: bigint;
 
     /**
      * Constructor.
@@ -49,12 +49,12 @@ export class Sequencer implements Iterable<bigint> {
 
         if (count >= 0) {
             this._nextDelta = 1n;
-            this._minValue = this._startValue;
-            this._maxValue = this._endValue - 1n;
+            this._minimumValue = this._startValue;
+            this._maximumValue = this._endValue - 1n;
         } else {
             this._nextDelta = -1n;
-            this._minValue = this._endValue + 1n;
-            this._maxValue = this._startValue;
+            this._minimumValue = this._endValue + 1n;
+            this._maximumValue = this._startValue;
         }
     }
 
@@ -82,15 +82,15 @@ export class Sequencer implements Iterable<bigint> {
     /**
      * Get the minimum value (inclusive).
      */
-    get minValue(): bigint {
-        return this._minValue;
+    get minimumValue(): bigint {
+        return this._minimumValue;
     }
 
     /**
      * Get the maximum value (inclusive).
      */
-    get maxValue(): bigint {
-        return this._maxValue;
+    get maximumValue(): bigint {
+        return this._maximumValue;
     }
 
     /**