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

package/src/identifier-descriptor.ts

@@ -0,0 +1,30 @@
+import type { ContentCharacterSet } from "./content-character-set.js";
+import type { IdentifierType } from "./identifier-type.js";
+import type { PrefixType } from "./prefix-type.js";
+
+/**
+ * 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";
-import type { IdentifierType } from "./identifier-type";
-import type { PrefixType } from "./prefix-type";
-import { PrefixValidator } from "./prefix-validator";
-
-/**
- * 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.js";
 
 /**
  * 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,47 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export * from "./locale/i18n";
-export * from "./character-set";
-export * from "./check";
-export * from "./prefix-type";
-export * from "./prefix-validator";
-export * from "./identifier-type";
-export * from "./identifier-validator";
-export * from "./numeric-identifier-validator";
-export * from "./gtin-validator";
-export * from "./non-gtin-numeric-identifier-validator";
-export * from "./serializable-numeric-identifier-validator";
-export * from "./non-numeric-identifier-validator";
-export * from "./identifier-creator";
-export * 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 "./prefix-manager";
+export * from "./locale/i18n.js";
+
+export * from "./character-set.js";
+
+export * from "./check.js";
+
+export * from "./prefix-type.js";
+export type * from "./prefix-provider.js";
+export * from "./prefix-validator.js";
+
+export * from "./content-character-set.js";
+
+export * from "./identifier-type.js";
+export * from "./numeric-identifier-type.js";
+export * from "./gtin-type.js";
+export type * from "./non-gtin-numeric-identifier-type.js";
+export type * from "./serializable-numeric-identifier-type.js";
+export type * from "./non-numeric-identifier-type.js";
+
+export type * from "./identifier-descriptor.js";
+export type * from "./numeric-identifier-descriptor.js";
+export type * from "./gtin-descriptor.js";
+export type * from "./non-gtin-numeric-identifier-descriptor.js";
+export type * from "./serializable-numeric-identifier-descriptor.js";
+export type * from "./non-numeric-identifier-descriptor.js";
+export * from "./descriptors.js";
+
+export type * from "./identifier-validator.js";
+export type * from "./numeric-identifier-validator.js";
+export { GTINLevels, type GTINLevelKey, type GTINLevel, type RCNReference, GTINValidator } 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 "./validators.js";
+
+export type * from "./identifier-creator.js";
+export type * 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 "./creators.js";
+
+export * from "./prefix-manager.js";

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 { 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";
-import frLocaleResources from "./fr/locale-resources";
+import enLocaleResources from "./en/locale-resources.js";
+import frLocaleResources from "./fr/locale-resources.js";
 
 export const gs1NS = "aidct_gs1";
 
@@ -23,7 +23,7 @@ export const gs1Resources: Resource = {
     }
 };
 
-// Explicit type is necessary to work around bug in type discovery with linked packages.
+// Explicit type is necessary because type can't be inferred without additional references.
 export const i18nextGS1: i18n = i18next.createInstance();
 
 /**

package/src/locale/i18next.d.ts

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

package/src/non-gtin-numeric-identifier-creator.ts

@@ -1,9 +1,9 @@
 import { Mixin } from "ts-mixer";
-import type { IdentifierType } from "./identifier-type";
-import { NonGTINNumericIdentifierValidator } from "./non-gtin-numeric-identifier-validator";
-import { AbstractNumericIdentifierCreator } from "./numeric-identifier-creator";
-import { type LeaderType, LeaderTypes } from "./numeric-identifier-validator";
-import type { PrefixProvider } from "./prefix-provider";
+import { AbstractNumericIdentifierCreator } from "./abstract-numeric-identifier-creator.js";
+import type { NonGTINNumericIdentifierType } from "./non-gtin-numeric-identifier-type.js";
+import { NonGTINNumericIdentifierValidator } from "./non-gtin-numeric-identifier-validator.js";
+import type { PrefixProvider } from "./prefix-provider.js";
+import type { SerializableNumericIdentifierType } from "./serializable-numeric-identifier-type.js";
 
 /**
  * Non-GTIN numeric identifier creator.
@@ -18,15 +18,9 @@ export class NonGTINNumericIdentifierCreator extends Mixin(NonGTINNumericIdentif
      *
      * @param identifierType
      * Identifier type.
-     *
-     * @param length
-     * Length.
-     *
-     * @param leaderType
-     * Leader type.
      */
-    constructor(prefixProvider: PrefixProvider, identifierType: IdentifierType, length: number, leaderType: LeaderType = LeaderTypes.None) {
-        super(identifierType, length, leaderType);
+    constructor(prefixProvider: PrefixProvider, identifierType: Exclude<NonGTINNumericIdentifierType, SerializableNumericIdentifierType>) {
+        super(identifierType);
 
         this.init(prefixProvider, prefixProvider.gs1CompanyPrefix);
     }

package/src/non-gtin-numeric-identifier-descriptor.ts

@@ -0,0 +1,24 @@
+import type { NonGTINNumericIdentifierType } from "./non-gtin-numeric-identifier-type.js";
+import type { NumericIdentifierDescriptor } from "./numeric-identifier-descriptor.js";
+import type { LeaderType, LeaderTypes } from "./numeric-identifier-type.js";
+import type { PrefixTypes } from "./prefix-type.js";
+
+/**
+ * Non-GTIN numeric identifier descriptor.
+ */
+export interface NonGTINNumericIdentifierDescriptor extends NumericIdentifierDescriptor {
+    /**
+     * @inheritDoc
+     */
+    readonly identifierType: NonGTINNumericIdentifierType;
+
+    /**
+     * @inheritDoc
+     */
+    readonly prefixType: typeof PrefixTypes.GS1CompanyPrefix;
+
+    /**
+     * @inheritDoc
+     */
+    readonly leaderType: Exclude<LeaderType, typeof LeaderTypes.IndicatorDigit>;
+}

package/src/non-gtin-numeric-identifier-type.ts

@@ -0,0 +1,7 @@
+import type { IdentifierTypes } from "./identifier-type.js";
+import type { NumericIdentifierType } from "./numeric-identifier-type.js";
+
+/**
+ * Non-GTIN numeric identifier type.
+ */
+export type NonGTINNumericIdentifierType = Exclude<NumericIdentifierType, typeof IdentifierTypes.GTIN>;

package/src/non-gtin-numeric-identifier-validator.ts

@@ -1,54 +1,20 @@
-import { type IdentifierType, IdentifierTypes } from "./identifier-type";
-import {
-    AbstractNumericIdentifierValidator,
-    type LeaderType,
-    LeaderTypes,
-    type NumericIdentifierType
-} from "./numeric-identifier-validator";
-import { PrefixTypes } from "./prefix-type";
-
-/**
- * Non-GTIN numeric identifier type.
- */
-export type NonGTINNumericIdentifierType = Exclude<NumericIdentifierType, typeof IdentifierTypes.GTIN>;
+import { AbstractNumericIdentifierValidator } from "./abstract-numeric-identifier-validator.js";
+import { IdentifierDescriptors } from "./descriptors.js";
+import type { NonGTINNumericIdentifierDescriptor } from "./non-gtin-numeric-identifier-descriptor.js";
+import type { NonGTINNumericIdentifierType } from "./non-gtin-numeric-identifier-type.js";
+import type { SerializableNumericIdentifierType } from "./serializable-numeric-identifier-type.js";
 
 /**
  * Non-GTIN numeric identifier validator.
  */
-export class NonGTINNumericIdentifierValidator extends AbstractNumericIdentifierValidator {
+export class NonGTINNumericIdentifierValidator extends AbstractNumericIdentifierValidator<NonGTINNumericIdentifierDescriptor> {
     /**
      * Constructor.
      *
      * @param identifierType
      * Identifier type.
-     *
-     * @param length
-     * Length.
-     *
-     * @param leaderType
-     * Leader type.
      */
-    constructor(identifierType: IdentifierType, length: number, leaderType: LeaderType = LeaderTypes.None) {
-        super(identifierType, PrefixTypes.GS1CompanyPrefix, length, leaderType);
+    constructor(identifierType: Exclude<NonGTINNumericIdentifierType, SerializableNumericIdentifierType>) {
+        super(IdentifierDescriptors[identifierType]);
     }
 }
-
-/**
- * GLN validator.
- */
-export const GLN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GLN, 13);
-
-/**
- * SSCC validator.
- */
-export const SSCC_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.SSCC, 18, LeaderTypes.ExtensionDigit);
-
-/**
- * GSRN validator.
- */
-export const GSRN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GSRN, 18);
-
-/**
- * GSIN validator.
- */
-export const GSIN_VALIDATOR = new NonGTINNumericIdentifierValidator(IdentifierTypes.GSIN, 17);

package/src/non-numeric-identifier-creator.ts

@@ -5,13 +5,12 @@ import {
     type TransformerOutput
 } from "@aidc-toolkit/utility";
 import { Mixin } from "ts-mixer";
-import { checkCharacterPair } from "./check";
-import { AbstractIdentifierCreator } from "./identifier-creator";
-import type { IdentifierType } from "./identifier-type";
-import type { ContentCharacterSet } from "./identifier-validator";
-import { i18nextGS1 } from "./locale/i18n";
-import { NonNumericIdentifierValidator } from "./non-numeric-identifier-validator";
-import type { PrefixProvider } from "./prefix-provider";
+import { AbstractIdentifierCreator } from "./abstract-identifier-creator.js";
+import { checkCharacterPair } from "./check.js";
+import { i18nextGS1 } from "./locale/i18n.js";
+import type { NonNumericIdentifierType } from "./non-numeric-identifier-type.js";
+import { NonNumericIdentifierValidator } from "./non-numeric-identifier-validator.js";
+import type { PrefixProvider } from "./prefix-provider.js";
 
 /**
  * Non-numeric identifier creator.
@@ -31,20 +30,11 @@ export class NonNumericIdentifierCreator extends Mixin(NonNumericIdentifierValid
      *
      * @param identifierType
      * Identifier type.
-     *
-     * @param length
-     * Length.
-     *
-     * @param referenceCharacterSet
-     * Reference character set.
-     *
-     * @param requiresCheckCharacterPair
-     * True if the identifier requires a check character pair.
      */
-    constructor(prefixProvider: PrefixProvider, identifierType: IdentifierType, length: number, referenceCharacterSet: ContentCharacterSet, requiresCheckCharacterPair = false) {
-        super(identifierType, length, referenceCharacterSet, requiresCheckCharacterPair);
+    constructor(prefixProvider: PrefixProvider, identifierType: NonNumericIdentifierType) {
+        super(identifierType);
 
-        this.init(prefixProvider, prefixProvider.gs1CompanyPrefix, 2 * Number(requiresCheckCharacterPair));
+        this.init(prefixProvider, prefixProvider.gs1CompanyPrefix, 2 * Number(this.requiresCheckCharacterPair));
 
         this._referenceValidation = {
             minimumLength: 1,

package/src/non-numeric-identifier-descriptor.ts

@@ -0,0 +1,29 @@
+import type { ContentCharacterSet, ContentCharacterSets } from "./content-character-set.js";
+import type { IdentifierDescriptor } from "./identifier-descriptor.js";
+import type { NonNumericIdentifierType } from "./non-numeric-identifier-type.js";
+import type { PrefixTypes } from "./prefix-type.js";
+
+/**
+ * Non-numeric identifier descriptor.
+ */
+export interface NonNumericIdentifierDescriptor extends IdentifierDescriptor {
+    /**
+     * @inheritDoc
+     */
+    readonly identifierType: NonNumericIdentifierType;
+
+    /**
+     * @inheritDoc
+     */
+    readonly prefixType: typeof PrefixTypes.GS1CompanyPrefix;
+
+    /**
+     * @inheritDoc
+     */
+    readonly referenceCharacterSet: Exclude<ContentCharacterSet, typeof ContentCharacterSets.Numeric>;
+
+    /**
+     * True if identifier requires a check character pair.
+     */
+    readonly requiresCheckCharacterPair: boolean;
+}

package/src/non-numeric-identifier-type.ts

@@ -0,0 +1,7 @@
+import type { IdentifierType } from "./identifier-type.js";
+import type { NumericIdentifierType } from "./numeric-identifier-type.js";
+
+/**
+ * Non-numeric identifier type.
+ */
+export type NonNumericIdentifierType = Exclude<IdentifierType, NumericIdentifierType>;