@aidc-toolkit/gs1 1.0.43 → 1.0.45-beta

package/dist/gcp-length-data.d.ts

@@ -0,0 +1,108 @@
+import type { AppData } from "@aidc-toolkit/core";
+/**
+ * GS1 Company Prefix length header.
+ */
+export interface GCPLengthHeader {
+    /**
+     * Date/time the data was last updated.
+     */
+    readonly dateTime: Date;
+    /**
+     * Disclaimer.
+     */
+    readonly disclaimer: string;
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length header.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length header.
+ */
+export declare function isGCPLengthHeader(appData: AppData | undefined): appData is GCPLengthHeader;
+/**
+ * GS1 Company Prefix length data.
+ */
+export interface GCPLengthData extends GCPLengthHeader {
+    /**
+     * Tree data in binary form.
+     */
+    readonly data: Uint8Array;
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length data.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length data.
+ */
+export declare function isGCPLengthData(appData: AppData | undefined): appData is GCPLengthData;
+/**
+ * GS1 Company Prefix length application data.
+ */
+export interface GCPLengthAppData {
+    /**
+     * Next check date/time.
+     */
+    nextCheckDateTime: Date | undefined;
+    /**
+     * GS1 Company Prefix length data.
+     */
+    gcpLengthData: GCPLengthData | undefined;
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length application data.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length application data.
+ */
+export declare function isGCPLengthAppData(appData: AppData | undefined): appData is GCPLengthAppData;
+/**
+ * GS1 Company Prefix length JSON source file format.
+ */
+export interface GCPLengthSourceJSON {
+    /**
+     * Disclaimer.
+     */
+    _disclaimer: string[];
+    /**
+     * Format list.
+     */
+    GCPPrefixFormatList: {
+        /**
+         * ISO data/time the table was last updated.
+         */
+        date: string;
+        /**
+         * Entries.
+         */
+        entry: Array<{
+            /**
+             * Identification key prefix start.
+             */
+            prefix: string;
+            /**
+             * Length of GS1 Company Prefix.
+             */
+            gcpLength: number;
+        }>;
+    };
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length source JSON.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length source JSON.
+ */
+export declare function isGCPLengthSourceJSON(appData: AppData | undefined): appData is GCPLengthSourceJSON;
+//# sourceMappingURL=gcp-length-data.d.ts.map

package/dist/gcp-length-data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcp-length-data.d.ts","sourceRoot":"","sources":["../src/gcp-length-data.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,IAAI,eAAe,CAG1F;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,eAAe;IAClD;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,IAAI,aAAa,CAGtF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,iBAAiB,EAAE,IAAI,GAAG,SAAS,CAAC;IAEpC;;OAEG;IACH,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;CAC5C;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,IAAI,gBAAgB,CAO5F;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,mBAAmB,EAAE;QACjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,KAAK,CAAC;YACT;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;SACrB,CAAC,CAAC;KACN,CAAC;CACL;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,OAAO,IAAI,mBAAmB,CAGlG"}

package/dist/gcp-length-data.js

@@ -0,0 +1,53 @@
+/**
+ * Determine if application data object is GS1 Company Prefix length header.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length header.
+ */
+export function isGCPLengthHeader(appData) {
+    // Property type check is necessary to guard against data corruption or changes in format.
+    return typeof appData === "object" && "dateTime" in appData && appData.dateTime instanceof Date && "disclaimer" in appData && typeof appData.disclaimer === "string";
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length data.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length data.
+ */
+export function isGCPLengthData(appData) {
+    // Property type check is necessary to guard against data corruption or changes in format.
+    return isGCPLengthHeader(appData) && "data" in appData && appData.data instanceof Uint8Array;
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length application data.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length application data.
+ */
+export function isGCPLengthAppData(appData) {
+    // Property type check is necessary to guard against data corruption or changes in format.
+    return typeof appData === "object" && "nextCheckDateTime" in appData && appData.nextCheckDateTime instanceof Date && (!("gcpLengthData" in appData) || appData.gcpLengthData === undefined || (typeof appData.gcpLengthData === "object" && appData.gcpLengthData !== null && isGCPLengthData(appData.gcpLengthData)));
+}
+/**
+ * Determine if application data object is GS1 Company Prefix length source JSON.
+ *
+ * @param appData
+ * Application data object.
+ *
+ * @returns
+ * True if application data object is GS1 Company Prefix length source JSON.
+ */
+export function isGCPLengthSourceJSON(appData) {
+    // Checking is minimal as this is generally used in a controlled environment (e.g., updating remote storage).
+    return typeof appData === "object" && "_disclaimer" in appData && "GCPPrefixFormatList" in appData;
+}
+//# sourceMappingURL=gcp-length-data.js.map

package/dist/gcp-length-data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcp-length-data.js","sourceRoot":"","sources":["../src/gcp-length-data.ts"],"names":[],"mappings":"AAiBA;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,OAA4B;IAC1D,0FAA0F;IAC1F,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,UAAU,IAAI,OAAO,IAAI,OAAO,CAAC,QAAQ,YAAY,IAAI,IAAI,YAAY,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,CAAC;AACzK,CAAC;AAYD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,OAA4B;IACxD,0FAA0F;IAC1F,OAAO,iBAAiB,CAAC,OAAO,CAAC,IAAI,MAAM,IAAI,OAAO,IAAI,OAAO,CAAC,IAAI,YAAY,UAAU,CAAC;AACjG,CAAC;AAiBD;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAA4B;IAC3D,0FAA0F;IAC1F,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,mBAAmB,IAAI,OAAO,IAAI,OAAO,CAAC,iBAAiB,YAAY,IAAI,IAAI,CACjH,CAAC,CAAC,eAAe,IAAI,OAAO,CAAC,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,CACpE,OAAO,OAAO,CAAC,aAAa,KAAK,QAAQ,IAAI,OAAO,CAAC,aAAa,KAAK,IAAI,IAAI,eAAe,CAAC,OAAO,CAAC,aAAa,CAAC,CACxH,CACJ,CAAC;AACN,CAAC;AAqCD;;;;;;;;GAQG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAA4B;IAC9D,6GAA6G;IAC7G,OAAO,OAAO,OAAO,KAAK,QAAQ,IAAI,aAAa,IAAI,OAAO,IAAI,qBAAqB,IAAI,OAAO,CAAC;AACvG,CAAC"}

package/dist/gcp-length.d.ts

@@ -0,0 +1,97 @@
+import type { GCPLengthCache } from "./gcp-length-cache.js";
+import { type GCPLengthHeader } from "./gcp-length-data.js";
+import { type IdentifierType } from "./identifier-type.js";
+/**
+ * Leaf of GS1 Company Prefix length tree.
+ */
+interface Leaf {
+    readonly length: number;
+}
+/**
+ * Branch of GS1 Company Prefix length tree.
+ */
+interface Branch {
+    readonly childNodes: ReadonlyArray<Node | undefined>;
+}
+/**
+ * Root of GS1 Company Prefix length tree.
+ */
+interface Root extends GCPLengthHeader, Branch {
+}
+/**
+ * Node in GS1 Company Prefix length tree.
+ */
+type Node = Branch | Leaf;
+/**
+ * Interim branch of GS1 Company Prefix length tree with writeable child nodes.
+ */
+export interface InterimBranch {
+    readonly childNodes: Array<InterimBranch | Leaf | undefined>;
+}
+/**
+ * GS1 Company Prefix length service. The constructor takes a {@linkcode GCPLengthCache} object, which is responsible
+ * for managing the cache and source.
+ *
+ * The first step is to load the GS1 Company Prefix length data. This is done using the
+ * {@linkcode GCPLength.load | load()} method, which works as follows:
+ *
+ * - If the next check date/time is in the future, the method returns immediately, regardless of whether any data is
+ * available. It does this to prevent a large number of requests to the source in the event of a failure.
+ * - Otherwise, if the cache date/time is undefined or less than the source date/time, it loads from the source,
+ * converts the data if necessary, and updates the cache.
+ * - Otherwise, it continues with the cached data.
+ * - The next check date/time is updated to the later of the source date/time plus one week and the current date/time
+ * plus one day.
+ *
+ * The base class implementation of the `GCPLengthCache` manages only the cache itself, and it requires an
+ * application-provided storage implementation. The source is expected to be either a {@linkcode GCPLengthData} object
+ * (created via another cache implementation) or a {@linkcode GCPLengthSourceJSON} object, which is the format of the
+ * file provided by GS1.
+ *
+ * Once the data is loaded, the {@linkcode GCPLength.lengthOf | lengthOf()} method can be used to get the length of a
+ * GS1 Company Prefix for an identifier type and identifier.
+ */
+export declare class GCPLength {
+    #private;
+    /**
+     * Constructor.
+     *
+     * @param gcpLengthCache
+     * GS1 Company Prefix length cache.
+     */
+    constructor(gcpLengthCache: GCPLengthCache);
+    /**
+     * Get the GS1 Company Prefix length tree root.
+     *
+     * @returns
+     * GS1 Company Prefix length tree root.
+     */
+    get root(): Root;
+    /**
+     * Get the date/time the GS1 Company Prefix length data was last updated.
+     */
+    get dateTime(): Date;
+    /**
+     * Get the disclaimer for the GS1 Company Prefix length data.
+     */
+    get disclaimer(): string;
+    /**
+     * Load the GS1 Company Prefix length data.
+     */
+    load(): Promise<void>;
+    /**
+     * 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.
+     */
+    lengthOf(identifierType: IdentifierType, identifier: string): number;
+}
+export {};
+//# sourceMappingURL=gcp-length.d.ts.map

package/dist/gcp-length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcp-length.d.ts","sourceRoot":"","sources":["../src/gcp-length.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAsB,KAAK,eAAe,EAAmB,MAAM,sBAAsB,CAAC;AAGjG,OAAO,EAAE,KAAK,cAAc,EAAmB,MAAM,sBAAsB,CAAC;AAK5E;;GAEG;AACH,UAAU,IAAI;IACV,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,UAAU,MAAM;IACZ,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC;CACxD;AAED;;GAEG;AACH,UAAU,IAAK,SAAQ,eAAe,EAAE,MAAM;CAC7C;AAED;;GAEG;AACH,KAAK,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;AAe1B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,aAAa,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;CAChE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,SAAS;;IAqBlB;;;;;OAKG;gBACS,cAAc,EAAE,cAAc;IAI1C;;;;;OAKG;IACH,IAAI,IAAI,IAAI,IAAI,CAMf;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,IAAI,CAEnB;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IA4LD;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAwG3B;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;CAyBvE"}

package/dist/gcp-length.js

@@ -0,0 +1,368 @@
+import { omit } from "@aidc-toolkit/core";
+import { isGCPLengthData } from "./gcp-length-data.js";
+import { GTINLengths } from "./gtin-length.js";
+import { GTINValidator } from "./gtin-validator.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { IdentifierValidators, isNumericIdentifierValidator } from "./identifier-validators.js";
+import { LeaderTypes } from "./leader-type.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+/**
+ * Determine if a node is a leaf.
+ *
+ * @param node
+ * Node.
+ *
+ * @returns
+ * True if node is a leaf.
+ */
+function isLeaf(node) {
+    return "length" in node;
+}
+/**
+ * GS1 Company Prefix length service. The constructor takes a {@linkcode GCPLengthCache} object, which is responsible
+ * for managing the cache and source.
+ *
+ * The first step is to load the GS1 Company Prefix length data. This is done using the
+ * {@linkcode GCPLength.load | load()} method, which works as follows:
+ *
+ * - If the next check date/time is in the future, the method returns immediately, regardless of whether any data is
+ * available. It does this to prevent a large number of requests to the source in the event of a failure.
+ * - Otherwise, if the cache date/time is undefined or less than the source date/time, it loads from the source,
+ * converts the data if necessary, and updates the cache.
+ * - Otherwise, it continues with the cached data.
+ * - The next check date/time is updated to the later of the source date/time plus one week and the current date/time
+ * plus one day.
+ *
+ * The base class implementation of the `GCPLengthCache` manages only the cache itself, and it requires an
+ * application-provided storage implementation. The source is expected to be either a {@linkcode GCPLengthData} object
+ * (created via another cache implementation) or a {@linkcode GCPLengthSourceJSON} object, which is the format of the
+ * file provided by GS1.
+ *
+ * Once the data is loaded, the {@linkcode GCPLength.lengthOf | lengthOf()} method can be used to get the length of a
+ * GS1 Company Prefix for an identifier type and identifier.
+ */
+export class GCPLength {
+    /**
+     * Entry in binary data to indicate that child node is undefined.
+     */
+    static #BINARY_UNDEFINED = 0x0F;
+    /**
+     * Entry in binary data to indicate that child node is a branch.
+     */
+    static #BINARY_BRANCH = 0x0E;
+    /**
+     * GS1 Company Prefix length cache.
+     */
+    #gcpLengthCache;
+    /**
+     * GS1 Company Prefix length tree root.
+     */
+    #root;
+    /**
+     * Constructor.
+     *
+     * @param gcpLengthCache
+     * GS1 Company Prefix length cache.
+     */
+    constructor(gcpLengthCache) {
+        this.#gcpLengthCache = gcpLengthCache;
+    }
+    /**
+     * Get the GS1 Company Prefix length tree root.
+     *
+     * @returns
+     * GS1 Company Prefix length tree root.
+     */
+    get root() {
+        if (this.#root === undefined) {
+            throw new RangeError(i18nextGS1.t("GCPLength.gs1CompanyPrefixLengthDataNotLoaded"));
+        }
+        return this.#root;
+    }
+    /**
+     * Get the date/time the GS1 Company Prefix length data was last updated.
+     */
+    get dateTime() {
+        return this.root.dateTime;
+    }
+    /**
+     * Get the disclaimer for the GS1 Company Prefix length data.
+     */
+    get disclaimer() {
+        return this.root.disclaimer;
+    }
+    /**
+     * Build the GS1 Company Prefix length tree from a binary data array.
+     *
+     * @param binaryData
+     * Binary data array.
+     *
+     * @param childNodes
+     * Child nodes array to fill.
+     *
+     * @param startIndex
+     * Start index into binary data array.
+     *
+     * @returns
+     * End index into binary data array.
+     */
+    static #fromBinary(binaryData, childNodes, startIndex) {
+        let endIndex = startIndex;
+        const decompressedLengths = new Array(10);
+        // Decompress lengths for the child nodes.
+        for (let childNodeIndex = 0; childNodeIndex < 10; childNodeIndex += 2) {
+            const byte = binaryData[endIndex++];
+            decompressedLengths[childNodeIndex] = byte >> 4;
+            decompressedLengths[childNodeIndex + 1] = byte & 0x0F;
+        }
+        for (let childNodeIndex = 0; childNodeIndex < 10; childNodeIndex++) {
+            const length = decompressedLengths[childNodeIndex];
+            if (length !== GCPLength.#BINARY_UNDEFINED) {
+                let childNode;
+                if (length === GCPLength.#BINARY_BRANCH) {
+                    const childNodes = [];
+                    endIndex = GCPLength.#fromBinary(binaryData, childNodes, endIndex);
+                    childNode = {
+                        childNodes
+                    };
+                }
+                else {
+                    childNode = {
+                        length
+                    };
+                }
+                // eslint-disable-next-line no-param-reassign -- Purpose is to build tree.
+                childNodes[childNodeIndex] = childNode;
+            }
+        }
+        return endIndex;
+    }
+    /**
+     * Add an entry to the tree by recursively walking the tree to a leaf.
+     *
+     * @param branch
+     * Current (interim) branch under construction.
+     *
+     * @param prefix
+     * Remainder of current prefix.
+     *
+     * @param length
+     * Current prefix length.
+     *
+     * @returns
+     * Number of branches added; used to determine size of binary array.
+     */
+    static #addEntry(branch, prefix, length) {
+        const digit = Number(prefix.charAt(0));
+        const existingChildNode = branch.childNodes[digit];
+        let branchesAdded = 0;
+        if (prefix.length !== 1) {
+            let childBranch;
+            if (existingChildNode === undefined) {
+                childBranch = {
+                    childNodes: []
+                };
+                branchesAdded++;
+            }
+            else {
+                if (isLeaf(existingChildNode)) {
+                    // File format error or application bug; localization not necessary.
+                    throw new Error("Overlapping entry");
+                }
+                childBranch = existingChildNode;
+            }
+            // eslint-disable-next-line no-param-reassign -- Purpose is to build tree.
+            branch.childNodes[digit] = childBranch;
+            // Continue with remainder of prefix.
+            branchesAdded += GCPLength.#addEntry(childBranch, prefix.substring(1), length);
+        }
+        else {
+            if (existingChildNode !== undefined) {
+                // File format error or application bug; localization not necessary.
+                throw new Error("Duplicate entry");
+            }
+            // eslint-disable-next-line no-param-reassign -- Purpose is to build tree.
+            branch.childNodes[digit] = {
+                length
+            };
+        }
+        return branchesAdded;
+    }
+    /**
+     * Get the length of a child node if defined and it's a leaf, otherwise mark it with 0x0E if defined (branch) or 0x0F
+     * (no branch) if not.
+     *
+     * @param childNode
+     * Child node.
+     *
+     * @returns
+     * Child node length, 0x0E (branch), or 0x0F (undefined).
+     */
+    static #childNodeValue(childNode) {
+        return childNode !== undefined ? isLeaf(childNode) ? childNode.length : GCPLength.#BINARY_BRANCH : GCPLength.#BINARY_UNDEFINED;
+    }
+    /**
+     * Add a branch to a binary data array.
+     *
+     * @param binaryData
+     * Binary data array.
+     *
+     * @param branch
+     * Branch.
+     *
+     * @param startIndex
+     * Start index into binary data array.
+     *
+     * @returns
+     * End index into binary data array.
+     */
+    static #toBinary(binaryData, branch, startIndex) {
+        let endIndex = startIndex;
+        const childNodes = branch.childNodes;
+        // Add length or non-leaf indicators, compressing 10 nibbles into 5 bytes.
+        for (let childNodeIndex = 0; childNodeIndex < 10; childNodeIndex += 2) {
+            // eslint-disable-next-line no-param-reassign -- Purpose is to build array.
+            binaryData[endIndex++] = (GCPLength.#childNodeValue(childNodes[childNodeIndex]) << 4) | GCPLength.#childNodeValue(childNodes[childNodeIndex + 1]);
+        }
+        // Process child nodes.
+        for (const childNode of childNodes) {
+            if (childNode !== undefined && !isLeaf(childNode)) {
+                endIndex = GCPLength.#toBinary(binaryData, childNode, endIndex);
+            }
+        }
+        return endIndex;
+    }
+    /**
+     * Add days to a date.
+     *
+     * @param date
+     * Date.
+     *
+     * @param days
+     * Days.
+     *
+     * @returns
+     * Future date.
+     */
+    static #addDays(date, days) {
+        const futureDate = new Date(date);
+        futureDate.setDate(futureDate.getDate() + days);
+        return futureDate;
+    }
+    /**
+     * Load the GS1 Company Prefix length data.
+     */
+    async load() {
+        let root = undefined;
+        const gcpLengthCache = this.#gcpLengthCache;
+        let nextCheckDateTime = await gcpLengthCache.nextCheckDateTime;
+        let cacheDateTime = await gcpLengthCache.cacheDateTime;
+        const now = new Date();
+        const tomorrow = GCPLength.#addDays(now, 1);
+        if (nextCheckDateTime === undefined || nextCheckDateTime.getTime() <= now.getTime()) {
+            const sourceDateTime = await gcpLengthCache.sourceDateTime;
+            if (cacheDateTime === undefined || cacheDateTime.getTime() < sourceDateTime.getTime()) {
+                const sourceData = await gcpLengthCache.sourceData;
+                let cacheData;
+                if (isGCPLengthData(sourceData)) {
+                    const childNodes = [];
+                    GCPLength.#fromBinary(sourceData.data, childNodes, 0);
+                    root = {
+                        dateTime: sourceData.dateTime,
+                        disclaimer: sourceData.disclaimer,
+                        childNodes
+                    };
+                    cacheData = sourceData;
+                }
+                else {
+                    const interimRoot = {
+                        childNodes: []
+                    };
+                    let branchesAdded = 1;
+                    for (const entry of sourceData.GCPPrefixFormatList.entry) {
+                        branchesAdded += GCPLength.#addEntry(interimRoot, entry.prefix, entry.gcpLength);
+                    }
+                    root = {
+                        dateTime: new Date(sourceData.GCPPrefixFormatList.date),
+                        // Join disclaimer as a single string.
+                        disclaimer: `${sourceData._disclaimer.reduce((lines, line) => {
+                            if (lines.length === 0 || lines[lines.length - 1] === "" || line === "") {
+                                lines.push(line);
+                            }
+                            else {
+                                // Lines are part of the same paragraph.
+                                lines.push(`${lines.pop()} ${line}`);
+                            }
+                            return lines;
+                        }, []).join("\n")}\n`,
+                        ...interimRoot
+                    };
+                    // Each branch has ten (some possibly undefined) entries, two per byte.
+                    const data = new Uint8Array(branchesAdded * 5);
+                    GCPLength.#toBinary(data, root, 0);
+                    cacheData = {
+                        ...omit(root, "childNodes"),
+                        data
+                    };
+                }
+                // Next check date/time is a week from source date/time or tomorrow, whichever is later.
+                nextCheckDateTime = GCPLength.#addDays(sourceDateTime, 7);
+                if (nextCheckDateTime.getTime() < tomorrow.getTime()) {
+                    nextCheckDateTime = tomorrow;
+                }
+                cacheDateTime = sourceDateTime;
+                await gcpLengthCache.update(nextCheckDateTime, cacheDateTime, cacheData);
+            }
+            else {
+                // Next check date/time is tomorrow.
+                await gcpLengthCache.update(tomorrow);
+            }
+        }
+        // Root is undefined if cache data is still valid or retrying after prior failure.
+        if (root === undefined && cacheDateTime !== undefined) {
+            const cacheData = await gcpLengthCache.cacheData;
+            const childNodes = [];
+            GCPLength.#fromBinary(cacheData.data, childNodes, 0);
+            root = {
+                ...omit(cacheData, "data"),
+                childNodes
+            };
+        }
+        // Update root only if successful.
+        if (root !== undefined) {
+            this.#root = root;
+        }
+    }
+    /**
+     * 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.
+     */
+    lengthOf(identifierType, identifier) {
+        let identifierPrefix;
+        if (identifierType === IdentifierTypes.GTIN) {
+            // Normalize the GTIN, pad to 14 digits, and extract the identifier prefix at the first character.
+            identifierPrefix = GTINValidator.normalize(identifier).padStart(GTINLengths.GTIN14, "0").substring(1);
+        }
+        else {
+            const identifierValidator = IdentifierValidators[identifierType];
+            identifierValidator.validate(identifier);
+            identifierPrefix = !isNumericIdentifierValidator(identifierValidator) || identifierValidator.leaderType !== LeaderTypes.ExtensionDigit ? identifier : identifier.substring(1);
+        }
+        let node = this.root;
+        let digitIndex = 0;
+        // Traverse tree until exhausted or at a leaf.
+        while (node !== undefined && !isLeaf(node)) {
+            node = node.childNodes[Number(identifierPrefix.charAt(digitIndex++))];
+        }
+        return node?.length ?? -1;
+    }
+}
+//# sourceMappingURL=gcp-length.js.map

package/dist/gcp-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcp-length.js","sourceRoot":"","sources":["../src/gcp-length.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAE1C,OAAO,EAA4C,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAC;AAChG,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AA2B9C;;;;;;;;GAQG;AACH,SAAS,MAAM,CAAC,IAAU;IACtB,OAAO,QAAQ,IAAI,IAAI,CAAC;AAC5B,CAAC;AASD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,SAAS;IAClB;;OAEG;IACH,MAAM,CAAU,iBAAiB,GAAG,IAAI,CAAC;IAEzC;;OAEG;IACH,MAAM,CAAU,cAAc,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACM,eAAe,CAAiB;IAEzC;;OAEG;IACH,KAAK,CAAQ;IAEb;;;;;OAKG;IACH,YAAY,cAA8B;QACtC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,IAAI,IAAI;QACJ,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC3B,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,+CAA+C,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,WAAW,CAAC,UAAsB,EAAE,UAAmC,EAAE,UAAkB;QAC9F,IAAI,QAAQ,GAAG,UAAU,CAAC;QAE1B,MAAM,mBAAmB,GAAG,IAAI,KAAK,CAAS,EAAE,CAAC,CAAC;QAElD,0CAA0C;QAC1C,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,EAAE,EAAE,cAAc,IAAI,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;YAEpC,mBAAmB,CAAC,cAAc,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC;YAChD,mBAAmB,CAAC,cAAc,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;QAC1D,CAAC;QAED,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,EAAE,EAAE,cAAc,EAAE,EAAE,CAAC;YACjE,MAAM,MAAM,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;YAEnD,IAAI,MAAM,KAAK,SAAS,CAAC,iBAAiB,EAAE,CAAC;gBACzC,IAAI,SAAe,CAAC;gBAEpB,IAAI,MAAM,KAAK,SAAS,CAAC,cAAc,EAAE,CAAC;oBACtC,MAAM,UAAU,GAA4B,EAAE,CAAC;oBAE/C,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;oBAEnE,SAAS,GAAG;wBACR,UAAU;qBACb,CAAC;gBACN,CAAC;qBAAM,CAAC;oBACJ,SAAS,GAAG;wBACR,MAAM;qBACT,CAAC;gBACN,CAAC;gBAED,0EAA0E;gBAC1E,UAAU,CAAC,cAAc,CAAC,GAAG,SAAS,CAAC;YAC3C,CAAC;QACL,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,SAAS,CAAC,MAAqB,EAAE,MAAc,EAAE,MAAc;QAClE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvC,MAAM,iBAAiB,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAEnD,IAAI,aAAa,GAAG,CAAC,CAAC;QAEtB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,IAAI,WAA0B,CAAC;YAE/B,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAClC,WAAW,GAAG;oBACV,UAAU,EAAE,EAAE;iBACjB,CAAC;gBAEF,aAAa,EAAE,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACJ,IAAI,MAAM,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBAC5B,oEAAoE;oBACpE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBACzC,CAAC;gBAED,WAAW,GAAG,iBAAiB,CAAC;YACpC,CAAC;YAED,0EAA0E;YAC1E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC;YAEvC,qCAAqC;YACrC,aAAa,IAAI,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnF,CAAC;aAAM,CAAC;YACJ,IAAI,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAClC,oEAAoE;gBACpE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACvC,CAAC;YAED,0EAA0E;YAC1E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG;gBACvB,MAAM;aACT,CAAC;QACN,CAAC;QAED,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,eAAe,CAAC,SAA2B;QAC9C,OAAO,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC;IACnI,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,SAAS,CAAC,UAAsB,EAAE,MAAc,EAAE,UAAkB;QACvE,IAAI,QAAQ,GAAG,UAAU,CAAC;QAE1B,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QAErC,0EAA0E;QAC1E,KAAK,IAAI,cAAc,GAAG,CAAC,EAAE,cAAc,GAAG,EAAE,EAAE,cAAc,IAAI,CAAC,EAAE,CAAC;YACpE,2EAA2E;YAC3E,UAAU,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,SAAS,CAAC,eAAe,CAAC,UAAU,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC,CAAC;QACtJ,CAAC;QAED,uBAAuB;QACvB,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,IAAI,SAAS,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAChD,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;YACpE,CAAC;QACL,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAU,EAAE,IAAY;QACpC,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAElC,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QAEhD,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACN,IAAI,IAAI,GAAqB,SAAS,CAAC;QAEvC,MAAM,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC;QAE5C,IAAI,iBAAiB,GAAG,MAAM,cAAc,CAAC,iBAAiB,CAAC;QAC/D,IAAI,aAAa,GAAG,MAAM,cAAc,CAAC,aAAa,CAAC;QAEvD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAE5C,IAAI,iBAAiB,KAAK,SAAS,IAAI,iBAAiB,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YAClF,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC;YAE3D,IAAI,aAAa,KAAK,SAAS,IAAI,aAAa,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,CAAC;gBACpF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC;gBAEnD,IAAI,SAAwB,CAAC;gBAE7B,IAAI,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;oBAC9B,MAAM,UAAU,GAA4B,EAAE,CAAC;oBAE/C,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;oBAEtD,IAAI,GAAG;wBACH,QAAQ,EAAE,UAAU,CAAC,QAAQ;wBAC7B,UAAU,EAAE,UAAU,CAAC,UAAU;wBACjC,UAAU;qBACb,CAAC;oBAEF,SAAS,GAAG,UAAU,CAAC;gBAC3B,CAAC;qBAAM,CAAC;oBACJ,MAAM,WAAW,GAAkB;wBAC/B,UAAU,EAAE,EAAE;qBACjB,CAAC;oBAEF,IAAI,aAAa,GAAG,CAAC,CAAC;oBAEtB,KAAK,MAAM,KAAK,IAAI,UAAU,CAAC,mBAAmB,CAAC,KAAK,EAAE,CAAC;wBACvD,aAAa,IAAI,SAAS,CAAC,SAAS,CAAC,WAAW,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;oBACrF,CAAC;oBAED,IAAI,GAAG;wBACH,QAAQ,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC;wBACvD,sCAAsC;wBACtC,UAAU,EAAE,GAAG,UAAU,CAAC,WAAW,CAAC,MAAM,CAAW,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;4BACnE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;gCACtE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;4BACrB,CAAC;iCAAM,CAAC;gCACJ,wCAAwC;gCACxC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;4BACzC,CAAC;4BAED,OAAO,KAAK,CAAC;wBACjB,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;wBACrB,GAAG,WAAW;qBACjB,CAAC;oBAEF,uEAAuE;oBACvE,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;oBAE/C,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;oBAEnC,SAAS,GAAG;wBACR,GAAG,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC;wBAC3B,IAAI;qBACP,CAAC;gBACN,CAAC;gBAED,wFAAwF;gBACxF,iBAAiB,GAAG,SAAS,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC;gBAC1D,IAAI,iBAAiB,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;oBACnD,iBAAiB,GAAG,QAAQ,CAAC;gBACjC,CAAC;gBAED,aAAa,GAAG,cAAc,CAAC;gBAE/B,MAAM,cAAc,CAAC,MAAM,CAAC,iBAAiB,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;YAC7E,CAAC;iBAAM,CAAC;gBACJ,oCAAoC;gBACpC,MAAM,cAAc,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;QAED,kFAAkF;QAClF,IAAI,IAAI,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YACpD,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,SAAS,CAAC;YAEjD,MAAM,UAAU,GAA4B,EAAE,CAAC;YAE/C,SAAS,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAErD,IAAI,GAAG;gBACH,GAAG,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;gBAC1B,UAAU;aACb,CAAC;QACN,CAAC;QAED,kCAAkC;QAClC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACtB,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,cAA8B,EAAE,UAAkB;QACvD,IAAI,gBAAwB,CAAC;QAE7B,IAAI,cAAc,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;YAC1C,kGAAkG;YAClG,gBAAgB,GAAG,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC1G,CAAC;aAAM,CAAC;YACJ,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;YAEjE,mBAAmB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAEzC,gBAAgB,GAAG,CAAC,4BAA4B,CAAC,mBAAmB,CAAC,IAAI,mBAAmB,CAAC,UAAU,KAAK,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClL,CAAC;QAED,IAAI,IAAI,GAAqB,IAAI,CAAC,IAAI,CAAC;QAEvC,IAAI,UAAU,GAAG,CAAC,CAAC;QAEnB,8CAA8C;QAC9C,OAAO,IAAI,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC;QAED,OAAO,IAAI,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;IAC9B,CAAC"}