@aidc-toolkit/gs1 0.9.17-beta → 0.9.19-beta

package/dist/locale/i18n.d.ts

@@ -1,5 +1,5 @@
-import { type I18NEnvironment } from "@aidc-toolkit/core";
-import { type i18n } from "i18next";
+import { type I18nEnvironment } from "@aidc-toolkit/core";
+import { type i18n, type Resource } from "i18next";
 import { localeStrings as enLocaleStrings } from "./en/locale-strings.js";
 export declare const gs1NS = "aidct_gs1";
 /**
@@ -9,86 +9,7 @@ export type GS1LocaleStrings = typeof enLocaleStrings;
 /**
  * GS1 resources.
  */
-export declare const gs1Resources: {
-    en: {
-        aidct_gs1: {
-            readonly Check: {
-                readonly lengthOfStringForPriceOrWeightMustBeExactly: "Length {{length}} of string for price or weight sum must be exactly {{exactLength}}";
-                readonly priceOrWeightComponent: "price or weight";
-                readonly lengthOfStringForCheckCharacterPairMustBeLessThanOrEqualTo: "Length {{length}} of string for check character pair must be less than or equal to {{maximumLength}}";
-            };
-            readonly IdentificationKey: {
-                readonly identificationKeyTypeLength: "{{identificationKeyType}} must be {{length}} digits long";
-                readonly invalidCheckDigit: "Invalid check digit";
-                readonly invalidGTINLength: "GTIN must be 13, 12, 8, or 14 digits long";
-                readonly invalidGTIN14Length: "GTIN must be 14 digits long";
-                readonly invalidZeroSuppressedGTIN12: "Invalid zero-suppressed GTIN-12";
-                readonly invalidZeroSuppressibleGTIN12: "GTIN-12 not zero-suppressible";
-                readonly invalidZeroSuppressedGTIN12AsGTIN13: "Invalid zero-suppressed GTIN-12 as GTIN-13";
-                readonly invalidZeroSuppressedGTIN12AsGTIN14: "Invalid zero-suppressed GTIN-12 as GTIN-14";
-                readonly invalidGTIN13AtRetail: "GTIN-13 at retail consumer trade item level can't start with zero";
-                readonly invalidGTINAtRetail: "GTIN not supported at retail consumer trade item level";
-                readonly invalidGTINAtOtherThanRetail: "GTIN not supported at other than retail consumer trade item level";
-                readonly indicatorDigit: "indicator digit";
-                readonly serialComponent: "serial component";
-                readonly reference: "reference";
-                readonly referenceCantBeAllNumeric: "Reference can't be all-numeric";
-                readonly invalidCheckCharacterPair: "Invalid check character pair";
-            };
-            readonly Prefix: {
-                readonly gs1CompanyPrefix: "GS1 Company Prefix";
-                readonly upcCompanyPrefix: "U.P.C. Company Prefix";
-                readonly gs18Prefix: "GS1-8 Prefix";
-                readonly invalidPrefixType: "Invalid prefix type";
-                readonly gs1CompanyPrefixCantStartWith0: "GS1 Company Prefix can't start with \"0\"";
-                readonly gs1CompanyPrefixCantStartWith00000: "GS1 Company Prefix can't start with \"00000\"";
-                readonly gs1CompanyPrefixCantStartWith000000: "GS1 Company Prefix can't start with \"000000\"";
-                readonly upcCompanyPrefixCantStartWith0000: "U.P.C. Company Prefix can't start with \"0000\"";
-                readonly gs18PrefixCantStartWith0: "GS1-8 Prefix can't start with \"0\"";
-                readonly identificationKeyTypeNotSupportedByGS18Prefix: "{{identificationKeyType}} not supported by GS1-8 Prefix";
-            };
-        };
-    };
-    fr: {
-        aidct_gs1: {
-            readonly Check: {
-                readonly lengthOfStringForPriceOrWeightMustBeExactly: "La longueur {{longueur}} de la chaîne pour le prix ou la somme du poids doit être exactement {{exactLength}}";
-                readonly priceOrWeightComponent: "prix ou poids";
-                readonly lengthOfStringForCheckCharacterPairMustBeLessThanOrEqualTo: "La longueur {{length}} de la chaîne pour la paire de caractères de vérification doit être inférieure ou égale à {{maximum Length}}";
-            };
-            readonly IdentificationKey: {
-                readonly identificationKeyTypeLength: "{{identificationKeyType}} doit comporter {{length}} chiffres";
-                readonly invalidCheckDigit: "Chiffre de contrôle non valide";
-                readonly invalidGTINLength: "Le GTIN doit comporter 13, 12, 8 ou 14 chiffres";
-                readonly invalidGTIN14Length: "Le GTIN doit comporter 14 chiffres";
-                readonly invalidZeroSuppressedGTIN12: "Code GTIN-12 non valide avec zéro supprimé";
-                readonly invalidZeroSuppressibleGTIN12: "Le GTIN-12 ne peut pas être supprimé par zéro";
-                readonly invalidZeroSuppressedGTIN12AsGTIN13: "GTIN-12 non valide avec zéro supprimé en tant que GTIN-13";
-                readonly invalidZeroSuppressedGTIN12AsGTIN14: "GTIN-12 non valide avec zéro supprimé en tant que GTIN-14";
-                readonly invalidGTIN13AtRetail: "Le GTIN-13 au niveau des articles de consommation au détail ne peut pas commencer par zéro";
-                readonly invalidGTINAtRetail: "Le GTIN n'est pas pris en charge au niveau des articles de consommation au détail";
-                readonly invalidGTINAtOtherThanRetail: "Le GTIN n'est pas pris en charge à d'autres niveaux que ceux des articles de consommation au détail";
-                readonly indicatorDigit: "chiffre indicateur";
-                readonly serialComponent: "composant série";
-                readonly reference: "référence";
-                readonly referenceCantBeAllNumeric: "La référence ne peut pas être entièrement numérique";
-                readonly invalidCheckCharacterPair: "Paire de caractères de contrôle non valide";
-            };
-            readonly Prefix: {
-                readonly gs1CompanyPrefix: "Préfixe de l'entreprise GS1";
-                readonly upcCompanyPrefix: "Préfixe de l'entreprise U.P.C.";
-                readonly gs18Prefix: "Préfixe GS1-8";
-                readonly invalidPrefixType: "Type de préfixe invalide";
-                readonly gs1CompanyPrefixCantStartWith0: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"0\"";
-                readonly gs1CompanyPrefixCantStartWith00000: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"00000\"";
-                readonly gs1CompanyPrefixCantStartWith000000: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"000000\"";
-                readonly upcCompanyPrefixCantStartWith0000: "Le préfixe de l'entreprise U.P.C. ne peut pas commencer par \"0000\"";
-                readonly gs18PrefixCantStartWith0: "Le préfixe GS1-8 ne peut pas commencer par \"0\"";
-                readonly identificationKeyTypeNotSupportedByGS18Prefix: "{{identificationKeyType}} non pris en charge par le préfixe GS1-8";
-            };
-        };
-    };
-};
+export declare const gs1Resources: Resource;
 export declare const i18nextGS1: i18n;
 /**
  * Initialize internationalization.
@@ -102,5 +23,5 @@ export declare const i18nextGS1: i18n;
  * @returns
  * Void promise.
  */
-export declare function i18nGS1Init(environment: I18NEnvironment, debug?: boolean): Promise<void>;
+export declare function i18nGS1Init(environment: I18nEnvironment, debug?: boolean): Promise<void>;
 //# sourceMappingURL=i18n.d.ts.map

package/dist/locale/i18n.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../../src/locale/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAElG,OAAgB,EAAE,KAAK,IAAI,EAAE,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG1E,eAAO,MAAM,KAAK,cAAc,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,eAAe,CAAC;AAItD;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOxB,CAAC;AAGF,eAAO,MAAM,UAAU,EAAE,IAA+B,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5F"}
+{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../../src/locale/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,KAAK,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAElG,OAAgB,EAAE,KAAK,IAAI,EAAE,KAAK,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG1E,eAAO,MAAM,KAAK,cAAc,CAAC;AAEjC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,eAAe,CAAC;AAItD;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,QAO1B,CAAC;AAGF,eAAO,MAAM,UAAU,EAAE,IAA+B,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,wBAAsB,WAAW,CAAC,WAAW,EAAE,eAAe,EAAE,KAAK,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAG5F"}

package/dist/locale/i18n.js.map

@@ -1 +1 @@
-{"version":3,"file":"i18n.js","sourceRoot":"","sources":["../../src/locale/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAwB,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,OAAsB,MAAM,SAAS,CAAC;AAC7C,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE1E,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC;AAOjC,wBAAwB,CAAC,eAAe,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IACxB,EAAE,EAAE;QACA,SAAS,EAAE,eAAe;KAC7B;IACD,EAAE,EAAE;QACA,SAAS,EAAE,eAAe;KAC7B;CACJ,CAAC;AAEF,wFAAwF;AACxF,MAAM,CAAC,MAAM,UAAU,GAAS,OAAO,CAAC,cAAc,EAAE,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,WAA4B,EAAE,KAAK,GAAG,KAAK;IACzE,MAAM,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1C,MAAM,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;AAC9F,CAAC"}
+{"version":3,"file":"i18n.js","sourceRoot":"","sources":["../../src/locale/i18n.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAwB,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC1E,OAAO,OAAqC,MAAM,SAAS,CAAC;AAC5D,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,aAAa,IAAI,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE1E,MAAM,CAAC,MAAM,KAAK,GAAG,WAAW,CAAC;AAOjC,wBAAwB,CAAC,eAAe,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAa;IAClC,EAAE,EAAE;QACA,SAAS,EAAE,eAAe;KAC7B;IACD,EAAE,EAAE;QACA,SAAS,EAAE,eAAe;KAC7B;CACJ,CAAC;AAEF,wFAAwF;AACxF,MAAM,CAAC,MAAM,UAAU,GAAS,OAAO,CAAC,cAAc,EAAE,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,WAA4B,EAAE,KAAK,GAAG,KAAK;IACzE,MAAM,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC1C,MAAM,YAAY,CAAC,UAAU,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,gBAAgB,EAAE,YAAY,CAAC,CAAC;AAC9F,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/gs1",
-  "version": "0.9.17-beta",
+  "version": "0.9.19-beta",
   "description": "GS1 AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -27,13 +27,13 @@
     "test": "vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "^0.9.17-beta",
-    "vitest": "^3.0.7"
+    "@aidc-toolkit/dev": "beta",
+    "vitest": "^4.0.13"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "^0.9.17-beta",
-    "@aidc-toolkit/utility": "^0.9.17-beta",
-    "i18next": "^24.2.2",
+    "@aidc-toolkit/core": "beta",
+    "@aidc-toolkit/utility": "beta",
+    "i18next": "^25.6.3",
     "ts-mixer": "^6.0.4"
   }
 }

package/src/character-set.ts

@@ -1,4 +1,4 @@
-import { CharacterSetCreator, Exclusion } from "@aidc-toolkit/utility";
+import { CharacterSetCreator, type CharacterSetValidator, Exclusion } from "@aidc-toolkit/utility";
 
 /**
  * GS1 AI encodable character set 82 creator as defined in section 7.11 of the {@link https://www.gs1.org/genspecs | GS1
@@ -15,6 +15,12 @@ export const AI82_CREATOR = new CharacterSetCreator([
     "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z"
 ], Exclusion.AllNumeric);
 
+/**
+ * GS1 AI encodable character set 82 validator as defined in section 7.11 of the {@link https://www.gs1.org/genspecs |
+ * GS1 General Specifications}. Supports {@linkcode Exclusion.AllNumeric}.
+ */
+export const AI82_VALIDATOR = AI82_CREATOR as CharacterSetValidator;
+
 /**
  * GS1 AI encodable character set 39 creator as defined in section 7.11 of the {@link https://www.gs1.org/genspecs | GS1
  * General Specifications}. Supports {@linkcode Exclusion.AllNumeric}.
@@ -25,3 +31,9 @@ export const AI39_CREATOR = new CharacterSetCreator([
     "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M",
     "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z"
 ], Exclusion.AllNumeric);
+
+/**
+ * GS1 AI encodable character set 39 validator as defined in section 7.11 of the {@link https://www.gs1.org/genspecs |
+ * GS1 General Specifications}. Supports {@linkcode Exclusion.AllNumeric}.
+ */
+export const AI39_VALIDATOR = AI39_CREATOR as CharacterSetValidator;

package/src/check.ts

@@ -100,7 +100,7 @@ export function hasValidCheckDigit(s: string): boolean {
 }
 
 /**
- * Calculate the price/weight sum for a numeric string.
+ * Calculate the price or weight sum for a numeric string.
  *
  * @param weightsResults
  * Array of weight results arrays to apply to each digit.
@@ -111,19 +111,9 @@ export function hasValidCheckDigit(s: string): boolean {
  * @returns
  * Accumulated sum of the weight result for each digit at the digit's position.
  */
-function priceWeightSum(weightsResults: ReadonlyArray<readonly number[]>, s: string): number {
-    if (s.length !== weightsResults.length) {
-        throw new RangeError(i18nextGS1.t("Check.lengthOfStringForPriceOrWeightMustBeExactly", {
-            length: s.length,
-            exactLength: weightsResults.length
-        }));
-    }
-
-    // The value of each character is its index in the character set.
-    const characterIndexes = NUMERIC_CREATOR.characterIndexes(s);
-
+function priceOrWeightSum(weightsResults: ReadonlyArray<readonly number[]>, s: string): number {
     // Calculate sum of each weight result for each digit at its position.
-    return characterIndexes.reduce<number>((accumulator, characterIndex, index) => {
+    return NUMERIC_CREATOR.characterIndexes(s).reduce<number>((accumulator, characterIndex, index) => {
         if (characterIndex === undefined) {
             throw new RangeError(i18nextGS1.t("CharacterSetValidator.invalidCharacterAtPositionOfComponent", {
                 ns: utilityNS,
@@ -139,31 +129,50 @@ function priceWeightSum(weightsResults: ReadonlyArray<readonly number[]>, s: str
 }
 
 /**
- * Calculate the price/weight check digit for a four-digit numeric string as per section 7.9.3 of the {@link
+ * Calculate the price or weight check digit for a four-or five-digit numeric string as per section 7.9.3 of the {@link
  * https://www.gs1.org/genspecs | GS1 General Specifications}.
  *
  * @param s
- * Numeric string exactly four characters long.
+ * Numeric string exactly four or five characters long.
  *
  * @returns
  * Check digit 0-9 as a string.
  */
-export function fourDigitPriceWeightCheckDigit(s: string): string {
-    return NUMERIC_CREATOR.character(priceWeightSum([TWO_MINUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS, THREE_WEIGHT_RESULTS, FIVE_MINUS_WEIGHT_RESULTS], s) * 3 % 10);
+export function priceOrWeightCheckDigit(s: string): string {
+    let checkDigit: string;
+
+    switch (s.length) {
+        case 4:
+            checkDigit = NUMERIC_CREATOR.character(priceOrWeightSum([TWO_MINUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS, THREE_WEIGHT_RESULTS, FIVE_MINUS_WEIGHT_RESULTS], s) * 3 % 10);
+            break;
+
+        case 5:
+            checkDigit = NUMERIC_CREATOR.character(INVERSE_FIVE_MINUS_WEIGHT_RESULTS[9 - (priceOrWeightSum([FIVE_PLUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS, FIVE_MINUS_WEIGHT_RESULTS, FIVE_PLUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS], s) + 9) % 10]);
+            break;
+
+        default:
+            throw new RangeError(i18nextGS1.t("Check.lengthOfStringForPriceOrWeightMustBeExactly", {
+                length: s.length
+            }));
+    }
+
+    return checkDigit;
 }
 
 /**
- * Calculate the price/weight check digit for a five-digit numeric string as per section 7.9.3 of the {@link
- * https://www.gs1.org/genspecs | GS1 General Specifications}.
+ * Determine if a price or weight check digit is valid for numeric string.
  *
  * @param s
- * Numeric string exactly five characters long.
+ * Numeric string exactly four or five characters long.
+ *
+ * @param checkDigit
+ * Price or weight check digit.
  *
  * @returns
- * Check digit 0-9 as a string.
+ * True if the check digit is valid.
  */
-export function fiveDigitPriceWeightCheckDigit(s: string): string {
-    return NUMERIC_CREATOR.character(INVERSE_FIVE_MINUS_WEIGHT_RESULTS[9 - (priceWeightSum([FIVE_PLUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS, FIVE_MINUS_WEIGHT_RESULTS, FIVE_PLUS_WEIGHT_RESULTS, TWO_MINUS_WEIGHT_RESULTS], s) + 9) % 10]);
+export function isValidPriceOrWeightCheckDigit(s: string, checkDigit: string): boolean {
+    return priceOrWeightCheckDigit(s) === checkDigit;
 }
 
 /**