@aidc-toolkit/gs1 1.0.25-beta → 1.0.26-beta

package/dist/prefix-manager.js

@@ -0,0 +1,334 @@
+import { isNumericIdentifierCreator } from "./creators.js";
+import { GTINCreator } from "./gtin-creator.js";
+import { GTIN_BASE_TYPES } from "./gtin-type.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+import { NonGTINNumericIdentifierCreator } from "./non-gtin-numeric-identifier-creator.js";
+import { NonNumericIdentifierCreator } from "./non-numeric-identifier-creator.js";
+import { PrefixTypes } from "./prefix-type.js";
+import { PrefixValidator } from "./prefix-validator.js";
+import { SerializableNumericIdentifierCreator } from "./serializable-numeric-identifier-creator.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 * PrefixManager.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 = PrefixManager.PREFIX_MANAGERS_MAP.get(normalizedPrefixProvider.gs1CompanyPrefix);
+        if (prefixManager === undefined) {
+            prefixManager = new PrefixManager(normalizedPrefixProvider.prefixType, normalizedPrefixProvider.prefix);
+            PrefixManager.PREFIX_MANAGERS_MAP.set(normalizedPrefixProvider.gs1CompanyPrefix, prefixManager);
+        }
+        return prefixManager;
+    }
+    /**
+     * Get an identifier creator.
+     *
+     * @template TIdentifierType
+     * Identifier type type.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @param constructorParameter
+     * Second constructor parameter passed to constructor callback alongside this.
+     *
+     * @param ConstructorCallback
+     * Constructor callback.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getIdentifierCreator(identifierType, constructorParameter, ConstructorCallback) {
+        let creator = this._identifierCreators[identifierType];
+        if (creator === undefined) {
+            if (this.prefixType === PrefixTypes.GS18Prefix && identifierType !== IdentifierTypes.GTIN) {
+                throw new RangeError(i18nextGS1.t("Prefix.identifierTypeNotSupportedByGS18Prefix", {
+                    identifierType
+                }));
+            }
+            creator = new ConstructorCallback(this, constructorParameter);
+            this.setCreatorTweak(creator);
+            this._identifierCreators[identifierType] = creator;
+        }
+        return creator;
+    }
+    /**
+     * Get non-GTIN numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getNonGTINNumericIdentifierCreator(identifierType) {
+        return this.getIdentifierCreator(identifierType, identifierType, NonGTINNumericIdentifierCreator);
+    }
+    /**
+     * Get serialized numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getSerializableNumericIdentifierCreator(identifierType) {
+        return this.getIdentifierCreator(identifierType, identifierType, SerializableNumericIdentifierCreator);
+    }
+    /**
+     * Get non-numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getNonNumericIdentifierCreator(identifierType) {
+        return this.getIdentifierCreator(identifierType, identifierType, NonNumericIdentifierCreator);
+    }
+    /**
+     * Get GTIN creator.
+     */
+    get gtinCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GTIN, GTIN_BASE_TYPES[this.prefixType], GTINCreator);
+    }
+    /**
+     * Get GLN creator.
+     */
+    get glnCreator() {
+        return this.getNonGTINNumericIdentifierCreator(IdentifierTypes.GLN);
+    }
+    /**
+     * Get SSCC creator.
+     */
+    get ssccCreator() {
+        return this.getNonGTINNumericIdentifierCreator(IdentifierTypes.SSCC);
+    }
+    /**
+     * Get GRAI creator.
+     */
+    get graiCreator() {
+        return this.getSerializableNumericIdentifierCreator(IdentifierTypes.GRAI);
+    }
+    /**
+     * Get GIAI creator.
+     */
+    get giaiCreator() {
+        return this.getNonNumericIdentifierCreator(IdentifierTypes.GIAI);
+    }
+    /**
+     * Get GSRN creator.
+     */
+    get gsrnCreator() {
+        return this.getNonGTINNumericIdentifierCreator(IdentifierTypes.GSRN);
+    }
+    /**
+     * Get GDTI creator.
+     */
+    get gdtiCreator() {
+        return this.getSerializableNumericIdentifierCreator(IdentifierTypes.GDTI);
+    }
+    /**
+     * Get GINC creator.
+     */
+    get gincCreator() {
+        return this.getNonNumericIdentifierCreator(IdentifierTypes.GINC);
+    }
+    /**
+     * Get GSIN creator.
+     */
+    get gsinCreator() {
+        return this.getNonGTINNumericIdentifierCreator(IdentifierTypes.GSIN);
+    }
+    /**
+     * Get GCN creator.
+     */
+    get gcnCreator() {
+        return this.getSerializableNumericIdentifierCreator(IdentifierTypes.GCN);
+    }
+    /**
+     * Get CPID creator.
+     */
+    get cpidCreator() {
+        return this.getNonNumericIdentifierCreator(IdentifierTypes.CPID);
+    }
+    /**
+     * Get GMN creator.
+     */
+    get gmnCreator() {
+        return this.getNonNumericIdentifierCreator(IdentifierTypes.GMN);
+    }
+}
+//# 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":"AAAA,OAAO,EAAiC,0BAA0B,EAAE,MAAM,eAAe,CAAC;AAC1F,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAE3F,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAIlF,OAAO,EAAmB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,oCAAoC,EAAE,MAAM,8CAA8C,CAAC;AAGpG;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAa;IACtB;;OAEG;IACK,MAAM,CAAU,mBAAmB,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE/E;;;OAGG;IACK,MAAM,CAAU,qBAAqB,GAAoD;QAC7F,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;IACc,WAAW,CAAa;IAEzC;;OAEG;IACc,OAAO,CAAS;IAEjC;;OAEG;IACc,iBAAiB,CAAS;IAE3C;;OAEG;IACc,iBAAiB,CAAqB;IAEvD;;OAEG;IACc,WAAW,CAAqB;IAEjD;;OAEG;IACc,mBAAmB,CAAS;IAE7C;;OAEG;IACK,YAAY,GAAG,EAAE,CAAC;IAE1B;;OAEG;IACc,mBAAmB,GAAsC,EAAE,CAAC;IAE7E;;;;;;;;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;IACK,eAAe,CAAC,iBAAoC;QACxD,IAAI,0BAA0B,CAAC,iBAAiB,CAAC,EAAE,CAAC;YAChD,oFAAoF;YACpF,iBAAiB,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,GAAG,aAAa,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;QACvH,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,eAAe,CAAC,OAAO,CAAC,CAAC;YAClC,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,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;QAErG,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9B,aAAa,GAAG,IAAI,aAAa,CAAC,wBAAwB,CAAC,UAAU,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC;YACxG,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QACpG,CAAC;QAED,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACK,oBAAoB,CAAgE,cAA+B,EAAE,oBAA2C,EAAE,mBAAmJ;QACzT,IAAI,OAAO,GAA0D,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE9G,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC,UAAU,IAAI,cAAc,KAAK,eAAe,CAAC,IAAI,EAAE,CAAC;gBACxF,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,+CAA+C,EAAE;oBAC/E,cAAc;iBACjB,CAAC,CAAC,CAAC;YACR,CAAC;YAED,OAAO,GAAG,IAAI,mBAAmB,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;YAE9D,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAE9B,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC;QACvD,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACK,kCAAkC,CAAC,cAAwF;QAC/H,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,+BAA+B,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;OAQG;IACK,uCAAuC,CAAC,cAAiD;QAC7F,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,oCAAoC,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;OAQG;IACK,8BAA8B,CAAC,cAAwC;QAC3E,OAAO,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,cAAc,EAAE,2BAA2B,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,CAAC;IAC1G,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,kCAAkC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,uCAAuC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,uCAAuC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,uCAAuC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,8BAA8B,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACpE,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,70 @@
+import { type CharacterSetValidation } from "@aidc-toolkit/utility";
+import type { PrefixProvider } from "./prefix-provider.js";
+import { type PrefixType } from "./prefix-type.js";
+/**
+ * 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: 6;
+    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 positionOffset
+     * Position offset within a larger string.
+     */
+    readonly validate: (prefixType: PrefixType, allowUPCCompanyPrefix: boolean, allowGS18Prefix: boolean, prefix: string, isFromIdentifier?: boolean, isNumericIdentifier?: boolean, positionOffset?: number) => 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;AAEhE;;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,8EAA0E,MAAM,KAAG,IAAI;IAwDhM;;;;;;;;;;;OAWG;qCACmB,UAAU,UAAU,MAAM,KAAG,cAAc;CAiD3D,CAAC"}