@tsed/stripe 8.11.0 → 8.11.2-rc.1

package/lib/esm/constants/constants.js

@@ -1,3 +1,2 @@
 export const STRIPE_WEBHOOK_EVENT = "strip_webhook_event";
 export const STRIPE_WEBHOOK_SIGNATURE = "strip_webhook_signature";
-//# sourceMappingURL=constants.js.map

package/lib/esm/decorators/webhookEvent.js

@@ -14,4 +14,3 @@ import { WebhookEventMiddleware } from "../middlewares/WebhookEventMiddleware.js
 export function WebhookEvent(options) {
     return useDecorators(useMethodDecorators(In("body").Type(Object).Required().Description("The raw webhook payload"), In("header").Name("stripe-signature").Type(String).Required().Description("The stripe webhook signature"), StoreSet(WebhookEventMiddleware, options), UseBefore(WebhookEventMiddleware)), Context(STRIPE_WEBHOOK_EVENT));
 }
-//# sourceMappingURL=webhookEvent.js.map

package/lib/esm/domain/StripeSettings.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=StripeSettings.js.map

package/lib/esm/index.js

@@ -6,4 +6,3 @@ export * from "./decorators/webhookEvent.js";
 export * from "./domain/StripeSettings.js";
 export * from "./middlewares/WebhookEventMiddleware.js";
 export * from "./services/StripeFactory.js";
-//# sourceMappingURL=index.js.map

package/lib/esm/middlewares/WebhookEventMiddleware.js

@@ -45,4 +45,3 @@ WebhookEventMiddleware = WebhookEventMiddleware_1 = __decorate([
     Middleware()
 ], WebhookEventMiddleware);
 export { WebhookEventMiddleware };
-//# sourceMappingURL=WebhookEventMiddleware.js.map

package/lib/esm/services/StripeFactory.js

@@ -16,4 +16,3 @@ registerProvider({
         return {};
     }
 });
-//# sourceMappingURL=StripeFactory.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/stripe",
   "description": "Stripe package for Ts.ED framework",
   "type": "module",
-  "version": "8.11.0",
+  "version": "8.11.2-rc.1",
   "keywords": [
     "Stripe",
     "Ts.ED",
@@ -35,15 +35,15 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/adapters": "8.11.0",
-    "@tsed/barrels": "8.11.0",
-    "@tsed/core": "8.11.0",
-    "@tsed/di": "8.11.0",
-    "@tsed/exceptions": "8.11.0",
-    "@tsed/platform-middlewares": "8.11.0",
-    "@tsed/platform-params": "8.11.0",
-    "@tsed/schema": "8.11.0",
-    "@tsed/typescript": "8.11.0",
+    "@tsed/adapters": "8.11.2-rc.1",
+    "@tsed/barrels": "8.11.2-rc.1",
+    "@tsed/core": "8.11.2-rc.1",
+    "@tsed/di": "8.11.2-rc.1",
+    "@tsed/exceptions": "8.11.2-rc.1",
+    "@tsed/platform-middlewares": "8.11.2-rc.1",
+    "@tsed/platform-params": "8.11.2-rc.1",
+    "@tsed/schema": "8.11.2-rc.1",
+    "@tsed/typescript": "8.11.2-rc.1",
     "eslint": "9.12.0",
     "stripe": "^17.7.0",
     "typescript": "5.4.5",
@@ -81,5 +81,8 @@
   },
   "homepage": "https://github.com/tsedio/tsed/tree/production/packages/third-parties/stripe",
   "author": "Romain Lenzotti",
-  "license": "MIT"
+  "license": "MIT",
+  "publishConfig": {
+    "tag": "rc"
+  }
 }

package/lib/esm/constants/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/constants/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAC1D,MAAM,CAAC,MAAM,wBAAwB,GAAG,yBAAyB,CAAC"}

package/lib/esm/decorators/webhookEvent.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"webhookEvent.js","sourceRoot":"","sources":["../../../src/decorators/webhookEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,aAAa,EAAE,mBAAmB,EAAC,MAAM,YAAY,CAAC;AACxE,OAAO,EAAC,SAAS,EAAC,MAAM,4BAA4B,CAAC;AACrD,OAAO,EAAC,OAAO,EAAC,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAC,EAAE,EAAC,MAAM,cAAc,CAAC;AAEhC,OAAO,EAAC,oBAAoB,EAAC,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAC,sBAAsB,EAAsB,MAAM,0CAA0C,CAAC;AAErG;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsC;IACjE,OAAO,aAAa,CAClB,mBAAmB,CACjB,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,yBAAyB,CAAC,EACzE,EAAE,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,WAAW,CAAC,8BAA8B,CAAC,EACzG,QAAQ,CAAC,sBAAsB,EAAE,OAAO,CAAC,EACzC,SAAS,CAAC,sBAAsB,CAAC,CAClC,EACD,OAAO,CAAC,oBAAoB,CAAC,CAC9B,CAAC;AACJ,CAAC"}

package/lib/esm/domain/StripeSettings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StripeSettings.js","sourceRoot":"","sources":["../../../src/domain/StripeSettings.ts"],"names":[],"mappings":""}

package/lib/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,0BAA0B,CAAC;AACzC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yCAAyC,CAAC;AACxD,cAAc,6BAA6B,CAAC"}

package/lib/esm/middlewares/WebhookEventMiddleware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WebhookEventMiddleware.js","sourceRoot":"","sources":["../../../src/middlewares/WebhookEventMiddleware.ts"],"names":[],"mappings":";;AAAA,OAAO,8BAA8B,CAAC;AAEtC,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAC,UAAU,EAAE,mBAAmB,EAAC,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAC,UAAU,EAAoB,MAAM,4BAA4B,CAAC;AACzE,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAC,oBAAoB,EAAE,wBAAwB,EAAC,MAAM,2BAA2B,CAAC;AAQlF,IAAM,sBAAsB,8BAA5B,MAAM,sBAAsB;IAOjC,GAAG,CAAmC,SAAiB,EAAmB,IAAY,EAAa,GAAY;QAC7G,MAAM,EAAC,MAAM,EAAE,SAAS,EAAC,GAAwB;YAC/C,GAAG,IAAI,CAAC,QAAQ;YAChB,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,wBAAsB,CAAC;SAClD,CAAC;QAEF,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,mBAAmB,CAC3B,qHAAqH,CACtH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,GAAG,CAAC,GAAG,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;YAC7C,GAAG,CAAC,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;QACzG,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,UAAU,CAAC,yBAAyB,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;CACF,CAAA;AAxBW;IADT,MAAM,EAAE;8BACS,MAAM;sDAAC;AAGf;IADT,QAAQ,CAAC,iBAAiB,CAAC;;wDACY;AAExC;IAAK,WAAA,YAAY,CAAC,kBAAkB,CAAC,CAAA;IAAqB,WAAA,aAAa,EAAE,CAAA;IAAgB,WAAA,OAAO,EAAE,CAAA;;6CAAlB,MAAM;;iDAkBrF;AAzBU,sBAAsB;IADlC,UAAU,EAAE;GACA,sBAAsB,CA0BlC"}

package/lib/esm/services/StripeFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"StripeFactory.js","sourceRoot":"","sources":["../../../src/services/StripeFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAE,gBAAgB,EAAC,MAAM,UAAU,CAAC;AACzD,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAI9B,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC;AAEpC,gBAAgB,CAAC;IACf,KAAK,EAAE,MAAM;IACb,IAAI,EAAE,CAAC,aAAa,CAAC;IACrB,UAAU,CAAC,QAAuB;QAChC,MAAM,EAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAC,GAAG,QAAQ,CAAC,GAAG,CAAiB,QAAQ,EAAE,EAAS,CAAC,CAAC;QAEzF,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAE9B,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE;gBACxB,GAAG,OAAO;gBACV,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF,CAAC,CAAC"}

package/src/constants/constants.ts

@@ -1,2 +0,0 @@
-export const STRIPE_WEBHOOK_EVENT = "strip_webhook_event";
-export const STRIPE_WEBHOOK_SIGNATURE = "strip_webhook_signature";

package/src/decorators/webhookEvent.ts

@@ -1,26 +0,0 @@
-import {StoreSet, useDecorators, useMethodDecorators} from "@tsed/core";
-import {UseBefore} from "@tsed/platform-middlewares";
-import {Context} from "@tsed/platform-params";
-import {In} from "@tsed/schema";
-
-import {STRIPE_WEBHOOK_EVENT} from "../constants/constants.js";
-import {WebhookEventMiddleware, WebhookEventOptions} from "../middlewares/WebhookEventMiddleware.js";
-
-/**
- * Get the stripe webhook event.
- *
- * @decorator
- * @operation
- * @input
- */
-export function WebhookEvent(options?: Partial<WebhookEventOptions>) {
-  return useDecorators(
-    useMethodDecorators(
-      In("body").Type(Object).Required().Description("The raw webhook payload"),
-      In("header").Name("stripe-signature").Type(String).Required().Description("The stripe webhook signature"),
-      StoreSet(WebhookEventMiddleware, options),
-      UseBefore(WebhookEventMiddleware)
-    ),
-    Context(STRIPE_WEBHOOK_EVENT)
-  );
-}

package/src/domain/StripeSettings.ts

@@ -1,30 +0,0 @@
-import {Stripe} from "stripe";
-
-export interface StripeSettings extends Stripe.StripeConfig {
-  /**
-   * Stripe ApiKey
-   */
-  apiKey: string;
-  /**
-   * Webhooks settings
-   */
-  webhooks?: {
-    /**
-     * Your Webhook Signing Secret for this endpoint (e.g., 'whsec_...').
-     * You can get this [in your dashboard](https://dashboard.stripe.com/webhooks).
-     */
-    secret: string;
-    /**
-     * Seconds of tolerance on timestamps.
-     */
-    tolerance?: number;
-  };
-}
-
-declare global {
-  namespace TsED {
-    interface Configuration {
-      stripe: StripeSettings;
-    }
-  }
-}

package/src/index.ts

@@ -1,8 +0,0 @@
-/**
- * @file Automatically generated by @tsed/barrels.
- */
-export * from "./constants/constants.js";
-export * from "./decorators/webhookEvent.js";
-export * from "./domain/StripeSettings.js";
-export * from "./middlewares/WebhookEventMiddleware.js";
-export * from "./services/StripeFactory.js";

package/src/middlewares/WebhookEventMiddleware.spec.ts

@@ -1,137 +0,0 @@
-import "../index.js";
-
-import {catchError} from "@tsed/core";
-import {EndpointMetadata} from "@tsed/platform-http";
-import {PlatformTest} from "@tsed/platform-http/testing";
-import {Stripe} from "stripe";
-
-import {STRIPE_WEBHOOK_EVENT, STRIPE_WEBHOOK_SIGNATURE} from "../constants/constants.js";
-import {WebhookEventMiddleware} from "./WebhookEventMiddleware.js";
-
-class Ctrl {
-  get() {}
-}
-
-describe("WebhookEventMiddleware", () => {
-  beforeEach(() =>
-    PlatformTest.create({
-      stripe: {
-        apiKey: "the_api_key",
-        apiVersion: "2025-02-24.acacia",
-        webhooks: {
-          secret: "whsec_test_secret",
-          tolerance: 1
-        }
-      }
-    })
-  );
-  afterEach(PlatformTest.reset);
-
-  it("should construct event", async () => {
-    const stripe = PlatformTest.get<Stripe>(Stripe);
-    const ctx = PlatformTest.createRequestContext();
-    ctx.endpoint = EndpointMetadata.get(Ctrl, "get");
-
-    const payload = {
-      id: "evt_test_webhook",
-      object: "event"
-    };
-    const payloadString = JSON.stringify(payload, null, 2);
-
-    const signature = stripe.webhooks.generateTestHeaderString({
-      payload: payloadString,
-      secret: "whsec_test_secret"
-    });
-
-    const middleware = await PlatformTest.invoke<WebhookEventMiddleware>(WebhookEventMiddleware);
-
-    middleware.use(signature, Buffer.from(payloadString), ctx);
-
-    expect(ctx.get(STRIPE_WEBHOOK_EVENT)).toEqual(payload);
-    expect(ctx.get(STRIPE_WEBHOOK_SIGNATURE)).toEqual(signature);
-  });
-  it("should construct event based on endpoint options", async () => {
-    const stripe = PlatformTest.get<Stripe>(Stripe);
-    const ctx = PlatformTest.createRequestContext();
-    ctx.endpoint = EndpointMetadata.get(Ctrl, "get");
-    ctx.endpoint = EndpointMetadata.get(Ctrl, "get");
-    ctx.endpoint.store.set(WebhookEventMiddleware, {
-      secret: "whsec_test_secret1"
-    });
-
-    const payload = {
-      id: "evt_test_webhook",
-      object: "event"
-    };
-    const payloadString = JSON.stringify(payload, null, 2);
-
-    const signature = stripe.webhooks.generateTestHeaderString({
-      payload: payloadString,
-      secret: "whsec_test_secret1"
-    });
-
-    const middleware = await PlatformTest.invoke<WebhookEventMiddleware>(WebhookEventMiddleware);
-
-    middleware.use(signature, Buffer.from(payloadString), ctx);
-
-    expect(ctx.get(STRIPE_WEBHOOK_EVENT)).toEqual(payload);
-    expect(ctx.get(STRIPE_WEBHOOK_SIGNATURE)).toEqual(signature);
-  });
-  it("should throw error when signature isn't valid", async () => {
-    const stripe = PlatformTest.get<Stripe>(Stripe);
-    const ctx = PlatformTest.createRequestContext();
-    ctx.endpoint = EndpointMetadata.get(Ctrl, "get");
-
-    const payload = {
-      id: "evt_test_webhook",
-      object: "event"
-    };
-    const payloadString = JSON.stringify(payload, null, 2);
-
-    const signature = stripe.webhooks.generateTestHeaderString({
-      payload: payloadString,
-      secret: "whsec_test_secretooo"
-    });
-
-    const middleware = await PlatformTest.invoke<WebhookEventMiddleware>(WebhookEventMiddleware);
-
-    const actualError: any = catchError(() => middleware.use(signature, Buffer.from(payloadString), ctx));
-
-    expect(actualError.message).toEqual(
-      `Stripe webhook error: No signatures found matching the expected signature for payload. Are you passing the raw request body you received from Stripe? 
- If a webhook request is being forwarded by a third-party tool, ensure that the exact request body, including JSON formatting and new line style, is preserved.
-
-Learn more about webhook signing and explore webhook integration examples for various frameworks at https://docs.stripe.com/webhooks/signature
-, innerException: No signatures found matching the expected signature for payload. Are you passing the raw request body you received from Stripe? 
- If a webhook request is being forwarded by a third-party tool, ensure that the exact request body, including JSON formatting and new line style, is preserved.
-
-Learn more about webhook signing and explore webhook integration examples for various frameworks at https://docs.stripe.com/webhooks/signature`
-    );
-  });
-  it("should throw error when secret is missing", async () => {
-    const stripe = PlatformTest.get<Stripe>(Stripe);
-    const ctx = PlatformTest.createRequestContext();
-    ctx.endpoint = EndpointMetadata.get(Ctrl, "get");
-    ctx.endpoint.store.set(WebhookEventMiddleware, {
-      secret: null
-    });
-    const payload = {
-      id: "evt_test_webhook",
-      object: "event"
-    };
-    const payloadString = JSON.stringify(payload, null, 2);
-
-    const signature = stripe.webhooks.generateTestHeaderString({
-      payload: payloadString,
-      secret: "whsec_test_secretooo"
-    });
-
-    const middleware = await PlatformTest.invoke<WebhookEventMiddleware>(WebhookEventMiddleware);
-
-    const actualError: any = catchError(() => middleware.use(signature, Buffer.from(payloadString), ctx));
-
-    expect(actualError.message).toEqual(
-      "Missing Stripe webhooks secret key. You can get this in your dashboard. See: https://dashboard.stripe.com/webhooks."
-    );
-  });
-});

package/src/middlewares/WebhookEventMiddleware.ts

@@ -1,43 +0,0 @@
-import "../services/StripeFactory.js";
-
-import {Constant, Inject} from "@tsed/di";
-import {BadRequest, InternalServerError} from "@tsed/exceptions";
-import {Middleware, MiddlewareMethods} from "@tsed/platform-middlewares";
-import {Context, HeaderParams, RawBodyParams} from "@tsed/platform-params";
-import {Stripe} from "stripe";
-
-import {STRIPE_WEBHOOK_EVENT, STRIPE_WEBHOOK_SIGNATURE} from "../constants/constants.js";
-
-export interface WebhookEventOptions {
-  secret: string;
-  tolerance: number;
-}
-
-@Middleware()
-export class WebhookEventMiddleware implements MiddlewareMethods {
-  @Inject()
-  protected stripe: Stripe;
-
-  @Constant("stripe.webhooks")
-  protected webhooks: WebhookEventOptions;
-
-  use(@HeaderParams("stripe-signature") signature: string, @RawBodyParams() body: Buffer, @Context() ctx: Context): any {
-    const {secret, tolerance}: WebhookEventOptions = {
-      ...this.webhooks,
-      ...ctx.endpoint.store.get(WebhookEventMiddleware)
-    };
-
-    if (!secret) {
-      throw new InternalServerError(
-        "Missing Stripe webhooks secret key. You can get this in your dashboard. See: https://dashboard.stripe.com/webhooks."
-      );
-    }
-
-    try {
-      ctx.set(STRIPE_WEBHOOK_SIGNATURE, signature);
-      ctx.set(STRIPE_WEBHOOK_EVENT, this.stripe.webhooks.constructEvent(body, signature, secret, tolerance));
-    } catch (err) {
-      throw new BadRequest(`Stripe webhook error: ${err.message}`, err);
-    }
-  }
-}

package/src/services/StripeFactory.spec.ts

@@ -1,34 +0,0 @@
-import "../index.js";
-
-import {PlatformTest} from "@tsed/platform-http/testing";
-import {Stripe} from "stripe";
-
-describe("StripeFactory", () => {
-  describe("when there is configuration", () => {
-    beforeEach(() =>
-      PlatformTest.create({
-        stripe: {
-          apiKey: "the_api_key",
-          apiVersion: "2025-02-24.acacia"
-        }
-      })
-    );
-    afterEach(PlatformTest.reset);
-
-    it("should inject the strip instance", () => {
-      const stripe = PlatformTest.get<Stripe>(Stripe);
-
-      expect(stripe).toBeInstanceOf(Stripe);
-    });
-  });
-  describe("when there is no configuration", () => {
-    beforeEach(() => PlatformTest.create({}));
-    afterEach(PlatformTest.reset);
-
-    it("should inject the strip instance", () => {
-      const stripe = PlatformTest.get<Stripe>(Stripe);
-
-      expect(stripe).not.toBeInstanceOf(Stripe);
-    });
-  });
-});

package/src/services/StripeFactory.ts

@@ -1,25 +0,0 @@
-import {Configuration, registerProvider} from "@tsed/di";
-import {Stripe} from "stripe";
-
-import {StripeSettings} from "../domain/StripeSettings.js";
-
-export const StripeFactory = Stripe;
-
-registerProvider({
-  token: Stripe,
-  deps: [Configuration],
-  useFactory(settings: Configuration) {
-    const {apiKey, webhooks, ...options} = settings.get<StripeSettings>("stripe", {} as any);
-
-    settings.set("rawBody", true);
-
-    if (apiKey) {
-      return new Stripe(apiKey, {
-        ...options,
-        typescript: true
-      });
-    }
-
-    return {};
-  }
-});

package/vitest.config.mts

@@ -1,21 +0,0 @@
-// @ts-ignore
-import {presets} from "@tsed/vitest/presets";
-import {defineConfig} from "vitest/config";
-
-export default defineConfig(
-  {
-    ...presets,
-    test: {
-      ...presets.test,
-      coverage: {
-        ...presets.test.coverage,
-        thresholds: {
-          statements: 0,
-          branches: 0,
-          functions: 0,
-          lines: 0
-        }
-      }
-    }
-  }
-);