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

package/src/gtin-validator.ts

@@ -1,40 +1,12 @@
 import { type CharacterSetValidation, NUMERIC_CREATOR } from "@aidc-toolkit/utility";
-import { checkDigit, hasValidCheckDigit, isValidPriceOrWeightCheckDigit } from "./check.js";
-import { IdentifierTypes } from "./identifier-type.js";
-import { i18nextGS1 } from "./locale/i18n.js";
-import { AbstractNumericIdentifierValidator, LeaderTypes } from "./numeric-identifier-validator.js";
-import { type PrefixType, PrefixTypes } from "./prefix-type.js";
-import { PrefixValidator } from "./prefix-validator.js";
-
-/**
- * GTIN types. The numeric values are equal to the lengths of the GTIN types.
- */
-export const GTINTypes = {
-    /**
-     * GTIN-13.
-     */
-    GTIN13: 13,
-
-    /**
-     * GTIN-12.
-     */
-    GTIN12: 12,
-
-    /**
-     * GTIN-8.
-     */
-    GTIN8: 8,
-
-    /**
-     * GTIN-14.
-     */
-    GTIN14: 14
-} as const;
-
-/**
- * GTIN type.
- */
-export type GTINType = typeof GTINTypes[keyof typeof GTINTypes];
+import { AbstractNumericIdentifierValidator } from "./abstract-numeric-identifier-validator";
+import { checkDigit, hasValidCheckDigit, isValidPriceOrWeightCheckDigit } from "./check";
+import { IdentifierDescriptors } from "./descriptors";
+import type { GTINDescriptor } from "./gtin-descriptor";
+import { type GTINBaseType, type GTINType, GTINTypes } from "./gtin-type";
+import { i18nextGS1 } from "./locale/i18n";
+import { type PrefixType, PrefixTypes } from "./prefix-type";
+import { PrefixValidator } from "./prefix-validator";
 
 /**
  * Levels at which GTIN is to be validated.
@@ -56,10 +28,15 @@ export const GTINLevels = {
     OtherThanRetailConsumer: 2
 } as const;
 
+/**
+ * GTIN level key.
+ */
+export type GTINLevelKey = keyof typeof GTINLevels;
+
 /**
  * GTIN level.
  */
-export type GTINLevel = typeof GTINLevels[keyof typeof GTINLevels];
+export type GTINLevel = typeof GTINLevels[GTINLevelKey];
 
 /**
  * Restricted Circulation Number reference.
@@ -79,7 +56,7 @@ export interface RCNReference {
 /**
  * GTIN validator.
  */
-export class GTINValidator extends AbstractNumericIdentifierValidator {
+export class GTINValidator extends AbstractNumericIdentifierValidator<GTINDescriptor> {
     /**
      * Validation parameters for optional indicator digit.
      */
@@ -97,35 +74,30 @@ export class GTINValidator extends AbstractNumericIdentifierValidator {
         maximumLength: 8
     };
 
+    /**
+     * Prefix type.
+     */
+    private readonly _prefixType: PrefixType;
+
     /**
      * Constructor.
      *
-     * @param gtinType
-     * GTIN type.
+     * @param gtinBaseType
+     * GTIN base type (all except GTIN-14).
      */
-    constructor(gtinType: GTINType) {
-        let prefixType: PrefixType;
-
-        // Determine the prefix type based on the GTIN type.
-        switch (gtinType) {
-            case GTINTypes.GTIN13:
-                prefixType = PrefixTypes.GS1CompanyPrefix;
-                break;
+    constructor(gtinBaseType: GTINBaseType) {
+        const identifierDescriptor = IdentifierDescriptors.GTIN[gtinBaseType];
 
-            case GTINTypes.GTIN12:
-                prefixType = PrefixTypes.UPCCompanyPrefix;
-                break;
-
-            case GTINTypes.GTIN8:
-                prefixType = PrefixTypes.GS18Prefix;
-                break;
+        super(identifierDescriptor);
 
-            default:
-                // Should never get here.
-                throw new Error("Not supported");
-        }
+        this._prefixType = identifierDescriptor.prefixType;
+    }
 
-        super(IdentifierTypes.GTIN, prefixType, gtinType, LeaderTypes.IndicatorDigit);
+    /**
+     * @inheritDoc
+     */
+    override get prefixType(): PrefixType {
+        return this._prefixType;
     }
 
     /**
@@ -542,23 +514,27 @@ export class GTINValidator extends AbstractNumericIdentifierValidator {
 /**
  * GTIN-13 validator.
  */
+// Defined here because of circular reference.
 export const GTIN13_VALIDATOR = new GTINValidator(GTINTypes.GTIN13);
 
 /**
  * GTIN-12 validator.
  */
+// Defined here because of circular reference.
 export const GTIN12_VALIDATOR = new GTINValidator(GTINTypes.GTIN12);
 
 /**
  * GTIN-8 validator.
  */
+// Defined here because of circular reference.
 export const GTIN8_VALIDATOR = new GTINValidator(GTINTypes.GTIN8);
 
 /**
  * GTIN validators indexed by prefix type.
  */
-export const GTIN_VALIDATORS: Record<PrefixType, GTINValidator> = {
-    [PrefixTypes.GS1CompanyPrefix]: GTIN13_VALIDATOR,
-    [PrefixTypes.UPCCompanyPrefix]: GTIN12_VALIDATOR,
-    [PrefixTypes.GS18Prefix]: GTIN8_VALIDATOR
+// Defined here because of circular reference.
+export const GTIN_VALIDATORS: Readonly<Record<GTINBaseType, GTINValidator>> = {
+    [GTINTypes.GTIN13]: GTIN13_VALIDATOR,
+    [GTINTypes.GTIN12]: GTIN12_VALIDATOR,
+    [GTINTypes.GTIN8]: GTIN8_VALIDATOR
 };

package/src/identifier-creator.ts

@@ -1,16 +1,20 @@
-import type { CharacterSetCreator } from "@aidc-toolkit/utility";
-import type { IdentifierType } from "./identifier-type.js";
-import type { ContentCharacterSet, IdentifierValidation, IdentifierValidator } from "./identifier-validator.js";
+import type { IdentifierDescriptor } from "./identifier-descriptor";
+import type { IdentifierValidation, IdentifierValidator } from "./identifier-validator";
 import type { PrefixProvider } from "./prefix-provider";
-import type { PrefixType } from "./prefix-type.js";
 
 /**
  * Identifier creator. Creates an identifier based on its definition in section 3 of the {@link
- * https://www.gs1.org/genspecs | GS1 General Specifications}.
+ * https://ref.gs1.org/standards/genspecs/ | GS1 General Specifications}.
  *
- * Keys are created based on a prefix defined in a prefix manager to which the identifier creator is bound.
+ * Keys are created based on a prefix defined in a prefix provider to which the identifier creator is bound.
+ *
+ * @template TIdentifierDescriptor
+ * Identifier descriptor type.
+ *
+ * @template TIdentifierValidation
+ * Identifier validation type.
  */
-export interface IdentifierCreator extends IdentifierValidator {
+export interface IdentifierCreator<TIdentifierDescriptor extends IdentifierDescriptor = IdentifierDescriptor, TIdentifierValidation extends IdentifierValidation = IdentifierValidation> extends IdentifierValidator<TIdentifierDescriptor, TIdentifierValidation> {
     /**
      * Get the prefix provider to which this identifier creator is bound.
      */
@@ -27,71 +31,3 @@ export interface IdentifierCreator extends IdentifierValidator {
      */
     get referenceLength(): number;
 }
-
-/**
- * Abstract identifier creator. Implements common functionality for an identifier creator, bound to a
- * {@link PrefixProvider}.
- */
-export abstract class AbstractIdentifierCreator implements IdentifierCreator {
-    /**
-     * Prefix provider.
-     */
-    private _prefixProvider!: PrefixProvider;
-
-    /**
-     * Reference length.
-     */
-    private _referenceLength!: number;
-
-    /**
-     * Initialize the prefix manager. 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.
-     *
-     * @param checkAllowance
-     * Number of characters to allow for check digit or check character pair.
-     */
-    protected init(prefixProvider: PrefixProvider, prefix: string, checkAllowance: number): void {
-        this._prefixProvider = prefixProvider;
-
-        // Reference length allows for prefix and optionally check digit or check character pair.
-        this._referenceLength = this.length - prefix.length - checkAllowance;
-    }
-
-    abstract get identifierType(): IdentifierType;
-
-    abstract get prefixType(): PrefixType;
-
-    abstract get length(): number;
-
-    abstract get referenceCharacterSet(): ContentCharacterSet;
-
-    abstract get referenceCreator(): CharacterSetCreator;
-
-    /**
-     * @inheritDoc
-     */
-    get prefixProvider(): PrefixProvider {
-        return this._prefixProvider;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get prefix(): string {
-        return this.prefixProvider.gs1CompanyPrefix;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get referenceLength(): number {
-        return this._referenceLength;
-    }
-
-    abstract validate(identifier: string, validation?: IdentifierValidation): void;
-}

package/src/identifier-descriptor.ts

@@ -0,0 +1,30 @@
+import type { ContentCharacterSet } from "./content-character-set";
+import type { IdentifierType } from "./identifier-type";
+import type { PrefixType } from "./prefix-type";
+
+/**
+ * Identifier descriptor. Instantiations of this type are used to parameterize validators and creators.
+ */
+export interface IdentifierDescriptor {
+    /**
+     * Identifier type. Per the GS1 General Specifications, the identifier type determines the remaining properties.
+     */
+    readonly identifierType: IdentifierType;
+
+    /**
+     * Prefix type supported by the identifier type. For all identifier types except the GTIN, this is a GS1 Company
+     * Prefix. For the GTIN, the prefix type determines the length.
+     */
+    readonly prefixType: PrefixType;
+
+    /**
+     * Length. For numeric identifier types, the length is fixed; for non-numeric identifier types, the length is the
+     * maximum.
+     */
+    readonly length: number;
+
+    /**
+     * Reference character set.
+     */
+    readonly referenceCharacterSet: ContentCharacterSet;
+}

package/src/identifier-type.ts

@@ -63,7 +63,12 @@ export const IdentifierTypes = {
     GMN: "GMN"
 } as const;
 
+/**
+ * Identifier type key.
+ */
+export type IdentifierTypeKey = keyof typeof IdentifierTypes;
+
 /**
  * Identifier type.
  */
-export type IdentifierType = typeof IdentifierTypes[keyof typeof IdentifierTypes];
+export type IdentifierType = typeof IdentifierTypes[IdentifierTypeKey];

package/src/identifier-validator.ts

@@ -1,69 +1,34 @@
-import {
-    type CharacterSetCreator,
-    NUMERIC_CREATOR,
-    type StringValidation,
-    type StringValidator
-} from "@aidc-toolkit/utility";
-import { AI39_CREATOR, AI82_CREATOR } from "./character-set.js";
-import type { IdentifierType } from "./identifier-type.js";
-import type { PrefixType } from "./prefix-type.js";
-import { PrefixValidator } from "./prefix-validator.js";
-
-/**
- * Character sets supported by the reference portion of an identifier or the serial component of a numeric identifier.
- */
-export const ContentCharacterSets = {
-    /**
-     * Numeric.
-     */
-    Numeric: "Numeric",
-
-    /**
-     * GS1 AI encodable character set 82.
-     */
-    AI82: "AI82",
-
-    /**
-     * GS1 AI encodable character set 39.
-     */
-    AI39: "AI39"
-} as const;
-
-/**
- * Content character set.
- */
-export type ContentCharacterSet = typeof ContentCharacterSets[keyof typeof ContentCharacterSets];
+import type { CharacterSetCreator, StringValidation, StringValidator } from "@aidc-toolkit/utility";
+import type { IdentifierDescriptor } from "./identifier-descriptor";
 
 /**
  * Identifier validation parameters.
  */
 export interface IdentifierValidation extends StringValidation {
-    /**
-     * Position offset within a larger string. Strings are sometimes composed of multiple substrings; this parameter
-     * ensures that the error notes the proper position in the string.
-     */
-    positionOffset?: number | undefined;
 }
 
 /**
  * Identifier validator. Validates an identifier against its definition in section 3 of the {@link
- * https://www.gs1.org/genspecs | GS1 General Specifications}.
+ * https://ref.gs1.org/standards/genspecs/ | GS1 General Specifications}.
+ *
+ * @template TIdentifierDescriptor
+ * Identifier descriptor type.
  *
  * @template TIdentifierValidation
  * Identifier validation type.
  */
-export interface IdentifierValidator<TIdentifierValidation extends IdentifierValidation = IdentifierValidation> extends StringValidator<TIdentifierValidation> {
+export interface IdentifierValidator<TIdentifierDescriptor extends IdentifierDescriptor = IdentifierDescriptor, TIdentifierValidation extends IdentifierValidation = IdentifierValidation> extends StringValidator<TIdentifierValidation> {
     /**
      * Get the identifier type. Per the GS1 General Specifications, the identifier type determines the remaining
      * properties.
      */
-    get identifierType(): IdentifierType;
+    get identifierType(): TIdentifierDescriptor["identifierType"];
 
     /**
-     * Get the prefix type supported by the identifier type. For all identifier types except the GTIN, this is
-     * {@linkcode PrefixTypes.GS1CompanyPrefix}. For the GTIN, the prefix type determines the length.
+     * Get the prefix type supported by the identifier type. For all identifier types except the GTIN, this is a GS1
+     * Company Prefix. For the GTIN, the prefix type determines the length.
      */
-    get prefixType(): PrefixType;
+    get prefixType(): TIdentifierDescriptor["prefixType"];
 
     /**
      * Get the length. For numeric identifier types, the length is fixed; for alphanumeric identifier types, the length
@@ -74,7 +39,7 @@ export interface IdentifierValidator<TIdentifierValidation extends IdentifierVal
     /**
      * Get the reference character set.
      */
-    get referenceCharacterSet(): ContentCharacterSet;
+    get referenceCharacterSet(): TIdentifierDescriptor["referenceCharacterSet"];
 
     /**
      * Get the reference creator.
@@ -92,144 +57,3 @@ export interface IdentifierValidator<TIdentifierValidation extends IdentifierVal
      */
     validate: (identifier: string, validation?: TIdentifierValidation) => void;
 }
-
-/**
- * Abstract identifier validator. Implements common functionality for an identifier validator.
- */
-export abstract class AbstractIdentifierValidator<TIdentifierValidation extends IdentifierValidation = IdentifierValidation> implements IdentifierValidator<TIdentifierValidation> {
-    private static readonly CHARACTER_SET_CREATORS: Record<ContentCharacterSet, CharacterSetCreator> = {
-        [ContentCharacterSets.Numeric]: NUMERIC_CREATOR,
-        [ContentCharacterSets.AI82]: AI82_CREATOR,
-        [ContentCharacterSets.AI39]: AI39_CREATOR
-    };
-
-    /**
-     * Identifier type.
-     */
-    private readonly _identifierType: IdentifierType;
-
-    /**
-     * Prefix type.
-     */
-    private readonly _prefixType: PrefixType;
-
-    /**
-     * Length.
-     */
-    private readonly _length: number;
-
-    /**
-     * Reference character set.
-     */
-    private readonly _referenceCharacterSet: ContentCharacterSet;
-
-    /**
-     * Reference creator.
-     */
-    private readonly _referenceCreator: CharacterSetCreator;
-
-    /**
-     * Get the character set creator for a character set.
-     *
-     * @param characterSet
-     * Character set.
-     *
-     * @returns
-     * Character set creator.
-     */
-    protected static creatorFor(characterSet: ContentCharacterSet): CharacterSetCreator {
-        return AbstractIdentifierValidator.CHARACTER_SET_CREATORS[characterSet];
-    }
-
-    /**
-     * Constructor.
-     *
-     * @param identifierType
-     * Identifier type.
-     *
-     * @param prefixType
-     * Prefix type.
-     *
-     * @param length
-     * Length.
-     *
-     * @param referenceCharacterSet
-     * Reference character set.
-     */
-    protected constructor(identifierType: IdentifierType, prefixType: PrefixType, length: number, referenceCharacterSet: ContentCharacterSet) {
-        this._identifierType = identifierType;
-        this._prefixType = prefixType;
-        this._length = length;
-        this._referenceCharacterSet = referenceCharacterSet;
-        this._referenceCreator = AbstractIdentifierValidator.creatorFor(referenceCharacterSet);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get identifierType(): IdentifierType {
-        return this._identifierType;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get prefixType(): PrefixType {
-        return this._prefixType;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get length(): number {
-        return this._length;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get referenceCharacterSet(): ContentCharacterSet {
-        return this._referenceCharacterSet;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get referenceCreator(): CharacterSetCreator {
-        return this._referenceCreator;
-    }
-
-    /**
-     * Pad an identifier on the left with zero-value character for validation purposes. This is done to align an
-     * identifier with a position offset for any error message that may be thrown by the reference validator.
-     *
-     * @param identifier
-     * Identifier.
-     *
-     * @param validation
-     * Identifier validation parameters.
-     *
-     * @returns
-     * Padded identifier.
-     */
-    protected padIdentifier(identifier: string, validation: IdentifierValidation | undefined): string {
-        // Identifier is returned as is if position offset is undefined.
-        return validation?.positionOffset === undefined ? identifier : this.referenceCreator.character(0).repeat(validation.positionOffset).concat(identifier);
-    }
-
-    /**
-     * Validate the prefix within an identifier.
-     *
-     * @param partialIdentifier
-     * Partial identifier.
-     *
-     * @param positionOffset
-     * Position offset within a larger string.
-     */
-    protected validatePrefix(partialIdentifier: string, positionOffset?: number): void {
-        // Delegate to prefix validator with support for U.P.C. Company Prefix but not GS1-8 Prefix.
-        PrefixValidator.validate(this.prefixType, true, false, partialIdentifier, true, this.referenceCharacterSet === ContentCharacterSets.Numeric, positionOffset);
-    }
-
-    abstract validate(identifier: string, validation?: TIdentifierValidation): void;
-}

package/src/index.ts

@@ -14,22 +14,46 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from "./locale/i18n.js";
-export * from "./character-set.js";
-export * from "./check.js";
-export * from "./prefix-type.js";
-export * from "./prefix-validator.js";
-export * from "./identifier-type.js";
-export * from "./identifier-validator.js";
-export * from "./numeric-identifier-validator.js";
-export * from "./gtin-validator.js";
-export * from "./non-gtin-numeric-identifier-validator.js";
-export * from "./serializable-numeric-identifier-validator.js";
-export * from "./non-numeric-identifier-validator.js";
-export * from "./identifier-creator.js";
-export * from "./numeric-identifier-creator.js";
-export * from "./gtin-creator.js";
-export * from "./non-gtin-numeric-identifier-creator.js";
-export * from "./serializable-numeric-identifier-creator.js";
-export * from "./non-numeric-identifier-creator.js";
-export * from "./prefix-manager.js";
+export * from "./locale/i18n";
+
+export * from "./character-set";
+
+export * from "./check";
+
+export * from "./prefix-type";
+export * from "./prefix-validator";
+
+export * from "./content-character-set";
+
+export * from "./identifier-type";
+export * from "./numeric-identifier-type";
+export * from "./gtin-type";
+export type * from "./non-gtin-numeric-identifier-type";
+export type * from "./serializable-numeric-identifier-type";
+export type * from "./non-numeric-identifier-type";
+
+export type * from "./identifier-descriptor";
+export type * from "./numeric-identifier-descriptor";
+export type * from "./gtin-descriptor";
+export type * from "./non-gtin-numeric-identifier-descriptor";
+export type * from "./serializable-numeric-identifier-descriptor";
+export type * from "./non-numeric-identifier-descriptor";
+export * from "./descriptors";
+
+export type * from "./identifier-validator";
+export type * from "./numeric-identifier-validator";
+export { GTINLevels, type GTINLevel, type RCNReference, GTINValidator } from "./gtin-validator";
+export * from "./non-gtin-numeric-identifier-validator";
+export * from "./serializable-numeric-identifier-validator";
+export * from "./non-numeric-identifier-validator";
+export * from "./validators";
+
+export type * from "./identifier-creator";
+export type * from "./numeric-identifier-creator";
+export * from "./gtin-creator";
+export * from "./non-gtin-numeric-identifier-creator";
+export * from "./serializable-numeric-identifier-creator";
+export * from "./non-numeric-identifier-creator";
+export * from "./creators";
+
+export * from "./prefix-manager";

package/src/locale/en/locale-resources.ts

@@ -30,7 +30,6 @@ export default {
         gs1CompanyPrefix: "GS1 Company Prefix",
         upcCompanyPrefix: "U.P.C. Company Prefix",
         gs18Prefix: "GS1-8 Prefix",
-        invalidPrefixType: "Invalid prefix type",
         gs1CompanyPrefixCantStartWith0: "GS1 Company Prefix can't start with \"0\"",
         gs1CompanyPrefixCantStartWith00000: "GS1 Company Prefix can't start with \"00000\"",
         gs1CompanyPrefixCantStartWith000000: "GS1 Company Prefix can't start with \"000000\"",

package/src/locale/fr/locale-resources.ts

@@ -30,7 +30,6 @@ export default {
         gs1CompanyPrefix: "Préfixe de l'entreprise GS1",
         upcCompanyPrefix: "Préfixe de l'entreprise U.P.C.",
         gs18Prefix: "Préfixe GS1-8",
-        invalidPrefixType: "Type de préfixe invalide",
         gs1CompanyPrefixCantStartWith0: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"0\"",
         gs1CompanyPrefixCantStartWith00000: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"00000\"",
         gs1CompanyPrefixCantStartWith000000: "Le préfixe de l'entreprise GS1 ne peut pas commencer par \"000000\"",

package/src/locale/i18n.ts

@@ -1,8 +1,8 @@
-import { i18nAssertValidResources, i18nCoreInit, type I18nEnvironment } from "@aidc-toolkit/core";
+import { i18nCoreInit, type I18nEnvironment } from "@aidc-toolkit/core";
 import { i18nUtilityInit, utilityResources } from "@aidc-toolkit/utility";
 import i18next, { type i18n, type Resource } from "i18next";
-import enLocaleResources from "./en/locale-resources.js";
-import frLocaleResources from "./fr/locale-resources.js";
+import enLocaleResources from "./en/locale-resources";
+import frLocaleResources from "./fr/locale-resources";
 
 export const gs1NS = "aidct_gs1";
 
@@ -11,8 +11,6 @@ export const gs1NS = "aidct_gs1";
  */
 export type GS1LocaleResources = typeof enLocaleResources;
 
-i18nAssertValidResources(enLocaleResources, "fr", frLocaleResources);
-
 /**
  * GS1 resources.
  */

package/src/locale/i18next.d.ts

@@ -1,5 +1,5 @@
 import type { UtilityLocaleResources } from "@aidc-toolkit/utility";
-import type { GS1LocaleResources } from "./i18n.js";
+import type { GS1LocaleResources } from "./i18n";
 
 /**
  * Internationalization module.