@forklaunch/implementation-billing-stripe 1.1.31 → 1.1.32

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

@@ -38,8 +38,8 @@ import { StripeSubscriptionService } from './subscription.service';
 type StripeWebhookEventEntity = InferEntity<typeof StripeWebhookEvent>;
 // mikro-orm 7 narrowed EntityName's type to exclude strings, but the runtime
 // resolves registered entity names as it always has — and name resolution is
-// exactly what we need here (see above).
-const STRIPE_WEBHOOK_EVENT_ENTITY =
+// exactly what we need by default (see above).
+const DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY =
   'StripeWebhookEvent' as unknown as EntityName<StripeWebhookEventEntity>;
 
 export class StripeWebhookService<
@@ -57,6 +57,7 @@ export class StripeWebhookService<
     StripeSubscriptionEntities<PartyEnum> = StripeSubscriptionEntities<PartyEnum>
 > {
   protected readonly partyEnum: PartyEnum;
+  protected readonly webhookEventEntity: EntityName<StripeWebhookEventEntity>;
   protected readonly stripeClient: Stripe;
   protected readonly em: EntityManager;
   protected readonly schemaValidator: SchemaValidator;
@@ -110,8 +111,16 @@ export class StripeWebhookService<
       PartyEnum,
       SubscriptionEntities
     >,
-    partyEnum: PartyEnum
+    partyEnum: PartyEnum,
+    /**
+     * The entity used for webhook idempotency records. Defaults to
+     * resolving the application's discovered entity named
+     * 'StripeWebhookEvent'; inject your own entity (mapper-style) to use a
+     * different one.
+     */
+    webhookEventEntity: EntityName<StripeWebhookEventEntity> = DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY
   ) {
+    this.webhookEventEntity = webhookEventEntity;
     this.partyEnum = partyEnum;
     this.stripeClient = stripeClient;
     this.em = em;
@@ -174,7 +183,7 @@ export class StripeWebhookService<
 
     if (
       await this.em.findOne<StripeWebhookEventEntity>(
-        STRIPE_WEBHOOK_EVENT_ENTITY,
+        this.webhookEventEntity,
         {
           idempotencyKey: event.request?.idempotency_key
         }
@@ -497,7 +506,7 @@ export class StripeWebhookService<
     // em.create (not native em.insert): the app's entity generates its id and
     // timestamps via onCreate hooks, which native inserts bypass — a native
     // insert fails NOT NULL on id for sqlBaseProperties-style entities.
-    this.em.create<StripeWebhookEventEntity>(STRIPE_WEBHOOK_EVENT_ENTITY, {
+    this.em.create<StripeWebhookEventEntity>(this.webhookEventEntity, {
       stripeId: event.id,
       idempotencyKey: event.request?.idempotency_key,
       eventType: event.type,

package/lib/services/index.js

@@ -627,9 +627,10 @@ var BillingProviderEnum = {
 };
 
 // services/webhook.service.ts
-var STRIPE_WEBHOOK_EVENT_ENTITY = "StripeWebhookEvent";
+var DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY = "StripeWebhookEvent";
 var StripeWebhookService = class {
   partyEnum;
+  webhookEventEntity;
   stripeClient;
   em;
   schemaValidator;
@@ -639,7 +640,8 @@ var StripeWebhookService = class {
   paymentLinkService;
   planService;
   subscriptionService;
-  constructor(stripeClient, em, schemaValidator, openTelemetryCollector, billingPortalService, checkoutSessionService, paymentLinkService, planService, subscriptionService, partyEnum) {
+  constructor(stripeClient, em, schemaValidator, openTelemetryCollector, billingPortalService, checkoutSessionService, paymentLinkService, planService, subscriptionService, partyEnum, webhookEventEntity = DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY) {
+    this.webhookEventEntity = webhookEventEntity;
     this.partyEnum = partyEnum;
     this.stripeClient = stripeClient;
     this.em = em;
@@ -686,7 +688,7 @@ var StripeWebhookService = class {
       this.openTelemetryCollector.info("Handling webhook event", event);
     }
     if (await this.em.findOne(
-      STRIPE_WEBHOOK_EVENT_ENTITY,
+      this.webhookEventEntity,
       {
         idempotencyKey: event.request?.idempotency_key
       }
@@ -933,7 +935,7 @@ var StripeWebhookService = class {
         );
         break;
     }
-    this.em.create(STRIPE_WEBHOOK_EVENT_ENTITY, {
+    this.em.create(this.webhookEventEntity, {
       stripeId: event.id,
       idempotencyKey: event.request?.idempotency_key,
       eventType: event.type,

package/lib/services/index.mjs

@@ -595,9 +595,10 @@ var BillingProviderEnum = {
 };
 
 // services/webhook.service.ts
-var STRIPE_WEBHOOK_EVENT_ENTITY = "StripeWebhookEvent";
+var DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY = "StripeWebhookEvent";
 var StripeWebhookService = class {
   partyEnum;
+  webhookEventEntity;
   stripeClient;
   em;
   schemaValidator;
@@ -607,7 +608,8 @@ var StripeWebhookService = class {
   paymentLinkService;
   planService;
   subscriptionService;
-  constructor(stripeClient, em, schemaValidator, openTelemetryCollector, billingPortalService, checkoutSessionService, paymentLinkService, planService, subscriptionService, partyEnum) {
+  constructor(stripeClient, em, schemaValidator, openTelemetryCollector, billingPortalService, checkoutSessionService, paymentLinkService, planService, subscriptionService, partyEnum, webhookEventEntity = DEFAULT_STRIPE_WEBHOOK_EVENT_ENTITY) {
+    this.webhookEventEntity = webhookEventEntity;
     this.partyEnum = partyEnum;
     this.stripeClient = stripeClient;
     this.em = em;
@@ -654,7 +656,7 @@ var StripeWebhookService = class {
       this.openTelemetryCollector.info("Handling webhook event", event);
     }
     if (await this.em.findOne(
-      STRIPE_WEBHOOK_EVENT_ENTITY,
+      this.webhookEventEntity,
       {
         idempotencyKey: event.request?.idempotency_key
       }
@@ -901,7 +903,7 @@ var StripeWebhookService = class {
         );
         break;
     }
-    this.em.create(STRIPE_WEBHOOK_EVENT_ENTITY, {
+    this.em.create(this.webhookEventEntity, {
       stripeId: event.id,
       idempotencyKey: event.request?.idempotency_key,
       eventType: event.type,

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

@@ -1,15 +1,29 @@
 import { MetricsDefinition, OpenTelemetryCollector } from '@forklaunch/core/http';
 import { AnySchemaValidator } from '@forklaunch/validator';
-import { EntityManager } from '@mikro-orm/core';
+import { EntityManager, EntityName, InferEntity } from '@mikro-orm/core';
 import Stripe from 'stripe';
 import { StripeBillingPortalEntities, StripeCheckoutSessionEntities, StripePaymentLinkEntities, StripePlanEntities, StripeSubscriptionEntities } from '../domain/types/stripe.entity.types';
+import { StripeWebhookEvent } from '../persistence/entities';
 import { StripeBillingPortalService } from './billingPortal.service';
 import { StripeCheckoutSessionService } from './checkoutSession.service';
 import { StripePaymentLinkService } from './paymentLink.service';
 import { StripePlanService } from './plan.service';
 import { StripeSubscriptionService } from './subscription.service';
+/**
+ * Webhook idempotency records are looked up and written BY NAME so they
+ * resolve against the consuming application's discovered metadata. Passing
+ * this package's internal `StripeWebhookEvent` object to the EntityManager
+ * queries an entity the app's ORM never discovered, which mikro-orm 7.1.x
+ * rejects deep in EntityLoader (`meta.relations` is undefined for
+ * undiscovered entities). Applications must discover an entity named
+ * `StripeWebhookEvent` — either their own definition (the blueprint app
+ * ships one) or this package's, importable from
+ * `@forklaunch/implementation-billing-stripe/persistence`.
+ */
+type StripeWebhookEventEntity = InferEntity<typeof StripeWebhookEvent>;
 export declare class StripeWebhookService<SchemaValidator extends AnySchemaValidator, StatusEnum, PartyEnum, BillingPortalEntities extends StripeBillingPortalEntities = StripeBillingPortalEntities, CheckoutSessionEntities extends StripeCheckoutSessionEntities<StatusEnum> = StripeCheckoutSessionEntities<StatusEnum>, PaymentLinkEntities extends StripePaymentLinkEntities<StatusEnum> = StripePaymentLinkEntities<StatusEnum>, PlanEntities extends StripePlanEntities = StripePlanEntities, SubscriptionEntities extends StripeSubscriptionEntities<PartyEnum> = StripeSubscriptionEntities<PartyEnum>> {
     protected readonly partyEnum: PartyEnum;
+    protected readonly webhookEventEntity: EntityName<StripeWebhookEventEntity>;
     protected readonly stripeClient: Stripe;
     protected readonly em: EntityManager;
     protected readonly schemaValidator: SchemaValidator;
@@ -19,7 +33,14 @@ export declare class StripeWebhookService<SchemaValidator extends AnySchemaValid
     protected readonly paymentLinkService: StripePaymentLinkService<SchemaValidator, StatusEnum, PaymentLinkEntities>;
     protected readonly planService: StripePlanService<SchemaValidator, PlanEntities>;
     protected readonly subscriptionService: StripeSubscriptionService<SchemaValidator, PartyEnum, SubscriptionEntities>;
-    constructor(stripeClient: Stripe, em: EntityManager, schemaValidator: SchemaValidator, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, billingPortalService: StripeBillingPortalService<SchemaValidator, BillingPortalEntities>, checkoutSessionService: StripeCheckoutSessionService<SchemaValidator, StatusEnum, CheckoutSessionEntities>, paymentLinkService: StripePaymentLinkService<SchemaValidator, StatusEnum, PaymentLinkEntities>, planService: StripePlanService<SchemaValidator, PlanEntities>, subscriptionService: StripeSubscriptionService<SchemaValidator, PartyEnum, SubscriptionEntities>, partyEnum: PartyEnum);
+    constructor(stripeClient: Stripe, em: EntityManager, schemaValidator: SchemaValidator, openTelemetryCollector: OpenTelemetryCollector<MetricsDefinition>, billingPortalService: StripeBillingPortalService<SchemaValidator, BillingPortalEntities>, checkoutSessionService: StripeCheckoutSessionService<SchemaValidator, StatusEnum, CheckoutSessionEntities>, paymentLinkService: StripePaymentLinkService<SchemaValidator, StatusEnum, PaymentLinkEntities>, planService: StripePlanService<SchemaValidator, PlanEntities>, subscriptionService: StripeSubscriptionService<SchemaValidator, PartyEnum, SubscriptionEntities>, partyEnum: PartyEnum, 
+    /**
+     * The entity used for webhook idempotency records. Defaults to
+     * resolving the application's discovered entity named
+     * 'StripeWebhookEvent'; inject your own entity (mapper-style) to use a
+     * different one.
+     */
+    webhookEventEntity?: EntityName<StripeWebhookEventEntity>);
     /**
      * Resolve the party type for a subscription event.
      * Stripe subscriptions are customer-scoped — customers map to users
@@ -36,4 +57,5 @@ export declare class StripeWebhookService<SchemaValidator extends AnySchemaValid
     private extractFeaturesFromProduct;
     handleWebhookEvent(event: Stripe.Event): Promise<void>;
 }
+export {};
 //# sourceMappingURL=webhook.service.d.ts.map

package/lib/services/webhook.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhook.service.d.ts","sourceRoot":"","sources":["../../services/webhook.service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAA2B,MAAM,iBAAiB,CAAC;AACzE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAK5B,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAoBnE,qBAAa,oBAAoB,CAC/B,eAAe,SAAS,kBAAkB,EAC1C,UAAU,EACV,SAAS,EACT,qBAAqB,SACnB,2BAA2B,GAAG,2BAA2B,EAC3D,uBAAuB,SACrB,6BAA6B,CAAC,UAAU,CAAC,GAAG,6BAA6B,CAAC,UAAU,CAAC,EACvF,mBAAmB,SACjB,yBAAyB,CAAC,UAAU,CAAC,GAAG,yBAAyB,CAAC,UAAU,CAAC,EAC/E,YAAY,SAAS,kBAAkB,GAAG,kBAAkB,EAC5D,oBAAoB,SAClB,0BAA0B,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC,SAAS,CAAC;IAE/E,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IACpD,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IACrF,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,0BAA0B,CACjE,eAAe,EACf,qBAAqB,CACtB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,4BAA4B,CACrE,eAAe,EACf,UAAU,EACV,uBAAuB,CACxB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,wBAAwB,CAC7D,eAAe,EACf,UAAU,EACV,mBAAmB,CACpB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAC/C,eAAe,EACf,YAAY,CACb,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,yBAAyB,CAC/D,eAAe,EACf,SAAS,EACT,oBAAoB,CACrB,CAAC;IAEF,YACE,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,aAAa,EACjB,eAAe,EAAE,eAAe,EAChC,sBAAsB,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,EACjE,oBAAoB,EAAE,0BAA0B,CAC9C,eAAe,EACf,qBAAqB,CACtB,EACD,sBAAsB,EAAE,4BAA4B,CAClD,eAAe,EACf,UAAU,EACV,uBAAuB,CACxB,EACD,kBAAkB,EAAE,wBAAwB,CAC1C,eAAe,EACf,UAAU,EACV,mBAAmB,CACpB,EACD,WAAW,EAAE,iBAAiB,CAAC,eAAe,EAAE,YAAY,CAAC,EAC7D,mBAAmB,EAAE,yBAAyB,CAC5C,eAAe,EACf,SAAS,EACT,oBAAoB,CACrB,EACD,SAAS,EAAE,SAAS,EAYrB;IAED;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,SAAS,CAAC,CAO3E;IAED;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;IAsB5B,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAiV3D;CACF"}
+{"version":3,"file":"webhook.service.d.ts","sourceRoot":"","sources":["../../services/webhook.service.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,OAAO,MAAM,MAAM,QAAQ,CAAC;AAK5B,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,EAC7B,yBAAyB,EACzB,kBAAkB,EAClB,0BAA0B,EAC3B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,yBAAyB,CAAC;AAErE,OAAO,EAAE,4BAA4B,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;;;;;;;;;GAUG;AACH,KAAK,wBAAwB,GAAG,WAAW,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAOvE,qBAAa,oBAAoB,CAC/B,eAAe,SAAS,kBAAkB,EAC1C,UAAU,EACV,SAAS,EACT,qBAAqB,SACnB,2BAA2B,GAAG,2BAA2B,EAC3D,uBAAuB,SACrB,6BAA6B,CAAC,UAAU,CAAC,GAAG,6BAA6B,CAAC,UAAU,CAAC,EACvF,mBAAmB,SACjB,yBAAyB,CAAC,UAAU,CAAC,GAAG,yBAAyB,CAAC,UAAU,CAAC,EAC/E,YAAY,SAAS,kBAAkB,GAAG,kBAAkB,EAC5D,oBAAoB,SAClB,0BAA0B,CAAC,SAAS,CAAC,GAAG,0BAA0B,CAAC,SAAS,CAAC;IAE/E,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,UAAU,CAAC,wBAAwB,CAAC,CAAC;IAC5E,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IACxC,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,aAAa,CAAC;IACrC,SAAS,CAAC,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IACpD,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;IACrF,SAAS,CAAC,QAAQ,CAAC,oBAAoB,EAAE,0BAA0B,CACjE,eAAe,EACf,qBAAqB,CACtB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,4BAA4B,CACrE,eAAe,EACf,UAAU,EACV,uBAAuB,CACxB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,wBAAwB,CAC7D,eAAe,EACf,UAAU,EACV,mBAAmB,CACpB,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,iBAAiB,CAC/C,eAAe,EACf,YAAY,CACb,CAAC;IACF,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,yBAAyB,CAC/D,eAAe,EACf,SAAS,EACT,oBAAoB,CACrB,CAAC;IAEF,YACE,YAAY,EAAE,MAAM,EACpB,EAAE,EAAE,aAAa,EACjB,eAAe,EAAE,eAAe,EAChC,sBAAsB,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,EACjE,oBAAoB,EAAE,0BAA0B,CAC9C,eAAe,EACf,qBAAqB,CACtB,EACD,sBAAsB,EAAE,4BAA4B,CAClD,eAAe,EACf,UAAU,EACV,uBAAuB,CACxB,EACD,kBAAkB,EAAE,wBAAwB,CAC1C,eAAe,EACf,UAAU,EACV,mBAAmB,CACpB,EACD,WAAW,EAAE,iBAAiB,CAAC,eAAe,EAAE,YAAY,CAAC,EAC7D,mBAAmB,EAAE,yBAAyB,CAC5C,eAAe,EACf,SAAS,EACT,oBAAoB,CACrB,EACD,SAAS,EAAE,SAAS;IACpB;;;;;OAKG;IACH,kBAAkB,GAAE,UAAU,CAAC,wBAAwB,CAAuC,EAa/F;IAED;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,MAAM,SAAS,CAAC,CAO3E;IAED;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B;IAsB5B,kBAAkB,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAiV3D;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forklaunch/implementation-billing-stripe",
-  "version": "1.1.31",
+  "version": "1.1.32",
   "description": "Stripe implementation for forklaunch billing",
   "homepage": "https://github.com/forklaunch/forklaunch-js#readme",
   "bugs": {