@aidc-toolkit/gs1 1.0.28-beta → 1.0.32-beta

package/dist/variable-measure.js

@@ -0,0 +1,210 @@
+import { NUMERIC_CREATOR } from "@aidc-toolkit/utility";
+import { checkDigit, hasValidCheckDigit, isValidPriceOrWeightCheckDigit, priceOrWeightCheckDigit } from "./check.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+/**
+ * Variable measure trade item support functions.
+ */
+// eslint-disable-next-line @typescript-eslint/no-extraneous-class -- Wrapper for future functionality.
+export class VariableMeasure {
+    /**
+     * Parse a Restricted Circulation Number (RCN) using a variable measure trade item format. The format is a 12- or
+     * 13-character string (for RCN-12 or RCN-13 respectively), containing the following:
+     *
+     * - '2' - The first character of the RCN.
+     * - '0'-'9' - The second character of the RCN (RCN-13 only).
+     * - 'I' - One or more, in sequence, for the item reference.
+     * - 'P' - One or more, in sequence, for the price or weight.
+     * - 'V' - Zero or one, for the price or weight check digit.
+     * - 'C' - The check digit of the entire RCN.
+     *
+     * The 'I', 'P', and 'V' formats may be in any order.
+     *
+     * Some examples:
+     *
+     * - 2IIIIIVPPPPC - RCN-12 with a five-digit item reference, a price or weight check digit, and a four-digit price
+     * or weight.
+     * - 23IIIIVPPPPPC - RCN-13 with a four-digit item reference, a price or weight check digit, and a five-digit price
+     * or weight.
+     * - 2IIIIIIPPPPC - RCN-12 with a six-digit item reference and a four-digit price or eight.
+     * - 29IIIIIPPPPPC - RCN-13 with a five-digit item reference and a five-digit price or weight.
+     *
+     * @param format
+     * Format.
+     *
+     * @param rcn
+     * RCN.
+     *
+     * @returns
+     * RCN reference.
+     */
+    static parseRCN(format, rcn) {
+        const formatLength = format.length;
+        if (rcn.length !== formatLength) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidRCNLength"));
+        }
+        let validFormat = formatLength === 12 || formatLength === 13;
+        let validRCNPrefix = true;
+        let buildingItemReference = false;
+        let itemReference = "";
+        let buildingPriceOrWeight = false;
+        let priceOrWeight = "";
+        let priceOrWeightCheckDigit = "";
+        for (let index = 0; validFormat && index < formatLength; index++) {
+            const formatChar = format.charAt(index);
+            const rcnChar = rcn.charAt(index);
+            if (index === 0) {
+                validFormat = formatChar === "2";
+                validRCNPrefix = rcnChar === "2";
+            }
+            else if (formatLength === 13 && index === 1) {
+                validFormat = NUMERIC_CREATOR.characterIndex(formatChar) !== undefined;
+                validRCNPrefix = rcnChar === formatChar;
+            }
+            else if (index === formatLength - 1) {
+                validFormat = formatChar === "C";
+            }
+            else {
+                switch (formatChar) {
+                    case "I":
+                        if (!buildingItemReference) {
+                            // Item reference can't appear more than once.
+                            validFormat = itemReference === "";
+                            buildingItemReference = true;
+                            buildingPriceOrWeight = false;
+                        }
+                        itemReference += rcnChar;
+                        break;
+                    case "P":
+                        if (!buildingPriceOrWeight) {
+                            // Price or weight can't appear more than once.
+                            validFormat = priceOrWeight === "";
+                            buildingPriceOrWeight = true;
+                            buildingItemReference = false;
+                        }
+                        priceOrWeight += rcnChar;
+                        break;
+                    case "V":
+                        // Price or weight check digit can't appear more than once.
+                        validFormat = priceOrWeightCheckDigit === "";
+                        buildingItemReference = false;
+                        buildingPriceOrWeight = false;
+                        priceOrWeightCheckDigit = rcnChar;
+                        break;
+                    default:
+                        validFormat = false;
+                        break;
+                }
+            }
+        }
+        validFormat &&= itemReference !== "" && priceOrWeight !== "";
+        if (!validFormat) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidVariableMeasureRCNFormat"));
+        }
+        if (!validRCNPrefix) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidVariableMeasureRCNPrefix"));
+        }
+        if (priceOrWeightCheckDigit !== "" && !isValidPriceOrWeightCheckDigit(priceOrWeight, priceOrWeightCheckDigit)) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidVariableMeasurePriceOrWeight"));
+        }
+        if (!hasValidCheckDigit(rcn)) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidCheckDigit"));
+        }
+        return {
+            itemReference: Number(itemReference),
+            priceOrWeight: Number(priceOrWeight)
+        };
+    }
+    /**
+     * Create a Restricted Circulation Number (RCN) using a variable measure trade item format. See {@linkcode parseRCN}
+     * for format details.
+     *
+     * @param format
+     * Format.
+     *
+     * @param itemReference
+     * Item reference.
+     *
+     * @param priceOrWeight
+     * Price or weight (whole number only).
+     *
+     * @returns
+     * RCN-12 or RCN-13.
+     */
+    static createRCN(format, itemReference, priceOrWeight) {
+        const formatLength = format.length;
+        let validFormat = formatLength === 12 || formatLength === 13;
+        let rcnPrefix = "";
+        let buildingItemReference = false;
+        let itemReferenceString = "";
+        let itemReferenceLength = 0;
+        let buildingPriceOrWeight = false;
+        let priceOrWeightString = "";
+        let priceOrWeightLength = 0;
+        let calculatePriceOrWeightCheckDigit = false;
+        // RCN may be built in almost any order, so defer to builders that will be in ordered array.
+        const rcnPrefixBuilder = (partialRCN) => partialRCN + rcnPrefix;
+        const itemReferenceBuilder = (partialRCN) => partialRCN + itemReferenceString;
+        const priceOrWeightBuilder = (partialRCN) => partialRCN + priceOrWeightString;
+        const priceOrWeightCheckDigitBuilder = (partialRCN) => partialRCN + priceOrWeightCheckDigit(priceOrWeightString);
+        const checkDigitBuilder = (partialRCN) => partialRCN + checkDigit(partialRCN);
+        const rcnBuilders = [rcnPrefixBuilder];
+        for (let index = 0; validFormat && index < formatLength; index++) {
+            const formatChar = format.charAt(index);
+            if (index === 0) {
+                validFormat = formatChar === "2";
+                rcnPrefix = formatChar;
+            }
+            else if (formatLength === 13 && index === 1) {
+                validFormat = NUMERIC_CREATOR.characterIndex(formatChar) !== undefined;
+                rcnPrefix += formatChar;
+            }
+            else if (index === formatLength - 1) {
+                validFormat = formatChar === "C";
+            }
+            else {
+                switch (formatChar) {
+                    case "I":
+                        if (!buildingItemReference) {
+                            // Item reference can't appear more than once.
+                            validFormat = itemReferenceLength === 0;
+                            buildingItemReference = true;
+                            buildingPriceOrWeight = false;
+                            rcnBuilders.push(itemReferenceBuilder);
+                        }
+                        itemReferenceLength++;
+                        break;
+                    case "P":
+                        if (!buildingPriceOrWeight) {
+                            // Price or weight can't appear more than once.
+                            validFormat = priceOrWeightLength === 0;
+                            buildingPriceOrWeight = true;
+                            buildingItemReference = false;
+                            rcnBuilders.push(priceOrWeightBuilder);
+                        }
+                        priceOrWeightLength++;
+                        break;
+                    case "V":
+                        // Price or weight check digit can't appear more than once.
+                        validFormat = !calculatePriceOrWeightCheckDigit;
+                        buildingItemReference = false;
+                        buildingPriceOrWeight = false;
+                        calculatePriceOrWeightCheckDigit = true;
+                        rcnBuilders.push(priceOrWeightCheckDigitBuilder);
+                        break;
+                    default:
+                        validFormat = false;
+                        break;
+                }
+            }
+        }
+        validFormat &&= itemReferenceLength !== 0 && priceOrWeightLength !== 0;
+        if (!validFormat) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidVariableMeasureRCNFormat"));
+        }
+        itemReferenceString = NUMERIC_CREATOR.create(itemReferenceLength, itemReference);
+        priceOrWeightString = NUMERIC_CREATOR.create(priceOrWeightLength, priceOrWeight);
+        rcnBuilders.push(checkDigitBuilder);
+        return rcnBuilders.reduce((partialRCN, rcnBuilder) => rcnBuilder(partialRCN), "");
+    }
+}
+//# sourceMappingURL=variable-measure.js.map

package/dist/variable-measure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable-measure.js","sourceRoot":"","sources":["../src/variable-measure.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrH,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAiB9C;;GAEG;AACH,uGAAuG;AACvG,MAAM,OAAO,eAAe;IACxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAc,EAAE,GAAW;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;QAEnC,IAAI,GAAG,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YAC9B,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,WAAW,GAAG,YAAY,KAAK,EAAE,IAAI,YAAY,KAAK,EAAE,CAAC;QAC7D,IAAI,cAAc,GAAG,IAAI,CAAC;QAE1B,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,aAAa,GAAG,EAAE,CAAC;QAEvB,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,aAAa,GAAG,EAAE,CAAC;QAEvB,IAAI,uBAAuB,GAAG,EAAE,CAAC;QAEjC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,WAAW,IAAI,KAAK,GAAG,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACxC,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAElC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBACd,WAAW,GAAG,UAAU,KAAK,GAAG,CAAC;gBACjC,cAAc,GAAG,OAAO,KAAK,GAAG,CAAC;YACrC,CAAC;iBAAM,IAAI,YAAY,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC5C,WAAW,GAAG,eAAe,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC;gBACvE,cAAc,GAAG,OAAO,KAAK,UAAU,CAAC;YAC5C,CAAC;iBAAM,IAAI,KAAK,KAAK,YAAY,GAAG,CAAC,EAAE,CAAC;gBACpC,WAAW,GAAG,UAAU,KAAK,GAAG,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACJ,QAAQ,UAAU,EAAE,CAAC;oBACjB,KAAK,GAAG;wBACJ,IAAI,CAAC,qBAAqB,EAAE,CAAC;4BACzB,8CAA8C;4BAC9C,WAAW,GAAG,aAAa,KAAK,EAAE,CAAC;4BAEnC,qBAAqB,GAAG,IAAI,CAAC;4BAC7B,qBAAqB,GAAG,KAAK,CAAC;wBAClC,CAAC;wBAED,aAAa,IAAI,OAAO,CAAC;wBACzB,MAAM;oBAEV,KAAK,GAAG;wBACJ,IAAI,CAAC,qBAAqB,EAAE,CAAC;4BACzB,+CAA+C;4BAC/C,WAAW,GAAG,aAAa,KAAK,EAAE,CAAC;4BAEnC,qBAAqB,GAAG,IAAI,CAAC;4BAC7B,qBAAqB,GAAG,KAAK,CAAC;wBAClC,CAAC;wBAED,aAAa,IAAI,OAAO,CAAC;wBACzB,MAAM;oBAEV,KAAK,GAAG;wBACJ,2DAA2D;wBAC3D,WAAW,GAAG,uBAAuB,KAAK,EAAE,CAAC;wBAE7C,qBAAqB,GAAG,KAAK,CAAC;wBAC9B,qBAAqB,GAAG,KAAK,CAAC;wBAE9B,uBAAuB,GAAG,OAAO,CAAC;wBAClC,MAAM;oBAEV;wBACI,WAAW,GAAG,KAAK,CAAC;wBACpB,MAAM;gBACd,CAAC;YACL,CAAC;QACL,CAAC;QAED,WAAW,KAAK,aAAa,KAAK,EAAE,IAAI,aAAa,KAAK,EAAE,CAAC;QAE7D,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,4CAA4C,CAAC,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YAClB,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,4CAA4C,CAAC,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,uBAAuB,KAAK,EAAE,IAAI,CAAC,8BAA8B,CAAC,aAAa,EAAE,uBAAuB,CAAC,EAAE,CAAC;YAC5G,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,gDAAgD,CAAC,CAAC,CAAC;QACzF,CAAC;QAED,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,OAAO;YACH,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC;YACpC,aAAa,EAAE,MAAM,CAAC,aAAa,CAAC;SACvC,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,SAAS,CAAC,MAAc,EAAE,aAAqB,EAAE,aAAqB;QACzE,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;QAEnC,IAAI,WAAW,GAAG,YAAY,KAAK,EAAE,IAAI,YAAY,KAAK,EAAE,CAAC;QAE7D,IAAI,SAAS,GAAG,EAAE,CAAC;QAEnB,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,mBAAmB,GAAG,EAAE,CAAC;QAC7B,IAAI,mBAAmB,GAAG,CAAC,CAAC;QAE5B,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAClC,IAAI,mBAAmB,GAAG,EAAE,CAAC;QAC7B,IAAI,mBAAmB,GAAG,CAAC,CAAC;QAE5B,IAAI,gCAAgC,GAAG,KAAK,CAAC;QAE7C,4FAA4F;QAC5F,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC;QAChF,MAAM,oBAAoB,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,UAAU,GAAG,mBAAmB,CAAC;QAC9F,MAAM,oBAAoB,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,UAAU,GAAG,mBAAmB,CAAC;QAC9F,MAAM,8BAA8B,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,UAAU,GAAG,uBAAuB,CAAC,mBAAmB,CAAC,CAAC;QACjI,MAAM,iBAAiB,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC;QAE9F,MAAM,WAAW,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAEvC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,WAAW,IAAI,KAAK,GAAG,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAExC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBACd,WAAW,GAAG,UAAU,KAAK,GAAG,CAAC;gBACjC,SAAS,GAAG,UAAU,CAAC;YAC3B,CAAC;iBAAM,IAAI,YAAY,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC5C,WAAW,GAAG,eAAe,CAAC,cAAc,CAAC,UAAU,CAAC,KAAK,SAAS,CAAC;gBACvE,SAAS,IAAI,UAAU,CAAC;YAC5B,CAAC;iBAAM,IAAI,KAAK,KAAK,YAAY,GAAG,CAAC,EAAE,CAAC;gBACpC,WAAW,GAAG,UAAU,KAAK,GAAG,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACJ,QAAQ,UAAU,EAAE,CAAC;oBACjB,KAAK,GAAG;wBACJ,IAAI,CAAC,qBAAqB,EAAE,CAAC;4BACzB,8CAA8C;4BAC9C,WAAW,GAAG,mBAAmB,KAAK,CAAC,CAAC;4BAExC,qBAAqB,GAAG,IAAI,CAAC;4BAC7B,qBAAqB,GAAG,KAAK,CAAC;4BAE9B,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;wBAC3C,CAAC;wBAED,mBAAmB,EAAE,CAAC;wBACtB,MAAM;oBAEV,KAAK,GAAG;wBACJ,IAAI,CAAC,qBAAqB,EAAE,CAAC;4BACzB,+CAA+C;4BAC/C,WAAW,GAAG,mBAAmB,KAAK,CAAC,CAAC;4BAExC,qBAAqB,GAAG,IAAI,CAAC;4BAC7B,qBAAqB,GAAG,KAAK,CAAC;4BAE9B,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;wBAC3C,CAAC;wBAED,mBAAmB,EAAE,CAAC;wBACtB,MAAM;oBAEV,KAAK,GAAG;wBACJ,2DAA2D;wBAC3D,WAAW,GAAG,CAAC,gCAAgC,CAAC;wBAEhD,qBAAqB,GAAG,KAAK,CAAC;wBAC9B,qBAAqB,GAAG,KAAK,CAAC;wBAE9B,gCAAgC,GAAG,IAAI,CAAC;wBAExC,WAAW,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;wBACjD,MAAM;oBAEV;wBACI,WAAW,GAAG,KAAK,CAAC;wBACpB,MAAM;gBACd,CAAC;YACL,CAAC;QACL,CAAC;QAED,WAAW,KAAK,mBAAmB,KAAK,CAAC,IAAI,mBAAmB,KAAK,CAAC,CAAC;QAEvE,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,4CAA4C,CAAC,CAAC,CAAC;QACrF,CAAC;QAED,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QACjF,mBAAmB,GAAG,eAAe,CAAC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QAEjF,WAAW,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAEpC,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IACtF,CAAC;CACJ"}

package/dist/verified-by-gs1.d.ts

@@ -0,0 +1,22 @@
+import type { Hyperlink } from "@aidc-toolkit/core";
+import { type IdentifierType } from "./identifier-type.js";
+/**
+ * Create a Verified by GS1 hyperlink.
+ *
+ * @param identifierType
+ * Identifier type.
+ *
+ * @param identifier
+ * Identifier.
+ *
+ * @param text
+ * Text for hyperlink. If not provided, the identifier is used.
+ *
+ * @param details
+ * Details to display when hovering over hyperlink.
+ *
+ * @returns
+ * Verified by GS1 hyperlink.
+ */
+export declare function verifiedByGS1(identifierType: IdentifierType, identifier: string, text?: string | undefined, details?: string): Hyperlink;
+//# sourceMappingURL=verified-by-gs1.d.ts.map

package/dist/verified-by-gs1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verified-by-gs1.d.ts","sourceRoot":"","sources":["../src/verified-by-gs1.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,KAAK,cAAc,EAAmB,MAAM,sBAAsB,CAAC;AAK5E;;;;;;;;;;;;;;;;;GAiBG;AAEH,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,GAAE,MAAM,GAAG,SAAqB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CA2BnJ"}

package/dist/verified-by-gs1.js

@@ -0,0 +1,46 @@
+import { GTINValidator } from "./gtin-validator.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { IdentifierValidators } from "./identifier-validators.js";
+const VERIFIED_BY_GS1_REFERENCE_BASE = "https://www.gs1.org/services/verified-by-gs1/results?";
+/**
+ * Create a Verified by GS1 hyperlink.
+ *
+ * @param identifierType
+ * Identifier type.
+ *
+ * @param identifier
+ * Identifier.
+ *
+ * @param text
+ * Text for hyperlink. If not provided, the identifier is used.
+ *
+ * @param details
+ * Details to display when hovering over hyperlink.
+ *
+ * @returns
+ * Verified by GS1 hyperlink.
+ */
+// eslint-disable-next-line @typescript-eslint/no-useless-default-assignment -- Undefined is necessary to allow bypass of text.
+export function verifiedByGS1(identifierType, identifier, text = undefined, details) {
+    let normalizedIdentifier;
+    let useKeyTypeParameter;
+    if (identifierType === IdentifierTypes.GTIN) {
+        // Normalization will validate resulting GTIN.
+        normalizedIdentifier = GTINValidator.normalize(identifier);
+        useKeyTypeParameter = true;
+    }
+    else {
+        const identifierValidator = IdentifierValidators[identifierType];
+        identifierValidator.validate(identifier);
+        normalizedIdentifier = identifier;
+        useKeyTypeParameter = identifierType === IdentifierTypes.GLN;
+    }
+    const lowerCaseIdentifierType = identifierType.toLowerCase();
+    const reference = useKeyTypeParameter ? `${VERIFIED_BY_GS1_REFERENCE_BASE}${lowerCaseIdentifierType}=${normalizedIdentifier}` : `${VERIFIED_BY_GS1_REFERENCE_BASE}key=${normalizedIdentifier}&key_type=${lowerCaseIdentifierType}`;
+    return {
+        reference,
+        text: text ?? identifier,
+        details
+    };
+}
+//# sourceMappingURL=verified-by-gs1.js.map

package/dist/verified-by-gs1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verified-by-gs1.js","sourceRoot":"","sources":["../src/verified-by-gs1.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAElE,MAAM,8BAA8B,GAAG,uDAAuD,CAAC;AAE/F;;;;;;;;;;;;;;;;;GAiBG;AACH,+HAA+H;AAC/H,MAAM,UAAU,aAAa,CAAC,cAA8B,EAAE,UAAkB,EAAE,OAA2B,SAAS,EAAE,OAAgB;IACpI,IAAI,oBAA4B,CAAC;IACjC,IAAI,mBAA4B,CAAC;IAEjC,IAAI,cAAc,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;QAC1C,8CAA8C;QAC9C,oBAAoB,GAAG,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAE3D,mBAAmB,GAAG,IAAI,CAAC;IAC/B,CAAC;SAAM,CAAC;QACJ,MAAM,mBAAmB,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;QAEjE,mBAAmB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAEzC,oBAAoB,GAAG,UAAU,CAAC;QAClC,mBAAmB,GAAG,cAAc,KAAK,eAAe,CAAC,GAAG,CAAC;IACjE,CAAC;IAED,MAAM,uBAAuB,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;IAE7D,MAAM,SAAS,GAAG,mBAAmB,CAAC,CAAC,CAAC,GAAG,8BAA8B,GAAG,uBAAuB,IAAI,oBAAoB,EAAE,CAAC,CAAC,CAAC,GAAG,8BAA8B,OAAO,oBAAoB,aAAa,uBAAuB,EAAE,CAAC;IAEnO,OAAO;QACH,SAAS;QACT,IAAI,EAAE,IAAI,IAAI,UAAU;QACxB,OAAO;KACV,CAAC;AACN,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aidc-toolkit/gs1",
-  "version": "1.0.28-beta",
+  "version": "1.0.32-beta",
   "description": "GS1 AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
@@ -21,17 +21,17 @@
   "scripts": {
     "lint": "eslint",
     "tsc:core": "tsc --project tsconfig-src.json",
-    "build:dev": "rimraf dist && npm run tsc:core -- --declarationMap --sourceMap",
-    "build:release": "npm run tsc:core -- --noEmit && tsup",
+    "build:dev": "rimraf dist tsconfig-src.tsbuildinfo && npm run tsc:core -- --declarationMap --sourceMap",
+    "build:release": "npm run tsc:core -- --noEmit && tsup --tsconfig tsconfig-tsup.json",
     "build:doc": "npm run build:dev",
-    "test": "vitest run"
+    "test": "tsc --project tsconfig-test.json --noEmit && vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "1.0.28-beta",
-    "vitest": "^4.0.15"
+    "@aidc-toolkit/dev": "1.0.32-beta",
+    "vitest": "^4.0.16"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "1.0.28-beta",
-    "@aidc-toolkit/utility": "1.0.28-beta"
+    "@aidc-toolkit/core": "1.0.32-beta",
+    "@aidc-toolkit/utility": "1.0.32-beta"
   }
 }

package/src/gcp-length-cache.ts

@@ -0,0 +1,117 @@
+import { Cache } from "@aidc-toolkit/core";
+import { type GCPLengthData, type GCPLengthHeader, parseGCPLengthHeader } from "./gcp-length-data.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+
+/**
+ * GS1 Company Prefix length cache.
+ */
+export abstract class GCPLengthCache extends Cache<GCPLengthData, GCPLengthData | string> {
+}
+
+/**
+ * GS1 Company Prefix length cache with remote source.
+ */
+export abstract class RemoteGCPLengthCache extends GCPLengthCache {
+    /**
+     * Default base URL pointing to AIDC Toolkit website data directory.
+     */
+    static DEFAULT_BASE_URL = "https://aidc-toolkit.com/data/";
+
+    /**
+     * File containing header information (date/time and disclaimer).
+     */
+    static SOURCE_HEADER_FILE_NAME = "gcp-length-header.json";
+
+    /**
+     * File containing tree data in binary form.
+     */
+    static SOURCE_DATA_FILE_NAME = "gcp-length-data.bin";
+
+    /**
+     * Base URL.
+     */
+    readonly #baseURL: string;
+
+    /**
+     * GS1 Company Prefix header data.
+     */
+    #gcpLengthHeader?: GCPLengthHeader | undefined;
+
+    /**
+     * Constructor.
+     *
+     * @param baseURL
+     * Base URL. The URL must end with a slash, and must host the {@linkcode SOURCE_HEADER_FILE_NAME} and {@linkcode
+     * SOURCE_DATA_FILE_NAME} files.
+     */
+    constructor(baseURL: string = RemoteGCPLengthCache.DEFAULT_BASE_URL) {
+        super();
+
+        this.#baseURL = baseURL;
+    }
+
+    /**
+     * Get a remote file. If an exception is thrown, retrying is delayed for ten minutes to prevent repeated network
+     * calls.
+     *
+     * @param fileName
+     * File name relative to base URL.
+     *
+     * @returns
+     * Response.
+     */
+    async #getRemoteFile(fileName: string): Promise<Response> {
+        return fetch(`${this.#baseURL}${fileName}`).then((response) => {
+            if (!response.ok) {
+                throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixLengthDataHTTPError", {
+                    status: response.status
+                }));
+            }
+
+            return response;
+        }).catch(async (e: unknown) => {
+            // Try again in ten minutes.
+            const nowPlus10Minutes = new Date();
+            nowPlus10Minutes.setMinutes(nowPlus10Minutes.getMinutes() + 10);
+
+            await this.update(nowPlus10Minutes);
+
+            throw e;
+        });
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get sourceDateTime(): Promise<Date> {
+        return this.#getRemoteFile(RemoteGCPLengthCache.SOURCE_HEADER_FILE_NAME).then(async response =>
+            response.text()
+        ).then((s) => {
+            this.#gcpLengthHeader = parseGCPLengthHeader(s);
+
+            return this.#gcpLengthHeader.dateTime;
+        });
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get sourceData(): Promise<GCPLengthData> {
+        if (this.#gcpLengthHeader === undefined) {
+            // Application error; no localization necessary.
+            throw new Error("GS1 Company Prefix length header not loaded");
+        }
+
+        const gcpLengthHeader = this.#gcpLengthHeader;
+
+        // Clear header to allow for retry in case of failure.
+        this.#gcpLengthHeader = undefined;
+
+        return this.#getRemoteFile(RemoteGCPLengthCache.SOURCE_DATA_FILE_NAME).then(async response =>
+            response.arrayBuffer()
+        ).then(a => ({
+            ...gcpLengthHeader,
+            data: new Uint8Array(a)
+        }));
+    }
+}

package/src/gcp-length-data.ts

@@ -0,0 +1,68 @@
+/**
+ * GS1 Company Prefix length header.
+ */
+export interface GCPLengthHeader {
+    /**
+     * Date/time the data was last updated.
+     */
+    readonly dateTime: Date;
+
+    /**
+     * Disclaimer.
+     */
+    readonly disclaimer: string;
+}
+
+/**
+ * Parse a JSON string representing a GS1 Company Prefix length header.
+ *
+ * @param s
+ * JSON string.
+ *
+ * @returns
+ * GS1 Company Prefix length header.
+ */
+export function parseGCPLengthHeader(s: string): GCPLengthHeader {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- File format is known.
+    return JSON.parse(s, (key, value: unknown) =>
+        key === "dateTime" && typeof value === "string" ? new Date(value) : value
+    ) as GCPLengthHeader;
+}
+
+/**
+ * Generate a JSON string representing a GS1 Company Prefix length header.
+ *
+ * @param gcpLengthHeader
+ * GS1 Company Prefix length header.
+ *
+ * @param space
+ * JSON string indentation.
+ *
+ * @returns
+ * JSON string.
+ */
+export function stringifyGCPLengthHeader(gcpLengthHeader: GCPLengthHeader, space?: string | number): string {
+    return JSON.stringify(gcpLengthHeader, (key, value: unknown) =>
+        key === "dateTime" && value instanceof Date ? value.toISOString() : value,
+    space);
+}
+
+/**
+ * GS1 Company Prefix length data.
+ */
+export interface GCPLengthData extends GCPLengthHeader {
+    /**
+     * Date/time the data was last updated.
+     */
+    readonly dateTime: Date;
+
+    /**
+     * Disclaimer.
+     */
+    readonly disclaimer: string;
+
+    /**
+     * Tree data in binary form.
+     */
+    readonly data: Uint8Array;
+}