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

package/src/abstract-identifier-validator.ts

@@ -1,140 +0,0 @@
-import { type CharacterSetCreator, NUMERIC_CREATOR } from "@aidc-toolkit/utility";
-import { AI39_CREATOR, AI82_CREATOR } from "./character-set";
-import { type ContentCharacterSet, ContentCharacterSets } from "./content-character-set";
-import type { IdentifierDescriptor } from "./identifier-descriptor";
-import type { IdentifierValidation, IdentifierValidator } from "./identifier-validator";
-import { PrefixTypes } from "./prefix-type";
-import { PrefixValidator } from "./prefix-validator";
-
-/**
- * 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;
-}

package/src/abstract-numeric-identifier-validator.ts

@@ -1,69 +0,0 @@
-import { AbstractIdentifierValidator } from "./abstract-identifier-validator";
-import { hasValidCheckDigit } from "./check";
-import { i18nextGS1 } from "./locale/i18n";
-import type { NumericIdentifierDescriptor } from "./numeric-identifier-descriptor";
-import { LeaderTypes } from "./numeric-identifier-type";
-import type { NumericIdentifierValidation, NumericIdentifierValidator } from "./numeric-identifier-validator";
-
-/**
- * Abstract numeric identifier validator.
- *
- * @template TNumericIdentifierDescriptor
- * Numeric identifier descriptor type.
- */
-export abstract class AbstractNumericIdentifierValidator<TNumericIdentifierDescriptor extends NumericIdentifierDescriptor> extends AbstractIdentifierValidator<TNumericIdentifierDescriptor, NumericIdentifierValidation> implements NumericIdentifierValidator<TNumericIdentifierDescriptor> {
-    /**
-     * Leader type.
-     */
-    private readonly _leaderType: TNumericIdentifierDescriptor["leaderType"];
-
-    /**
-     * Prefix position, determined by the leader type.
-     */
-    private readonly _prefixPosition: number;
-
-    /**
-     * Constructor.
-     *
-     * @param identifierDescriptor
-     * Identifier descriptor.
-     */
-    constructor(identifierDescriptor: NumericIdentifierDescriptor) {
-        super(identifierDescriptor);
-
-        this._leaderType = identifierDescriptor.leaderType;
-        this._prefixPosition = Number(this.leaderType === LeaderTypes.ExtensionDigit);
-    }
-
-    /**
-     * @inheritDoc
-     */
-    get leaderType(): TNumericIdentifierDescriptor["leaderType"] {
-        return this._leaderType;
-    }
-
-    /**
-     * @inheritDoc
-     */
-    validate(identifier: string, validation?: NumericIdentifierValidation): void {
-        // 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?.positionOffset))) {
-            throw new RangeError(i18nextGS1.t("Identifier.invalidCheckDigit"));
-        }
-    }
-}