@forklaunch/implementation-billing-stripe 0.5.23 → 1.0.0

package/lib/eject/domain/enum/index.ts

@@ -1,4 +1,5 @@
 export * from './billingProvider.enum';
 export * from './currency.enum';
+export * from './party.enum';
 export * from './paymentMethod.enum';
 export * from './planCadence.enum';

package/lib/eject/domain/enum/party.enum.ts

@@ -0,0 +1,5 @@
+export const PartyEnum = {
+  USER: 'user',
+  ORGANIZATION: 'organization'
+} as const;
+export type PartyEnum = (typeof PartyEnum)[keyof typeof PartyEnum];

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

@@ -27,7 +27,7 @@ export const CreatePlanSchema = {
   features: optional(array(string)),
   stripeFields: type<StripeCreatePlanDto['stripeFields']>(),
   externalId: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
+  billingProvider: enum_(BillingProviderEnum),
   active: boolean
 };
 
@@ -55,7 +55,7 @@ export const PlanSchema = {
   features: optional(array(string)),
   stripeFields: type<StripePlanDto['stripeFields']>(),
   externalId: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
+  billingProvider: enum_(BillingProviderEnum),
   active: boolean,
   createdAt: optional(date),
   updatedAt: optional(date)

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

@@ -29,7 +29,7 @@ export const CreateSubscriptionSchema = <
   startDate: date,
   endDate: optional(date),
   status: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
+  billingProvider: enum_(BillingProviderEnum),
   stripeFields: type<StripeCreateSubscriptionDto<T>['stripeFields']>()
 });
 
@@ -65,7 +65,7 @@ export const SubscriptionSchema = <T extends Record<string, LiteralSchema>>(
   startDate: date,
   endDate: optional(date),
   status: string,
-  billingProvider: optional(enum_(BillingProviderEnum)),
+  billingProvider: enum_(BillingProviderEnum),
   stripeFields: type<StripeSubscriptionDto<T>['stripeFields']>(),
   createdAt: optional(date),
   updatedAt: optional(date)

package/lib/eject/domain/types/billingPortal.mapper.types.ts

@@ -1,4 +1,4 @@
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripeBillingPortalDtos } from './stripe.dto.types';
 import { StripeBillingPortalEntities } from './stripe.entity.types';
@@ -8,24 +8,27 @@ export type StripeBillingPortalMappers<
   Dto extends StripeBillingPortalDtos
 > = {
   BillingPortalMapper: {
+    entity: Entities['BillingPortalMapper'];
     toDto: (
-      entity: Entities['BillingPortalMapper']
+      entity: InferEntity<Entities['BillingPortalMapper']>
     ) => Promise<Dto['BillingPortalMapper']>;
   };
   CreateBillingPortalMapper: {
+    entity: Entities['CreateBillingPortalMapper'];
     toEntity: (
       dto: Dto['CreateBillingPortalMapper'],
       em: EntityManager,
       stripeSession: Stripe.BillingPortal.Session,
       ...args: unknown[]
-    ) => Promise<Entities['CreateBillingPortalMapper']>;
+    ) => Promise<InferEntity<Entities['CreateBillingPortalMapper']>>;
   };
   UpdateBillingPortalMapper: {
+    entity: Entities['UpdateBillingPortalMapper'];
     toEntity: (
       dto: Dto['UpdateBillingPortalMapper'],
       em: EntityManager,
       stripeSession: Stripe.BillingPortal.Session,
       ...args: unknown[]
-    ) => Promise<Entities['UpdateBillingPortalMapper']>;
+    ) => Promise<InferEntity<Entities['UpdateBillingPortalMapper']>>;
   };
 };

package/lib/eject/domain/types/checkoutSession.mapper.types.ts

@@ -1,4 +1,4 @@
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripeCheckoutSessionDtos } from './stripe.dto.types';
 import { StripeCheckoutSessionEntities } from './stripe.entity.types';
@@ -9,24 +9,27 @@ export type StripeCheckoutSessionMappers<
   Dto extends StripeCheckoutSessionDtos<StatusEnum>
 > = {
   CheckoutSessionMapper: {
+    entity: Entities['CheckoutSessionMapper'];
     toDto: (
-      entity: Entities['CheckoutSessionMapper']
+      entity: InferEntity<Entities['CheckoutSessionMapper']>
     ) => Promise<Dto['CheckoutSessionMapper']>;
   };
   CreateCheckoutSessionMapper: {
+    entity: Entities['CreateCheckoutSessionMapper'];
     toEntity: (
       dto: Dto['CreateCheckoutSessionMapper'],
       em: EntityManager,
       stripeSession: Stripe.Checkout.Session,
       ...args: unknown[]
-    ) => Promise<Entities['CreateCheckoutSessionMapper']>;
+    ) => Promise<InferEntity<Entities['CreateCheckoutSessionMapper']>>;
   };
   UpdateCheckoutSessionMapper: {
+    entity: Entities['UpdateCheckoutSessionMapper'];
     toEntity: (
       dto: Dto['UpdateCheckoutSessionMapper'],
       em: EntityManager,
       stripeSession: Stripe.Checkout.Session,
       ...args: unknown[]
-    ) => Promise<Entities['UpdateCheckoutSessionMapper']>;
+    ) => Promise<InferEntity<Entities['UpdateCheckoutSessionMapper']>>;
   };
 };

package/lib/eject/domain/types/paymentLink.mapper.types.ts

@@ -1,4 +1,4 @@
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripePaymentLinkDtos } from './stripe.dto.types';
 import { StripePaymentLinkEntities } from './stripe.entity.types';
@@ -9,24 +9,27 @@ export type StripePaymentLinkMappers<
   Dto extends StripePaymentLinkDtos<StatusEnum>
 > = {
   PaymentLinkMapper: {
+    entity: Entities['PaymentLinkMapper'];
     toDto: (
-      entity: Entities['PaymentLinkMapper']
+      entity: InferEntity<Entities['PaymentLinkMapper']>
     ) => Promise<Dto['PaymentLinkMapper']>;
   };
   CreatePaymentLinkMapper: {
+    entity: Entities['CreatePaymentLinkMapper'];
     toEntity: (
       dto: Dto['CreatePaymentLinkMapper'],
       em: EntityManager,
       stripePaymentLink: Stripe.PaymentLink,
       ...args: unknown[]
-    ) => Promise<Entities['CreatePaymentLinkMapper']>;
+    ) => Promise<InferEntity<Entities['CreatePaymentLinkMapper']>>;
   };
   UpdatePaymentLinkMapper: {
+    entity: Entities['UpdatePaymentLinkMapper'];
     toEntity: (
       dto: Dto['UpdatePaymentLinkMapper'],
       em: EntityManager,
       stripePaymentLink: Stripe.PaymentLink,
       ...args: unknown[]
-    ) => Promise<Entities['UpdatePaymentLinkMapper']>;
+    ) => Promise<InferEntity<Entities['UpdatePaymentLinkMapper']>>;
   };
 };

package/lib/eject/domain/types/plan.mapper.types.ts

@@ -1,4 +1,4 @@
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripePlanDtos } from './stripe.dto.types';
 import { StripePlanEntities } from './stripe.entity.types';
@@ -8,22 +8,27 @@ export type StripePlanMappers<
   Dto extends StripePlanDtos
 > = {
   PlanMapper: {
-    toDto: (entity: Entities['PlanMapper']) => Promise<Dto['PlanMapper']>;
+    entity: Entities['PlanMapper'];
+    toDto: (
+      entity: InferEntity<Entities['PlanMapper']>
+    ) => Promise<Dto['PlanMapper']>;
   };
   CreatePlanMapper: {
+    entity: Entities['CreatePlanMapper'];
     toEntity: (
       dto: Dto['CreatePlanMapper'],
       em: EntityManager,
       stripePlan: Stripe.Product,
       ...args: unknown[]
-    ) => Promise<Entities['CreatePlanMapper']>;
+    ) => Promise<InferEntity<Entities['CreatePlanMapper']>>;
   };
   UpdatePlanMapper: {
+    entity: Entities['UpdatePlanMapper'];
     toEntity: (
       dto: Dto['UpdatePlanMapper'],
       em: EntityManager,
       stripePlan: Stripe.Product,
       ...args: unknown[]
-    ) => Promise<Entities['UpdatePlanMapper']>;
+    ) => Promise<InferEntity<Entities['UpdatePlanMapper']>>;
   };
 };

package/lib/eject/domain/types/stripe.entity.types.ts

@@ -1,83 +1,123 @@
 import {
-  BillingPortalDto,
-  CheckoutSessionDto,
-  PaymentLinkDto,
-  PlanDto,
-  SubscriptionDto
-} from '@forklaunch/interfaces-billing/types';
-import Stripe from 'stripe';
-import { BillingProviderEnum } from '../enum/billingProvider.enum';
-import { CurrencyEnum } from '../enum/currency.enum';
-import { PaymentMethodEnum } from '../enum/paymentMethod.enum';
-import { PlanCadenceEnum } from '../enum/planCadence.enum';
+  BillingPortal,
+  CheckoutSession,
+  PaymentLink,
+  Plan,
+  Subscription
+} from '../../persistence/entities';
+import {
+  BillingProviderEnum,
+  CurrencyEnum,
+  PaymentMethodEnum,
+  PlanCadenceEnum
+} from '../enum';
 
 // Billing Portal Types
-export type StripeBillingPortalEntity = BillingPortalDto & {
-  providerFields: Stripe.BillingPortal.Session;
-};
-
 export type StripeBillingPortalEntities = {
-  BillingPortalMapper: StripeBillingPortalEntity;
-  CreateBillingPortalMapper: StripeBillingPortalEntity;
-  UpdateBillingPortalMapper: StripeBillingPortalEntity;
+  BillingPortalMapper: {
+    '~entity': (typeof BillingPortal)['~entity'];
+  };
+  CreateBillingPortalMapper: {
+    '~entity': (typeof BillingPortal)['~entity'];
+  };
+  UpdateBillingPortalMapper: {
+    '~entity': (typeof BillingPortal)['~entity'];
+  };
 };
 
 // Checkout Session Types
-
-export type StripeCheckoutSessionEntity<StatusEnum> = CheckoutSessionDto<
-  typeof PaymentMethodEnum,
-  typeof CurrencyEnum,
-  StatusEnum
-> & {
-  providerFields: Stripe.Checkout.Session;
-};
-
 export type StripeCheckoutSessionEntities<StatusEnum> = {
-  CheckoutSessionMapper: StripeCheckoutSessionEntity<StatusEnum>;
-  CreateCheckoutSessionMapper: StripeCheckoutSessionEntity<StatusEnum>;
-  UpdateCheckoutSessionMapper: StripeCheckoutSessionEntity<StatusEnum>;
+  CheckoutSessionMapper: {
+    '~entity': (typeof CheckoutSession)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
+  CreateCheckoutSessionMapper: {
+    '~entity': (typeof CheckoutSession)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
+  UpdateCheckoutSessionMapper: {
+    '~entity': (typeof CheckoutSession)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
 };
 
 // Payment Link Types
-export type StripePaymentLinkEntity<StatusEnum> = PaymentLinkDto<
-  typeof PaymentMethodEnum,
-  typeof CurrencyEnum,
-  StatusEnum
-> & {
-  providerFields: Stripe.PaymentLink;
-};
-
 export type StripePaymentLinkEntities<StatusEnum> = {
-  PaymentLinkMapper: StripePaymentLinkEntity<StatusEnum>;
-  CreatePaymentLinkMapper: StripePaymentLinkEntity<StatusEnum>;
-  UpdatePaymentLinkMapper: StripePaymentLinkEntity<StatusEnum>;
+  PaymentLinkMapper: {
+    '~entity': (typeof PaymentLink)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
+  CreatePaymentLinkMapper: {
+    '~entity': (typeof PaymentLink)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
+  UpdatePaymentLinkMapper: {
+    '~entity': (typeof PaymentLink)['~entity'] & {
+      paymentMethods: PaymentMethodEnum[keyof PaymentMethodEnum][];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      status: StatusEnum[keyof StatusEnum];
+    };
+  };
 };
 
 // Plan Types
-export type StripePlanEntity = PlanDto<
-  typeof PlanCadenceEnum,
-  typeof CurrencyEnum,
-  typeof BillingProviderEnum
-> & {
-  providerFields: Stripe.Product;
-};
-
 export type StripePlanEntities = {
-  PlanMapper: StripePlanEntity;
-  CreatePlanMapper: StripePlanEntity;
-  UpdatePlanMapper: StripePlanEntity;
+  PlanMapper: {
+    '~entity': (typeof Plan)['~entity'] & {
+      cadence: PlanCadenceEnum[keyof PlanCadenceEnum];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
+  CreatePlanMapper: {
+    '~entity': (typeof Plan)['~entity'] & {
+      cadence: PlanCadenceEnum[keyof PlanCadenceEnum];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
+  UpdatePlanMapper: {
+    '~entity': (typeof Plan)['~entity'] & {
+      cadence: PlanCadenceEnum[keyof PlanCadenceEnum];
+      currency: CurrencyEnum[keyof CurrencyEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
 };
 
 // Subscription Types
-export type StripeSubscriptionEntity<PartyType> = SubscriptionDto<
-  PartyType,
-  typeof BillingProviderEnum
-> & {
-  providerFields: Stripe.Subscription;
-};
-
-export type StripeSubscriptionEntities<PartyType> = {
-  SubscriptionMapper: StripeSubscriptionEntity<PartyType>;
-  CreateSubscriptionMapper: StripeSubscriptionEntity<PartyType>;
-  UpdateSubscriptionMapper: StripeSubscriptionEntity<PartyType>;
+export type StripeSubscriptionEntities<PartyTypeEnum> = {
+  SubscriptionMapper: {
+    '~entity': (typeof Subscription)['~entity'] & {
+      partyType: PartyTypeEnum[keyof PartyTypeEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
+  CreateSubscriptionMapper: {
+    '~entity': (typeof Subscription)['~entity'] & {
+      partyType: PartyTypeEnum[keyof PartyTypeEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
+  UpdateSubscriptionMapper: {
+    '~entity': (typeof Subscription)['~entity'] & {
+      partyType: PartyTypeEnum[keyof PartyTypeEnum];
+      billingProvider: BillingProviderEnum[keyof BillingProviderEnum];
+    };
+  };
 };

package/lib/eject/domain/types/stripeWebhookEvent.types.ts

@@ -0,0 +1,16 @@
+import { defineEntity, p, type InferEntity } from '@mikro-orm/core';
+
+export const StripeWebhookEventEntity = defineEntity({
+  name: 'StripeWebhookEvent',
+  properties: {
+    id: p.uuid().primary(),
+    createdAt: p.datetime(),
+    updatedAt: p.datetime(),
+    stripeId: p.string(),
+    idempotencyKey: p.string().nullable(),
+    eventType: p.string(),
+    eventData: p.json<unknown>()
+  }
+});
+
+export type StripeWebhookEvent = InferEntity<typeof StripeWebhookEventEntity>;

package/lib/eject/domain/types/subscription.mapper.types.ts

@@ -1,32 +1,35 @@
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripeSubscriptionDtos } from './stripe.dto.types';
 import { StripeSubscriptionEntities } from './stripe.entity.types';
 
 export type StripeSubscriptionMappers<
-  PartyType,
-  Entities extends StripeSubscriptionEntities<PartyType>,
-  Dto extends StripeSubscriptionDtos<PartyType>
+  PartyTypeEnum,
+  Entities extends StripeSubscriptionEntities<PartyTypeEnum>,
+  Dto extends StripeSubscriptionDtos<PartyTypeEnum>
 > = {
   SubscriptionMapper: {
+    entity: Entities['SubscriptionMapper'];
     toDto: (
-      entity: Entities['SubscriptionMapper']
+      entity: InferEntity<Entities['SubscriptionMapper']>
     ) => Promise<Dto['SubscriptionMapper']>;
   };
   CreateSubscriptionMapper: {
+    entity: Entities['CreateSubscriptionMapper'];
     toEntity: (
       dto: Dto['CreateSubscriptionMapper'],
       em: EntityManager,
       stripeSubscription: Stripe.Subscription,
       ...args: unknown[]
-    ) => Promise<Entities['CreateSubscriptionMapper']>;
+    ) => Promise<InferEntity<Entities['CreateSubscriptionMapper']>>;
   };
   UpdateSubscriptionMapper: {
+    entity: Entities['UpdateSubscriptionMapper'];
     toEntity: (
       dto: Dto['UpdateSubscriptionMapper'],
       em: EntityManager,
       stripeSubscription: Stripe.Subscription,
       ...args: unknown[]
-    ) => Promise<Entities['UpdateSubscriptionMapper']>;
+    ) => Promise<InferEntity<Entities['UpdateSubscriptionMapper']>>;
   };
 };

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

@@ -23,7 +23,7 @@ import { StripeCheckoutSessionEntities } from '../domain/types/stripe.entity.typ
 export class StripeCheckoutSessionService<
   SchemaValidator extends AnySchemaValidator,
   StatusEnum,
-  Entities extends StripeCheckoutSessionEntities<StatusEnum>,
+  MapperEntities extends StripeCheckoutSessionEntities<StatusEnum>,
   Dto extends
     StripeCheckoutSessionDtos<StatusEnum> = StripeCheckoutSessionDtos<StatusEnum>
 > implements
@@ -43,7 +43,7 @@ export class StripeCheckoutSessionService<
     PaymentMethodEnum,
     CurrencyEnum,
     StatusEnum,
-    Entities,
+    MapperEntities,
     Dto
   >;
   protected readonly stripeClient: Stripe;
@@ -53,7 +53,7 @@ export class StripeCheckoutSessionService<
   protected readonly schemaValidator: SchemaValidator;
   protected readonly mappers: StripeCheckoutSessionMappers<
     StatusEnum,
-    Entities,
+    MapperEntities,
     Dto
   >;
 
@@ -63,7 +63,7 @@ export class StripeCheckoutSessionService<
     cache: TtlCache,
     openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>,
     schemaValidator: SchemaValidator,
-    mappers: StripeCheckoutSessionMappers<StatusEnum, Entities, Dto>,
+    mappers: StripeCheckoutSessionMappers<StatusEnum, MapperEntities, Dto>,
     readonly options?: {
       enableDatabaseBackup?: boolean;
       telemetry?: TelemetryOptions;
@@ -84,7 +84,7 @@ export class StripeCheckoutSessionService<
         PaymentMethodEnum,
         CurrencyEnum,
         StatusEnum,
-        Entities,
+        MapperEntities,
         Dto
       >,
       options

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

@@ -138,18 +138,20 @@ export class StripePaymentLinkService<
     );
 
     const paymentLink = await this.basePaymentLinkService.updatePaymentLink(
-      await this.mappers.UpdatePaymentLinkMapper.toEntity(
-        {
-          ...paymentLinkDto,
-          id: session.id,
-          amount:
-            session.line_items?.data.reduce<number>(
-              (total, item) => total + item.amount_total,
-              0
-            ) ?? 0
-        },
-        this.em,
-        session
+      await this.mappers.PaymentLinkMapper.toDto(
+        await this.mappers.UpdatePaymentLinkMapper.toEntity(
+          {
+            ...paymentLinkDto,
+            id: session.id,
+            amount:
+              session.line_items?.data.reduce<number>(
+                (total, item) => total + item.amount_total,
+                0
+              ) ?? 0
+          },
+          this.em,
+          session
+        )
       ),
       ...args
     );

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

@@ -5,7 +5,8 @@ import {
 import { AnySchemaValidator } from '@forklaunch/validator';
 import { EntityManager } from '@mikro-orm/core';
 import Stripe from 'stripe';
-import { PartyEnum } from '../../../../billing-base/domain/enum/party.enum';
+import { PartyEnum } from '../domain/enum/party.enum';
+import { StripeWebhookEvent } from '../persistence/entities';
 import { BillingProviderEnum } from '../domain/enum/billingProvider.enum';
 import { CurrencyEnum } from '../domain/enum/currency.enum';
 import { PaymentMethodEnum } from '../domain/enum/paymentMethod.enum';
@@ -136,7 +137,7 @@ export class StripeWebhookService<
     }
 
     if (
-      await this.em.findOne('StripeWebhookEvent', {
+      await this.em.findOne(StripeWebhookEvent, {
         idempotencyKey: event.request?.idempotency_key
       })
     ) {
@@ -454,7 +455,7 @@ export class StripeWebhookService<
         break;
     }
 
-    await this.em.insert('StripeWebhookEvent', {
+    await this.em.insert(StripeWebhookEvent, {
       stripeId: event.id,
       idempotencyKey: event.request?.idempotency_key,
       eventType: event.type,