@aidc-toolkit/gs1 1.0.39-beta → 1.0.41-beta

package/src/index.ts

@@ -68,6 +68,8 @@ export * from "./identifier-creators.js";
 
 export * from "./variable-measure.js";
 
+export * from "./prefix-manager.js";
+
 export * from "./gcp-length-data.js";
 export * from "./gcp-length-cache.js";
-export * from "./prefix-manager.js";
+export * from "./gcp-length.js";

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

@@ -37,7 +37,9 @@ export default {
         gs1CompanyPrefixCantStartWith000000: "GS1 Company Prefix can't start with \"000000\"",
         upcCompanyPrefixCantStartWith0000: "U.P.C. Company Prefix can't start with \"0000\"",
         gs18PrefixCantStartWith0: "GS1-8 Prefix can't start with \"0\"",
-        identifierTypeNotSupportedByGS18Prefix: "{{identifierType}} not supported by GS1-8 Prefix",
+        identifierTypeNotSupportedByGS18Prefix: "{{identifierType}} not supported by GS1-8 Prefix"
+    },
+    GCPLength: {
         gs1CompanyPrefixLengthDataFileNotFound: "GS1 Company Prefix length data \"{{key}}\" not found",
         gs1CompanyPrefixLengthDataNotLoaded: "GS1 Company Prefix length data not loaded"
     }

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

@@ -37,7 +37,9 @@ export default {
         gs1CompanyPrefixCantStartWith000000: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"000000\"",
         upcCompanyPrefixCantStartWith0000: "Le préfixe de l'entreprise U.P.C. ne peut pas commencer par \"0000\"",
         gs18PrefixCantStartWith0: "Le préfixe GS1-8 ne peut pas commencer par \"0\"",
-        identifierTypeNotSupportedByGS18Prefix: "{{identifierType}} non pris en charge par le préfixe GS1-8",
+        identifierTypeNotSupportedByGS18Prefix: "{{identifierType}} non pris en charge par le préfixe GS1-8"
+    },
+    GCPLength: {
         gs1CompanyPrefixLengthDataFileNotFound: "Données de longueur du préfixe d'entreprise GS1 «{{key}}» introuvables",
         gs1CompanyPrefixLengthDataNotLoaded: "Les données relatives à la longueur du préfixe d'entreprise GS1 n'ont pas été chargées"
     }

package/src/prefix-manager.ts

@@ -1,4 +1,3 @@
-import * as GCPLength from "./gcp-length.js";
 import type { GTINCreator } from "./gtin-creator.js";
 import { GTIN_BASE_TYPES } from "./gtin-length.js";
 import type { GTINType } from "./gtin-type.js";
@@ -18,7 +17,6 @@ import type { PrefixProvider } from "./prefix-provider.js";
 import { type PrefixType, PrefixTypes } from "./prefix-type.js";
 import { PrefixValidator } from "./prefix-validator.js";
 import type { SerializableNumericIdentifierCreator } from "./serializable-numeric-identifier-creator.js";
-import type { GCPLengthCache } from "./gcp-length-cache.js";
 
 /**
  * Prefix manager. This is the core class for identifier creation.
@@ -101,11 +99,6 @@ export class PrefixManager implements PrefixProvider {
      */
     readonly #identifierCreators: Partial<IdentifierCreatorsRecord> = {};
 
-    /**
-     * GS1 Company Prefix length root.
-     */
-    static #gcpLengthRoot: GCPLength.Root | undefined = undefined;
-
     /**
      * Constructor.
      *
@@ -357,62 +350,4 @@ export class PrefixManager implements PrefixProvider {
     get gmnCreator(): NonNumericIdentifierCreator {
         return this.getIdentifierCreator(IdentifierTypes.GMN);
     }
-
-    /**
-     * Load GS1 Company Prefix length data.
-     *
-     * @param gcpLengthCache
-     * GS1 Company Prefix length cache.
-     */
-    static async loadGCPLengthData(gcpLengthCache: GCPLengthCache): Promise<void> {
-        PrefixManager.#gcpLengthRoot = await GCPLength.loadData(gcpLengthCache);
-    }
-
-    /**
-     * Get the length of a GS1 Company Prefix for an identifier.
-     *
-     * @param identifierType
-     * Identifier type.
-     *
-     * @param identifier
-     * Identifier.
-     *
-     * @returns
-     * Length of GS1 Company Prefix, 0 if not a GS1 Company Prefix, or -1 if not found.
-     */
-    static gcpLength(identifierType: IdentifierType, identifier: string): number {
-        if (PrefixManager.#gcpLengthRoot === undefined) {
-            throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixLengthDataNotLoaded"));
-        }
-
-        return GCPLength.getFor(PrefixManager.#gcpLengthRoot, identifierType, identifier);
-    }
-
-    /**
-     * Get the date/time the GS1 Company Prefix length data was last updated.
-     *
-     * @returns
-     * Date/time the GS1 Company Prefix length data was last updated.
-     */
-    static gcpLengthDateTime(): Date {
-        if (PrefixManager.#gcpLengthRoot === undefined) {
-            throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixLengthDataNotLoaded"));
-        }
-
-        return PrefixManager.#gcpLengthRoot.dateTime;
-    }
-
-    /**
-     * Get the disclaimer for the GS1 Company Prefix length data.
-     *
-     * @returns
-     * Disclaimer for the GS1 Company Prefix length data.
-     */
-    static gcpLengthDisclaimer(): string {
-        if (PrefixManager.#gcpLengthRoot === undefined) {
-            throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixLengthDataNotLoaded"));
-        }
-
-        return PrefixManager.#gcpLengthRoot.disclaimer;
-    }
 }

package/test/gcp-length.test.ts

@@ -2,8 +2,9 @@ import { type AppDataStorage, LocalAppDataStorage } from "@aidc-toolkit/core";
 import * as fs from "node:fs";
 import * as path from "node:path";
 import { afterAll, beforeAll, describe, expect, test } from "vitest";
-import * as GCPLength from "../src/gcp-length.js";
+import * as GCPLengthTree from "../src/gcp-length-tree.js";
 import {
+    GCPLength,
     GCPLengthCache,
     type GCPLengthData,
     type GCPLengthHeader,
@@ -102,23 +103,23 @@ const BINARY_2_HEADER_PATH = path.resolve(DATA_DIRECTORY, "gcp-length-header-2.j
 const BINARY_2_DATA_PATH = path.resolve(DATA_DIRECTORY, "gcp-length-data-2.bin");
 
 describe("GS1 Company Prefix length", () => {
-    function verifyEqual(prefix: string, node1: GCPLength.Node | undefined, node2: GCPLength.Node | undefined): void {
+    function verifyEqual(prefix: string, node1: GCPLengthTree.Node | undefined, node2: GCPLengthTree.Node | undefined): void {
         if (node1 !== undefined) {
             if (node2 === undefined) {
                 throw new RangeError(`Prefix ${prefix}: node1 defined, node2 undefined`);
             }
 
-            if (GCPLength.isLeaf(node1)) {
-                if (!GCPLength.isLeaf(node2)) {
+            if (GCPLengthTree.isLeaf(node1)) {
+                if (!GCPLengthTree.isLeaf(node2)) {
                     throw new RangeError(`Prefix ${prefix}: node1 is leaf, node2 is branch`);
                 }
 
                 if (node1.length !== node2.length) {
                     throw new RangeError(`Prefix ${prefix}: node1.length = ${node1.length}, node2.length = ${node2.length}`);
                 }
-            } else if (!GCPLength.isLeaf(node2)) {
+            } else if (!GCPLengthTree.isLeaf(node2)) {
                 for (let index = 0; index < 10; index++) {
-                    verifyEqual(`${prefix}${index}`, node1.childNodes[index], (node2 as GCPLength.Branch).childNodes[index]);
+                    verifyEqual(`${prefix}${index}`, node1.childNodes[index], node2.childNodes[index]);
                 }
             } else {
                 throw new RangeError(`Prefix ${prefix}: node1 is branch, node2 is leaf`);
@@ -173,13 +174,15 @@ describe("GS1 Company Prefix length", () => {
         const gcpLengthCacheBinary1Source = new GCPLengthCacheBinarySource(appDataStorage, 1);
         const gcpLengthCacheBinary2Source = new GCPLengthCacheBinarySource(appDataStorage, 2);
 
-        let root1: GCPLength.Root | undefined;
-        let root2: GCPLength.Root | undefined;
+        let root1: GCPLengthTree.Root | undefined;
+        let root2: GCPLengthTree.Root | undefined;
         let nextCheckDateTime: Date | undefined;
 
+        const gcpLengthJSON1Source = new GCPLength(gcpLengthCacheJSON1Source);
+
         // Binary not available, JSON 1 available.
-        await expect(GCPLength.loadData(gcpLengthCacheJSON1Source).then((root) => {
-            root1 = root;
+        await expect(gcpLengthJSON1Source.load().then(() => {
+            root1 = gcpLengthJSON1Source.root;
         })).resolves.not.toThrowError(RangeError);
 
         nextCheckDateTime = await gcpLengthCacheJSON1Source.nextCheckDateTime;
@@ -191,9 +194,11 @@ describe("GS1 Company Prefix length", () => {
         // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Known to be defined.
         expect(new Date().getTime() + 24 * 60 * 60 * 1000 - nextCheckDateTime!.getTime()).toBeLessThan(10000);
 
+        const gcpLengthBinary1Source = new GCPLength(gcpLengthCacheBinary1Source);
+
         // Binary available, binary 1 not available but not in next check date/time window.
-        await expect(GCPLength.loadData(gcpLengthCacheBinary1Source).then((root) => {
-            root2 = root;
+        await expect(gcpLengthBinary1Source.load().then(() => {
+            root2 = gcpLengthBinary1Source.root;
         })).resolves.not.toThrowError(RangeError);
 
         expect(root2).not.toBeUndefined();
@@ -206,9 +211,11 @@ describe("GS1 Company Prefix length", () => {
         saveBinary(1);
         rm(NEXT_CHECK_DATE_TIME_PATH);
 
+        const gcpLengthJSON2Source = new GCPLength(gcpLengthCacheJSON2Source);
+
         // Binary not available, JSON 2 available.
-        await expect(GCPLength.loadData(gcpLengthCacheJSON2Source).then((root) => {
-            root2 = root;
+        await expect(gcpLengthJSON2Source.load().then(() => {
+            root2 = gcpLengthJSON2Source.root;
         })).resolves.not.toThrowError(RangeError);
 
         nextCheckDateTime = await gcpLengthCacheJSON2Source.nextCheckDateTime;
@@ -219,9 +226,11 @@ describe("GS1 Company Prefix length", () => {
         saveBinary(2);
         restoreBinary(1);
 
+        const gcpLengthBinary2Source = new GCPLength(gcpLengthCacheBinary2Source);
+
         // Binary available, binary 2 available and more recent but not in next check date/time window.
-        await expect(GCPLength.loadData(gcpLengthCacheBinary2Source).then((root) => {
-            root2 = root;
+        await expect(gcpLengthBinary2Source.load().then(() => {
+            root2 = gcpLengthBinary2Source.root;
         })).resolves.not.toThrowError(RangeError);
 
         // No change.
@@ -232,8 +241,8 @@ describe("GS1 Company Prefix length", () => {
         await gcpLengthCacheBinary2Source.update(new Date());
 
         // Binary 1 available, binary 2 available and more recent and in next check date/time window.
-        await expect(GCPLength.loadData(gcpLengthCacheBinary2Source).then((root) => {
-            root2 = root;
+        await expect(gcpLengthBinary2Source.load().then(() => {
+            root2 = gcpLengthBinary2Source.root;
         })).resolves.not.toThrowError(RangeError);
 
         expect(root2).not.toBeUndefined();
@@ -259,23 +268,20 @@ describe("GS1 Company Prefix length", () => {
             }
         }(new (await LocalAppDataStorage)(DATA_DIRECTORY), 2);
 
-        const tempRoot = await GCPLength.loadData(gcpLengthCacheJSON2Source);
+        const gcpLengthJSON2Source = new GCPLength(gcpLengthCacheJSON2Source);
 
-        expect(tempRoot).not.toBeUndefined();
-
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Known to be defined.
-        const root = tempRoot!;
+        await expect(gcpLengthJSON2Source.load()).resolves.not.toThrowError(RangeError);
 
         function testIdentifiers(prefixManager: PrefixManager, prefixLength: number): void {
-            expect(GCPLength.getFor(root, IdentifierTypes.GTIN, prefixManager.gtinCreator.create(0, true))).toBe(prefixLength);
-            expect(GCPLength.getFor(root, IdentifierTypes.GTIN, prefixManager.gtinCreator.createGTIN14("4", 0, true))).toBe(prefixLength);
+            expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GTIN, prefixManager.gtinCreator.create(0, true))).toBe(prefixLength);
+            expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GTIN, prefixManager.gtinCreator.createGTIN14("4", 0, true))).toBe(prefixLength);
 
             if (prefixManager.prefixType !== PrefixTypes.GS18Prefix) {
-                expect(GCPLength.getFor(root, IdentifierTypes.GLN, prefixManager.glnCreator.create(0, true))).toBe(prefixLength);
-                expect(GCPLength.getFor(root, IdentifierTypes.SSCC, prefixManager.ssccCreator.create(0, true))).toBe(prefixLength);
-                expect(GCPLength.getFor(root, IdentifierTypes.GRAI, prefixManager.graiCreator.create(0, true))).toBe(prefixLength);
-                expect(GCPLength.getFor(root, IdentifierTypes.GRAI, prefixManager.graiCreator.createSerialized(0, "ABCD1234", true))).toBe(prefixLength);
-                expect(GCPLength.getFor(root, IdentifierTypes.GIAI, prefixManager.giaiCreator.create("EFGH5678"))).toBe(prefixLength);
+                expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GLN, prefixManager.glnCreator.create(0, true))).toBe(prefixLength);
+                expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.SSCC, prefixManager.ssccCreator.create(0, true))).toBe(prefixLength);
+                expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GRAI, prefixManager.graiCreator.create(0, true))).toBe(prefixLength);
+                expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GRAI, prefixManager.graiCreator.createSerialized(0, "ABCD1234", true))).toBe(prefixLength);
+                expect(gcpLengthJSON2Source.lengthOf(IdentifierTypes.GIAI, prefixManager.giaiCreator.create("EFGH5678"))).toBe(prefixLength);
             }
         }
 
@@ -335,7 +341,9 @@ describe("GS1 Company Prefix length", () => {
             }
         }(new (await LocalAppDataStorage)(DATA_DIRECTORY));
 
-        await expect(GCPLength.loadData(gcpLengthCache)).resolves.not.toThrowError(RangeError);
+        const gcpLength = new GCPLength(gcpLengthCache);
+
+        await expect(gcpLength.load()).resolves.not.toThrowError(RangeError);
 
         expect(savedNextCheckDateTime).not.toBeUndefined();
         expect(savedCacheDateTime).not.toBeUndefined();