@dodopayments/convex 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -18,7 +18,6 @@ interface DodoPaymentsComponent {
18
18
  type DodoPaymentsClientConfig = {
19
19
  identify: (ctx: GenericActionCtx<any>) => Promise<{
20
20
  dodoCustomerId: string;
21
- customerData?: any;
22
21
  } | null>;
23
22
  apiKey: string;
24
23
  environment: "test_mode" | "live_mode";
@@ -55,13 +54,29 @@ type CustomerPortalResponse = {
55
54
  portal_url: string;
56
55
  };
57
56
 
57
+ type ConvexWebhookHandlerConfig = Omit<WebhookHandlerConfig<GenericActionCtx<any>>, 'webhookKey'>;
58
58
  /**
59
59
  * Creates a Convex HTTP action to securely handle Dodo Payments webhooks.
60
60
  *
61
+ * All webhook handlers receive the Convex ActionCtx as the first parameter,
62
+ * allowing you to use ctx.runQuery() and ctx.runMutation() to interact with your database.
63
+ *
61
64
  * @param handlers - An object containing your webhook event handlers (e.g., onPaymentSucceeded).
62
65
  * @returns A Convex HTTP action.
66
+ *
67
+ * @example
68
+ * ```typescript
69
+ * createDodoWebhookHandler({
70
+ * onPaymentSucceeded: async (ctx, payload) => {
71
+ * await ctx.runMutation(internal.orders.markAsPaid, {
72
+ * orderId: payload.data.metadata.orderId,
73
+ * paymentId: payload.data.payment_id,
74
+ * });
75
+ * },
76
+ * })
77
+ * ```
63
78
  */
64
- declare const createDodoWebhookHandler: (handlers: Omit<WebhookHandlerConfig, "webhookKey">) => convex_server.PublicHttpAction;
79
+ declare const createDodoWebhookHandler: (handlers: ConvexWebhookHandlerConfig) => convex_server.PublicHttpAction;
65
80
 
66
81
  export { DodoPayments, _default as component, createDodoWebhookHandler };
67
- export type { CheckoutResponse, CustomerPortalResponse, DodoPaymentsClientConfig };
82
+ export type { CheckoutResponse, ConvexWebhookHandlerConfig, CustomerPortalResponse, DodoPaymentsClientConfig };
package/dist/index.js CHANGED
@@ -2231,153 +2231,163 @@ var __generator = (undefined && undefined.__generator) || function (thisArg, bod
2231
2231
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
2232
2232
  }
2233
2233
  };
2234
- var handleWebhookPayload = function (payload, config) { return __awaiter(void 0, void 0, void 0, function () {
2235
- return __generator(this, function (_a) {
2236
- switch (_a.label) {
2237
- case 0:
2238
- if (!config.onPayload) return [3 /*break*/, 2];
2239
- return [4 /*yield*/, config.onPayload(payload)];
2240
- case 1:
2241
- _a.sent();
2242
- _a.label = 2;
2243
- case 2:
2244
- if (!(payload.type === "payment.succeeded" && config.onPaymentSucceeded)) return [3 /*break*/, 4];
2245
- return [4 /*yield*/, config.onPaymentSucceeded(payload)];
2246
- case 3:
2247
- _a.sent();
2248
- _a.label = 4;
2249
- case 4:
2250
- if (!(payload.type === "payment.failed" && config.onPaymentFailed)) return [3 /*break*/, 6];
2251
- return [4 /*yield*/, config.onPaymentFailed(payload)];
2252
- case 5:
2253
- _a.sent();
2254
- _a.label = 6;
2255
- case 6:
2256
- if (!(payload.type === "payment.processing" && config.onPaymentProcessing)) return [3 /*break*/, 8];
2257
- return [4 /*yield*/, config.onPaymentProcessing(payload)];
2258
- case 7:
2259
- _a.sent();
2260
- _a.label = 8;
2261
- case 8:
2262
- if (!(payload.type === "payment.cancelled" && config.onPaymentCancelled)) return [3 /*break*/, 10];
2263
- return [4 /*yield*/, config.onPaymentCancelled(payload)];
2264
- case 9:
2265
- _a.sent();
2266
- _a.label = 10;
2267
- case 10:
2268
- if (!(payload.type === "refund.succeeded" && config.onRefundSucceeded)) return [3 /*break*/, 12];
2269
- return [4 /*yield*/, config.onRefundSucceeded(payload)];
2270
- case 11:
2271
- _a.sent();
2272
- _a.label = 12;
2273
- case 12:
2274
- if (!(payload.type === "refund.failed" && config.onRefundFailed)) return [3 /*break*/, 14];
2275
- return [4 /*yield*/, config.onRefundFailed(payload)];
2276
- case 13:
2277
- _a.sent();
2278
- _a.label = 14;
2279
- case 14:
2280
- if (!(payload.type === "dispute.opened" && config.onDisputeOpened)) return [3 /*break*/, 16];
2281
- return [4 /*yield*/, config.onDisputeOpened(payload)];
2282
- case 15:
2283
- _a.sent();
2284
- _a.label = 16;
2285
- case 16:
2286
- if (!(payload.type === "dispute.expired" && config.onDisputeExpired)) return [3 /*break*/, 18];
2287
- return [4 /*yield*/, config.onDisputeExpired(payload)];
2288
- case 17:
2289
- _a.sent();
2290
- _a.label = 18;
2291
- case 18:
2292
- if (!(payload.type === "dispute.accepted" && config.onDisputeAccepted)) return [3 /*break*/, 20];
2293
- return [4 /*yield*/, config.onDisputeAccepted(payload)];
2294
- case 19:
2295
- _a.sent();
2296
- _a.label = 20;
2297
- case 20:
2298
- if (!(payload.type === "dispute.cancelled" && config.onDisputeCancelled)) return [3 /*break*/, 22];
2299
- return [4 /*yield*/, config.onDisputeCancelled(payload)];
2300
- case 21:
2301
- _a.sent();
2302
- _a.label = 22;
2303
- case 22:
2304
- if (!(payload.type === "dispute.challenged" && config.onDisputeChallenged)) return [3 /*break*/, 24];
2305
- return [4 /*yield*/, config.onDisputeChallenged(payload)];
2306
- case 23:
2307
- _a.sent();
2308
- _a.label = 24;
2309
- case 24:
2310
- if (!(payload.type === "dispute.won" && config.onDisputeWon)) return [3 /*break*/, 26];
2311
- return [4 /*yield*/, config.onDisputeWon(payload)];
2312
- case 25:
2313
- _a.sent();
2314
- _a.label = 26;
2315
- case 26:
2316
- if (!(payload.type === "dispute.lost" && config.onDisputeLost)) return [3 /*break*/, 28];
2317
- return [4 /*yield*/, config.onDisputeLost(payload)];
2318
- case 27:
2319
- _a.sent();
2320
- _a.label = 28;
2321
- case 28:
2322
- if (!(payload.type === "subscription.active" && config.onSubscriptionActive)) return [3 /*break*/, 30];
2323
- return [4 /*yield*/, config.onSubscriptionActive(payload)];
2324
- case 29:
2325
- _a.sent();
2326
- _a.label = 30;
2327
- case 30:
2328
- if (!(payload.type === "subscription.on_hold" && config.onSubscriptionOnHold)) return [3 /*break*/, 32];
2329
- return [4 /*yield*/, config.onSubscriptionOnHold(payload)];
2330
- case 31:
2331
- _a.sent();
2332
- _a.label = 32;
2333
- case 32:
2334
- if (!(payload.type === "subscription.renewed" && config.onSubscriptionRenewed)) return [3 /*break*/, 34];
2335
- return [4 /*yield*/, config.onSubscriptionRenewed(payload)];
2336
- case 33:
2337
- _a.sent();
2338
- _a.label = 34;
2339
- case 34:
2340
- if (!(payload.type === "subscription.paused" && config.onSubscriptionPaused)) return [3 /*break*/, 36];
2341
- return [4 /*yield*/, config.onSubscriptionPaused(payload)];
2342
- case 35:
2343
- _a.sent();
2344
- _a.label = 36;
2345
- case 36:
2346
- if (!(payload.type === "subscription.plan_changed" &&
2347
- config.onSubscriptionPlanChanged)) return [3 /*break*/, 38];
2348
- return [4 /*yield*/, config.onSubscriptionPlanChanged(payload)];
2349
- case 37:
2350
- _a.sent();
2351
- _a.label = 38;
2352
- case 38:
2353
- if (!(payload.type === "subscription.cancelled" &&
2354
- config.onSubscriptionCancelled)) return [3 /*break*/, 40];
2355
- return [4 /*yield*/, config.onSubscriptionCancelled(payload)];
2356
- case 39:
2357
- _a.sent();
2358
- _a.label = 40;
2359
- case 40:
2360
- if (!(payload.type === "subscription.failed" && config.onSubscriptionFailed)) return [3 /*break*/, 42];
2361
- return [4 /*yield*/, config.onSubscriptionFailed(payload)];
2362
- case 41:
2363
- _a.sent();
2364
- _a.label = 42;
2365
- case 42:
2366
- if (!(payload.type === "subscription.expired" && config.onSubscriptionExpired)) return [3 /*break*/, 44];
2367
- return [4 /*yield*/, config.onSubscriptionExpired(payload)];
2368
- case 43:
2369
- _a.sent();
2370
- _a.label = 44;
2371
- case 44:
2372
- if (!(payload.type === "license_key.created" && config.onLicenseKeyCreated)) return [3 /*break*/, 46];
2373
- return [4 /*yield*/, config.onLicenseKeyCreated(payload)];
2374
- case 45:
2375
- _a.sent();
2376
- _a.label = 46;
2377
- case 46: return [2 /*return*/];
2378
- }
2234
+ // Implementation
2235
+ function handleWebhookPayload(payload, config, context) {
2236
+ return __awaiter(this, void 0, void 0, function () {
2237
+ var callHandler;
2238
+ return __generator(this, function (_a) {
2239
+ switch (_a.label) {
2240
+ case 0:
2241
+ callHandler = function (handler, payload) {
2242
+ if (!handler)
2243
+ return;
2244
+ if (context !== undefined) {
2245
+ return handler(context, payload);
2246
+ }
2247
+ return handler(payload);
2248
+ };
2249
+ if (!config.onPayload) return [3 /*break*/, 2];
2250
+ return [4 /*yield*/, callHandler(config.onPayload, payload)];
2251
+ case 1:
2252
+ _a.sent();
2253
+ _a.label = 2;
2254
+ case 2:
2255
+ if (!(payload.type === "payment.succeeded")) return [3 /*break*/, 4];
2256
+ return [4 /*yield*/, callHandler(config.onPaymentSucceeded, payload)];
2257
+ case 3:
2258
+ _a.sent();
2259
+ _a.label = 4;
2260
+ case 4:
2261
+ if (!(payload.type === "payment.failed")) return [3 /*break*/, 6];
2262
+ return [4 /*yield*/, callHandler(config.onPaymentFailed, payload)];
2263
+ case 5:
2264
+ _a.sent();
2265
+ _a.label = 6;
2266
+ case 6:
2267
+ if (!(payload.type === "payment.processing")) return [3 /*break*/, 8];
2268
+ return [4 /*yield*/, callHandler(config.onPaymentProcessing, payload)];
2269
+ case 7:
2270
+ _a.sent();
2271
+ _a.label = 8;
2272
+ case 8:
2273
+ if (!(payload.type === "payment.cancelled")) return [3 /*break*/, 10];
2274
+ return [4 /*yield*/, callHandler(config.onPaymentCancelled, payload)];
2275
+ case 9:
2276
+ _a.sent();
2277
+ _a.label = 10;
2278
+ case 10:
2279
+ if (!(payload.type === "refund.succeeded")) return [3 /*break*/, 12];
2280
+ return [4 /*yield*/, callHandler(config.onRefundSucceeded, payload)];
2281
+ case 11:
2282
+ _a.sent();
2283
+ _a.label = 12;
2284
+ case 12:
2285
+ if (!(payload.type === "refund.failed")) return [3 /*break*/, 14];
2286
+ return [4 /*yield*/, callHandler(config.onRefundFailed, payload)];
2287
+ case 13:
2288
+ _a.sent();
2289
+ _a.label = 14;
2290
+ case 14:
2291
+ if (!(payload.type === "dispute.opened")) return [3 /*break*/, 16];
2292
+ return [4 /*yield*/, callHandler(config.onDisputeOpened, payload)];
2293
+ case 15:
2294
+ _a.sent();
2295
+ _a.label = 16;
2296
+ case 16:
2297
+ if (!(payload.type === "dispute.expired")) return [3 /*break*/, 18];
2298
+ return [4 /*yield*/, callHandler(config.onDisputeExpired, payload)];
2299
+ case 17:
2300
+ _a.sent();
2301
+ _a.label = 18;
2302
+ case 18:
2303
+ if (!(payload.type === "dispute.accepted")) return [3 /*break*/, 20];
2304
+ return [4 /*yield*/, callHandler(config.onDisputeAccepted, payload)];
2305
+ case 19:
2306
+ _a.sent();
2307
+ _a.label = 20;
2308
+ case 20:
2309
+ if (!(payload.type === "dispute.cancelled")) return [3 /*break*/, 22];
2310
+ return [4 /*yield*/, callHandler(config.onDisputeCancelled, payload)];
2311
+ case 21:
2312
+ _a.sent();
2313
+ _a.label = 22;
2314
+ case 22:
2315
+ if (!(payload.type === "dispute.challenged")) return [3 /*break*/, 24];
2316
+ return [4 /*yield*/, callHandler(config.onDisputeChallenged, payload)];
2317
+ case 23:
2318
+ _a.sent();
2319
+ _a.label = 24;
2320
+ case 24:
2321
+ if (!(payload.type === "dispute.won")) return [3 /*break*/, 26];
2322
+ return [4 /*yield*/, callHandler(config.onDisputeWon, payload)];
2323
+ case 25:
2324
+ _a.sent();
2325
+ _a.label = 26;
2326
+ case 26:
2327
+ if (!(payload.type === "dispute.lost")) return [3 /*break*/, 28];
2328
+ return [4 /*yield*/, callHandler(config.onDisputeLost, payload)];
2329
+ case 27:
2330
+ _a.sent();
2331
+ _a.label = 28;
2332
+ case 28:
2333
+ if (!(payload.type === "subscription.active")) return [3 /*break*/, 30];
2334
+ return [4 /*yield*/, callHandler(config.onSubscriptionActive, payload)];
2335
+ case 29:
2336
+ _a.sent();
2337
+ _a.label = 30;
2338
+ case 30:
2339
+ if (!(payload.type === "subscription.on_hold")) return [3 /*break*/, 32];
2340
+ return [4 /*yield*/, callHandler(config.onSubscriptionOnHold, payload)];
2341
+ case 31:
2342
+ _a.sent();
2343
+ _a.label = 32;
2344
+ case 32:
2345
+ if (!(payload.type === "subscription.renewed")) return [3 /*break*/, 34];
2346
+ return [4 /*yield*/, callHandler(config.onSubscriptionRenewed, payload)];
2347
+ case 33:
2348
+ _a.sent();
2349
+ _a.label = 34;
2350
+ case 34:
2351
+ if (!(payload.type === "subscription.paused")) return [3 /*break*/, 36];
2352
+ return [4 /*yield*/, callHandler(config.onSubscriptionPaused, payload)];
2353
+ case 35:
2354
+ _a.sent();
2355
+ _a.label = 36;
2356
+ case 36:
2357
+ if (!(payload.type === "subscription.plan_changed")) return [3 /*break*/, 38];
2358
+ return [4 /*yield*/, callHandler(config.onSubscriptionPlanChanged, payload)];
2359
+ case 37:
2360
+ _a.sent();
2361
+ _a.label = 38;
2362
+ case 38:
2363
+ if (!(payload.type === "subscription.cancelled")) return [3 /*break*/, 40];
2364
+ return [4 /*yield*/, callHandler(config.onSubscriptionCancelled, payload)];
2365
+ case 39:
2366
+ _a.sent();
2367
+ _a.label = 40;
2368
+ case 40:
2369
+ if (!(payload.type === "subscription.failed")) return [3 /*break*/, 42];
2370
+ return [4 /*yield*/, callHandler(config.onSubscriptionFailed, payload)];
2371
+ case 41:
2372
+ _a.sent();
2373
+ _a.label = 42;
2374
+ case 42:
2375
+ if (!(payload.type === "subscription.expired")) return [3 /*break*/, 44];
2376
+ return [4 /*yield*/, callHandler(config.onSubscriptionExpired, payload)];
2377
+ case 43:
2378
+ _a.sent();
2379
+ _a.label = 44;
2380
+ case 44:
2381
+ if (!(payload.type === "license_key.created")) return [3 /*break*/, 46];
2382
+ return [4 /*yield*/, callHandler(config.onLicenseKeyCreated, payload)];
2383
+ case 45:
2384
+ _a.sent();
2385
+ _a.label = 46;
2386
+ case 46: return [2 /*return*/];
2387
+ }
2388
+ });
2379
2389
  });
2380
- }); };
2390
+ }
2381
2391
  var verifyWebhookPayload = function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
2382
2392
  var standardWebhook, _c, success, payload, error;
2383
2393
  var webhookKey = _b.webhookKey, headers = _b.headers, body = _b.body;
@@ -2403,11 +2413,26 @@ var verifyWebhookPayload = function (_a) { return __awaiter(void 0, [_a], void 0
2403
2413
  /**
2404
2414
  * Creates a Convex HTTP action to securely handle Dodo Payments webhooks.
2405
2415
  *
2416
+ * All webhook handlers receive the Convex ActionCtx as the first parameter,
2417
+ * allowing you to use ctx.runQuery() and ctx.runMutation() to interact with your database.
2418
+ *
2406
2419
  * @param handlers - An object containing your webhook event handlers (e.g., onPaymentSucceeded).
2407
2420
  * @returns A Convex HTTP action.
2421
+ *
2422
+ * @example
2423
+ * ```typescript
2424
+ * createDodoWebhookHandler({
2425
+ * onPaymentSucceeded: async (ctx, payload) => {
2426
+ * await ctx.runMutation(internal.orders.markAsPaid, {
2427
+ * orderId: payload.data.metadata.orderId,
2428
+ * paymentId: payload.data.payment_id,
2429
+ * });
2430
+ * },
2431
+ * })
2432
+ * ```
2408
2433
  */
2409
2434
  const createDodoWebhookHandler = (handlers) => {
2410
- return httpAction(async (_, request) => {
2435
+ return httpAction(async (ctx, request) => {
2411
2436
  const webhookSecret = process.env.DODO_PAYMENTS_WEBHOOK_SECRET;
2412
2437
  if (!webhookSecret) {
2413
2438
  throw new Error("DODO_PAYMENTS_WEBHOOK_SECRET environment variable is not set.");
@@ -2423,10 +2448,11 @@ const createDodoWebhookHandler = (handlers) => {
2423
2448
  headers,
2424
2449
  body,
2425
2450
  });
2451
+ // Use the core library's handleWebhookPayload with ctx as the third parameter
2426
2452
  await handleWebhookPayload(payload, {
2427
2453
  webhookKey: webhookSecret,
2428
2454
  ...handlers,
2429
- });
2455
+ }, ctx);
2430
2456
  return new Response(null, { status: 200 });
2431
2457
  }
2432
2458
  catch (error) {