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

package/src/abstract-identifier-creator.ts

@@ -1,97 +1,178 @@
-import type { CharacterSetCreator } from "@aidc-toolkit/utility";
-import type { IdentifierCreator } from "./identifier-creator";
-import type { IdentifierDescriptor } from "./identifier-descriptor";
-import type { IdentifierValidation } from "./identifier-validator";
-import type { PrefixProvider } from "./prefix-provider";
+import type { IdentifierCreator } from "./identifier-creator.js";
+import type { IdentifierType } from "./identifier-type.js";
+import type { IdentifierValidation, IdentifierValidator } from "./identifier-validator.js";
+import type { IdentifierTypeValidator } from "./identifier-validators.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}.
+ * Identifier extension constructor type.
  *
- * @template TIdentifierDescriptor
- * Identifier descriptor type.
+ * @template TConstructorArguments
+ * Constructor arguments types.
+ *
+ * @template TConstructorInstance
+ * Constructor instance type.
+ */
+export type IdentifierExtensionConstructor<
+    TConstructorArguments extends unknown[],
+    TConstructorInstance
+> = abstract new (...args: TConstructorArguments) => TConstructorInstance;
+
+/**
+ * Identifier validator constructor type.
+ *
+ * @template TConstructorArguments
+ * Constructor arguments types.
+ *
+ * @template TIdentifierType
+ * Identifier type type.
  *
  * @template TIdentifierValidation
  * Identifier validation type.
+ *
+ * @template TIdentifierValidator
+ * Identifier validator 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;
+export type IdentifierValidatorConstructor<
+    TConstructorArguments extends unknown[],
+    TIdentifierType extends IdentifierType,
+    TIdentifierValidation extends IdentifierValidation,
+    TIdentifierValidator extends IdentifierValidator<TIdentifierType, TIdentifierValidation> = IdentifierTypeValidator<TIdentifierType>
+> = IdentifierExtensionConstructor<
+    TConstructorArguments,
+    TIdentifierValidator
+>;
 
-        // Reference length allows for prefix and optionally check digit or check character pair.
-        this._referenceLength = this.length - prefix.length - checkAllowance;
-    }
+/**
+ * Identifier creator constructor type, which delegates to an identifier validator constructor.
+ *
+ * @template TConstructorArguments
+ * Constructor arguments types.
+ *
+ * @template TIdentifierType
+ * Identifier type type.
+ *
+ * @template TIdentifierValidation
+ * Identifier validation type.
+ *
+ * @template TIdentifierValidator
+ * Identifier validator type.
+ */
+export type IdentifierCreatorConstructor<
+    TConstructorArguments extends unknown[],
+    TIdentifierType extends IdentifierType,
+    TIdentifierValidation extends IdentifierValidation,
+    TIdentifierValidator extends IdentifierValidator<TIdentifierType, TIdentifierValidation>
+> = IdentifierExtensionConstructor<
+    [prefixProvider: PrefixProvider, prefix: string, checkAllowance: number, ...args: TConstructorArguments],
+    TIdentifierValidator & IdentifierCreator<TIdentifierType, TIdentifierValidation>
+>;
 
+/**
+ * Mixin implementation of {@linkcode IdentifierCreator} with an appropriate identifier validator base.
+ *
+ * @template TConstructorArguments
+ * Constructor arguments types.
+ *
+ * @template TIdentifierType
+ * Identifier type type.
+ *
+ * @template TIdentifierValidation
+ * Identifier validation type.
+ *
+ * @template TIdentifierValidatorConstructor
+ * Identifier validator constructor type.
+ *
+ * @param IdentifierValidatorBase
+ * Identifier validator base.
+ *
+ * @returns
+ * Identifier creator class.
+ */
+export function MixinAbstractIdentifierCreator<
+    TConstructorArguments extends unknown[],
+    TIdentifierType extends IdentifierType,
+    TIdentifierValidation extends IdentifierValidation,
+    TIdentifierValidatorConstructor extends IdentifierValidatorConstructor<
+        TConstructorArguments,
+        TIdentifierType,
+        TIdentifierValidation
+    >
+>(IdentifierValidatorBase: TIdentifierValidatorConstructor): IdentifierCreatorConstructor<
+    TConstructorArguments,
+    TIdentifierType,
+    TIdentifierValidation,
+    IdentifierTypeValidator<TIdentifierType>
+> {
     /**
-     * @inheritDoc
+     * Abstract numeric identifier creator. Implements common functionality for a numeric identifier creator, mixed in
+     * with a matching numeric identifier validator.
      */
-    abstract get identifierType(): TIdentifierDescriptor["identifierType"];
+    abstract class AbstractIdentifierCreator extends (IdentifierValidatorBase as IdentifierValidatorConstructor<
+        TConstructorArguments,
+        TIdentifierType,
+        TIdentifierValidation,
+        IdentifierValidator<TIdentifierType, TIdentifierValidation>
+    >) implements IdentifierCreator<TIdentifierType, TIdentifierValidation> {
+        /**
+         * Prefix provider.
+         */
+        readonly #prefixProvider: PrefixProvider;
 
-    /**
-     * @inheritDoc
-     */
-    abstract get prefixType(): TIdentifierDescriptor["prefixType"];
+        /**
+         * Reference length.
+         */
+        readonly #referenceLength: number;
 
-    /**
-     * @inheritDoc
-     */
-    abstract get length(): number;
+        /**
+         * Constructor.
+         *
+         * @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.
+         * 
+         * @param args
+         * Originating constructor arguments.
+         */
+        constructor(prefixProvider: PrefixProvider, prefix: string, checkAllowance: number, ...args: TConstructorArguments) {
+            super(...args);
 
-    /**
-     * @inheritDoc
-     */
-    abstract get referenceCharacterSet(): TIdentifierDescriptor["referenceCharacterSet"];
+            this.#prefixProvider = prefixProvider;
 
-    /**
-     * @inheritDoc
-     */
-    abstract get referenceCreator(): CharacterSetCreator;
+            // Reference length allows for prefix and optionally check digit or check character pair.
+            this.#referenceLength = this.length - prefix.length - checkAllowance;
+        }
 
-    /**
-     * @inheritDoc
-     */
-    get prefixProvider(): PrefixProvider {
-        return this._prefixProvider;
-    }
+        /**
+         * @inheritDoc
+         */
+        get prefixProvider(): PrefixProvider {
+            return this.#prefixProvider;
+        }
 
-    /**
-     * @inheritDoc
-     */
-    get prefix(): string {
-        return this.prefixProvider.gs1CompanyPrefix;
-    }
+        /**
+         * @inheritDoc
+         */
+        get prefix(): string {
+            return this.prefixProvider.gs1CompanyPrefix;
+        }
 
-    /**
-     * @inheritDoc
-     */
-    get referenceLength(): number {
-        return this._referenceLength;
+        /**
+         * @inheritDoc
+         */
+        get referenceLength(): number {
+            return this.#referenceLength;
+        }
     }
 
-    /**
-     * @inheritDoc
-     */
-    abstract validate(identifier: string, validation?: TIdentifierValidation): void;
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Base class was upcast to type with statically known members for mixin, downcast result.
+    return AbstractIdentifierCreator as IdentifierExtensionConstructor<
+        ConstructorParameters<typeof AbstractIdentifierCreator>,
+        IdentifierTypeValidator<TIdentifierType> & AbstractIdentifierCreator
+    >;
 }

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

@@ -0,0 +1,86 @@
+import type { IdentifierExtensionConstructor, IdentifierValidatorConstructor } from "./abstract-identifier-creator.js";
+import {
+    MixinAbstractNumericIdentifierCreator,
+    type NumericIdentifierCreatorConstructor
+} from "./abstract-numeric-identifier-creator.js";
+import type { IdentifierTypeValidator } from "./identifier-validators.js";
+import type { NonGTINNumericIdentifierCreator } from "./non-gtin-numeric-identifier-creator.js";
+import type { NonGTINNumericIdentifierType } from "./non-gtin-numeric-identifier-type.js";
+import type { NonGTINNumericIdentifierValidator } from "./non-gtin-numeric-identifier-validator.js";
+import type { NumericIdentifierValidation } from "./numeric-identifier-validator.js";
+import type { PrefixProvider } from "./prefix-provider.js";
+
+/**
+ * Non-GTIN numeric identifier creator constructor type, which delegates to a non-GTIN numeric identifier validator
+ * constructor.
+ *
+ * @template TNonGTINNumericIdentifierType
+ * Non-GTIN numeric identifier type type.
+ *
+ * @template TNonGTINNumericIdentifierValidator
+ * Non-GTIN numeric identifier validator type.
+ */
+type NonGTINNumericIdentifierCreatorConstructor<
+    TNonGTINNumericIdentifierType extends NonGTINNumericIdentifierType,
+    TNonGTINNumericIdentifierValidator extends NonGTINNumericIdentifierValidator<TNonGTINNumericIdentifierType>
+> = IdentifierExtensionConstructor<
+    [prefixProvider: PrefixProvider, identifierType: TNonGTINNumericIdentifierType],
+    TNonGTINNumericIdentifierValidator & NonGTINNumericIdentifierCreator<TNonGTINNumericIdentifierType>
+>;
+
+/**
+ * Mixin implementation of {@linkcode NonGTINNumericIdentifierCreator} with an appropriate non-GTIN numeric identifier
+ * validator base.
+ *
+ * @template TNonGTINNumericIdentifierType
+ * Non-GTIN numeric identifier type type.
+ *
+ * @template TNonGTINNumericIdentifierValidatorConstructor
+ * Non-GTIN numeric identifier validator constructor type.
+ *
+ * @param NonGTINNumericIdentifierValidatorBase
+ * Non-GTIN numeric identifier validator base.
+ *
+ * @returns
+ * Non-GTIN numeric identifier creator class.
+ */
+export function MixinAbstractNonGTINNumericIdentifierCreator<
+    TNonGTINNumericIdentifierType extends NonGTINNumericIdentifierType,
+    TNonGTINNumericIdentifierValidatorConstructor extends IdentifierValidatorConstructor<
+        [TNonGTINNumericIdentifierType],
+        TNonGTINNumericIdentifierType,
+        NumericIdentifierValidation
+    >
+>(NonGTINNumericIdentifierValidatorBase: TNonGTINNumericIdentifierValidatorConstructor): NonGTINNumericIdentifierCreatorConstructor<
+    TNonGTINNumericIdentifierType,
+    IdentifierTypeValidator<TNonGTINNumericIdentifierType>
+> {
+    /**
+     * Abstract non-GTIN numeric identifier creator. Implements common functionality for a non-GTIN numeric identifier
+     * creator, mixed in with a matching non-GTIN numeric identifier validator.
+     */
+    abstract class AbstractNonGTINNumericIdentifierCreator extends (MixinAbstractNumericIdentifierCreator(NonGTINNumericIdentifierValidatorBase) as NumericIdentifierCreatorConstructor<
+        [TNonGTINNumericIdentifierType],
+        TNonGTINNumericIdentifierType,
+        NonGTINNumericIdentifierValidator<TNonGTINNumericIdentifierType>
+    >) implements NonGTINNumericIdentifierCreator<TNonGTINNumericIdentifierType> {
+        /**
+         * Constructor.
+         *
+         * @param prefixProvider
+         * Prefix provider.
+         *
+         * @param identifierType
+         * Identifier type.
+         */
+        constructor(prefixProvider: PrefixProvider, identifierType: TNonGTINNumericIdentifierType) {
+            super(prefixProvider, prefixProvider.gs1CompanyPrefix, identifierType);
+        }
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion -- Base class was upcast to type with statically known members for mixin, downcast result.
+    return AbstractNonGTINNumericIdentifierCreator as IdentifierExtensionConstructor<
+        ConstructorParameters<typeof AbstractNonGTINNumericIdentifierCreator>,
+        IdentifierTypeValidator<TNonGTINNumericIdentifierType> & AbstractNonGTINNumericIdentifierCreator
+    >;
+}