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

package/dist/validators.d.ts

@@ -0,0 +1,96 @@
+import type { GTINBaseType } from "./gtin-type.js";
+import { type GTINValidator } from "./gtin-validator.js";
+import { type IdentifierType, IdentifierTypes } from "./identifier-type.js";
+import type { IdentifierValidator } from "./identifier-validator.js";
+import type { NonGTINNumericIdentifierType } from "./non-gtin-numeric-identifier-type.js";
+import { NonGTINNumericIdentifierValidator } from "./non-gtin-numeric-identifier-validator.js";
+import type { NonNumericIdentifierType } from "./non-numeric-identifier-type.js";
+import { NonNumericIdentifierValidator } from "./non-numeric-identifier-validator.js";
+import type { NumericIdentifierValidator } from "./numeric-identifier-validator.js";
+import type { SerializableNumericIdentifierType } from "./serializable-numeric-identifier-type.js";
+import { SerializableNumericIdentifierValidator } from "./serializable-numeric-identifier-validator.js";
+/**
+ * Identifier validator type based on identifier type type.
+ *
+ * @template TIdentifierType
+ * Identifier type type.
+ */
+export type IdentifierTypeValidator<TIdentifierType extends IdentifierType> = TIdentifierType extends NonNumericIdentifierType ? NonNumericIdentifierValidator : TIdentifierType extends SerializableNumericIdentifierType ? SerializableNumericIdentifierValidator : TIdentifierType extends NonGTINNumericIdentifierType ? NonGTINNumericIdentifierValidator : TIdentifierType extends typeof IdentifierTypes.GTIN ? GTINValidator : IdentifierValidator;
+/**
+ * Identifier validators entry type based on identifier type type.
+ *
+ * @template TIdentifierType
+ * Identifier type type.
+ */
+export type IdentifierValidatorsEntry<TIdentifierType extends IdentifierType> = TIdentifierType extends typeof IdentifierTypes.GTIN ? Readonly<Record<GTINBaseType, GTINValidator>> : IdentifierTypeValidator<TIdentifierType>;
+/**
+ * Identifier validators record type.
+ */
+export type IdentifierValidatorsRecord = {
+    [TIdentifierType in IdentifierType]: IdentifierValidatorsEntry<TIdentifierType>;
+};
+/**
+ * Identifier validators for all identifier types.
+ */
+export declare const IdentifierValidators: IdentifierValidatorsRecord;
+/**
+ * Determine if identifier validators or validator is GTIN validators.
+ *
+ * @param identifierValidatorsOrValidator
+ * Identifier validators or validator.
+ *
+ * @returns
+ * True if GTIN validators.
+ */
+export declare function isGTINValidators(identifierValidatorsOrValidator: IdentifierValidatorsEntry<IdentifierType>): identifierValidatorsOrValidator is Readonly<Record<GTINBaseType, GTINValidator>>;
+/**
+ * Determine if identifier validator is a numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a numeric identifier validator.
+ */
+export declare function isNumericIdentifierValidator(identifierValidator: IdentifierValidator): identifierValidator is NumericIdentifierValidator;
+/**
+ * Determine if identifier validator is a GTIN validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a GTIN validator.
+ */
+export declare function isGTINValidator(identifierValidator: IdentifierValidator): identifierValidator is GTINValidator;
+/**
+ * Determine if identifier validator is a non-GTIN numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a non-GTIN numeric identifier validator.
+ */
+export declare function isNonGTINNumericIdentifierValidator(identifierValidator: IdentifierValidator): identifierValidator is NonGTINNumericIdentifierValidator;
+/**
+ * Determine if identifier validator is a serializable numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a serializable numeric identifier validator.
+ */
+export declare function isSerializableNumericIdentifierValidator(identifierValidator: IdentifierValidator): identifierValidator is SerializableNumericIdentifierValidator;
+/**
+ * Determine if identifier validator is a non-numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a non-numeric identifier validator.
+ */
+export declare function isNonNumericIdentifierValidator(identifierValidator: IdentifierValidator): identifierValidator is NonNumericIdentifierValidator;
+//# sourceMappingURL=validators.d.ts.map

package/dist/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAE,KAAK,cAAc,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,EAAE,iCAAiC,EAAE,MAAM,4CAA4C,CAAC;AAC/F,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AACtF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AACpF,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,2CAA2C,CAAC;AACnG,OAAO,EAAE,sCAAsC,EAAE,MAAM,gDAAgD,CAAC;AAyDxG;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CAAC,eAAe,SAAS,cAAc,IAAI,eAAe,SAAS,wBAAwB,GAC1H,6BAA6B,GAC7B,eAAe,SAAS,iCAAiC,GACrD,sCAAsC,GACtC,eAAe,SAAS,4BAA4B,GAChD,iCAAiC,GACjC,eAAe,SAAS,OAAO,eAAe,CAAC,IAAI,GAC/C,aAAa,GACb,mBAAmB,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,CAAC,eAAe,SAAS,cAAc,IAAI,eAAe,SAAS,OAAO,eAAe,CAAC,IAAI,GAC/H,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,GAC7C,uBAAuB,CAAC,eAAe,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;KACpC,eAAe,IAAI,cAAc,GAAG,yBAAyB,CAAC,eAAe,CAAC;CAClF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,0BAazB,CAAC;AAEX;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,+BAA+B,EAAE,yBAAyB,CAAC,cAAc,CAAC,GAAG,+BAA+B,IAAI,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAE7L;AAED;;;;;;;;GAQG;AACH,wBAAgB,4BAA4B,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,mBAAmB,IAAI,0BAA0B,CAExI;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,mBAAmB,IAAI,aAAa,CAE9G;AAED;;;;;;;;GAQG;AACH,wBAAgB,mCAAmC,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,mBAAmB,IAAI,iCAAiC,CAEtJ;AAED;;;;;;;;GAQG;AACH,wBAAgB,wCAAwC,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,mBAAmB,IAAI,sCAAsC,CAEhK;AAED;;;;;;;;GAQG;AACH,wBAAgB,+BAA+B,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,mBAAmB,IAAI,6BAA6B,CAE9I"}

package/dist/validators.js

@@ -0,0 +1,140 @@
+import { isGTINDescriptor, isGTINDescriptors, isNonGTINNumericIdentifierDescriptor, isNonNumericIdentifierDescriptor, isNumericIdentifierDescriptor, isSerializableNumericIdentifierDescriptor } from "./descriptors.js";
+import { GTIN_VALIDATORS } from "./gtin-validator.js";
+import { IdentifierTypes } from "./identifier-type.js";
+import { NonGTINNumericIdentifierValidator } from "./non-gtin-numeric-identifier-validator.js";
+import { NonNumericIdentifierValidator } from "./non-numeric-identifier-validator.js";
+import { SerializableNumericIdentifierValidator } from "./serializable-numeric-identifier-validator.js";
+/**
+ * GLN validator.
+ */
+const GLN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GLN);
+/**
+ * SSCC validator.
+ */
+const SSCC_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.SSCC);
+/**
+ * GRAI validator.
+ */
+const GRAI_VALIDATOR = new SerializableNumericIdentifierValidator(IdentifierTypes.GRAI);
+/**
+ * GIAI validator.
+ */
+const GIAI_VALIDATOR = new NonNumericIdentifierValidator(IdentifierTypes.GIAI);
+/**
+ * GSRN validator.
+ */
+const GSRN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GSRN);
+/**
+ * GDTI validator.
+ */
+const GDTI_VALIDATOR = new SerializableNumericIdentifierValidator(IdentifierTypes.GDTI);
+/**
+ * GINC validator.
+ */
+const GINC_VALIDATOR = new NonNumericIdentifierValidator(IdentifierTypes.GINC);
+/**
+ * GSIN validator.
+ */
+const GSIN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GSIN);
+/**
+ * GCN validator.
+ */
+const GCN_VALIDATOR = new SerializableNumericIdentifierValidator(IdentifierTypes.GCN);
+/**
+ * CPID validator.
+ */
+const CPID_VALIDATOR = new NonNumericIdentifierValidator(IdentifierTypes.CPID);
+/**
+ * GMN validator.
+ */
+const GMN_VALIDATOR = new NonNumericIdentifierValidator(IdentifierTypes.GMN);
+/**
+ * Identifier validators for all identifier types.
+ */
+export const IdentifierValidators = {
+    [IdentifierTypes.GTIN]: GTIN_VALIDATORS,
+    [IdentifierTypes.GLN]: GLN_VALIDATOR,
+    [IdentifierTypes.SSCC]: SSCC_VALIDATOR,
+    [IdentifierTypes.GRAI]: GRAI_VALIDATOR,
+    [IdentifierTypes.GIAI]: GIAI_VALIDATOR,
+    [IdentifierTypes.GSRN]: GSRN_VALIDATOR,
+    [IdentifierTypes.GDTI]: GDTI_VALIDATOR,
+    [IdentifierTypes.GINC]: GINC_VALIDATOR,
+    [IdentifierTypes.GSIN]: GSIN_VALIDATOR,
+    [IdentifierTypes.GCN]: GCN_VALIDATOR,
+    [IdentifierTypes.CPID]: CPID_VALIDATOR,
+    [IdentifierTypes.GMN]: GMN_VALIDATOR
+};
+/**
+ * Determine if identifier validators or validator is GTIN validators.
+ *
+ * @param identifierValidatorsOrValidator
+ * Identifier validators or validator.
+ *
+ * @returns
+ * True if GTIN validators.
+ */
+export function isGTINValidators(identifierValidatorsOrValidator) {
+    return isGTINDescriptors(identifierValidatorsOrValidator);
+}
+/**
+ * Determine if identifier validator is a numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a numeric identifier validator.
+ */
+export function isNumericIdentifierValidator(identifierValidator) {
+    return isNumericIdentifierDescriptor(identifierValidator);
+}
+/**
+ * Determine if identifier validator is a GTIN validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a GTIN validator.
+ */
+export function isGTINValidator(identifierValidator) {
+    return isGTINDescriptor(identifierValidator);
+}
+/**
+ * Determine if identifier validator is a non-GTIN numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a non-GTIN numeric identifier validator.
+ */
+export function isNonGTINNumericIdentifierValidator(identifierValidator) {
+    return isNonGTINNumericIdentifierDescriptor(identifierValidator);
+}
+/**
+ * Determine if identifier validator is a serializable numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a serializable numeric identifier validator.
+ */
+export function isSerializableNumericIdentifierValidator(identifierValidator) {
+    return isSerializableNumericIdentifierDescriptor(identifierValidator);
+}
+/**
+ * Determine if identifier validator is a non-numeric identifier validator.
+ *
+ * @param identifierValidator
+ * Identifier validator.
+ *
+ * @returns
+ * True if identifier validator is a non-numeric identifier validator.
+ */
+export function isNonNumericIdentifierValidator(identifierValidator) {
+    return isNonNumericIdentifierDescriptor(identifierValidator);
+}
+//# sourceMappingURL=validators.js.map

package/dist/validators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.js","sourceRoot":"","sources":["../src/validators.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,iBAAiB,EACjB,oCAAoC,EACpC,gCAAgC,EAChC,6BAA6B,EAC7B,yCAAyC,EAC5C,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,eAAe,EAAsB,MAAM,qBAAqB,CAAC;AAC1E,OAAO,EAAuB,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAG5E,OAAO,EAAE,iCAAiC,EAAE,MAAM,4CAA4C,CAAC;AAE/F,OAAO,EAAE,6BAA6B,EAAE,MAAM,uCAAuC,CAAC;AAGtF,OAAO,EAAE,sCAAsC,EAAE,MAAM,gDAAgD,CAAC;AAExG;;GAEG;AACH,MAAM,aAAa,GAAG,IAAI,iCAAiC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;AAEjF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,iCAAiC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,sCAAsC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAExF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,iCAAiC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,sCAAsC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAExF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,iCAAiC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAEnF;;GAEG;AACH,MAAM,aAAa,GAAG,IAAI,sCAAsC,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;AAEtF;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,6BAA6B,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,aAAa,GAAG,IAAI,6BAA6B,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;AAmC7E;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA+B;IAC5D,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,eAAe;IACvC,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,aAAa;IACpC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,aAAa;IACpC,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc;IACtC,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,aAAa;CAC9B,CAAC;AAEX;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAC,+BAA0E;IACvG,OAAO,iBAAiB,CAAC,+BAA+B,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,4BAA4B,CAAC,mBAAwC;IACjF,OAAO,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,mBAAwC;IACpE,OAAO,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,mCAAmC,CAAC,mBAAwC;IACxF,OAAO,oCAAoC,CAAC,mBAAmB,CAAC,CAAC;AACrE,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,wCAAwC,CAAC,mBAAwC;IAC7F,OAAO,yCAAyC,CAAC,mBAAmB,CAAC,CAAC;AAC1E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,+BAA+B,CAAC,mBAAwC;IACpF,OAAO,gCAAgC,CAAC,mBAAmB,CAAC,CAAC;AACjE,CAAC"}

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "@aidc-toolkit/gs1",
-  "version": "1.0.24-beta",
+  "version": "1.0.26-beta",
   "description": "GS1 AIDC Toolkit",
   "type": "module",
   "main": "dist/index.js",
   "homepage": "https://aidc-toolkit.com/",
-  "repository": "aidc-toolkit/gs1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aidc-toolkit/gs1.git"
+  },
   "bugs": {
     "url": "https://github.com/aidc-toolkit/gs1/issues"
   },
@@ -17,18 +20,19 @@
   },
   "scripts": {
     "lint": "eslint",
-    "build:dev": "tsup --define.mode=dev",
-    "build:release": "tsup",
+    "tsc:core": "tsc --project tsconfig-src.json",
+    "build:dev": "rimraf dist && npm run tsc:core -- --declarationMap --sourceMap",
+    "build:release": "npm run tsc:core -- --noEmit && tsup",
     "build:doc": "npm run build:dev",
     "test": "vitest run"
   },
   "devDependencies": {
-    "@aidc-toolkit/dev": "beta",
-    "vitest": "^4.0.14"
+    "@aidc-toolkit/dev": "1.0.26-beta",
+    "vitest": "^4.0.15"
   },
   "dependencies": {
-    "@aidc-toolkit/core": "beta",
-    "@aidc-toolkit/utility": "beta",
+    "@aidc-toolkit/core": "1.0.26-beta",
+    "@aidc-toolkit/utility": "1.0.26-beta",
     "ts-mixer": "^6.0.4"
   }
 }

package/src/abstract-identifier-creator.ts

@@ -0,0 +1,97 @@
+import type { CharacterSetCreator } from "@aidc-toolkit/utility";
+import type { IdentifierCreator } from "./identifier-creator.js";
+import type { IdentifierDescriptor } from "./identifier-descriptor.js";
+import type { IdentifierValidation } from "./identifier-validator.js";
+import type { PrefixProvider } from "./prefix-provider.js";
+
+/**
+ * Abstract identifier creator. Implements common functionality for an identifier creator, bound to a {@link
+ * PrefixProvider | prefix provider}.
+ *
+ * @template TIdentifierDescriptor
+ * Identifier descriptor type.
+ *
+ * @template TIdentifierValidation
+ * Identifier validation type.
+ */
+export abstract class AbstractIdentifierCreator<TIdentifierDescriptor extends IdentifierDescriptor, TIdentifierValidation extends IdentifierValidation> implements IdentifierCreator<TIdentifierDescriptor, TIdentifierValidation> {
+    /**
+     * Prefix provider.
+     */
+    private _prefixProvider!: PrefixProvider;
+
+    /**
+     * Reference length.
+     */
+    private _referenceLength!: number;
+
+    /**
+     * 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 provider 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;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    abstract get identifierType(): TIdentifierDescriptor["identifierType"];
+
+    /**
+     * @inheritDoc
+     */
+    abstract get prefixType(): TIdentifierDescriptor["prefixType"];
+
+    /**
+     * @inheritDoc
+     */
+    abstract get length(): number;
+
+    /**
+     * @inheritDoc
+     */
+    abstract get referenceCharacterSet(): TIdentifierDescriptor["referenceCharacterSet"];
+
+    /**
+     * @inheritDoc
+     */
+    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;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    abstract validate(identifier: string, validation?: TIdentifierValidation): void;
+}

package/src/abstract-identifier-validator.ts

@@ -0,0 +1,140 @@
+import { type CharacterSetCreator, NUMERIC_CREATOR } from "@aidc-toolkit/utility";
+import { AI39_CREATOR, AI82_CREATOR } from "./character-set.js";
+import { type ContentCharacterSet, ContentCharacterSets } from "./content-character-set.js";
+import type { IdentifierDescriptor } from "./identifier-descriptor.js";
+import type { IdentifierValidation, IdentifierValidator } from "./identifier-validator.js";
+import { PrefixTypes } from "./prefix-type.js";
+import { PrefixValidator } from "./prefix-validator.js";
+
+/**
+ * Abstract identifier validator. Implements common functionality for an identifier validator.
+ *
+ * @template TIdentifierDescriptor
+ * Identifier descriptor type.
+ *
+ * @template TIdentifierValidation
+ * Identifier validation type.
+ */
+export abstract class AbstractIdentifierValidator<TIdentifierDescriptor extends IdentifierDescriptor, TIdentifierValidation extends IdentifierValidation> implements IdentifierValidator<TIdentifierDescriptor, 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: TIdentifierDescriptor["identifierType"];
+
+    /**
+     * Length.
+     */
+    private readonly _length: number;
+
+    /**
+     * Reference character set.
+     */
+    private readonly _referenceCharacterSet: TIdentifierDescriptor["referenceCharacterSet"];
+
+    /**
+     * 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 identifierDescriptor
+     * Identifier descriptor.
+     */
+    protected constructor(identifierDescriptor: IdentifierDescriptor) {
+        this._identifierType = identifierDescriptor.identifierType;
+        this._length = identifierDescriptor.length;
+        this._referenceCharacterSet = identifierDescriptor.referenceCharacterSet;
+        this._referenceCreator = AbstractIdentifierValidator.creatorFor(identifierDescriptor.referenceCharacterSet);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get identifierType(): TIdentifierDescriptor["identifierType"] {
+        return this._identifierType;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get prefixType(): TIdentifierDescriptor["prefixType"] {
+        // All identifier types except GTIN support only the GS1 Company Prefix.
+        return PrefixTypes.GS1CompanyPrefix;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get length(): number {
+        return this._length;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    get referenceCharacterSet(): TIdentifierDescriptor["referenceCharacterSet"] {
+        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 positionOffset
+     * Position offset within a larger string.
+     *
+     * @returns
+     * Padded identifier.
+     */
+    protected padIdentifier(identifier: string, positionOffset?: number): string {
+        // Identifier is returned as is if position offset is undefined.
+        return positionOffset === undefined ? identifier : this.referenceCreator.character(0).repeat(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;
+}