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

package/dist/numeric-identifier-creator.js

@@ -0,0 +1,135 @@
+import { CharacterSetCreator, Exclusions, NUMERIC_CREATOR } from "@aidc-toolkit/utility";
+import { checkDigit, checkDigitSum } from "./check.js";
+import { AbstractIdentifierCreator } from "./identifier-creator.js";
+import { LeaderTypes } from "./numeric-identifier-validator.js";
+/**
+ * Abstract numeric identifier creator. Implements common functionality for a numeric identifier
+ * creator.
+ */
+export class AbstractNumericIdentifierCreator extends AbstractIdentifierCreator {
+    /**
+     * Capacity.
+     */
+    _capacity;
+    /**
+     * Tweak for sparse creation.
+     */
+    _tweak = 0n;
+    /**
+     * Initialize the prefix provider. This method is in lieu of a constructor due to the mixin architecture.
+     *
+     * @param prefixProvider
+     * Prefix provider.
+     *
+     * @param prefix
+     * Prefix within prefix manager to use to calculate reference length.
+     */
+    init(prefixProvider, prefix) {
+        super.init(prefixProvider, prefix, 1);
+        // Capacity is always in number range.
+        this._capacity = Number(CharacterSetCreator.powerOf10(this.referenceLength));
+    }
+    /**
+     * @inheritDoc
+     */
+    get capacity() {
+        return this._capacity;
+    }
+    /**
+     * Get the tweak for sparse creation.
+     */
+    get tweak() {
+        return this._tweak;
+    }
+    /**
+     * Set the tweak for sparse creation.
+     */
+    set tweak(value) {
+        this._tweak = value;
+    }
+    /**
+     * Build an identifier from a reference by merging it with the prefix and adding the check digit.
+     *
+     * @param reference
+     * Identifier reference.
+     *
+     * @returns
+     * Identifier.
+     */
+    buildIdentifier(reference) {
+        const partialIdentifier = this.leaderType === LeaderTypes.ExtensionDigit ? reference.substring(0, 1) + this.prefix + reference.substring(1) : this.prefix + reference;
+        return partialIdentifier + checkDigit(partialIdentifier);
+    }
+    /**
+     * @inheritDoc
+     */
+    create(valueOrValues, sparse = false) {
+        return NUMERIC_CREATOR.create(this.referenceLength, valueOrValues, Exclusions.None, sparse ? this.tweak : undefined, reference => this.buildIdentifier(reference));
+    }
+    /**
+     * Create all identifiers from a partial identifier. Call is recursive until remaining reference
+     * length is 0.
+     *
+     * @param partialIdentifier
+     * Partial identifier. Initial value is `this.prefix`.
+     *
+     * @param remainingReferenceLength
+     * Remaining reference length. Initial value is `this.referenceLength`.
+     *
+     * @param extensionWeight
+     * If this value is not zero, the identifier has an extension digit, this call is setting it, and this value
+     * is applied to the calculation of the check digit.
+     *
+     * @param weight
+     * If the extension weight is zero, this value is applied to the calculation of the check digit.
+     *
+     * @param partialCheckDigitSum
+     * Partial check digit sum for the partial identifier.
+     *
+     * @yields
+     * Identifier.
+     */
+    static *createAllPartial(partialIdentifier, remainingReferenceLength, extensionWeight, weight, partialCheckDigitSum) {
+        if (remainingReferenceLength === 0) {
+            // Finalize check digit calculation and append.
+            yield partialIdentifier + NUMERIC_CREATOR.character(9 - (partialCheckDigitSum + 9) % 10);
+        }
+        else {
+            const nextRemainingReferenceLength = remainingReferenceLength - 1;
+            let nextPartialCheckDigitSum = partialCheckDigitSum;
+            if (extensionWeight !== 0) {
+                // Apply every digit to the extension digit.
+                for (const c of NUMERIC_CREATOR.characterSet) {
+                    yield* AbstractNumericIdentifierCreator.createAllPartial(c + partialIdentifier, nextRemainingReferenceLength, 0, weight, nextPartialCheckDigitSum);
+                    nextPartialCheckDigitSum += extensionWeight;
+                }
+            }
+            else {
+                const nextWeight = 4 - weight;
+                // Apply every digit to the current character in the identifier.
+                for (const c of NUMERIC_CREATOR.characterSet) {
+                    yield* AbstractNumericIdentifierCreator.createAllPartial(partialIdentifier + c, nextRemainingReferenceLength, 0, nextWeight, nextPartialCheckDigitSum);
+                    nextPartialCheckDigitSum += weight;
+                }
+            }
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    createAll() {
+        const hasExtensionDigit = this.leaderType === LeaderTypes.ExtensionDigit;
+        const prefix = this.prefix;
+        const length = this.length;
+        const referenceLength = this.referenceLength;
+        // Start weight is for reference excluding extension digit, which has its weight calculated separately.
+        const startWeight = 3 - 2 * ((referenceLength + 1 - Number(hasExtensionDigit)) % 2);
+        // Returning separate Iterable object makes iteration repeatable.
+        return {
+            [Symbol.iterator]() {
+                return AbstractNumericIdentifierCreator.createAllPartial(prefix, referenceLength, hasExtensionDigit ? 3 - 2 * length % 2 : 0, startWeight, checkDigitSum(startWeight === 3, prefix));
+            }
+        };
+    }
+}
+//# sourceMappingURL=numeric-identifier-creator.js.map

package/dist/numeric-identifier-creator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-creator.js","sourceRoot":"","sources":["../src/numeric-identifier-creator.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,mBAAmB,EACnB,UAAU,EACV,eAAe,EAGlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,yBAAyB,EAA0B,MAAM,yBAAyB,CAAC;AAC5F,OAAO,EAAmB,WAAW,EAAmC,MAAM,mCAAmC,CAAC;AA2ClH;;;GAGG;AACH,MAAM,OAAgB,gCAAiC,SAAQ,yBAAyB;IACpF;;OAEG;IACK,SAAS,CAAU;IAE3B;;OAEG;IACK,MAAM,GAAG,EAAE,CAAC;IAEpB;;;;;;;;OAQG;IACgB,IAAI,CAAC,cAA8B,EAAE,MAAc;QAClE,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;QAEtC,sCAAsC;QACtC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IACjF,CAAC;IAID;;OAEG;IACH,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK,CAAC,KAAa;QACnB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACK,eAAe,CAAC,SAAiB;QACrC,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QAEtK,OAAO,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,MAAM,CAA8D,aAAgC,EAAE,MAAM,GAAG,KAAK;QAChH,OAAO,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,aAAa,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IACvK,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACK,MAAM,CAAC,CAAE,gBAAgB,CAAC,iBAAyB,EAAE,wBAAgC,EAAE,eAAuB,EAAE,MAAc,EAAE,oBAA4B;QAChK,IAAI,wBAAwB,KAAK,CAAC,EAAE,CAAC;YACjC,+CAA+C;YAC/C,MAAM,iBAAiB,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,oBAAoB,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;QAC7F,CAAC;aAAM,CAAC;YACJ,MAAM,4BAA4B,GAAG,wBAAwB,GAAG,CAAC,CAAC;YAElE,IAAI,wBAAwB,GAAG,oBAAoB,CAAC;YAEpD,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;gBACxB,4CAA4C;gBAC5C,KAAK,MAAM,CAAC,IAAI,eAAe,CAAC,YAAY,EAAE,CAAC;oBAC3C,KAAM,CAAC,CAAC,gCAAgC,CAAC,gBAAgB,CAAC,CAAC,GAAG,iBAAiB,EAAE,4BAA4B,EAAE,CAAC,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;oBAEpJ,wBAAwB,IAAI,eAAe,CAAC;gBAChD,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,MAAM,UAAU,GAAG,CAAC,GAAG,MAAM,CAAC;gBAE9B,gEAAgE;gBAChE,KAAK,MAAM,CAAC,IAAI,eAAe,CAAC,YAAY,EAAE,CAAC;oBAC3C,KAAM,CAAC,CAAC,gCAAgC,CAAC,gBAAgB,CAAC,iBAAiB,GAAG,CAAC,EAAE,4BAA4B,EAAE,CAAC,EAAE,UAAU,EAAE,wBAAwB,CAAC,CAAC;oBAExJ,wBAAwB,IAAI,MAAM,CAAC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED;;OAEG;IACH,SAAS;QACL,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC,cAAc,CAAC;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAE7C,uGAAuG;QACvG,MAAM,WAAW,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,eAAe,GAAG,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAEpF,iEAAiE;QACjE,OAAO;YACH,CAAC,MAAM,CAAC,QAAQ,CAAC;gBACb,OAAO,gCAAgC,CAAC,gBAAgB,CAAC,MAAM,EAAE,eAAe,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,WAAW,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;YACzL,CAAC;SACJ,CAAC;IACN,CAAC;CACJ"}

package/dist/numeric-identifier-validator.d.ts

@@ -0,0 +1,76 @@
+import type { IdentifierType, IdentifierTypes } from "./identifier-type.js";
+import { AbstractIdentifierValidator, type IdentifierValidation, type IdentifierValidator } from "./identifier-validator.js";
+import type { PrefixType } from "./prefix-type.js";
+/**
+ * Numeric identifier type.
+ */
+export type NumericIdentifierType = typeof IdentifierTypes.GTIN | typeof IdentifierTypes.GLN | typeof IdentifierTypes.SSCC | typeof IdentifierTypes.GRAI | typeof IdentifierTypes.GSRN | typeof IdentifierTypes.GDTI | typeof IdentifierTypes.GSIN | typeof IdentifierTypes.GCN;
+/**
+ * Leader type.
+ */
+export declare const LeaderTypes: {
+    /**
+     * No leader.
+     */
+    None: string;
+    /**
+     * Indicator digit (GTIN only).
+     */
+    IndicatorDigit: string;
+    /**
+     * Extension digit (SSCC only).
+     */
+    ExtensionDigit: string;
+};
+/**
+ * Leader type.
+ */
+export type LeaderType = typeof LeaderTypes[keyof typeof LeaderTypes];
+/**
+ * Numeric identifier validator. Validates a numeric identifier.
+ */
+export interface NumericIdentifierValidator extends IdentifierValidator {
+    /**
+     * Get the leader type.
+     */
+    get leaderType(): LeaderType;
+}
+/**
+ * Abstract numeric identifier validator. Implements common functionality for a numeric identifier
+ * validator.
+ */
+export declare abstract class AbstractNumericIdentifierValidator extends AbstractIdentifierValidator implements NumericIdentifierValidator {
+    /**
+     * Leader type.
+     */
+    private readonly _leaderType;
+    /**
+     * Prefix position, determined by the leader type.
+     */
+    private readonly _prefixPosition;
+    /**
+     * Constructor.
+     *
+     * @param identifierType
+     * Identifier type.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param length
+     * Length.
+     *
+     * @param leaderType
+     * Leader type.
+     */
+    protected constructor(identifierType: IdentifierType, prefixType: PrefixType, length: number, leaderType: LeaderType);
+    /**
+     * @inheritDoc
+     */
+    get leaderType(): LeaderType;
+    /**
+     * @inheritDoc
+     */
+    validate(identifier: string, validation?: IdentifierValidation): void;
+}
+//# sourceMappingURL=numeric-identifier-validator.d.ts.map

package/dist/numeric-identifier-validator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-validator.d.ts","sourceRoot":"","sources":["../src/numeric-identifier-validator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,EACH,2BAA2B,EAE3B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EAC3B,MAAM,2BAA2B,CAAC;AAEnC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,GAAG,GAC1B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,IAAI,GAC3B,OAAO,eAAe,CAAC,GAAG,CAAC;AAE/B;;GAEG;AACH,eAAO,MAAM,WAAW;IACpB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEN,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,mBAAmB;IACnE;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAAC;CAChC;AAED;;;GAGG;AACH,8BAAsB,kCAAmC,SAAQ,2BAA4B,YAAW,0BAA0B;IAC9H;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IAEzC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IAEzC;;;;;;;;;;;;;;OAcG;IACH,SAAS,aAAa,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAOpH;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,oBAAoB,GAAG,IAAI;CAqBxE"}

package/dist/numeric-identifier-validator.js

@@ -0,0 +1,84 @@
+import { hasValidCheckDigit } from "./check.js";
+import { AbstractIdentifierValidator, ContentCharacterSets } from "./identifier-validator.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+/**
+ * Leader type.
+ */
+export const LeaderTypes = {
+    /**
+     * No leader.
+     */
+    None: "None",
+    /**
+     * Indicator digit (GTIN only).
+     */
+    IndicatorDigit: "Indicator digit",
+    /**
+     * Extension digit (SSCC only).
+     */
+    ExtensionDigit: "Extension digit"
+};
+/**
+ * Abstract numeric identifier validator. Implements common functionality for a numeric identifier
+ * validator.
+ */
+export class AbstractNumericIdentifierValidator extends AbstractIdentifierValidator {
+    /**
+     * Leader type.
+     */
+    _leaderType;
+    /**
+     * Prefix position, determined by the leader type.
+     */
+    _prefixPosition;
+    /**
+     * Constructor.
+     *
+     * @param identifierType
+     * Identifier type.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param length
+     * Length.
+     *
+     * @param leaderType
+     * Leader type.
+     */
+    constructor(identifierType, prefixType, length, leaderType) {
+        super(identifierType, prefixType, length, ContentCharacterSets.Numeric);
+        this._leaderType = leaderType;
+        this._prefixPosition = Number(this.leaderType === LeaderTypes.ExtensionDigit);
+    }
+    /**
+     * @inheritDoc
+     */
+    get leaderType() {
+        return this._leaderType;
+    }
+    /**
+     * @inheritDoc
+     */
+    validate(identifier, validation) {
+        // Validate the prefix, with care taken for its position within the identifier.
+        if (this._prefixPosition === 0) {
+            super.validatePrefix(identifier, validation?.positionOffset);
+        }
+        else {
+            super.validatePrefix(identifier.substring(this._prefixPosition), validation?.positionOffset === undefined ? this._prefixPosition : validation.positionOffset + this._prefixPosition);
+        }
+        // Validate the length.
+        if (identifier.length !== this.length) {
+            throw new RangeError(i18nextGS1.t("Identifier.identifierTypeLength", {
+                identifierType: this.identifierType,
+                length: this.length
+            }));
+        }
+        // Validating the check digit will also validate the characters.
+        if (!hasValidCheckDigit(this.padIdentifier(identifier, validation))) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidCheckDigit"));
+        }
+    }
+}
+//# sourceMappingURL=numeric-identifier-validator.js.map

package/dist/numeric-identifier-validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-validator.js","sourceRoot":"","sources":["../src/numeric-identifier-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EACH,2BAA2B,EAC3B,oBAAoB,EAGvB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAgB9C;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB;;OAEG;IACH,IAAI,EAAE,MAAM;IAEZ;;OAEG;IACH,cAAc,EAAE,iBAAiB;IAEjC;;OAEG;IACH,cAAc,EAAE,iBAAiB;CACpC,CAAC;AAiBF;;;GAGG;AACH,MAAM,OAAgB,kCAAmC,SAAQ,2BAA2B;IACxF;;OAEG;IACc,WAAW,CAAa;IAEzC;;OAEG;IACc,eAAe,CAAS;IAEzC;;;;;;;;;;;;;;OAcG;IACH,YAAsB,cAA8B,EAAE,UAAsB,EAAE,MAAc,EAAE,UAAsB;QAChH,KAAK,CAAC,cAAc,EAAE,UAAU,EAAE,MAAM,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAExE,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,WAAW,CAAC,cAAc,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,IAAI,UAAU;QACV,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,UAAkB,EAAE,UAAiC;QAC1D,+EAA+E;QAC/E,IAAI,IAAI,CAAC,eAAe,KAAK,CAAC,EAAE,CAAC;YAC7B,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACJ,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC;QACzL,CAAC;QAED,uBAAuB;QACvB,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,iCAAiC,EAAE;gBACjE,cAAc,EAAE,IAAI,CAAC,cAAc;gBACnC,MAAM,EAAE,IAAI,CAAC,MAAM;aACtB,CAAC,CAAC,CAAC;QACR,CAAC;QAED,gEAAgE;QAChE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC,CAAC;QACvE,CAAC;IACL,CAAC;CACJ"}

package/dist/prefix-manager.d.ts

@@ -0,0 +1,224 @@
+import { GTINCreator } from "./gtin-creator.js";
+import { NonGTINNumericIdentifierCreator } from "./non-gtin-numeric-identifier-creator.js";
+import { NonNumericIdentifierCreator } from "./non-numeric-identifier-creator.js";
+import type { PrefixProvider } from "./prefix-provider.js";
+import { type PrefixType } from "./prefix-type.js";
+import { SerializableNumericIdentifierCreator } from "./serializable-numeric-identifier-creator.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 declare class PrefixManager implements PrefixProvider {
+    /**
+     * Cached prefix managers, keyed by GS1 Company Prefix.
+     */
+    private static readonly PREFIX_MANAGERS_MAP;
+    /**
+     * Creator tweak factors. Different numeric identifier types have different tweak factors so that sparse
+     * creation generates different sequences for each.
+     */
+    private static readonly CREATOR_TWEAK_FACTORS_MAP;
+    /**
+     * Normalized prefix type.
+     */
+    private readonly _prefixType;
+    /**
+     * Normalized prefix.
+     */
+    private readonly _prefix;
+    /**
+     * Prefix as GS1 Company Prefix.
+     */
+    private readonly _gs1CompanyPrefix;
+    /**
+     * U.P.C. Company Prefix if prefix type is {@link PrefixTypes.UPCCompanyPrefix}.
+     */
+    private readonly _upcCompanyPrefix;
+    /**
+     * GS1-8 Prefix if prefix type is {@link PrefixTypes.GS18Prefix}.
+     */
+    private readonly _gs18Prefix;
+    /**
+     * Default tweak factor.
+     */
+    private readonly _defaultTweakFactor;
+    /**
+     * Tweak factor.
+     */
+    private _tweakFactor;
+    /**
+     * Cached identifier creators.
+     */
+    private readonly _identifierCreatorsMap;
+    /**
+     * Constructor.
+     *
+     * @param gs1CompanyPrefix
+     * GS1 Company Prefix.
+     */
+    private constructor();
+    /**
+     * Get the prefix type.
+     */
+    get prefixType(): PrefixType;
+    /**
+     * Get the prefix.
+     */
+    get prefix(): string;
+    /**
+     * Get the GS1 Company Prefix.
+     */
+    get gs1CompanyPrefix(): string;
+    /**
+     * Get the U.P.C. Company Prefix if prefix type is {@link PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    get upcCompanyPrefix(): string | undefined;
+    /**
+     * Get the GS1-8 Prefix if prefix type is {@link PrefixTypes.GS18Prefix} or undefined if not.
+     */
+    get gs18Prefix(): string | undefined;
+    /**
+     * Set the tweak for an identifier creator if it's a numeric identifier creator.
+     *
+     * @param creator
+     * Identifier creator.
+     */
+    private setCreatorTweak;
+    /**
+     * Get the tweak factor.
+     */
+    get tweakFactor(): bigint;
+    /**
+     * Set the tweak factor.
+     *
+     * @param value
+     * Tweak factor.
+     */
+    set tweakFactor(value: number | bigint);
+    /**
+     * Reset the tweak factor to its default (numeric value of the GS1 Company Prefix preceded by '1').
+     */
+    resetTweakFactor(): void;
+    /**
+     * Get a prefix manager.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     *
+     * @returns
+     * Prefix manager with normalized prefix type and prefix.
+     */
+    static get(prefixType: PrefixType, prefix: string): PrefixManager;
+    /**
+     * Get an identifier creator.
+     *
+     * @param identifierType
+     * Identifier type.
+     *
+     * @param constructorCallback
+     * Constructor callback.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getIdentifierCreator;
+    /**
+     * Get non-GTIN numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getNonGTINNumericIdentifierCreator;
+    /**
+     * Get serialized numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getSerializableNumericIdentifierCreator;
+    /**
+     * Get non-numeric identifier creator.
+     *
+     * @param validator
+     * Validator on which identifier creator is based.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getNonNumericIdentifierCreator;
+    /**
+     * Get GTIN creator.
+     */
+    get gtinCreator(): GTINCreator;
+    /**
+     * Get GLN creator.
+     */
+    get glnCreator(): NonGTINNumericIdentifierCreator;
+    /**
+     * Get SSCC creator.
+     */
+    get ssccCreator(): NonGTINNumericIdentifierCreator;
+    /**
+     * Get GRAI creator.
+     */
+    get graiCreator(): SerializableNumericIdentifierCreator;
+    /**
+     * Get GIAI creator.
+     */
+    get giaiCreator(): NonNumericIdentifierCreator;
+    /**
+     * Get GSRN creator.
+     */
+    get gsrnCreator(): NonGTINNumericIdentifierCreator;
+    /**
+     * Get GDTI creator.
+     */
+    get gdtiCreator(): SerializableNumericIdentifierCreator;
+    /**
+     * Get GINC creator.
+     */
+    get gincCreator(): NonNumericIdentifierCreator;
+    /**
+     * Get GSIN creator.
+     */
+    get gsinCreator(): NonGTINNumericIdentifierCreator;
+    /**
+     * Get GCN creator.
+     */
+    get gcnCreator(): SerializableNumericIdentifierCreator;
+    /**
+     * Get CPID creator.
+     */
+    get cpidCreator(): NonNumericIdentifierCreator;
+    /**
+     * Get GMN creator.
+     */
+    get gmnCreator(): NonNumericIdentifierCreator;
+}
+//# sourceMappingURL=prefix-manager.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"prefix-manager.d.ts","sourceRoot":"","sources":["../src/prefix-manager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAKhD,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAQ3F,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AASlF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,kBAAkB,CAAC;AAEhE,OAAO,EAAE,oCAAoC,EAAE,MAAM,8CAA8C,CAAC;AAQpG;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,aAAc,YAAW,cAAc;IAChD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAoC;IAE/E;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAS9C;IAEH;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IAEzC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAEjC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAE3C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAqB;IAEvD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqB;IAEjD;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAE7C;;OAEG;IACH,OAAO,CAAC,YAAY,CAAM;IAE1B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAgD;IAEvF;;;;;OAKG;IACH,OAAO;IAuBP;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,MAAM,GAAG,SAAS,CAEnC;IAED;;;;;OAKG;IACH,OAAO,CAAC,eAAe;IAUvB;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;;;;OAKG;IACH,IAAI,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAUrC;IAED;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa;IAiCjE;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,oBAAoB;IAqB5B;;;;;;;;OAQG;IACH,OAAO,CAAC,kCAAkC;IAI1C;;;;;;;;OAQG;IACH,OAAO,CAAC,uCAAuC;IAI/C;;;;;;;;OAQG;IACH,OAAO,CAAC,8BAA8B;IAItC;;OAEG;IACH,IAAI,WAAW,IAAI,WAAW,CAoB7B;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,+BAA+B,CAEhD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,+BAA+B,CAEjD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,oCAAoC,CAEtD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,2BAA2B,CAE7C;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,+BAA+B,CAEjD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,oCAAoC,CAEtD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,2BAA2B,CAE7C;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,+BAA+B,CAEjD;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,oCAAoC,CAErD;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,2BAA2B,CAE7C;IAED;;OAEG;IACH,IAAI,UAAU,IAAI,2BAA2B,CAE5C;CACJ"}