@aidc-toolkit/gs1 1.0.43 → 1.0.44-beta

package/dist/prefix-manager.js

@@ -0,0 +1,297 @@
+var _a;
+import { GTIN_BASE_TYPES } from "./gtin-length.js";
+import { IdentifierCreatorConstructors, isNumericIdentifierCreator } from "./identifier-creators.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+import { PrefixTypes } from "./prefix-type.js";
+import { PrefixValidator } from "./prefix-validator.js";
+/**
+ * Prefix manager. This is the core class for identifier creation.
+ *
+ * A prefix manager may be constructed for any {@link PrefixType | prefix type}. Construction may be done directly or
+ * via the static {@linkcode PrefixManager.get | get()} method, which allows for caching and reuse. As most applications
+ * work with a limited number of prefixes for creating identifiers, caching and reuse may be a more efficient option.
+ *
+ * The prefix type and prefix are normalized before the prefix manager is constructed, so they may not match the input
+ * values. For example, the GS1 Company Prefix 0614141 is equivalent to U.P.C. Company Prefix 614141; both result in a
+ * prefix manager with prefix type equal to {@linkcode PrefixTypes.UPCCompanyPrefix} and prefix equal to "614141".
+ *
+ * To support the creation of sparse identifiers, a prefix manager maintains a {@link tweakFactor | tweak factor} which
+ * is used, along with a type-specific multiplier, as the tweak when creating numeric identifiers. The default tweak
+ * factor is the numeric value of the GS1 Company Prefix representation of the prefix preceded by '1' to ensure
+ * uniqueness (i.e., so that prefixes 0 N1 N2 N3... and N1 N2 N3... produce different tweak factors). This is usually
+ * sufficient for obfuscation, but as the sparse creation algorithm is reversible and as the GS1 Company Prefix is
+ * discoverable via {@link https://www.gs1.org/services/verified-by-gs1 | Verified by GS1}, a user-defined tweak factor
+ * should be used if a higher degree of obfuscation is required. When using a tweak factor other than the default, care
+ * should be taken to restore it when resuming the application. A tweak factor of 0 creates a straight sequence.
+ */
+export class PrefixManager {
+    /**
+     * Cached prefix managers, keyed by GS1 Company Prefix.
+     */
+    static #PREFIX_MANAGERS_MAP = new Map();
+    /**
+     * Creator tweak factors. Different numeric identifier types have different tweak factors so that sparse creation
+     * generates different sequences for each.
+     */
+    static #CREATOR_TWEAK_FACTORS = {
+        GTIN: 1987n,
+        GLN: 4241n,
+        SSCC: 8087n,
+        GRAI: 3221n,
+        GSRN: 2341n,
+        GDTI: 7333n,
+        GSIN: 5623n,
+        GCN: 6869n
+    };
+    /**
+     * Normalized prefix type.
+     */
+    #prefixType;
+    /**
+     * Normalized prefix.
+     */
+    #prefix;
+    /**
+     * Prefix as GS1 Company Prefix.
+     */
+    #gs1CompanyPrefix;
+    /**
+     * U.P.C. Company Prefix if prefix type is {@linkcode PrefixTypes.UPCCompanyPrefix}.
+     */
+    #upcCompanyPrefix;
+    /**
+     * GS1-8 Prefix if prefix type is {@linkcode PrefixTypes.GS18Prefix}.
+     */
+    #gs18Prefix;
+    /**
+     * Default tweak factor.
+     */
+    #defaultTweakFactor;
+    /**
+     * Tweak factor.
+     */
+    #tweakFactor = 0n;
+    /**
+     * Cached identifier creators.
+     */
+    #identifierCreators = {};
+    /**
+     * Constructor.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     */
+    constructor(prefixType, prefix) {
+        const normalizedPrefixProvider = PrefixValidator.normalize(prefixType, prefix);
+        this.#prefixType = normalizedPrefixProvider.prefixType;
+        this.#prefix = normalizedPrefixProvider.prefix;
+        this.#gs1CompanyPrefix = normalizedPrefixProvider.gs1CompanyPrefix;
+        this.#upcCompanyPrefix = normalizedPrefixProvider.upcCompanyPrefix;
+        this.#gs18Prefix = normalizedPrefixProvider.gs18Prefix;
+        // Default tweak factor is the numeric value of the GS1 Company Prefix preceded by '1'.
+        this.#defaultTweakFactor = BigInt(`1${this.gs1CompanyPrefix}`);
+        this.resetTweakFactor();
+    }
+    /**
+     * Get the prefix type.
+     */
+    get prefixType() {
+        return this.#prefixType;
+    }
+    /**
+     * Get the prefix.
+     */
+    get prefix() {
+        return this.#prefix;
+    }
+    /**
+     * Get the GS1 Company Prefix.
+     */
+    get gs1CompanyPrefix() {
+        return this.#gs1CompanyPrefix;
+    }
+    /**
+     * Get the U.P.C. Company Prefix if prefix type is {@linkcode PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    get upcCompanyPrefix() {
+        return this.#upcCompanyPrefix;
+    }
+    /**
+     * Get the GS1-8 Prefix if prefix type is {@linkcode PrefixTypes.GS18Prefix} or undefined if not.
+     */
+    get gs18Prefix() {
+        return this.#gs18Prefix;
+    }
+    /**
+     * Set the tweak for an identifier creator if it's a numeric identifier creator.
+     *
+     * @param identifierCreator
+     * Identifier creator.
+     */
+    #setCreatorTweak(identifierCreator) {
+        if (isNumericIdentifierCreator(identifierCreator)) {
+            // eslint-disable-next-line no-param-reassign -- Method purpose is to set the tweak.
+            identifierCreator.tweak = this.tweakFactor * _a.#CREATOR_TWEAK_FACTORS[identifierCreator.identifierType];
+        }
+    }
+    /**
+     * Get the tweak factor.
+     */
+    get tweakFactor() {
+        return this.#tweakFactor;
+    }
+    /**
+     * Set the tweak factor.
+     *
+     * @param value
+     * Tweak factor.
+     */
+    set tweakFactor(value) {
+        const tweakFactor = BigInt(value);
+        if (this.#tweakFactor !== tweakFactor) {
+            this.#tweakFactor = tweakFactor;
+            for (const creator of Object.values(this.#identifierCreators)) {
+                this.#setCreatorTweak(creator);
+            }
+        }
+    }
+    /**
+     * Reset the tweak factor to its default (numeric value of the GS1 Company Prefix preceded by '1').
+     */
+    resetTweakFactor() {
+        this.tweakFactor = this.#defaultTweakFactor;
+    }
+    /**
+     * Get a prefix manager.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @returns
+     * Prefix manager with normalized prefix type and prefix.
+     */
+    static get(prefixType, prefix) {
+        // Normalization will occur in constructor as well, but it's necessary here for the map.
+        const normalizedPrefixProvider = PrefixValidator.normalize(prefixType, prefix);
+        let prefixManager = _a.#PREFIX_MANAGERS_MAP.get(normalizedPrefixProvider.gs1CompanyPrefix);
+        if (prefixManager === undefined) {
+            prefixManager = new _a(normalizedPrefixProvider.prefixType, normalizedPrefixProvider.prefix);
+            _a.#PREFIX_MANAGERS_MAP.set(normalizedPrefixProvider.gs1CompanyPrefix, prefixManager);
+        }
+        return prefixManager;
+    }
+    /**
+     * Get an identifier creator.
+     *
+     * @template TIdentifierType
+     * Identifier type type.
+     *
+     * @param identifierType
+     * Identifier type for which to retrieve or construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getIdentifierCreator(identifierType) {
+        let creator = this.#identifierCreators[identifierType];
+        if (creator === undefined) {
+            if (identifierType === IdentifierTypes.GTIN) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Types are known to match.
+                creator = new IdentifierCreatorConstructors.GTIN(this, GTIN_BASE_TYPES[this.prefixType]);
+            }
+            else {
+                if (this.prefixType === PrefixTypes.GS18Prefix) {
+                    throw new RangeError(i18nextGS1.t("Prefix.identifierTypeNotSupportedByGS18Prefix", {
+                        identifierType
+                    }));
+                }
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Types are known to match.
+                creator = new IdentifierCreatorConstructors[identifierType](this, identifierType);
+            }
+            this.#setCreatorTweak(creator);
+            this.#identifierCreators[identifierType] = creator;
+        }
+        return creator;
+    }
+    /**
+     * Get GTIN creator.
+     */
+    get gtinCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GTIN);
+    }
+    /**
+     * Get GLN creator.
+     */
+    get glnCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GLN);
+    }
+    /**
+     * Get SSCC creator.
+     */
+    get ssccCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.SSCC);
+    }
+    /**
+     * Get GRAI creator.
+     */
+    get graiCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GRAI);
+    }
+    /**
+     * Get GIAI creator.
+     */
+    get giaiCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GIAI);
+    }
+    /**
+     * Get GSRN creator.
+     */
+    get gsrnCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GSRN);
+    }
+    /**
+     * Get GDTI creator.
+     */
+    get gdtiCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GDTI);
+    }
+    /**
+     * Get GINC creator.
+     */
+    get gincCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GINC);
+    }
+    /**
+     * Get GSIN creator.
+     */
+    get gsinCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GSIN);
+    }
+    /**
+     * Get GCN creator.
+     */
+    get gcnCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GCN);
+    }
+    /**
+     * Get CPID creator.
+     */
+    get cpidCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.CPID);
+    }
+    /**
+     * Get GMN creator.
+     */
+    get gmnCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GMN);
+    }
+}
+_a = PrefixManager;
+//# sourceMappingURL=prefix-manager.js.map

package/dist/prefix-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-manager.js","sourceRoot":"","sources":["../src/prefix-manager.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGnD,OAAO,EACH,6BAA6B,EAE7B,0BAA0B,EAE7B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAK9C,OAAO,EAAmB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAa;IACtB;;OAEG;IACH,MAAM,CAAU,oBAAoB,GAAG,IAAI,GAAG,EAAyB,CAAC;IAExE;;;OAGG;IACH,MAAM,CAAU,sBAAsB,GAAoD;QACtF,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,KAAK;QACV,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK;QACX,GAAG,EAAE,KAAK;KACb,CAAC;IAEF;;OAEG;IACM,WAAW,CAAa;IAEjC;;OAEG;IACM,OAAO,CAAS;IAEzB;;OAEG;IACM,iBAAiB,CAAS;IAEnC;;OAEG;IACM,iBAAiB,CAAqB;IAE/C;;OAEG;IACM,WAAW,CAAqB;IAEzC;;OAEG;IACM,mBAAmB,CAAS;IAErC;;OAEG;IACH,YAAY,GAAG,EAAE,CAAC;IAElB;;OAEG;IACM,mBAAmB,GAAsC,EAAE,CAAC;IAErE;;;;;;;;OAQG;IACH,YAAY,UAAsB,EAAE,MAAc;QAC9C,MAAM,wBAAwB,GAAG,eAAe,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAE/E,IAAI,CAAC,WAAW,GAAG,wBAAwB,CAAC,UAAU,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,wBAAwB,CAAC,MAAM,CAAC;QAC/C,IAAI,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,gBAAgB,CAAC;QACnE,IAAI,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,gBAAgB,CAAC;QACnE,IAAI,CAAC,WAAW,GAAG,wBAAwB,CAAC,UAAU,CAAC;QAEvD,uFAAuF;QACvF,IAAI,CAAC,mBAAmB,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,iBAAoC;QACjD,IAAI,0BAA0B,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChD,oFAAoF;YACpF,iBAAiB,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,GAAG,EAAa,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACxH,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACH,IAAI,WAAW,CAAC,KAAsB;QAClC,MAAM,WAAW,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,IAAI,CAAC,YAAY,KAAK,WAAW,EAAE,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;YAEhC,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC;QACL,CAAC;IACL,CAAC;IAED;;OAEG;IACH,gBAAgB;QACZ,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,GAAG,CAAC,UAAsB,EAAE,MAAc;QAC7C,wFAAwF;QACxF,MAAM,wBAAwB,GAAG,eAAe,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAE/E,IAAI,aAAa,GAAG,EAAa,CAAC,oBAAoB,CAAC,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QAEtG,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9B,aAAa,GAAG,IAAI,EAAa,CAAC,wBAAwB,CAAC,UAAU,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC;YACxG,EAAa,CAAC,oBAAoB,CAAC,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QACrG,CAAC;QAED,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAyC,cAA+B;QACxF,IAAI,OAAO,GAA0D,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9G,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,cAAc,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;gBAC1C,oGAAoG;gBACpG,OAAO,GAAG,IAAI,6BAA6B,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAA8C,CAAC;YAC1I,CAAC;iBAAM,CAAC;gBACJ,IAAI,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC,UAAU,EAAE,CAAC;oBAC7C,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,+CAA+C,EAAE;wBAC/E,cAAc;qBACjB,CAAC,CAAC,CAAC;gBACR,CAAC;gBAED,oGAAoG;gBACpG,OAAO,GAAG,IAAK,6BAA6B,CAAC,cAAc,CAA8E,CAAC,IAAI,EAAE,cAAoD,CAAC,CAAC;YAC1M,CAAC;YAED,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAE/B,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC;QACvD,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC1D,CAAC"}

package/dist/prefix-provider.d.ts

@@ -0,0 +1,27 @@
+import type { PrefixType } from "./prefix-type.js";
+/**
+ * Prefix provider.
+ */
+export interface PrefixProvider {
+    /**
+     * Prefix type.
+     */
+    readonly prefixType: PrefixType;
+    /**
+     * Prefix appropriate to the prefix type.
+     */
+    readonly prefix: string;
+    /**
+     * Prefix as GS1 Company Prefix.
+     */
+    readonly gs1CompanyPrefix: string;
+    /**
+     * Prefix as U.P.C. Company Prefix if prefix type is {@linkcode PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    readonly upcCompanyPrefix: string | undefined;
+    /**
+     * Prefix as GS1-8 Prefix if prefix type is {@linkcode PrefixTypes.GS18Prefix} or undefined if not.
+     */
+    readonly gs18Prefix: string | undefined;
+}
+//# sourceMappingURL=prefix-provider.d.ts.map

package/dist/prefix-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-provider.d.ts","sourceRoot":"","sources":["../src/prefix-provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3C"}

package/dist/prefix-provider.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=prefix-provider.js.map

package/dist/prefix-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-provider.js","sourceRoot":"","sources":["../src/prefix-provider.ts"],"names":[],"mappings":""}

package/dist/prefix-type.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Prefix types.
+ */
+export declare const PrefixTypes: {
+    /**
+     * GS1 Company Prefix.
+     */
+    readonly GS1CompanyPrefix: "GS1 Company Prefix";
+    /**
+     * U.P.C. Company Prefix.
+     */
+    readonly UPCCompanyPrefix: "U.P.C. Company Prefix";
+    /**
+     * GS1-8 Prefix.
+     */
+    readonly GS18Prefix: "GS1-8 Prefix";
+};
+/**
+ * Prefix type key.
+ */
+export type PrefixTypeKey = keyof typeof PrefixTypes;
+/**
+ * Prefix type.
+ */
+export type PrefixType = typeof PrefixTypes[PrefixTypeKey];
+//# sourceMappingURL=prefix-type.d.ts.map

package/dist/prefix-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-type.d.ts","sourceRoot":"","sources":["../src/prefix-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,WAAW;IACpB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEG,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,WAAW,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,WAAW,CAAC,aAAa,CAAC,CAAC"}

package/dist/prefix-type.js

@@ -0,0 +1,18 @@
+/**
+ * Prefix types.
+ */
+export const PrefixTypes = {
+    /**
+     * GS1 Company Prefix.
+     */
+    GS1CompanyPrefix: "GS1 Company Prefix",
+    /**
+     * U.P.C. Company Prefix.
+     */
+    UPCCompanyPrefix: "U.P.C. Company Prefix",
+    /**
+     * GS1-8 Prefix.
+     */
+    GS18Prefix: "GS1-8 Prefix"
+};
+//# sourceMappingURL=prefix-type.js.map

package/dist/prefix-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-type.js","sourceRoot":"","sources":["../src/prefix-type.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB;;OAEG;IACH,gBAAgB,EAAE,oBAAoB;IAEtC;;OAEG;IACH,gBAAgB,EAAE,uBAAuB;IAEzC;;OAEG;IACH,UAAU,EAAE,cAAc;CACpB,CAAC"}

package/dist/prefix-validator.d.ts

@@ -0,0 +1,71 @@
+import { type CharacterSetValidation } from "@aidc-toolkit/utility";
+import type { PrefixProvider } from "./prefix-provider.js";
+import { type PrefixType } from "./prefix-type.js";
+import type { ParseKeys } from "i18next";
+/**
+ * Prefix validation parameters.
+ */
+export interface PrefixValidation extends CharacterSetValidation {
+    /**
+     * Minimum length.
+     */
+    minimumLength: number;
+    /**
+     * Maximum length.
+     */
+    maximumLength: number;
+    /**
+     * Callback to localized prefix type name.
+     */
+    component: () => string;
+}
+/**
+ * Prefix validator.
+ */
+export declare const PrefixValidator: {
+    readonly GS1_COMPANY_PREFIX_MINIMUM_LENGTH: 4;
+    readonly GS1_COMPANY_PREFIX_MAXIMUM_LENGTH: 12;
+    readonly UPC_COMPANY_PREFIX_MINIMUM_LENGTH: 5;
+    readonly UPC_COMPANY_PREFIX_MAXIMUM_LENGTH: 11;
+    readonly GS1_8_PREFIX_MINIMUM_LENGTH: 2;
+    readonly GS1_8_PREFIX_MAXIMUM_LENGTH: 7;
+    /**
+     * Validate a prefix.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param allowUPCCompanyPrefix
+     * If true, a U.P.C. Company Prefix expressed as a GS1 Company Prefix is permitted.
+     *
+     * @param allowGS18Prefix
+     * If true, a GS1-8 Prefix expressed as a GS1 Company Prefix is permitted.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @param isFromIdentifier
+     * If true, the prefix is from an identifier and should be trimmed before its character set is validated.
+     *
+     * @param isNumericIdentifier
+     * If true, the prefix is from a numeric identifier and its character set will be validated by the caller.
+     *
+     * @param errorMessageParseKey
+     * Parse key for error message when validating GS1 Company Prefix type.
+     */
+    readonly validate: (prefixType: PrefixType, allowUPCCompanyPrefix: boolean, allowGS18Prefix: boolean, prefix: string, isFromIdentifier?: boolean, isNumericIdentifier?: boolean, errorMessageParseKey?: ParseKeys) => void;
+    /**
+     * Normalize a prefix.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @returns
+     * Prefix provider with normalized prefix type and prefix.
+     */
+    readonly normalize: (prefixType: PrefixType, prefix: string) => PrefixProvider;
+};
+//# sourceMappingURL=prefix-validator.d.ts.map

package/dist/prefix-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-validator.d.ts","sourceRoot":"","sources":["../src/prefix-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,sBAAsB,EAAmB,MAAM,uBAAuB,CAAC;AAErF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,kBAAkB,CAAC;AAChE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,sBAAsB;IAC5D;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC;CAC3B;AA6ED;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;IAQxB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;oCACkB,UAAU,yBAAyB,OAAO,mBAAmB,OAAO,UAAU,MAAM,oFAAgF,SAAS,KAAG,IAAI;IAmDzM;;;;;;;;;;;OAWG;qCACmB,UAAU,UAAU,MAAM,KAAG,cAAc;CAiD3D,CAAC"}

package/dist/prefix-validator.js

@@ -0,0 +1,204 @@
+import { NUMERIC_CREATOR } from "@aidc-toolkit/utility";
+import { i18nextGS1 } from "./locale/i18n.js";
+import { PrefixTypes } from "./prefix-type.js";
+/**
+ * GS1 Company Prefix minimum length.
+ */
+const GS1_COMPANY_PREFIX_MINIMUM_LENGTH = 4;
+/**
+ * GS1 Company Prefix maximum length.
+ */
+const GS1_COMPANY_PREFIX_MAXIMUM_LENGTH = 12;
+/**
+ * U.P.C. Company Prefix minimum length.
+ */
+const UPC_COMPANY_PREFIX_MINIMUM_LENGTH = 5;
+/**
+ * U.P.C. Company Prefix maximum length.
+ */
+const UPC_COMPANY_PREFIX_MAXIMUM_LENGTH = 11;
+/**
+ * GS1-8 Prefix minimum length.
+ */
+const GS1_8_PREFIX_MINIMUM_LENGTH = 2;
+/**
+ * GS1-8 Prefix maximum length.
+ */
+const GS1_8_PREFIX_MAXIMUM_LENGTH = 7;
+/**
+ * Validation parameters for GS1 Company Prefix.
+ */
+const GS1_COMPANY_PREFIX_VALIDATION = {
+    minimumLength: GS1_COMPANY_PREFIX_MINIMUM_LENGTH,
+    maximumLength: GS1_COMPANY_PREFIX_MAXIMUM_LENGTH,
+    component: () => i18nextGS1.t("Prefix.gs1CompanyPrefix")
+};
+/**
+ * Validation parameters for U.P.C. Company Prefix expressed as GS1 Company Prefix.
+ */
+const UPC_COMPANY_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION = {
+    minimumLength: UPC_COMPANY_PREFIX_MINIMUM_LENGTH + 1,
+    maximumLength: UPC_COMPANY_PREFIX_MAXIMUM_LENGTH + 1,
+    component: () => i18nextGS1.t("Prefix.gs1CompanyPrefix")
+};
+/**
+ * Validation parameters for GS1-8 Prefix expressed as GS1 Company Prefix.
+ */
+const GS1_8_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION = {
+    minimumLength: GS1_8_PREFIX_MINIMUM_LENGTH + 5,
+    maximumLength: GS1_8_PREFIX_MAXIMUM_LENGTH + 5,
+    component: () => i18nextGS1.t("Prefix.gs1CompanyPrefix")
+};
+/**
+ * Validation parameters for U.P.C. Company Prefix.
+ */
+const UPC_COMPANY_PREFIX_VALIDATION = {
+    minimumLength: UPC_COMPANY_PREFIX_MINIMUM_LENGTH,
+    maximumLength: UPC_COMPANY_PREFIX_MAXIMUM_LENGTH,
+    component: () => i18nextGS1.t("Prefix.upcCompanyPrefix")
+};
+/**
+ * Validation parameters for GS1-8 Prefix.
+ */
+const GS1_8_PREFIX_VALIDATION = {
+    minimumLength: GS1_8_PREFIX_MINIMUM_LENGTH,
+    maximumLength: GS1_8_PREFIX_MAXIMUM_LENGTH,
+    component: () => i18nextGS1.t("Prefix.gs18Prefix")
+};
+/**
+ * Prefix validator.
+ */
+export const PrefixValidator = {
+    GS1_COMPANY_PREFIX_MINIMUM_LENGTH,
+    GS1_COMPANY_PREFIX_MAXIMUM_LENGTH,
+    UPC_COMPANY_PREFIX_MINIMUM_LENGTH,
+    UPC_COMPANY_PREFIX_MAXIMUM_LENGTH,
+    GS1_8_PREFIX_MINIMUM_LENGTH,
+    GS1_8_PREFIX_MAXIMUM_LENGTH,
+    /**
+     * Validate a prefix.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param allowUPCCompanyPrefix
+     * If true, a U.P.C. Company Prefix expressed as a GS1 Company Prefix is permitted.
+     *
+     * @param allowGS18Prefix
+     * If true, a GS1-8 Prefix expressed as a GS1 Company Prefix is permitted.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @param isFromIdentifier
+     * If true, the prefix is from an identifier and should be trimmed before its character set is validated.
+     *
+     * @param isNumericIdentifier
+     * If true, the prefix is from a numeric identifier and its character set will be validated by the caller.
+     *
+     * @param errorMessageParseKey
+     * Parse key for error message when validating GS1 Company Prefix type.
+     */
+    validate(prefixType, allowUPCCompanyPrefix, allowGS18Prefix, prefix, isFromIdentifier = false, isNumericIdentifier = false, errorMessageParseKey) {
+        let validation;
+        // Validate the prefix type and determine the prefix validation parameters.
+        switch (prefixType) {
+            case PrefixTypes.GS1CompanyPrefix:
+                if (!prefix.startsWith("0")) {
+                    validation = GS1_COMPANY_PREFIX_VALIDATION;
+                }
+                else if (!prefix.startsWith("00000")) {
+                    if (!allowUPCCompanyPrefix) {
+                        throw new RangeError(i18nextGS1.t(errorMessageParseKey ?? "Prefix.gs1CompanyPrefixCantStartWith0"));
+                    }
+                    validation = UPC_COMPANY_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION;
+                }
+                else if (!prefix.startsWith("000000")) {
+                    if (!allowGS18Prefix) {
+                        throw new RangeError(i18nextGS1.t(errorMessageParseKey ?? "Prefix.gs1CompanyPrefixCantStartWith00000"));
+                    }
+                    validation = GS1_8_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION;
+                }
+                else {
+                    throw new RangeError(i18nextGS1.t(errorMessageParseKey ?? "Prefix.gs1CompanyPrefixCantStartWith000000"));
+                }
+                break;
+            case PrefixTypes.UPCCompanyPrefix:
+                if (prefix.startsWith("0000")) {
+                    throw new RangeError(i18nextGS1.t("Prefix.upcCompanyPrefixCantStartWith0000"));
+                }
+                validation = UPC_COMPANY_PREFIX_VALIDATION;
+                break;
+            case PrefixTypes.GS18Prefix:
+                if (prefix.startsWith("0")) {
+                    throw new RangeError(i18nextGS1.t("Prefix.gs18PrefixCantStartWith0"));
+                }
+                validation = GS1_8_PREFIX_VALIDATION;
+                break;
+        }
+        // If from identifier and numeric, identifier validation will take care of character set validation.
+        if (!isFromIdentifier) {
+            NUMERIC_CREATOR.validate(prefix, validation);
+        }
+        else if (!isNumericIdentifier) {
+            // Validate only the minimum length, allowing at least one character for the (possibly non-numeric) reference.
+            NUMERIC_CREATOR.validate(prefix.substring(0, Math.min(validation.minimumLength, prefix.length - 1)), validation);
+        }
+    },
+    /**
+     * Normalize a prefix.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @returns
+     * Prefix provider with normalized prefix type and prefix.
+     */
+    normalize(prefixType, prefix) {
+        // Validate first.
+        this.validate(prefixType, true, true, prefix);
+        let gs1CompanyPrefix;
+        // First step is to map the prefix to a GS1 Company Prefix.
+        switch (prefixType) {
+            case PrefixTypes.GS1CompanyPrefix:
+                gs1CompanyPrefix = prefix;
+                break;
+            case PrefixTypes.UPCCompanyPrefix:
+                gs1CompanyPrefix = `0${prefix}`;
+                break;
+            case PrefixTypes.GS18Prefix:
+                gs1CompanyPrefix = `00000${prefix}`;
+                break;
+        }
+        let normalizedPrefixType;
+        let normalizedPrefix;
+        let upcCompanyPrefix = undefined;
+        let gs18Prefix = undefined;
+        // Determine the prefix type and populate the remaining fields.
+        if (!gs1CompanyPrefix.startsWith("0")) {
+            normalizedPrefixType = PrefixTypes.GS1CompanyPrefix;
+            normalizedPrefix = gs1CompanyPrefix;
+        }
+        else if (!gs1CompanyPrefix.startsWith("00000")) {
+            normalizedPrefixType = PrefixTypes.UPCCompanyPrefix;
+            upcCompanyPrefix = gs1CompanyPrefix.substring(1);
+            normalizedPrefix = upcCompanyPrefix;
+        }
+        else {
+            normalizedPrefixType = PrefixTypes.GS18Prefix;
+            gs18Prefix = gs1CompanyPrefix.substring(5);
+            normalizedPrefix = gs18Prefix;
+        }
+        return {
+            prefixType: normalizedPrefixType,
+            prefix: normalizedPrefix,
+            gs1CompanyPrefix,
+            upcCompanyPrefix,
+            gs18Prefix
+        };
+    }
+};
+//# sourceMappingURL=prefix-validator.js.map