@aidc-toolkit/gs1 0.9.5 → 0.9.7-beta

package/src/index.ts

@@ -1,3 +1,4 @@
+export { gs1NS } from "./locale/i18n.js";
 export * from "./character_set.js";
 export * from "./check.js";
 export * from "./idkey.js";

package/test/check.test.ts

@@ -11,7 +11,7 @@ import {
     hasValidCheckDigit
 } from "../src/index.js";
 
-await i18nInit(I18NEnvironment.CLI, true);
+await i18nInit(I18NEnvironment.CLI);
 
 describe("Check digit", () => {
     const testNumericString = "1234567890";

package/test/idkey.test.ts

@@ -4,7 +4,7 @@ import { describe, expect, test } from "vitest";
 import {
     AI39_CREATOR,
     AI82_CREATOR,
-    CharacterSet,
+    ContentCharacterSet,
     CPID_VALIDATOR,
     GCN_VALIDATOR,
     GDTI_VALIDATOR,
@@ -41,21 +41,21 @@ import {
     SSCC_VALIDATOR
 } from "../src/index.js";
 
-await i18nInit(I18NEnvironment.CLI, true);
+await i18nInit(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,8 +73,8 @@ function validateNumericIdentificationKeyValidator(validator: NumericIdentificat
     validateIdentificationKeyValidator(validator, identificationKeyType, prefixType, length);
 
     expect(validator.leaderType).toBe(leaderType);
-    expect(validator.referenceCharacterSet).toBe(CharacterSet.Numeric);
-    expect(validator.referenceValidator).toBe(NUMERIC_CREATOR);
+    expect(validator.referenceCharacterSet).toBe(ContentCharacterSet.Numeric);
+    expect(validator.referenceCreator).toBe(NUMERIC_CREATOR);
 
     if (isCreator) {
         expect((validator as NumericIdentificationKeyCreator).referenceCreator).toBe(NUMERIC_CREATOR);
@@ -110,27 +110,27 @@ function validateNonGTINNumericIdentificationKeyValidator<T extends NonGTINNumer
     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);
 
     expect(validator.serialComponentLength).toBe(serialLength);
     expect(validator.serialComponentCharacterSet).toBe(serialCharacterSet);
-    expect(validator.serialComponentValidator).toBe(serialCreator);
+    expect(validator.serialComponentCreator).toBe(serialCreator);
 
     if (isCreator) {
         expect((validator as SerializableNumericIdentificationKeyCreator).serialComponentCreator).toBe(serialCreator);
     }
 }
 
-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);
 
     expect(validator.referenceCharacterSet).toBe(referenceCharacterSet);
-    expect(validator.referenceValidator).toBe(referenceCreator);
+    expect(validator.referenceCreator).toBe(referenceCreator);
     expect(validator.requiresCheckCharacterPair).toBe(requiresCheckCharacterPair);
 
     if (isCreator) {
@@ -151,15 +151,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 +202,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 +902,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;
             }

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Platform**
- - OS: [e.g. Windows, iOS]
- - Browser [e.g. chrome, safari]
- - Browser Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/build-publish.yml

@@ -1,20 +0,0 @@
-name: Build and publish
-
-on:
-  release:
-    types:
-      - published
-
-jobs:
-  build-and-publish:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Build and publish gs1
-        uses: aidc-toolkit/dev/.github/actions/build-publish@main
-        with:
-          project: gs1
-          node_version: ${{ vars.NODE_VERSION }}
-          node_auth_token: ${{ secrets.NODE_AUTH_TOKEN }}
-          terminal_pre_build: ${{ vars.TERMINAL_PRE_BUILD }}
-          terminal_post_build: ${{ vars.TERMINAL_POST_BUILD }}

package/.idea/gs1.iml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="JAVA_MODULE" version="4">
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/.idea/inspectionProfiles/Project_Default.xml

@@ -1,7 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0">
-    <option name="myName" value="Project Default" />
-    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
-    <inspection_tool class="UpdateDependencyToLatestVersion" enabled="true" level="WARNING" enabled_by_default="true" editorAttributes="WARNING_ATTRIBUTES" />
-  </profile>
-</component>

package/.idea/misc.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="openjdk-21" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/out" />
-  </component>
-</project>

package/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/gs1.iml" filepath="$PROJECT_DIR$/.idea/gs1.iml" />
-    </modules>
-  </component>
-</project>

package/.idea/runConfigurations/Test_all.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Test all" type="JavaScriptTestRunnerVitest">
-    <node-interpreter value="project" />
-    <vitest-package value="$PROJECT_DIR$/node_modules/vitest" />
-    <working-dir value="$PROJECT_DIR$" />
-    <vitest-options value="--run" />
-    <envs />
-    <scope-kind value="DIRECTORY" />
-    <test-directory value="$PROJECT_DIR$/test" />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/Test_check.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Test check" type="JavaScriptTestRunnerVitest">
-    <node-interpreter value="project" />
-    <vitest-package value="$PROJECT_DIR$/node_modules/vitest" />
-    <working-dir value="$PROJECT_DIR$" />
-    <vitest-options value="--run" />
-    <envs />
-    <scope-kind value="TEST_FILE" />
-    <test-file value="$PROJECT_DIR$/test/check.test.ts" />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/Test_identification_key.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Test identification key" type="JavaScriptTestRunnerVitest">
-    <node-interpreter value="project" />
-    <vitest-package value="$PROJECT_DIR$/node_modules/vitest" />
-    <working-dir value="$PROJECT_DIR$" />
-    <vitest-options value="--run" />
-    <envs />
-    <scope-kind value="TEST_FILE" />
-    <test-file value="$PROJECT_DIR$/test/idkey.test.ts" />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/build.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="build" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="build" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/runConfigurations/eslint.xml

@@ -1,12 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="eslint" type="js.build_tools.npm" nameIsGenerated="true">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="eslint" />
-    </scripts>
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

package/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>