@aidc-toolkit/gs1 0.9.19-beta → 0.9.21-beta

package/dist/prefix-manager.js

@@ -0,0 +1,369 @@
+import { GTINCreator } from "./gtin-creator.js";
+import { GTINTypes } from "./gtin-validator.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+import { NonGTINNumericIdentifierCreator } from "./non-gtin-numeric-identifier-creator.js";
+import { GLN_VALIDATOR, GSIN_VALIDATOR, GSRN_VALIDATOR, SSCC_VALIDATOR } from "./non-gtin-numeric-identifier-validator.js";
+import { NonNumericIdentifierCreator } from "./non-numeric-identifier-creator.js";
+import { CPID_VALIDATOR, GIAI_VALIDATOR, GINC_VALIDATOR, GMN_VALIDATOR } from "./non-numeric-identifier-validator.js";
+import { PrefixTypes } from "./prefix-type.js";
+import { PrefixValidator } from "./prefix-validator.js";
+import { SerializableNumericIdentifierCreator } from "./serializable-numeric-identifier-creator.js";
+import { GCN_VALIDATOR, GDTI_VALIDATOR, GRAI_VALIDATOR } from "./serializable-numeric-identifier-validator.js";
+/**
+ * Prefix manager. This is the core class for identifier creation.
+ *
+ * A prefix manager may be created for any {@link PrefixType | prefix type}. As most applications work with a limited
+ * number of prefixes for creating identifiers, prefix managers are cached in memory and may be reused.
+ *
+ * Prefix managers are keyed by GS1 Company Prefix, so the prefix type that is requested may not match the prefix type
+ * of the returned prefix manager. For example, the prefix manager for GS1 Company Prefix 0614141 is identical to the
+ * one for U.P.C. Company Prefix 614141, with the prefix type equal to {@link PrefixTypes.UPCCompanyPrefix} and the
+ * 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_MAP = new Map([
+        [IdentifierTypes.GTIN, 1987n],
+        [IdentifierTypes.GLN, 4241n],
+        [IdentifierTypes.SSCC, 8087n],
+        [IdentifierTypes.GRAI, 3221n],
+        [IdentifierTypes.GSRN, 2341n],
+        [IdentifierTypes.GDTI, 7333n],
+        [IdentifierTypes.GSIN, 5623n],
+        [IdentifierTypes.GCN, 6869n]
+    ]);
+    /**
+     * Normalized prefix type.
+     */
+    _prefixType;
+    /**
+     * Normalized prefix.
+     */
+    _prefix;
+    /**
+     * Prefix as GS1 Company Prefix.
+     */
+    _gs1CompanyPrefix;
+    /**
+     * U.P.C. Company Prefix if prefix type is {@link PrefixTypes.UPCCompanyPrefix}.
+     */
+    _upcCompanyPrefix;
+    /**
+     * GS1-8 Prefix if prefix type is {@link PrefixTypes.GS18Prefix}.
+     */
+    _gs18Prefix;
+    /**
+     * Default tweak factor.
+     */
+    _defaultTweakFactor;
+    /**
+     * Tweak factor.
+     */
+    _tweakFactor = 0n;
+    /**
+     * Cached identifier creators.
+     */
+    _identifierCreatorsMap = new Map();
+    /**
+     * Constructor.
+     *
+     * @param gs1CompanyPrefix
+     * GS1 Company Prefix.
+     */
+    constructor(gs1CompanyPrefix) {
+        this._gs1CompanyPrefix = gs1CompanyPrefix;
+        // Determine the prefix type and populate the remaining fields.
+        if (!gs1CompanyPrefix.startsWith("0")) {
+            this._prefixType = PrefixTypes.GS1CompanyPrefix;
+            this._prefix = this._gs1CompanyPrefix;
+        }
+        else if (!gs1CompanyPrefix.startsWith("00000")) {
+            this._prefixType = PrefixTypes.UPCCompanyPrefix;
+            this._upcCompanyPrefix = gs1CompanyPrefix.substring(1);
+            this._prefix = this._upcCompanyPrefix;
+        }
+        else {
+            this._prefixType = PrefixTypes.GS18Prefix;
+            this._gs18Prefix = gs1CompanyPrefix.substring(5);
+            this._prefix = this._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 {@link PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    get upcCompanyPrefix() {
+        return this._upcCompanyPrefix;
+    }
+    /**
+     * Get the GS1-8 Prefix if prefix type is {@link 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 creator
+     * Identifier creator.
+     */
+    setCreatorTweak(creator) {
+        const creatorTweakFactor = PrefixManager.CREATOR_TWEAK_FACTORS_MAP.get(creator.identifierType);
+        // Creator tweak factor is defined for numeric identifiers only.
+        if (creatorTweakFactor !== undefined) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion,no-param-reassign -- Explicit cast without testing is necessary as "instanceof" doesn't work for mixin types. Method purpose is to set the tweak.
+            creator.tweak = this.tweakFactor * creatorTweakFactor;
+        }
+    }
+    /**
+     * 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 this._identifierCreatorsMap.values()) {
+                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) {
+        PrefixValidator.validate(prefixType, true, true, prefix);
+        let gs1CompanyPrefix;
+        switch (prefixType) {
+            case PrefixTypes.GS1CompanyPrefix:
+                gs1CompanyPrefix = prefix;
+                break;
+            case PrefixTypes.UPCCompanyPrefix:
+                gs1CompanyPrefix = "0" + prefix;
+                break;
+            case PrefixTypes.GS18Prefix:
+                gs1CompanyPrefix = "00000" + prefix;
+                break;
+            // eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check -- Method may be called by unsafe means.
+            default:
+                throw new RangeError(i18nextGS1.t("Prefix.invalidPrefixType"));
+        }
+        let prefixManager = PrefixManager.PREFIX_MANAGERS_MAP.get(gs1CompanyPrefix);
+        if (prefixManager === undefined) {
+            prefixManager = new PrefixManager(gs1CompanyPrefix);
+            PrefixManager.PREFIX_MANAGERS_MAP.set(gs1CompanyPrefix, prefixManager);
+        }
+        return prefixManager;
+    }
+    /**
+     * Get an identifier creator.
+     *
+     * @param identifierType
+     * Identifier type.
+     *
+     * @param constructorCallback
+     * Constructor callback.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getIdentifierCreator(identifierType, constructorCallback) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Type is paired with constructor callback.
+        let creator = this._identifierCreatorsMap.get(identifierType);
+        if (creator === undefined) {
+            if (this.prefixType === PrefixTypes.GS18Prefix && identifierType !== IdentifierTypes.GTIN) {
+                throw new RangeError(i18nextGS1.t("Prefix.identifierTypeNotSupportedByGS18Prefix", {
+                    identifierType
+                }));
+            }
+            creator = constructorCallback();
+            this.setCreatorTweak(creator);
+            this._identifierCreatorsMap.set(identifierType, creator);
+        }
+        return creator;
+    }
+    /**
+     * Get non-GTIN numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getNonGTINNumericIdentifierCreator(validator) {
+        return this.getIdentifierCreator(validator.identifierType, () => new NonGTINNumericIdentifierCreator(this, validator.identifierType, validator.length, validator.leaderType));
+    }
+    /**
+     * Get serialized numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getSerializableNumericIdentifierCreator(validator) {
+        return this.getIdentifierCreator(validator.identifierType, () => new SerializableNumericIdentifierCreator(this, validator.identifierType, validator.length, validator.serialComponentLength, validator.serialComponentCharacterSet));
+    }
+    /**
+     * Get non-numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    getNonNumericIdentifierCreator(validator) {
+        return this.getIdentifierCreator(validator.identifierType, () => new NonNumericIdentifierCreator(this, validator.identifierType, validator.length, validator.referenceCharacterSet, validator.requiresCheckCharacterPair));
+    }
+    /**
+     * Get GTIN creator.
+     */
+    get gtinCreator() {
+        return this.getIdentifierCreator(IdentifierTypes.GTIN, () => {
+            let gtinType;
+            switch (this.prefixType) {
+                case PrefixTypes.GS1CompanyPrefix:
+                    gtinType = GTINTypes.GTIN13;
+                    break;
+                case PrefixTypes.UPCCompanyPrefix:
+                    gtinType = GTINTypes.GTIN12;
+                    break;
+                case PrefixTypes.GS18Prefix:
+                    gtinType = GTINTypes.GTIN8;
+                    break;
+            }
+            return new GTINCreator(this, gtinType);
+        });
+    }
+    /**
+     * Get GLN creator.
+     */
+    get glnCreator() {
+        return this.getNonGTINNumericIdentifierCreator(GLN_VALIDATOR);
+    }
+    /**
+     * Get SSCC creator.
+     */
+    get ssccCreator() {
+        return this.getNonGTINNumericIdentifierCreator(SSCC_VALIDATOR);
+    }
+    /**
+     * Get GRAI creator.
+     */
+    get graiCreator() {
+        return this.getSerializableNumericIdentifierCreator(GRAI_VALIDATOR);
+    }
+    /**
+     * Get GIAI creator.
+     */
+    get giaiCreator() {
+        return this.getNonNumericIdentifierCreator(GIAI_VALIDATOR);
+    }
+    /**
+     * Get GSRN creator.
+     */
+    get gsrnCreator() {
+        return this.getNonGTINNumericIdentifierCreator(GSRN_VALIDATOR);
+    }
+    /**
+     * Get GDTI creator.
+     */
+    get gdtiCreator() {
+        return this.getSerializableNumericIdentifierCreator(GDTI_VALIDATOR);
+    }
+    /**
+     * Get GINC creator.
+     */
+    get gincCreator() {
+        return this.getNonNumericIdentifierCreator(GINC_VALIDATOR);
+    }
+    /**
+     * Get GSIN creator.
+     */
+    get gsinCreator() {
+        return this.getNonGTINNumericIdentifierCreator(GSIN_VALIDATOR);
+    }
+    /**
+     * Get GCN creator.
+     */
+    get gcnCreator() {
+        return this.getSerializableNumericIdentifierCreator(GCN_VALIDATOR);
+    }
+    /**
+     * Get CPID creator.
+     */
+    get cpidCreator() {
+        return this.getNonNumericIdentifierCreator(CPID_VALIDATOR);
+    }
+    /**
+     * Get GMN creator.
+     */
+    get gmnCreator() {
+        return this.getNonNumericIdentifierCreator(GMN_VALIDATOR);
+    }
+}
+//# 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,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAiB,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAE/D,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAC3F,OAAO,EACH,aAAa,EACb,cAAc,EACd,cAAc,EAEd,cAAc,EACjB,MAAM,4CAA4C,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,EACH,cAAc,EACd,cAAc,EACd,cAAc,EACd,aAAa,EAEhB,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EAAmB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAChE,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,oCAAoC,EAAE,MAAM,8CAA8C,CAAC;AACpG,OAAO,EACH,aAAa,EACb,cAAc,EACd,cAAc,EAEjB,MAAM,gDAAgD,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,aAAa;IACtB;;OAEG;IACK,MAAM,CAAU,mBAAmB,GAAG,IAAI,GAAG,EAAyB,CAAC;IAE/E;;;OAGG;IACK,MAAM,CAAU,yBAAyB,GAAwC,IAAI,GAAG,CAAC;QAC7F,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC;QAC5B,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC;QAC7B,CAAC,eAAe,CAAC,GAAG,EAAE,KAAK,CAAC;KAC/B,CAAC,CAAC;IAEH;;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,sBAAsB,GAAG,IAAI,GAAG,EAAqC,CAAC;IAEvF;;;;;OAKG;IACH,YAAoB,gBAAwB;QACxC,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAE1C,+DAA+D;QAC/D,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,gBAAgB,CAAC;YAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC1C,CAAC;aAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,gBAAgB,CAAC;YAChD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,iBAAiB,CAAC;QAC1C,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,UAAU,CAAC;YAC1C,IAAI,CAAC,WAAW,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YACjD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QACpC,CAAC;QAED,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,OAA0B;QAC9C,MAAM,kBAAkB,GAAG,aAAa,CAAC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAE/F,gEAAgE;QAChE,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;YACnC,yNAAyN;YACxN,OAA4C,CAAC,KAAK,GAAG,IAAI,CAAC,WAAW,GAAG,kBAAkB,CAAC;QAChG,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,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,EAAE,CAAC;gBACzD,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,eAAe,CAAC,QAAQ,CAAC,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAEzD,IAAI,gBAAwB,CAAC;QAE7B,QAAQ,UAAU,EAAE,CAAC;YACjB,KAAK,WAAW,CAAC,gBAAgB;gBAC7B,gBAAgB,GAAG,MAAM,CAAC;gBAC1B,MAAM;YAEV,KAAK,WAAW,CAAC,gBAAgB;gBAC7B,gBAAgB,GAAG,GAAG,GAAG,MAAM,CAAC;gBAChC,MAAM;YAEV,KAAK,WAAW,CAAC,UAAU;gBACvB,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAC;gBACpC,MAAM;YAEV,mHAAmH;YACnH;gBACI,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,aAAa,GAAG,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAE5E,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAC9B,aAAa,GAAG,IAAI,aAAa,CAAC,gBAAgB,CAAC,CAAC;YACpD,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAC3E,CAAC;QAED,OAAO,aAAa,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;OAWG;IACK,oBAAoB,CAA+C,cAA8B,EAAE,mBAA6C;QACpJ,oHAAoH;QACpH,IAAI,OAAO,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,CAAmC,CAAC;QAEhG,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,mBAAmB,EAAE,CAAC;YAEhC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YAE9B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC;QAED,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;OAQG;IACK,kCAAkC,CAAC,SAA4C;QACnF,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,+BAA+B,CAAC,IAAI,EAAE,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;IAClL,CAAC;IAED;;;;;;;;OAQG;IACK,uCAAuC,CAAC,SAAiD;QAC7F,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,oCAAoC,CAAC,IAAI,EAAE,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,qBAAqB,EAAE,SAAS,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACzO,CAAC;IAED;;;;;;;;OAQG;IACK,8BAA8B,CAAC,SAAwC;QAC3E,OAAO,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,2BAA2B,CAAC,IAAI,EAAE,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,qBAAqB,EAAE,SAAS,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAC/N,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,oBAAoB,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE;YACxD,IAAI,QAAkB,CAAC;YAEvB,QAAQ,IAAI,CAAC,UAAU,EAAE,CAAC;gBACtB,KAAK,WAAW,CAAC,gBAAgB;oBAC7B,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC;oBAC5B,MAAM;gBAEV,KAAK,WAAW,CAAC,gBAAgB;oBAC7B,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC;oBAC5B,MAAM;gBAEV,KAAK,WAAW,CAAC,UAAU;oBACvB,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC;oBAC3B,MAAM;YACd,CAAC;YAED,OAAO,IAAI,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,kCAAkC,CAAC,aAAa,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,uCAAuC,CAAC,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,uCAAuC,CAAC,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,kCAAkC,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,uCAAuC,CAAC,aAAa,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,8BAA8B,CAAC,aAAa,CAAC,CAAC;IAC9D,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 {@link PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    readonly upcCompanyPrefix: string | undefined;
+    /**
+     * Prefix as GS1-8 Prefix if prefix type is {@link 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,22 @@
+/**
+ * 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.
+ */
+export type PrefixType = typeof PrefixTypes[keyof typeof PrefixTypes];
+//# 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,UAAU,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,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,58 @@
+import { type CharacterSetValidation } from "@aidc-toolkit/utility";
+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;
+}
+/**
+ * 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.
+ */
+declare function validate(prefixType: PrefixType, allowUPCCompanyPrefix: boolean, allowGS18Prefix: boolean, prefix: string, isFromIdentifier?: boolean, isNumericIdentifier?: boolean, positionOffset?: number): void;
+/**
+ * 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;
+    readonly validate: typeof validate;
+};
+export {};
+//# 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,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;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,iBAAS,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,qBAAqB,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,UAAQ,EAAE,mBAAmB,UAAQ,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAsDxM;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;CAQlB,CAAC"}

package/dist/prefix-validator.js

@@ -0,0 +1,154 @@
+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 = 6;
+/**
+ * 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")
+};
+/**
+ * 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.
+ */
+function validate(prefixType, allowUPCCompanyPrefix, allowGS18Prefix, prefix, isFromIdentifier = false, isNumericIdentifier = false, positionOffset) {
+    let baseValidation;
+    // Validate the prefix type and determine the prefix validation parameters.
+    switch (prefixType) {
+        case PrefixTypes.GS1CompanyPrefix:
+            if (!prefix.startsWith("0")) {
+                baseValidation = GS1_COMPANY_PREFIX_VALIDATION;
+            }
+            else if (!prefix.startsWith("00000")) {
+                if (!allowUPCCompanyPrefix) {
+                    throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixCantStartWith0"));
+                }
+                baseValidation = UPC_COMPANY_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION;
+            }
+            else if (!prefix.startsWith("000000")) {
+                if (!allowGS18Prefix) {
+                    throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixCantStartWith00000"));
+                }
+                baseValidation = GS1_8_PREFIX_AS_GS1_COMPANY_PREFIX_VALIDATION;
+            }
+            else {
+                throw new RangeError(i18nextGS1.t("Prefix.gs1CompanyPrefixCantStartWith000000"));
+            }
+            break;
+        case PrefixTypes.UPCCompanyPrefix:
+            if (prefix.startsWith("0000")) {
+                throw new RangeError(i18nextGS1.t("Prefix.upcCompanyPrefixCantStartWith0000"));
+            }
+            baseValidation = UPC_COMPANY_PREFIX_VALIDATION;
+            break;
+        case PrefixTypes.GS18Prefix:
+            if (prefix.startsWith("0")) {
+                throw new RangeError(i18nextGS1.t("Prefix.gs18PrefixCantStartWith0"));
+            }
+            baseValidation = GS1_8_PREFIX_VALIDATION;
+            break;
+    }
+    const mergedValidation = {
+        ...baseValidation,
+        positionOffset
+    };
+    // If from key and numeric, key validation will take care of character set validation.
+    if (!isFromIdentifier) {
+        NUMERIC_CREATOR.validate(prefix, mergedValidation);
+    }
+    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(mergedValidation.minimumLength, prefix.length - 1)), mergedValidation);
+    }
+}
+/**
+ * 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
+};
+//# sourceMappingURL=prefix-validator.js.map