zibri 2.2.0 → 2.3.0

package/src/plugin/payment/services/payment-service.interface.ts

@@ -1,25 +1,25 @@
-import { AnyObject } from '../../../entity';
-import { PaymentMethod } from '../models';
-import { PaymentProviderInterface } from '../providers';
-import { AllowedCancellationMethods, AllowedRefundMethods, AllowedReservationMethods, PaymentDataForMethod, PaymentForMethod, PaymentReservationForMethod, ValidatedPaymentDataForMethod } from './payment-service.types';
+import { PaymentDataForMethod, ValidatedPaymentDataForMethod, PaymentForMethod, AllowedReservationMethods, PaymentReservationForMethod, AllowedCancellationMethods, AllowedRefundMethods } from './payment-service.types';
+import { PaymentMethod } from '../models/payment-method.model';
+import { AnyPaymentProviderInterface } from '../providers/payment-provider.interface';
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type MethodsCoveredByProviders<P extends readonly AnyPaymentProviderInterface[]>
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    = P[number] extends { __supportedMethods: infer SM }
+        ? SM extends readonly (infer S)[] ? S : never
+        : never;
 
 /**
  * Interface for a payment service.
  */
 export interface PaymentServiceInterface<
     Methods extends readonly PaymentMethod[],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[],
+    // eslint-disable-next-line unusedImports/no-unused-vars
+    _Check extends (Methods[number] extends MethodsCoveredByProviders<P>
+        // eslint-disable-next-line stylistic/max-len
+        ? unknown : 'Error: not all payment methods are covered by the provided providers') = Methods[number] extends MethodsCoveredByProviders<P>
+        ? unknown : 'Error: not all payment methods are covered by the provided providers'
 > {
     /**
      * Validates the given data of the given payment method.

package/src/plugin/payment/services/payment-service.types.ts

@@ -1,7 +1,8 @@
-/* eslint-disable unusedImports/no-unused-vars */
-import { AnyObject } from '../../../entity';
-import { Payment, PaymentMethod, PaymentPluginOptions } from '../models';
-import { PaymentProviderInterface } from '../providers';
+/* eslint-disable jsdoc/require-jsdoc */
+import { PaymentMethod } from '../models/payment-method.model';
+import { PaymentPluginOptions } from '../models/payment-plugin-options.model';
+import { Payment } from '../models/payment.model';
+import { AnyPaymentProviderInterface } from '../providers/payment-provider.interface';
 
 /**
  * Helper: pick the provider *instance* (from the P tuple) for the given method M.
@@ -9,21 +10,10 @@ import { PaymentProviderInterface } from '../providers';
 type ProviderInstanceForMethod<
     Methods extends readonly PaymentMethod[],
     M extends Methods[number],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[]
 > = Extract<
     P[number],
-    // eslint-disable-next-line jsdoc/require-jsdoc
+
     { name: PaymentPluginOptions<Methods, P>['providerNameForMethod'][M] }
 >;
 
@@ -33,31 +23,11 @@ type ProviderInstanceForMethod<
 export type PaymentDataForMethod<
     Methods extends readonly PaymentMethod[],
     M extends Methods[number],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
->
-  = ProviderInstanceForMethod<Methods, M, P> extends PaymentProviderInterface<
-      infer _SM,
-      infer PaymentDataMap,
-      infer _ValidatedMap,
-      infer _ProviderPaymentData,
-      infer _ProviderReservationPaymentData,
-      infer _CS,
-      infer _RS,
-      infer _ReservationSupport
-  >
-      ? PaymentDataMap[M]
-      : never;
+    P extends readonly AnyPaymentProviderInterface[]
+> = ProviderInstanceForMethod<Methods, M, P> extends { __paymentDataMap: infer DataMap }
+    // eslint-disable-next-line typescript/no-explicit-any
+    ? (DataMap & Record<string, any>)[M] & { transactionId: string }
+    : never;
 
 /**
  * ValidatedPaymentDataForMethod: the validated/normalized data type returned by validatePaymentData.
@@ -65,31 +35,12 @@ export type PaymentDataForMethod<
 export type ValidatedPaymentDataForMethod<
     Methods extends readonly PaymentMethod[],
     M extends Methods[number],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
->
-  = ProviderInstanceForMethod<Methods, M, P> extends PaymentProviderInterface<
-      infer _SM,
-      infer _PaymentDataMap,
-      infer ValidatedMap,
-      infer _ProviderPaymentData,
-      infer _ProviderReservationPaymentData,
-      infer _CS,
-      infer _RS,
-      infer _ReservationSupport
-  >
-      ? ValidatedMap[M]
-      : never;
+    P extends readonly AnyPaymentProviderInterface[]
+
+> = ProviderInstanceForMethod<Methods, M, P> extends { __validatedDataMap: infer DataMap }
+    // eslint-disable-next-line typescript/no-explicit-any
+    ? (DataMap & Record<string, any>)[M]
+    : never;
 
 /**
  * The payment entity type used for payments.
@@ -97,31 +48,9 @@ export type ValidatedPaymentDataForMethod<
 export type PaymentForMethod<
     Methods extends readonly PaymentMethod[],
     M extends Methods[number],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
->
-  = ProviderInstanceForMethod<Methods, M, P> extends PaymentProviderInterface<
-      infer _SM,
-      infer _PaymentDataMap,
-      infer _ValidatedMap,
-      infer ProviderPaymentDataMap,
-      infer _ProviderReservationPaymentData,
-      infer _CS,
-      infer _RS,
-      infer _ReservationSupport
-  >
-      ? Payment<M, ProviderPaymentDataMap[M]>
-      : never;
+    P extends readonly AnyPaymentProviderInterface[]
+
+> = Payment<M, (ProviderInstanceForMethod<Methods, M, P>['__providerPaymentDataMap'])[M]>;
 
 /**
  * The payment entity type used for reservation payments.
@@ -129,63 +58,19 @@ export type PaymentForMethod<
 export type PaymentReservationForMethod<
     Methods extends readonly PaymentMethod[],
     M extends Methods[number],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
->
-  = ProviderInstanceForMethod<Methods, M, P> extends PaymentProviderInterface<
-      infer _SM,
-      infer _PaymentDataMap,
-      infer _ValidatedMap,
-      infer _ProviderPaymentDataMap,
-      infer ProviderReservationPaymentDataMap,
-      infer _CS,
-      infer _RS,
-      infer _ReservationSupport
-  >
-      ? Payment<M, ProviderReservationPaymentDataMap[M]>
-      : never;
+    P extends readonly AnyPaymentProviderInterface[]
+> = Payment<M, (ProviderInstanceForMethod<Methods, M, P>['__providerReservationPaymentDataMap'])[M]>;
 
 /**
  * Filters to all methods that are allowed for reservation.
  */
 export type AllowedReservationMethods<
     Methods extends readonly PaymentMethod[],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[]
 > = {
-    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends PaymentProviderInterface<
-        infer _SM,
-        infer _PaymentDataMap,
-        infer _ValidatedMap,
-        infer _ProviderPaymentDataMap,
-        infer _ProviderReservationPaymentDataMap,
-        infer _CancellationSupport,
-        infer _RefundSupport,
-        infer ReservationSupport
-    >
-        ? ReservationSupport[K] extends true
-            ? K
-            : never
+    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends { __reservationSupportMap: infer RS }
+        // eslint-disable-next-line typescript/no-explicit-any
+        ? (RS & Record<string, any>)[K] extends true ? K : never
         : never;
 }[Methods[number]];
 
@@ -194,32 +79,12 @@ export type AllowedReservationMethods<
  */
 export type AllowedCancellationMethods<
     Methods extends readonly PaymentMethod[],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[]
 > = {
-    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends PaymentProviderInterface<
-        infer _SM,
-        infer _PaymentDataMap,
-        infer _ValidatedMap,
-        infer _ProviderPaymentDataMap,
-        infer _ProviderReservationPaymentDataMap,
-        infer CancellationSupport,
-        infer _RefundSupport,
-        infer ReservationSupport
-    >
-        ? CancellationSupport[K] extends true
-            ? K
-            : ReservationSupport[K] extends true ? K : never
+    // eslint-disable-next-line stylistic/max-len
+    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends { __cancellationSupportMap: infer CS, __reservationSupportMap: infer RS }
+        // eslint-disable-next-line typescript/no-explicit-any
+        ? (CS & Record<string, any>)[K] extends true ? K : (RS & Record<string, any>)[K] extends true ? K : never
         : never;
 }[Methods[number]];
 
@@ -228,31 +93,10 @@ export type AllowedCancellationMethods<
  */
 export type AllowedRefundMethods<
     Methods extends readonly PaymentMethod[],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[]
 > = {
-    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends PaymentProviderInterface<
-        infer _SM,
-        infer _PaymentDataMap,
-        infer _ValidatedMap,
-        infer _ProviderPaymentDataMap,
-        infer _ProviderReservationPaymentDataMap,
-        infer _CancellationSupport,
-        infer _RefundSupport,
-        infer _ReservationSupport
-    >
-        ? _RefundSupport[K] extends true
-            ? K
-            : never
+    [K in Methods[number]]: ProviderInstanceForMethod<Methods, K, P> extends { __refundSupportMap: infer RS }
+        // eslint-disable-next-line typescript/no-explicit-any
+        ? (RS & Record<string, any>)[K] extends true ? K : never
         : never;
 }[Methods[number]];

package/src/plugin/payment/services/payment.service.ts

@@ -1,34 +1,30 @@
-import { Inject, InjectRepository, ZIBRI_DI_TOKENS } from '../../../di';
-import { AnyObject } from '../../../entity';
-import { type LoggerInterface } from '../../../logging';
-import { Payment, PaymentMethod, PaymentStatus, type PaymentPluginOptions } from '../models';
-import { ZIBRI_PAYMENT_DI_TOKENS } from '../payment.tokens';
-import { PaymentProviderInterface } from '../providers';
 import { PaymentServiceInterface } from './payment-service.interface';
-import { AllowedCancellationMethods, AllowedRefundMethods, AllowedReservationMethods, PaymentDataForMethod, PaymentForMethod, PaymentReservationForMethod, ValidatedPaymentDataForMethod } from './payment-service.types';
-import { Repository } from '../../../data-source';
+import { PaymentDataForMethod, ValidatedPaymentDataForMethod, PaymentForMethod, AllowedReservationMethods, PaymentReservationForMethod, AllowedCancellationMethods, AllowedRefundMethods } from './payment-service.types';
+import { Repository } from '../../../data-source/repository';
+import { InjectRepository } from '../../../di/decorators/inject-repository.decorator';
+import { Inject } from '../../../di/decorators/inject.decorator';
+import { Injectable } from '../../../di/decorators/injectable.decorator';
+import { ZIBRI_DI_TOKENS } from '../../../di/default/zibri-di-tokens.default';
+import { AnyObject } from '../../../entity/any-object.model';
+import { type LoggerInterface } from '../../../logging/logger.interface';
+import { PaymentMethod } from '../models/payment-method.model';
+import { type PaymentPluginOptions } from '../models/payment-plugin-options.model';
+import { PaymentStatus } from '../models/payment-status.enum';
+import { Payment } from '../models/payment.model';
+import { ZIBRI_PAYMENT_PLUGIN_DI_TOKENS } from '../payment.tokens';
+import { AnyPaymentProviderInterface } from '../providers/payment-provider.interface';
 
 /**
  * Default payment service implementation of zibri.
  */
+@Injectable({ register: 'onUse' })
 export class PaymentService<
     Methods extends readonly PaymentMethod[],
-    P extends readonly PaymentProviderInterface<
-        Methods[number][],
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        // eslint-disable-next-line jsdoc/require-jsdoc
-        Record<Methods[number], AnyObject & { transactionId: string }>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], AnyObject>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>,
-        Record<Methods[number], boolean>
-    >[]
+    P extends readonly AnyPaymentProviderInterface[]
 >implements PaymentServiceInterface<Methods, P> {
 
     constructor(
-        @Inject(ZIBRI_PAYMENT_DI_TOKENS.OPTIONS)
+        @Inject(ZIBRI_PAYMENT_PLUGIN_DI_TOKENS.OPTIONS)
         protected readonly options: PaymentPluginOptions<Methods, P>,
         @Inject(ZIBRI_DI_TOKENS.LOGGER)
         protected readonly logger: LoggerInterface,
@@ -55,8 +51,11 @@ export class PaymentService<
             method,
             data
         ) as ValidatedPaymentDataForMethod<Methods, M, P>;
-        if ((await this.paymentRepository.findAll({ where: { transactionId: data.transactionId } })).length) {
-            throw new Error(`a payment for the transactionId "${data.transactionId}" already exists`);
+
+        // eslint-disable-next-line jsdoc/require-jsdoc
+        const { transactionId } = data as unknown as { transactionId: string };
+        if ((await this.paymentRepository.findAll({ where: { transactionId } })).length) {
+            throw new Error(`a payment for the transactionId "${transactionId}" already exists`);
         }
         return res;
     }
@@ -76,7 +75,7 @@ export class PaymentService<
         data: ValidatedPaymentDataForMethod<Methods, M, P>
     ): Promise<PaymentReservationForMethod<Methods, M, P>> {
         const provider: P[number] = this.findPaymentProviderForMethod(method);
-        return await provider.startPayment(method, data) as PaymentReservationForMethod<Methods, M, P>;
+        return await provider.startPaymentReservation(method, data) as PaymentReservationForMethod<Methods, M, P>;
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc

package/src/plugin/plugin.model.ts

@@ -1,9 +1,9 @@
 import { ZibriApplication } from '../application';
-import { AuthStrategies } from '../auth';
-import { CronJob } from '../cron';
-import { DiProvider } from '../di';
-import { BodyParserInterface } from '../parsing';
-import { Newable } from '../types';
+import { AuthStrategies } from '../auth/strategies/auth-strategies.model';
+import { CronJob } from '../cron/cron-job.model';
+import { DiProvider } from '../di/models/di-provider.model';
+import { BodyParserInterface } from '../parsing/body-parser.interface';
+import { Newable } from '../types/newable.type';
 
 /**
  * A bundle of providers, controllers, cronJobs, bodyParsers and authStrategies.
@@ -37,7 +37,7 @@ export abstract class ZibriPlugin {
      * Validates that the plugin can work correctly. This should check that all entities exist,
      * all required providers exist etc.
      *
-     * It's called after the initialization of the app, so that data sources etc. Should all be available.
+     * It's called at the end of app initialization, so that data sources etc. Should all be available.
      */
     abstract validate(app: ZibriApplication): void | Promise<void>;
 }