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

package/dist/gtin-length.js

@@ -0,0 +1,36 @@
+import { omit } from "@aidc-toolkit/core";
+import { PrefixTypes } from "./prefix-type.js";
+/**
+ * GTIN lengths. The numeric values are equal to the lengths of the GTINs.
+ */
+export const GTINLengths = {
+    /**
+     * GTIN-13.
+     */
+    GTIN13: 13,
+    /**
+     * GTIN-12.
+     */
+    GTIN12: 12,
+    /**
+     * GTIN-8.
+     */
+    GTIN8: 8,
+    /**
+     * GTIN-14.
+     */
+    GTIN14: 14
+};
+/**
+ * GTIN base lengths (all except GTIN-14).
+ */
+export const GTINBaseLengths = omit(GTINLengths, "GTIN14");
+/**
+ * GTIN base lengths by prefix type. Used to determine the GTIN length supported by a prefix type.
+ */
+export const GTIN_BASE_TYPES = {
+    [PrefixTypes.GS1CompanyPrefix]: GTINLengths.GTIN13,
+    [PrefixTypes.UPCCompanyPrefix]: GTINLengths.GTIN12,
+    [PrefixTypes.GS18Prefix]: GTINLengths.GTIN8
+};
+//# sourceMappingURL=gtin-length.js.map

package/dist/gtin-length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gtin-length.js","sourceRoot":"","sources":["../src/gtin-length.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAmB,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IACvB;;OAEG;IACH,MAAM,EAAE,EAAE;IAEV;;OAEG;IACH,MAAM,EAAE,EAAE;IAEV;;OAEG;IACH,KAAK,EAAE,CAAC;IAER;;OAEG;IACH,MAAM,EAAE,EAAE;CACJ,CAAC;AAYX;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;AAY3D;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAiD;IACzE,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,MAAM;IAClD,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,WAAW,CAAC,MAAM;IAClD,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,KAAK;CAC9C,CAAC"}

package/dist/gtin-type.d.ts

@@ -0,0 +1,26 @@
+/**
+ * GTIN types.
+ */
+export declare const GTINTypes: Pick<Pick<{
+    readonly GTIN: "GTIN";
+    readonly GLN: "GLN";
+    readonly SSCC: "SSCC";
+    readonly GRAI: "GRAI";
+    readonly GIAI: "GIAI";
+    readonly GSRN: "GSRN";
+    readonly GDTI: "GDTI";
+    readonly GINC: "GINC";
+    readonly GSIN: "GSIN";
+    readonly GCN: "GCN";
+    readonly CPID: "CPID";
+    readonly GMN: "GMN";
+}, "GTIN" | "GLN" | "SSCC" | "GRAI" | "GSRN" | "GDTI" | "GSIN" | "GCN">, "GTIN">;
+/**
+ * GTIN type key.
+ */
+export type GTINTypeKey = keyof typeof GTINTypes;
+/**
+ * GTIN type.
+ */
+export type GTINType = typeof GTINTypes[GTINTypeKey];
+//# sourceMappingURL=gtin-type.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gtin-type.d.ts","sourceRoot":"","sources":["../src/gtin-type.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;gFAErB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,OAAO,SAAS,CAAC;AAEjD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,SAAS,CAAC,WAAW,CAAC,CAAC"}

package/dist/gtin-type.js

@@ -0,0 +1,7 @@
+import { pick } from "@aidc-toolkit/core";
+import { NumericIdentifierTypes } from "./numeric-identifier-type.js";
+/**
+ * GTIN types.
+ */
+export const GTINTypes = pick(NumericIdentifierTypes, NumericIdentifierTypes.GTIN);
+//# sourceMappingURL=gtin-type.js.map

package/dist/gtin-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gtin-type.js","sourceRoot":"","sources":["../src/gtin-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,EAChD,sBAAsB,CAAC,IAAI,CAC9B,CAAC"}

package/dist/gtin-validator.d.ts

@@ -0,0 +1,177 @@
+import type { GTINDescriptor } from "./gtin-descriptor.js";
+import { type GTINBaseLength } from "./gtin-length.js";
+import type { GTINType } from "./gtin-type.js";
+import { NumericIdentifierValidator } from "./numeric-identifier-validator.js";
+import { type PrefixType } from "./prefix-type.js";
+/**
+ * Levels at which GTIN is to be validated.
+ */
+export declare const GTINLevels: {
+    /**
+     * Any level (level is ignored).
+     */
+    readonly Any: 0;
+    /**
+     * Retail consumer trade item level, supporting GTIN-13, GTIN-12 (optionally zero-suppressed), and GTIN-8.
+     */
+    readonly RetailConsumer: 1;
+    /**
+     * Other than retail consumer trade item level, supporting GTIN-13, GTIN-12 (not zero-suppressed), and GTIN-14.
+     */
+    readonly OtherThanRetailConsumer: 2;
+};
+/**
+ * GTIN level key.
+ */
+export type GTINLevelKey = keyof typeof GTINLevels;
+/**
+ * GTIN level.
+ */
+export type GTINLevel = typeof GTINLevels[GTINLevelKey];
+/**
+ * Restricted Circulation Number reference.
+ */
+export interface RCNReference {
+    /**
+     * Item reference.
+     */
+    itemReference: number;
+    /**
+     * Price or weight (whole number only).
+     */
+    priceOrWeight: number;
+}
+/**
+ * GTIN validator.
+ */
+export declare class GTINValidator extends NumericIdentifierValidator<GTINType> implements GTINDescriptor {
+    #private;
+    /**
+     * Constructor.
+     *
+     * @param gtinBaseLength
+     * GTIN base length (all except GTIN-14).
+     */
+    constructor(gtinBaseLength: GTINBaseLength);
+    /**
+     * @inheritDoc
+     */
+    get prefixType(): PrefixType;
+    /**
+     * @inheritDoc
+     */
+    protected validatePrefix(partialIdentifier: string, positionOffset?: number): void;
+    /**
+     * Zero suppress a GTIN-12.
+     *
+     * @param gtin12
+     * GTIN-12.
+     *
+     * @returns
+     * Zero-suppressed GTIN-12.
+     */
+    static zeroSuppress(gtin12: string): string;
+    /**
+     * Zero expand a zero-suppressed GTIN-12.
+     *
+     * @param zeroSuppressedGTIN12
+     * Zero-suppressed GTIN-12.
+     *
+     * @returns
+     * GTIN-12.
+     */
+    static zeroExpand(zeroSuppressedGTIN12: string): string;
+    /**
+     * Convert a GTIN of any length to a GTIN-14 with an optional indicator digit.
+     *
+     * @param indicatorDigit
+     * Indicator digit. If blank, assumes "0" if the GTIN is not already a GTIN-14.
+     *
+     * @param gtin
+     * GTIN.
+     *
+     * @returns
+     * GTIN-14.
+     */
+    static convertToGTIN14(indicatorDigit: string, gtin: string): string;
+    /**
+     * Normalize a GTIN of any length.
+     * - A GTIN-14 that starts with six zeros or a GTIN-13 that starts with five zeros is normalized to GTIN-8.
+     * - A GTIN-14 that starts with two zeros or a GTIN-13 that starts with one zero is normalized to GTIN-12.
+     * - A GTIN-14 that starts with one zero is normalized to GTIN-13.
+     * - Otherwise, the GTIN is unchanged.
+     *
+     * @param gtin
+     * GTIN.
+     *
+     * @returns
+     * Normalized GTIN.
+     */
+    static normalize(gtin: string): string;
+    /**
+     * Validate any GTIN, optionally against a level.
+     *
+     * @param gtin
+     * GTIN.
+     *
+     * @param gtinLevel
+     * Level at which GTIN is to be validated.
+     */
+    static validateAny(gtin: string, gtinLevel?: GTINLevel): void;
+    /**
+     * Validate a GTIN-14.
+     *
+     * @param gtin14
+     * GTIN-14.
+     */
+    static validateGTIN14(gtin14: string): void;
+    /**
+     * Parse a Restricted Circulation Number (RCN) using a variable measure trade item format. The format is a 12- or
+     * 13-character string (for RCN-12 or RCN-13 respectively), containing the following:
+     *
+     * - '2' - The first character of the RCN.
+     * - '0'-'9' - The second character of the RCN (RCN-13 only).
+     * - 'I' - One or more, in sequence, for the item reference.
+     * - 'P' - One or more, in sequence, for the price or weight.
+     * - 'V' - Zero or one, for the price or weight check digit.
+     * - 'C' - The check digit of the entire RCN.
+     *
+     * The 'I', 'P', and 'V' formats may be in any order.
+     *
+     * Some examples:
+     *
+     * - 2IIIIIVPPPPC - RCN-12 with a five-digit item reference, a price or weight check digit, and a four-digit price
+     * or weight.
+     * - 23IIIIVPPPPPC - RCN-13 with a four-digit item reference, a price or weight check digit, and a five-digit price
+     * or weight.
+     * - 2IIIIIIPPPPC - RCN-12 with a six-digit item reference and a four-digit price or eight.
+     * - 29IIIIIPPPPPC - RCN-13 with a five-digit item reference and a five-digit price or weight.
+     *
+     * @param format
+     * Format.
+     *
+     * @param rcn
+     * RCN.
+     *
+     * @returns
+     * RCN reference.
+     */
+    static parseVariableMeasureRCN(format: string, rcn: string): RCNReference;
+}
+/**
+ * GTIN-13 validator.
+ */
+export declare const GTIN13_VALIDATOR: GTINValidator;
+/**
+ * GTIN-12 validator.
+ */
+export declare const GTIN12_VALIDATOR: GTINValidator;
+/**
+ * GTIN-8 validator.
+ */
+export declare const GTIN8_VALIDATOR: GTINValidator;
+/**
+ * GTIN validators indexed by prefix type.
+ */
+export declare const GTIN_VALIDATORS: Readonly<Record<GTINBaseLength, GTINValidator>>;
+//# sourceMappingURL=gtin-validator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gtin-validator.d.ts","sourceRoot":"","sources":["../src/gtin-validator.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,KAAK,cAAc,EAAe,MAAM,kBAAkB,CAAC;AACpE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAG/C,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,KAAK,UAAU,EAAe,MAAM,kBAAkB,CAAC;AAGhE;;GAEG;AACH,eAAO,MAAM,UAAU;IACnB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;CAEG,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,OAAO,UAAU,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,UAAU,CAAC,YAAY,CAAC,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,0BAA0B,CAAC,QAAQ,CAAE,YAAW,cAAc;;IAuB7F;;;;;OAKG;gBACS,cAAc,EAAE,cAAc;IAQ1C;;OAEG;IACH,IAAa,UAAU,IAAI,UAAU,CAEpC;IAED;;OAEG;cACgB,cAAc,CAAC,iBAAiB,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI;IAK3F;;;;;;;;OAQG;IACH,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IA4B3C;;;;;;;;OAQG;IACH,MAAM,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,GAAG,MAAM;IA+BvD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM;IAkBpE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAgEtC;;;;;;;;OAQG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,GAAE,SAA0B,GAAG,IAAI;IA2D7E;;;;;OAKG;IACH,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQ3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,YAAY;CAgG5E;AAED;;GAEG;AAEH,eAAO,MAAM,gBAAgB,eAAwC,CAAC;AAEtE;;GAEG;AAEH,eAAO,MAAM,gBAAgB,eAAwC,CAAC;AAEtE;;GAEG;AAEH,eAAO,MAAM,eAAe,eAAuC,CAAC;AAEpE;;GAEG;AAEH,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,aAAa,CAAC,CAI3E,CAAC"}