@forklaunch/implementation-billing-base 0.3.2 → 0.3.3

package/lib/eject/domain/schemas/billingPortal.schema.ts

@@ -8,22 +8,24 @@ import {
 
 export const CreateBillingPortalSchema = {
   customerId: string,
-  uri: string,
-  expiresAt: date
+  expiresAt: date,
+  uri: optional(string),
+  providerFields: optional(unknown)
 };
 
 export const UpdateBillingPortalSchema = ({ uuidId }: { uuidId: boolean }) => ({
   id: uuidId ? uuid : string,
   uri: optional(string),
-  expiresAt: optional(date)
+  expiresAt: optional(date),
+  providerFields: optional(unknown)
 });
 
 export const BillingPortalSchema = ({ uuidId }: { uuidId: boolean }) => ({
   id: uuidId ? uuid : string,
   customerId: string,
-  uri: string,
+  uri: optional(string),
   expiresAt: date,
-  extraFields: optional(unknown),
+  providerFields: optional(unknown),
   createdAt: optional(date),
   updatedAt: optional(date)
 });

package/lib/eject/domain/schemas/checkoutSession.schema.ts

@@ -11,57 +11,65 @@ import {
 
 export const CreateCheckoutSessionSchema = <
   T extends Record<string, LiteralSchema>,
-  U extends Record<string, LiteralSchema>
+  U extends Record<string, LiteralSchema>,
+  V extends Record<string, LiteralSchema>
 >(
   PaymentMethodEnum: T,
+  CurrencyEnum: V,
   StatusEnum: U
 ) => ({
   customerId: string,
   paymentMethods: array(enum_(PaymentMethodEnum)),
-  successRedirectUri: string,
-  cancelRedirectUri: string,
+  currency: enum_(CurrencyEnum),
+  successRedirectUri: optional(string),
+  cancelRedirectUri: optional(string),
   expiresAt: date,
   status: enum_(StatusEnum),
-  extraFields: optional(unknown)
+  providerFields: optional(unknown)
 });
 
 export const UpdateCheckoutSessionSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
     PaymentMethodEnum: T,
-    StatusEnum: U
+    CurrencyEnum: U,
+    StatusEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     customerId: optional(string),
     paymentMethods: optional(array(enum_(PaymentMethodEnum))),
+    currency: optional(enum_(CurrencyEnum)),
     successRedirectUri: optional(string),
     cancelRedirectUri: optional(string),
     expiresAt: optional(date),
     status: optional(enum_(StatusEnum)),
-    extraFields: optional(unknown)
+    providerFields: optional(unknown)
   });
 
 export const CheckoutSessionSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
     PaymentMethodEnum: T,
-    StatusEnum: U
+    CurrencyEnum: U,
+    StatusEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     customerId: string,
-    metadata: optional(unknown),
     paymentMethods: array(enum_(PaymentMethodEnum)),
-    successRedirectUri: string,
-    cancelRedirectUri: string,
+    currency: enum_(CurrencyEnum),
+    successRedirectUri: optional(string),
+    cancelRedirectUri: optional(string),
     expiresAt: date,
     status: enum_(StatusEnum),
-    extraFields: optional(unknown),
+    providerFields: optional(unknown),
     createdAt: optional(date),
     updatedAt: optional(date)
   });

package/lib/eject/domain/schemas/paymentLink.schema.ts

@@ -1,5 +1,6 @@
 import { LiteralSchema } from '@forklaunch/validator';
 import {
+  array,
   date,
   enum_,
   number,
@@ -11,62 +12,56 @@ import {
 
 export const CreatePaymentLinkSchema = <
   T extends Record<string, LiteralSchema>,
-  U extends Record<string, LiteralSchema>
+  U extends Record<string, LiteralSchema>,
+  V extends Record<string, LiteralSchema>
 >(
-  CurrencyEnum: T,
-  StatusEnum: U
+  PaymentMethodEnum: T,
+  CurrencyEnum: U,
+  StatusEnum: V
 ) => ({
   amount: number,
+  paymentMethods: array(enum_(PaymentMethodEnum)),
   currency: enum_(CurrencyEnum),
-  description: optional(string),
-  metadata: optional(unknown),
-  successRedirectUri: string,
-  cancelRedirectUri: string,
-  expiresAt: date,
   status: enum_(StatusEnum),
-  extraFields: optional(unknown)
+  providerFields: optional(unknown)
 });
 
 export const UpdatePaymentLinkSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
-    CurrencyEnum: T,
-    StatusEnum: U
+    PaymentMethodEnum: T,
+    CurrencyEnum: U,
+    StatusEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     amount: optional(number),
+    paymentMethods: optional(array(enum_(PaymentMethodEnum))),
     currency: optional(enum_(CurrencyEnum)),
-    description: optional(string),
-    metadata: optional(unknown),
-    successRedirectUri: optional(string),
-    cancelRedirectUri: optional(string),
-    expiresAt: optional(date),
     status: optional(enum_(StatusEnum)),
-    extraFields: optional(unknown)
+    providerFields: optional(unknown)
   });
 
 export const PaymentLinkSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
-    CurrencyEnum: T,
-    StatusEnum: U
+    PaymentMethodEnum: T,
+    CurrencyEnum: U,
+    StatusEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     amount: number,
+    paymentMethods: array(enum_(PaymentMethodEnum)),
     currency: enum_(CurrencyEnum),
-    description: optional(string),
-    metadata: optional(unknown),
-    successRedirectUri: string,
-    cancelRedirectUri: string,
-    expiresAt: date,
     status: enum_(StatusEnum),
-    extraFields: optional(unknown),
+    providerFields: optional(unknown),
     createdAt: optional(date),
     updatedAt: optional(date)
   });

package/lib/eject/domain/schemas/plan.schema.ts

@@ -13,62 +13,71 @@ import {
 
 export const CreatePlanSchema = <
   T extends Record<string, LiteralSchema>,
-  U extends Record<string, LiteralSchema>
+  U extends Record<string, LiteralSchema>,
+  V extends Record<string, LiteralSchema>
 >(
   PlanCadenceEnum: T,
-  BillingProviderEnum: U
+  CurrencyEnum: U,
+  BillingProviderEnum: V
 ) => ({
   name: string,
   description: optional(string),
   price: number,
   cadence: enum_(PlanCadenceEnum),
-  features: array(string),
-  extraFields: optional(unknown),
+  currency: enum_(CurrencyEnum),
+  features: optional(array(string)),
   externalId: string,
   billingProvider: optional(enum_(BillingProviderEnum)),
-  active: boolean
+  active: boolean,
+  providerFields: optional(unknown)
 });
 
 export const UpdatePlanSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
     PlanCadenceEnum: T,
-    BillingProviderEnum: U
+    CurrencyEnum: U,
+    BillingProviderEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     name: optional(string),
     description: optional(string),
     price: optional(number),
     cadence: optional(enum_(PlanCadenceEnum)),
+    currency: optional(enum_(CurrencyEnum)),
     features: optional(array(string)),
-    extraFields: optional(unknown),
     externalId: optional(string),
     billingProvider: optional(enum_(BillingProviderEnum)),
-    active: optional(boolean)
+    active: optional(boolean),
+    providerFields: optional(unknown)
   });
 
 export const PlanSchema =
   ({ uuidId }: { uuidId: boolean }) =>
   <
     T extends Record<string, LiteralSchema>,
-    U extends Record<string, LiteralSchema>
+    U extends Record<string, LiteralSchema>,
+    V extends Record<string, LiteralSchema>
   >(
     PlanCadenceEnum: T,
-    BillingProviderEnum: U
+    CurrencyEnum: U,
+    BillingProviderEnum: V
   ) => ({
     id: uuidId ? uuid : string,
     name: string,
     description: optional(string),
     price: number,
     cadence: enum_(PlanCadenceEnum),
+    currency: enum_(CurrencyEnum),
     features: optional(array(string)),
-    extraFields: optional(unknown),
     externalId: string,
     billingProvider: optional(enum_(BillingProviderEnum)),
     active: boolean,
+    providerFields: optional(unknown),
     createdAt: optional(date),
     updatedAt: optional(date)
   });

package/lib/eject/domain/schemas/subscription.schema.ts

@@ -23,10 +23,10 @@ export const CreateSubscriptionSchema = <
   active: boolean,
   externalId: string,
   startDate: date,
-  endDate: date,
+  endDate: optional(date),
   status: string,
   billingProvider: optional(enum_(BillingProviderEnum)),
-  extraFields: optional(unknown)
+  providerFields: optional(unknown)
 });
 
 export const UpdateSubscriptionSchema =
@@ -49,7 +49,7 @@ export const UpdateSubscriptionSchema =
     endDate: optional(date),
     status: optional(string),
     billingProvider: optional(enum_(BillingProviderEnum)),
-    extraFields: optional(unknown)
+    providerFields: optional(unknown)
   });
 
 export const SubscriptionSchema =
@@ -69,10 +69,10 @@ export const SubscriptionSchema =
     active: boolean,
     externalId: string,
     startDate: date,
-    endDate: date,
+    endDate: optional(date),
     status: string,
     billingProvider: optional(enum_(BillingProviderEnum)),
-    extraFields: optional(unknown),
+    providerFields: optional(unknown),
     createdAt: optional(date),
     updatedAt: optional(date)
   });

package/lib/eject/services/billingPortal.service.ts

@@ -6,76 +6,61 @@ import {
   OpenTelemetryCollector,
   TelemetryOptions
 } from '@forklaunch/core/http';
-import {
-  InternalDtoMapper,
-  RequestDtoMapperConstructor,
-  ResponseDtoMapperConstructor,
-  transformIntoInternalDtoMapper
-} from '@forklaunch/core/mappers';
 import { BillingPortalService } from '@forklaunch/interfaces-billing/interfaces';
+import { UpdateBillingPortalDto } from '@forklaunch/interfaces-billing/types';
 import {
-  BillingPortalDto,
-  CreateBillingPortalDto,
-  UpdateBillingPortalDto
-} from '@forklaunch/interfaces-billing/types';
+  InternalMapper,
+  RequestMapperConstructor,
+  ResponseMapperConstructor,
+  transformIntoInternalMapper
+} from '@forklaunch/internal';
 import { AnySchemaValidator } from '@forklaunch/validator';
 import { EntityManager } from '@mikro-orm/core';
+import { BaseBillingDtos } from '../types/baseBillingDto.types';
+import { BaseBillingEntities } from '../types/baseBillingEntity.types';
 
 export class BaseBillingPortalService<
   SchemaValidator extends AnySchemaValidator,
-  Metrics extends MetricsDefinition = MetricsDefinition,
-  Dto extends {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: CreateBillingPortalDto;
-    UpdateBillingPortalDtoMapper: UpdateBillingPortalDto;
-  } = {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: CreateBillingPortalDto;
-    UpdateBillingPortalDtoMapper: UpdateBillingPortalDto;
-  },
-  Entities extends {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: BillingPortalDto;
-    UpdateBillingPortalDtoMapper: BillingPortalDto;
-  } = {
-    BillingPortalDtoMapper: BillingPortalDto;
-    CreateBillingPortalDtoMapper: BillingPortalDto;
-    UpdateBillingPortalDtoMapper: BillingPortalDto;
-  }
+  Entities extends BaseBillingEntities,
+  Dto extends BaseBillingDtos = BaseBillingDtos
 > implements BillingPortalService
 {
-  #mappers: InternalDtoMapper<
-    InstanceTypeRecord<typeof this.mappers>,
-    Entities,
-    Dto
-  >;
-  private evaluatedTelemetryOptions: {
+  protected _mappers: InternalMapper<InstanceTypeRecord<typeof this.mappers>>;
+  protected evaluatedTelemetryOptions: {
     logging?: boolean;
     metrics?: boolean;
     tracing?: boolean;
   };
-  private enableDatabaseBackup: boolean;
+  protected enableDatabaseBackup: boolean;
 
   constructor(
     protected em: EntityManager,
     protected cache: TtlCache,
-    protected openTelemetryCollector: OpenTelemetryCollector<Metrics>,
+    protected openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
     protected schemaValidator: SchemaValidator,
     protected mappers: {
-      BillingPortalDtoMapper: ResponseDtoMapperConstructor<
+      BillingPortalMapper: ResponseMapperConstructor<
         SchemaValidator,
-        Dto['BillingPortalDtoMapper'],
-        Entities['BillingPortalDtoMapper']
+        Dto['BillingPortalMapper'],
+        Entities['BillingPortalMapper']
       >;
-      CreateBillingPortalDtoMapper: RequestDtoMapperConstructor<
+      CreateBillingPortalMapper: RequestMapperConstructor<
         SchemaValidator,
-        Dto['CreateBillingPortalDtoMapper'],
-        Entities['CreateBillingPortalDtoMapper']
+        Dto['CreateBillingPortalMapper'],
+        Entities['CreateBillingPortalMapper'],
+        (
+          dto: Dto['CreateBillingPortalMapper'],
+          em: EntityManager
+        ) => Promise<Entities['CreateBillingPortalMapper']>
       >;
-      UpdateBillingPortalDtoMapper: RequestDtoMapperConstructor<
+      UpdateBillingPortalMapper: RequestMapperConstructor<
         SchemaValidator,
-        Dto['UpdateBillingPortalDtoMapper'],
-        Entities['UpdateBillingPortalDtoMapper']
+        Dto['UpdateBillingPortalMapper'],
+        Entities['UpdateBillingPortalMapper'],
+        (
+          dto: Dto['UpdateBillingPortalMapper'],
+          em: EntityManager
+        ) => Promise<Entities['UpdateBillingPortalMapper']>
       >;
     },
     readonly options?: {
@@ -83,7 +68,7 @@ export class BaseBillingPortalService<
       enableDatabaseBackup?: boolean;
     }
   ) {
-    this.#mappers = transformIntoInternalDtoMapper(mappers, schemaValidator);
+    this._mappers = transformIntoInternalMapper(mappers, schemaValidator);
     this.enableDatabaseBackup = options?.enableDatabaseBackup ?? false;
     this.evaluatedTelemetryOptions = options?.telemetry
       ? evaluateTelemetryOptions(options.telemetry).enabled
@@ -97,8 +82,8 @@ export class BaseBillingPortalService<
   protected createCacheKey = createCacheKey('billing_portal_session');
 
   async createBillingPortalSession(
-    billingPortalDto: Dto['CreateBillingPortalDtoMapper']
-  ): Promise<Dto['BillingPortalDtoMapper']> {
+    billingPortalDto: Dto['CreateBillingPortalMapper']
+  ): Promise<Dto['BillingPortalMapper']> {
     if (this.evaluatedTelemetryOptions.logging) {
       this.openTelemetryCollector.info(
         'Creating billing portal session',
@@ -107,7 +92,7 @@ export class BaseBillingPortalService<
     }
 
     const billingPortal =
-      await this.#mappers.CreateBillingPortalDtoMapper.deserializeDtoToEntity(
+      await this._mappers.CreateBillingPortalMapper.deserializeDtoToEntity(
         billingPortalDto,
         this.em
       );
@@ -117,7 +102,7 @@ export class BaseBillingPortalService<
     }
 
     const createdBillingPortalDto =
-      await this.#mappers.BillingPortalDtoMapper.serializeEntityToDto(
+      await this._mappers.BillingPortalMapper.serializeEntityToDto(
         billingPortal
       );
 
@@ -132,13 +117,13 @@ export class BaseBillingPortalService<
 
   async getBillingPortalSession(
     idDto: IdDto
-  ): Promise<Dto['BillingPortalDtoMapper']> {
+  ): Promise<Dto['BillingPortalMapper']> {
     if (this.evaluatedTelemetryOptions.logging) {
       this.openTelemetryCollector.info('Getting billing portal session', idDto);
     }
 
     const billingPortalDetails = await this.cache.readRecord<
-      Entities['BillingPortalDtoMapper']
+      Entities['BillingPortalMapper']
     >(this.createCacheKey(idDto.id));
 
     if (!billingPortalDetails) {
@@ -150,7 +135,7 @@ export class BaseBillingPortalService<
 
   async updateBillingPortalSession(
     billingPortalDto: UpdateBillingPortalDto
-  ): Promise<Dto['BillingPortalDtoMapper']> {
+  ): Promise<Dto['BillingPortalMapper']> {
     if (this.evaluatedTelemetryOptions.logging) {
       this.openTelemetryCollector.info(
         'Updating billing portal session',
@@ -159,7 +144,7 @@ export class BaseBillingPortalService<
     }
 
     const existingBillingPortal = (
-      await this.cache.readRecord<Entities['BillingPortalDtoMapper']>(
+      await this.cache.readRecord<Entities['BillingPortalMapper']>(
         this.createCacheKey(billingPortalDto.id)
       )
     )?.value;
@@ -169,7 +154,7 @@ export class BaseBillingPortalService<
     }
 
     const billingPortal =
-      await this.#mappers.UpdateBillingPortalDtoMapper.deserializeDtoToEntity(
+      await this._mappers.UpdateBillingPortalMapper.deserializeDtoToEntity(
         billingPortalDto,
         this.em
       );
@@ -182,7 +167,7 @@ export class BaseBillingPortalService<
 
     const updatedBillingPortalDto = {
       ...existingBillingPortal,
-      ...(await this.#mappers.BillingPortalDtoMapper.serializeEntityToDto(
+      ...(await this._mappers.BillingPortalMapper.serializeEntityToDto(
         billingPortal
       ))
     };