@aidc-toolkit/gs1 0.9.6-beta → 0.9.8-beta

package/src/locale/i18next.d.ts

@@ -1,4 +1,5 @@
-import type { localeStrings } from "./en/locale_strings.js";
+import type { UtilityLocaleStrings } from "@aidc-toolkit/utility";
+import type { GS1LocaleStrings } from "./i18n.js";
 
 /**
  * Internationalization module.
@@ -8,9 +9,10 @@ declare module "i18next" {
      * Custom type options for this package.
      */
     interface CustomTypeOptions {
+        defaultNS: "aidct_gs1";
         resources: {
-            // Extract the type from the English locale strings object.
-            aidct_gs1: typeof localeStrings;
+            aidct_utility: UtilityLocaleStrings;
+            aidct_gs1: GS1LocaleStrings;
         };
     }
 }

package/test/check.test.ts

@@ -1,4 +1,4 @@
-import { I18NEnvironment, i18nInit } from "@aidc-toolkit/core";
+import { I18NEnvironment } from "@aidc-toolkit/core";
 import { NUMERIC_CREATOR } from "@aidc-toolkit/utility";
 import { describe, expect, test } from "vitest";
 import {
@@ -8,10 +8,11 @@ import {
     fiveDigitPriceWeightCheckDigit,
     fourDigitPriceWeightCheckDigit,
     hasValidCheckCharacterPair,
-    hasValidCheckDigit
+    hasValidCheckDigit,
+    i18nGS1Init
 } from "../src/index.js";
 
-await i18nInit(I18NEnvironment.CLI);
+await i18nGS1Init(I18NEnvironment.CLI, true);
 
 describe("Check digit", () => {
     const testNumericString = "1234567890";
@@ -93,8 +94,8 @@ describe("Price/weight check digit", () => {
         testFourDigitPriceWeightCheckDigit("9012");
 
         expect(() => fourDigitPriceWeightCheckDigit("l234")).toThrow("Invalid character 'l' at position 1");
-        expect(() => fourDigitPriceWeightCheckDigit("123")).toThrow("String for price or weight sum must be exactly 4 characters");
-        expect(() => fourDigitPriceWeightCheckDigit("12345")).toThrow("String for price or weight sum must be exactly 4 characters");
+        expect(() => fourDigitPriceWeightCheckDigit("123")).toThrow("Length 3 of string for price or weight sum must be exactly 4");
+        expect(() => fourDigitPriceWeightCheckDigit("12345")).toThrow("Length 5 of string for price or weight sum must be exactly 4");
     });
 
     test("Five-digit", () => {
@@ -109,9 +110,9 @@ describe("Price/weight check digit", () => {
         testFiveDigitPriceWeightCheckDigit("89012");
         testFiveDigitPriceWeightCheckDigit("90123");
 
-        expect(() => fiveDigitPriceWeightCheckDigit("l2345")).toThrow("Invalid character 'l' at position 1");
-        expect(() => fiveDigitPriceWeightCheckDigit("1234")).toThrow("String for price or weight sum must be exactly 5 characters");
-        expect(() => fiveDigitPriceWeightCheckDigit("123456")).toThrow("String for price or weight sum must be exactly 5 characters");
+        expect(() => fiveDigitPriceWeightCheckDigit("l2345")).toThrow("Invalid character 'l' at position 1 of price or weight");
+        expect(() => fiveDigitPriceWeightCheckDigit("1234")).toThrow("Length 4 of string for price or weight sum must be exactly 5");
+        expect(() => fiveDigitPriceWeightCheckDigit("123456")).toThrow("Length 6 of string for price or weight sum must be exactly 5");
     });
 });
 

package/test/idkey.test.ts

@@ -1,10 +1,10 @@
-import { I18NEnvironment, i18nInit } from "@aidc-toolkit/core";
+import { I18NEnvironment } from "@aidc-toolkit/core";
 import { CharacterSetCreator, Exclusion, NUMERIC_CREATOR, Sequencer } from "@aidc-toolkit/utility";
 import { describe, expect, test } from "vitest";
 import {
     AI39_CREATOR,
     AI82_CREATOR,
-    CharacterSet,
+    ContentCharacterSet,
     CPID_VALIDATOR,
     GCN_VALIDATOR,
     GDTI_VALIDATOR,
@@ -25,6 +25,7 @@ import {
     type GTINValidator,
     hasValidCheckCharacterPair,
     hasValidCheckDigit,
+    i18nGS1Init,
     IdentificationKeyType,
     type IdentificationKeyValidator,
     LeaderType,
@@ -41,21 +42,21 @@ import {
     SSCC_VALIDATOR
 } from "../src/index.js";
 
-await i18nInit(I18NEnvironment.CLI);
+await i18nGS1Init(I18NEnvironment.CLI);
 
-function creatorFor(characterSet: CharacterSet): CharacterSetCreator {
+function creatorFor(characterSet: ContentCharacterSet): CharacterSetCreator {
     let creator: CharacterSetCreator;
 
     switch (characterSet) {
-        case CharacterSet.Numeric:
+        case ContentCharacterSet.Numeric:
             creator = NUMERIC_CREATOR;
             break;
 
-        case CharacterSet.AI82:
+        case ContentCharacterSet.AI82:
             creator = AI82_CREATOR;
             break;
 
-        case CharacterSet.AI39:
+        case ContentCharacterSet.AI39:
             creator = AI39_CREATOR;
             break;
     }
@@ -73,7 +74,7 @@ function validateNumericIdentificationKeyValidator(validator: NumericIdentificat
     validateIdentificationKeyValidator(validator, identificationKeyType, prefixType, length);
 
     expect(validator.leaderType).toBe(leaderType);
-    expect(validator.referenceCharacterSet).toBe(CharacterSet.Numeric);
+    expect(validator.referenceCharacterSet).toBe(ContentCharacterSet.Numeric);
     expect(validator.referenceCreator).toBe(NUMERIC_CREATOR);
 
     if (isCreator) {
@@ -106,11 +107,11 @@ function validateGTINValidator(validator: GTINValidator, isCreator: boolean, gti
     expect(validator.gtinType).toBe(gtinType);
 }
 
-function validateNonGTINNumericIdentificationKeyValidator<T extends NonGTINNumericIdentificationKeyValidator>(validator: T, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, leaderType: LeaderType): void {
+function validateNonGTINNumericIdentificationKeyValidator(validator: NonGTINNumericIdentificationKeyValidator, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, leaderType: LeaderType): void {
     validateNumericIdentificationKeyValidator(validator, isCreator, identificationKeyType, PrefixType.GS1CompanyPrefix, length, leaderType);
 }
 
-function validateSerializableNumericIdentificationKeyValidator(validator: SerializableNumericIdentificationKeyValidator, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, leaderType: LeaderType, serialLength: number, serialCharacterSet: CharacterSet): void {
+function validateSerializableNumericIdentificationKeyValidator(validator: SerializableNumericIdentificationKeyValidator, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, leaderType: LeaderType, serialLength: number, serialCharacterSet: ContentCharacterSet): void {
     validateNonGTINNumericIdentificationKeyValidator(validator, isCreator, identificationKeyType, length, leaderType);
 
     const serialCreator = creatorFor(serialCharacterSet);
@@ -124,7 +125,7 @@ function validateSerializableNumericIdentificationKeyValidator(validator: Serial
     }
 }
 
-function validateNonNumericIdentificationKeyValidator(validator: NonNumericIdentificationKeyValidator, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, referenceCharacterSet: CharacterSet, requiresCheckCharacterPair: boolean): void {
+function validateNonNumericIdentificationKeyValidator(validator: NonNumericIdentificationKeyValidator, isCreator: boolean, identificationKeyType: IdentificationKeyType, length: number, referenceCharacterSet: ContentCharacterSet, requiresCheckCharacterPair: boolean): void {
     validateIdentificationKeyValidator(validator, identificationKeyType, PrefixType.GS1CompanyPrefix, length);
 
     const referenceCreator = creatorFor(referenceCharacterSet);
@@ -151,15 +152,15 @@ describe("Validators", () => {
         validateGTINValidator(GTIN8_VALIDATOR, false, GTINType.GTIN8);
         validateNonGTINNumericIdentificationKeyValidator(GLN_VALIDATOR, false, IdentificationKeyType.GLN, 13, LeaderType.None);
         validateNonGTINNumericIdentificationKeyValidator(SSCC_VALIDATOR, false, IdentificationKeyType.SSCC, 18, LeaderType.ExtensionDigit);
-        validateSerializableNumericIdentificationKeyValidator(GRAI_VALIDATOR, false, IdentificationKeyType.GRAI, 13, LeaderType.None, 16, CharacterSet.AI82);
-        validateNonNumericIdentificationKeyValidator(GIAI_VALIDATOR, false, IdentificationKeyType.GIAI, 30, CharacterSet.AI82, false);
+        validateSerializableNumericIdentificationKeyValidator(GRAI_VALIDATOR, false, IdentificationKeyType.GRAI, 13, LeaderType.None, 16, ContentCharacterSet.AI82);
+        validateNonNumericIdentificationKeyValidator(GIAI_VALIDATOR, false, IdentificationKeyType.GIAI, 30, ContentCharacterSet.AI82, false);
         validateNonGTINNumericIdentificationKeyValidator(GSRN_VALIDATOR, false, IdentificationKeyType.GSRN, 18, LeaderType.None);
-        validateSerializableNumericIdentificationKeyValidator(GDTI_VALIDATOR, false, IdentificationKeyType.GDTI, 13, LeaderType.None, 17, CharacterSet.AI82);
-        validateNonNumericIdentificationKeyValidator(GINC_VALIDATOR, false, IdentificationKeyType.GINC, 30, CharacterSet.AI82, false);
+        validateSerializableNumericIdentificationKeyValidator(GDTI_VALIDATOR, false, IdentificationKeyType.GDTI, 13, LeaderType.None, 17, ContentCharacterSet.AI82);
+        validateNonNumericIdentificationKeyValidator(GINC_VALIDATOR, false, IdentificationKeyType.GINC, 30, ContentCharacterSet.AI82, false);
         validateNonGTINNumericIdentificationKeyValidator(GSIN_VALIDATOR, false, IdentificationKeyType.GSIN, 17, LeaderType.None);
-        validateSerializableNumericIdentificationKeyValidator(GCN_VALIDATOR, false, IdentificationKeyType.GCN, 13, LeaderType.None, 12, CharacterSet.Numeric);
-        validateNonNumericIdentificationKeyValidator(CPID_VALIDATOR, false, IdentificationKeyType.CPID, 30, CharacterSet.AI39, false);
-        validateNonNumericIdentificationKeyValidator(GMN_VALIDATOR, false, IdentificationKeyType.GMN, 25, CharacterSet.AI82, true);
+        validateSerializableNumericIdentificationKeyValidator(GCN_VALIDATOR, false, IdentificationKeyType.GCN, 13, LeaderType.None, 12, ContentCharacterSet.Numeric);
+        validateNonNumericIdentificationKeyValidator(CPID_VALIDATOR, false, IdentificationKeyType.CPID, 30, ContentCharacterSet.AI39, false);
+        validateNonNumericIdentificationKeyValidator(GMN_VALIDATOR, false, IdentificationKeyType.GMN, 25, ContentCharacterSet.AI82, true);
     });
 });
 
@@ -202,15 +203,15 @@ function validateIdentificationKeyCreators(prefixManager: PrefixManager): void {
 
         validateNonGTINNumericIdentificationKeyValidator(prefixManager.glnCreator, true, IdentificationKeyType.GLN, 13, LeaderType.None);
         validateNonGTINNumericIdentificationKeyValidator(prefixManager.ssccCreator, true, IdentificationKeyType.SSCC, 18, LeaderType.ExtensionDigit);
-        validateSerializableNumericIdentificationKeyValidator(prefixManager.graiCreator, true, IdentificationKeyType.GRAI, 13, LeaderType.None, 16, CharacterSet.AI82);
-        validateNonNumericIdentificationKeyValidator(prefixManager.giaiCreator, true, IdentificationKeyType.GIAI, 30, CharacterSet.AI82, false);
+        validateSerializableNumericIdentificationKeyValidator(prefixManager.graiCreator, true, IdentificationKeyType.GRAI, 13, LeaderType.None, 16, ContentCharacterSet.AI82);
+        validateNonNumericIdentificationKeyValidator(prefixManager.giaiCreator, true, IdentificationKeyType.GIAI, 30, ContentCharacterSet.AI82, false);
         validateNonGTINNumericIdentificationKeyValidator(prefixManager.gsrnCreator, true, IdentificationKeyType.GSRN, 18, LeaderType.None);
-        validateSerializableNumericIdentificationKeyValidator(prefixManager.gdtiCreator, true, IdentificationKeyType.GDTI, 13, LeaderType.None, 17, CharacterSet.AI82);
-        validateNonNumericIdentificationKeyValidator(prefixManager.gincCreator, true, IdentificationKeyType.GINC, 30, CharacterSet.AI82, false);
+        validateSerializableNumericIdentificationKeyValidator(prefixManager.gdtiCreator, true, IdentificationKeyType.GDTI, 13, LeaderType.None, 17, ContentCharacterSet.AI82);
+        validateNonNumericIdentificationKeyValidator(prefixManager.gincCreator, true, IdentificationKeyType.GINC, 30, ContentCharacterSet.AI82, false);
         validateNonGTINNumericIdentificationKeyValidator(prefixManager.gsinCreator, true, IdentificationKeyType.GSIN, 17, LeaderType.None);
-        validateSerializableNumericIdentificationKeyValidator(prefixManager.gcnCreator, true, IdentificationKeyType.GCN, 13, LeaderType.None, 12, CharacterSet.Numeric);
-        validateNonNumericIdentificationKeyValidator(prefixManager.cpidCreator, true, IdentificationKeyType.CPID, 30, CharacterSet.AI39, false);
-        validateNonNumericIdentificationKeyValidator(prefixManager.gmnCreator, true, IdentificationKeyType.GMN, 25, CharacterSet.AI82, true);
+        validateSerializableNumericIdentificationKeyValidator(prefixManager.gcnCreator, true, IdentificationKeyType.GCN, 13, LeaderType.None, 12, ContentCharacterSet.Numeric);
+        validateNonNumericIdentificationKeyValidator(prefixManager.cpidCreator, true, IdentificationKeyType.CPID, 30, ContentCharacterSet.AI39, false);
+        validateNonNumericIdentificationKeyValidator(prefixManager.gmnCreator, true, IdentificationKeyType.GMN, 25, ContentCharacterSet.AI82, true);
     } else {
         expect(() => prefixManager.glnCreator).toThrow("GLN not supported by GS1-8 Prefix");
         expect(() => prefixManager.ssccCreator).toThrow("SSCC not supported by GS1-8 Prefix");
@@ -902,15 +903,15 @@ function testSerializableNumericIdentificationKeyCreator(creator: SerializableNu
             let invalidSerial: string;
 
             switch (creator.serialComponentCharacterSet) {
-                case CharacterSet.Numeric:
+                case ContentCharacterSet.Numeric:
                     invalidSerial = "1234A5678";
                     break;
 
-                case CharacterSet.AI82:
+                case ContentCharacterSet.AI82:
                     invalidSerial = "ABCD~1234";
                     break;
 
-                case CharacterSet.AI39:
+                case ContentCharacterSet.AI39:
                     invalidSerial = "ABCD%1234";
                     break;
             }
@@ -927,7 +928,7 @@ function testSerializableNumericIdentificationKeyCreator(creator: SerializableNu
 
 const TEST_REFERENCE_LENGTH = 2;
 
-function testNonNumericIdentificationKeyCreator<T extends NonNumericIdentificationKeyCreator>(creator: T): void {
+function testNonNumericIdentificationKeyCreator(creator: NonNumericIdentificationKeyCreator): void {
     describe(creator.identificationKeyType, () => {
         const prefix = creator.prefix;
         const prefixLength = prefix.length;