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

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

@@ -0,0 +1,49 @@
+import { Exclusions } from "@aidc-toolkit/utility";
+import { AbstractIdentifierValidator } from "./abstract-identifier-validator.js";
+import type { IdentifierValidation } from "./identifier-validator.js";
+import type { NonNumericIdentifierDescriptor } from "./non-numeric-identifier-descriptor.js";
+import type { NonNumericIdentifierType } from "./non-numeric-identifier-type.js";
+/**
+ * Non-numeric identifier validation parameters.
+ */
+export interface NonNumericIdentifierValidation extends IdentifierValidation {
+    /**
+     * Exclusion support for reference. Prevents non-numeric identifier from being mistaken for numeric identifier.
+     */
+    exclusion?: typeof Exclusions.None | typeof Exclusions.AllNumeric | undefined;
+}
+/**
+ * Non-numeric identifier validator.
+ */
+export declare class NonNumericIdentifierValidator extends AbstractIdentifierValidator<NonNumericIdentifierDescriptor, NonNumericIdentifierValidation> {
+    /**
+     * Validator to ensure that an identifier (minus check character pair) is not all numeric.
+     */
+    private static readonly NOT_ALL_NUMERIC_VALIDATOR;
+    /**
+     * True if the identifier requires a check character pair.
+     */
+    private readonly _requiresCheckCharacterPair;
+    /**
+     * Constructor.
+     *
+     * @param identifierType
+     * Identifier type.
+     */
+    constructor(identifierType: NonNumericIdentifierType);
+    /**
+     * Determine if the identifier requires a check character pair.
+     */
+    get requiresCheckCharacterPair(): boolean;
+    /**
+     * Validate a non-numeric identifier and throw an error if validation fails.
+     *
+     * @param identifier
+     * Identifier.
+     *
+     * @param validation
+     * Validation parameters.
+     */
+    validate(identifier: string, validation?: NonNumericIdentifierValidation): void;
+}
+//# sourceMappingURL=non-numeric-identifier-validator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"non-numeric-identifier-validator.d.ts","sourceRoot":"","sources":["../src/non-numeric-identifier-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAmB,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAGjF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEtE,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AAC7F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,oBAAoB;IACxE;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,UAAU,CAAC,IAAI,GAAG,OAAO,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC;CACjF;AAED;;GAEG;AACH,qBAAa,6BAA8B,SAAQ,2BAA2B,CAAC,8BAA8B,EAAE,8BAA8B,CAAC;IAC1I;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,yBAAyB,CAOzC;IAER;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAU;IAEtD;;;;;OAKG;gBACS,cAAc,EAAE,wBAAwB;IAQpD;;OAEG;IACH,IAAI,0BAA0B,IAAI,OAAO,CAExC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,8BAA8B,GAAG,IAAI;CAmBlF"}

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

@@ -0,0 +1,69 @@
+import { Exclusions, RegExpValidator } from "@aidc-toolkit/utility";
+import { AbstractIdentifierValidator } from "./abstract-identifier-validator.js";
+import { hasValidCheckCharacterPair } from "./check.js";
+import { IdentifierDescriptors } from "./descriptors.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+/**
+ * Non-numeric identifier validator.
+ */
+export class NonNumericIdentifierValidator extends AbstractIdentifierValidator {
+    /**
+     * Validator to ensure that an identifier (minus check character pair) is not all numeric.
+     */
+    static NOT_ALL_NUMERIC_VALIDATOR = new class extends RegExpValidator {
+        /**
+         * @inheritDoc
+         */
+        createErrorMessage(_s) {
+            return i18nextGS1.t("Identifier.referenceCantBeAllNumeric");
+        }
+    }(/\D/);
+    /**
+     * True if the identifier requires a check character pair.
+     */
+    _requiresCheckCharacterPair;
+    /**
+     * Constructor.
+     *
+     * @param identifierType
+     * Identifier type.
+     */
+    constructor(identifierType) {
+        const identifierDescriptor = IdentifierDescriptors[identifierType];
+        super(identifierDescriptor);
+        this._requiresCheckCharacterPair = identifierDescriptor.requiresCheckCharacterPair;
+    }
+    /**
+     * Determine if the identifier requires a check character pair.
+     */
+    get requiresCheckCharacterPair() {
+        return this._requiresCheckCharacterPair;
+    }
+    /**
+     * Validate a non-numeric identifier and throw an error if validation fails.
+     *
+     * @param identifier
+     * Identifier.
+     *
+     * @param validation
+     * Validation parameters.
+     */
+    validate(identifier, validation) {
+        const partialIdentifier = this.requiresCheckCharacterPair ? identifier.substring(0, identifier.length - 2) : identifier;
+        super.validatePrefix(partialIdentifier);
+        if (!this.requiresCheckCharacterPair) {
+            this.referenceCreator.validate(identifier, {
+                maximumLength: this.length
+            });
+            // Validating the check character pair will also validate the characters.
+        }
+        else if (!hasValidCheckCharacterPair(this.padIdentifier(identifier))) {
+            throw new RangeError(i18nextGS1.t("Identifier.invalidCheckCharacterPair"));
+        }
+        // Check for all-numeric identifier (minus check character pair) if excluded.
+        if (validation?.exclusion === Exclusions.AllNumeric) {
+            NonNumericIdentifierValidator.NOT_ALL_NUMERIC_VALIDATOR.validate(partialIdentifier);
+        }
+    }
+}
+//# sourceMappingURL=non-numeric-identifier-validator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"non-numeric-identifier-validator.js","sourceRoot":"","sources":["../src/non-numeric-identifier-validator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAc9C;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,2BAA2F;IAC1I;;OAEG;IACK,MAAM,CAAU,yBAAyB,GAAG,IAAI,KAAM,SAAQ,eAAe;QACjF;;WAEG;QACgB,kBAAkB,CAAC,EAAU;YAC5C,OAAO,UAAU,CAAC,CAAC,CAAC,sCAAsC,CAAC,CAAC;QAChE,CAAC;KACJ,CAAC,IAAI,CAAC,CAAC;IAER;;OAEG;IACc,2BAA2B,CAAU;IAEtD;;;;;OAKG;IACH,YAAY,cAAwC;QAChD,MAAM,oBAAoB,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC;QAEnE,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAE5B,IAAI,CAAC,2BAA2B,GAAG,oBAAoB,CAAC,0BAA0B,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,IAAI,0BAA0B;QAC1B,OAAO,IAAI,CAAC,2BAA2B,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAC,UAAkB,EAAE,UAA2C;QACpE,MAAM,iBAAiB,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC;QAExH,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAC;QAExC,IAAI,CAAC,IAAI,CAAC,0BAA0B,EAAE,CAAC;YACnC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,EAAE;gBACvC,aAAa,EAAE,IAAI,CAAC,MAAM;aAC7B,CAAC,CAAC;YACH,yEAAyE;QAC7E,CAAC;aAAM,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,sCAAsC,CAAC,CAAC,CAAC;QAC/E,CAAC;QAED,6EAA6E;QAC7E,IAAI,UAAU,EAAE,SAAS,KAAK,UAAU,CAAC,UAAU,EAAE,CAAC;YAClD,6BAA6B,CAAC,yBAAyB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACxF,CAAC;IACL,CAAC"}

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

@@ -0,0 +1,53 @@
+import type { TransformerInput, TransformerOutput } from "@aidc-toolkit/utility";
+import type { IdentifierCreator } from "./identifier-creator.js";
+import type { NumericIdentifierDescriptor } from "./numeric-identifier-descriptor.js";
+import type { NumericIdentifierValidation, NumericIdentifierValidator } from "./numeric-identifier-validator.js";
+/**
+ * Numeric identifier creator. Creates one or many numeric identifiers.
+ *
+ * @template TNumericIdentifierDescriptor
+ * Numeric identifier descriptor type.
+ */
+export interface NumericIdentifierCreator<TNumericIdentifierDescriptor extends NumericIdentifierDescriptor = NumericIdentifierDescriptor> extends NumericIdentifierValidator<TNumericIdentifierDescriptor>, IdentifierCreator<TNumericIdentifierDescriptor, NumericIdentifierValidation> {
+    /**
+     * Get the capacity (`10**referenceLength`).
+     */
+    get capacity(): number;
+    /**
+     * Get the tweak for sparse creation.
+     */
+    get tweak(): bigint;
+    /**
+     * Set the tweak for sparse creation.
+     */
+    set tweak(value: bigint);
+    /**
+     * Create identifier(s) with reference(s) based on numeric value(s). The value(s) is/are converted to references of
+     * the appropriate length using the numeric creator.
+     *
+     * @template TTransformerInput
+     * Transformer input type.
+     *
+     * @param valueOrValues
+     * Numeric value(s).
+     *
+     * @param sparse
+     * If true, the value(s) are mapped to a sparse sequence resistant to discovery. Default is false.
+     *
+     * @returns
+     * Identifier(s).
+     */
+    create: <TTransformerInput extends TransformerInput<number | bigint>>(valueOrValues: TTransformerInput, sparse?: boolean) => TransformerOutput<TTransformerInput, string>;
+    /**
+     * Create all identifiers for the prefix from `0` to `capacity - 1`.
+     *
+     * The implementation creates the strings only as needed using an internal generator function. Although the result
+     * is equivalent to calling `creator.create(new Sequence(0, creator.capacity))`, this method is significantly
+     * faster.
+     *
+     * @returns
+     * All identifiers for the prefix.
+     */
+    createAll: () => Iterable<string>;
+}
+//# sourceMappingURL=numeric-identifier-creator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-creator.d.ts","sourceRoot":"","sources":["../src/numeric-identifier-creator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AACjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AACtF,OAAO,KAAK,EAAE,2BAA2B,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAEjH;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB,CAAC,4BAA4B,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,0BAA0B,CAAC,4BAA4B,CAAC,EAAE,iBAAiB,CAAC,4BAA4B,EAAE,2BAA2B,CAAC;IACpR;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAAC;IAEpB;;OAEG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE;IAEzB;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,CAAC,iBAAiB,SAAS,gBAAgB,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,OAAO,KAAK,iBAAiB,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IAE1K;;;;;;;;;OASG;IACH,SAAS,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;CACrC"}

package/dist/numeric-identifier-creator.js

@@ -0,0 +1,2 @@
+export {};
+//# 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":""}

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

@@ -0,0 +1,21 @@
+import type { ContentCharacterSets } from "./content-character-set.js";
+import type { IdentifierDescriptor } from "./identifier-descriptor.js";
+import type { LeaderType, NumericIdentifierType } from "./numeric-identifier-type.js";
+/**
+ * Numeric identifier descriptor.
+ */
+export interface NumericIdentifierDescriptor extends IdentifierDescriptor {
+    /**
+     * @inheritDoc
+     */
+    readonly identifierType: NumericIdentifierType;
+    /**
+     * @inheritDoc
+     */
+    readonly referenceCharacterSet: typeof ContentCharacterSets.Numeric;
+    /**
+     * Leader type.
+     */
+    readonly leaderType: LeaderType;
+}
+//# sourceMappingURL=numeric-identifier-descriptor.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-descriptor.d.ts","sourceRoot":"","sources":["../src/numeric-identifier-descriptor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;IACrE;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,qBAAqB,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,OAAO,oBAAoB,CAAC,OAAO,CAAC;IAEpE;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;CACnC"}

package/dist/numeric-identifier-descriptor.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=numeric-identifier-descriptor.js.map

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

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

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

@@ -0,0 +1,31 @@
+import type { IdentifierTypes } from "./identifier-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.
+     */
+    readonly None: "None";
+    /**
+     * Indicator digit (GTIN only).
+     */
+    readonly IndicatorDigit: "Indicator digit";
+    /**
+     * Extension digit (SSCC only).
+     */
+    readonly ExtensionDigit: "Extension digit";
+};
+/**
+ * Leader type key.
+ */
+export type LeaderTypeKey = keyof typeof LeaderTypes;
+/**
+ * Leader type.
+ */
+export type LeaderType = typeof LeaderTypes[LeaderTypeKey];
+//# sourceMappingURL=numeric-identifier-type.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-type.d.ts","sourceRoot":"","sources":["../src/numeric-identifier-type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D;;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;;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/numeric-identifier-type.js

@@ -0,0 +1,18 @@
+/**
+ * Leader type.
+ */
+export const LeaderTypes = {
+    /**
+     * No leader.
+     */
+    None: "None",
+    /**
+     * Indicator digit (GTIN only).
+     */
+    IndicatorDigit: "Indicator digit",
+    /**
+     * Extension digit (SSCC only).
+     */
+    ExtensionDigit: "Extension digit"
+};
+//# sourceMappingURL=numeric-identifier-type.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"numeric-identifier-type.js","sourceRoot":"","sources":["../src/numeric-identifier-type.ts"],"names":[],"mappings":"AAeA;;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;CAC3B,CAAC"}

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

@@ -0,0 +1,24 @@
+import type { IdentifierValidation, IdentifierValidator } from "./identifier-validator.js";
+import type { NumericIdentifierDescriptor } from "./numeric-identifier-descriptor.js";
+/**
+ * Numeric identifier validation parameters.
+ */
+export interface NumericIdentifierValidation extends IdentifierValidation {
+    /**
+     * Position offset within a larger string. Some numeric identifier types have the prefix offset by one.
+     */
+    positionOffset?: number | undefined;
+}
+/**
+ * Numeric identifier validator.
+ *
+ * @template TNumericIdentifierDescriptor
+ * Numeric identifier descriptor type.
+ */
+export interface NumericIdentifierValidator<TNumericIdentifierDescriptor extends NumericIdentifierDescriptor = NumericIdentifierDescriptor> extends IdentifierValidator<TNumericIdentifierDescriptor, NumericIdentifierValidation> {
+    /**
+     * Get the leader type.
+     */
+    get leaderType(): TNumericIdentifierDescriptor["leaderType"];
+}
+//# 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":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC3F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,oBAAoB;IACrE;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B,CAAC,4BAA4B,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,mBAAmB,CAAC,4BAA4B,EAAE,2BAA2B,CAAC;IAC9N;;OAEG;IACH,IAAI,UAAU,IAAI,4BAA4B,CAAC,YAAY,CAAC,CAAC;CAChE"}

package/dist/numeric-identifier-validator.js

@@ -0,0 +1,2 @@
+export {};
+//# 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":""}

package/dist/prefix-manager.d.ts

@@ -0,0 +1,232 @@
+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 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 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;
+    /**
+     * 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 {@linkcode PrefixTypes.UPCCompanyPrefix}.
+     */
+    private readonly _upcCompanyPrefix;
+    /**
+     * GS1-8 Prefix if prefix type is {@linkcode PrefixTypes.GS18Prefix}.
+     */
+    private readonly _gs18Prefix;
+    /**
+     * Default tweak factor.
+     */
+    private readonly _defaultTweakFactor;
+    /**
+     * Tweak factor.
+     */
+    private _tweakFactor;
+    /**
+     * Cached identifier creators.
+     */
+    private readonly _identifierCreators;
+    /**
+     * Constructor.
+     *
+     * @param prefixType
+     * Prefix type.
+     *
+     * @param prefix
+     * Prefix.
+     */
+    constructor(prefixType: PrefixType, prefix: string);
+    /**
+     * 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 {@linkcode PrefixTypes.UPCCompanyPrefix} or undefined if not.
+     */
+    get upcCompanyPrefix(): string | undefined;
+    /**
+     * Get the GS1-8 Prefix if prefix type is {@linkcode 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 identifierCreator
+     * 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.
+     *
+     * @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.
+     */
+    private getIdentifierCreator;
+    /**
+     * Get non-GTIN numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getNonGTINNumericIdentifierCreator;
+    /**
+     * Get serialized numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @returns
+     * Identifier creator.
+     */
+    private getSerializableNumericIdentifierCreator;
+    /**
+     * Get non-numeric identifier creator.
+     *
+     * @param identifierType
+     * Identifier type used to construct identifier creator.
+     *
+     * @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":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAKhD,OAAO,EAAE,+BAA+B,EAAE,MAAM,0CAA0C,CAAC;AAE3F,OAAO,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AAGlF,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;AAGpG;;;;;;;;;;;;;;;;;;;GAmBG;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,qBAAqB,CAS3C;IAEF;;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,mBAAmB,CAAyC;IAE7E;;;;;;;;OAQG;gBACS,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM;IAelD;;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;IAOvB;;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;IAcjE;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,CAAC,oBAAoB;IAoB5B;;;;;;;;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,CAE7B;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"}