@paykit-sdk/polar 1.1.91 → 1.1.93

package/README.md

@@ -5,7 +5,7 @@ Polar provider for PayKit
 ## Quick Start
 
 ```typescript
-import { PayKit } from '@paykit-sdk/core';
+import { createEndpointHandlers, PayKit } from '@paykit-sdk/core';
 import { polar, createPolar } from '@paykit-sdk/polar';
 
 // Method 1: Using environment variables
@@ -14,167 +14,183 @@ const provider = polar(); // Ensure POLAR_ACCESS_TOKEN environment variable is s
 // Method 2: Direct configuration
 const provider = createPolar({
   accessToken: process.env.POLAR_ACCESS_TOKEN,
-  server: 'sandbox', // or 'production'
-  debug: true,
 });
 
-const paykit = new PayKit(provider);
+export const paykit = new PayKit(provider);
+export const endpoints = createEndpointHandlers(paykit);
+```
 
-// Create checkout
-const checkout = await paykit.checkouts.create({
-  item_id: 'product-id',
-  metadata: { plan: 'pro' },
-  provider_metadata: {
-    successUrl: 'https://your-app.com/success',
-  },
-});
+### Next.js Catch All API Route (/api/paykit/[...endpoint]/route.ts)
 
-// Handle webhooks
-paykit.webhooks
-  .setup({ webhookSecret: process.env.POLAR_WEBHOOK_SECRET })
-  .on('$checkoutCreated', async event => {
-    console.log('Checkout created:', event.data);
-  })
-  .on('$invoicePaid', async event => {
-    console.log('Payment received:', event.data);
-  });
-```
+```typescript
+import { endpoints } from '@/lib/paykit';
+import { EndpointPath } from '@paykit-sdk/core';
+import { NextRequest, NextResponse } from 'next/server';
 
-## Webhook Implementation
+export async function POST(
+  request: NextRequest,
+  { params }: { params: { endpoint: string[] } },
+) {
+  try {
+    // Construct the endpoint path with full type safety
+    const endpoint = ('/' + params.endpoint.join('/')) as EndpointPath;
+    const handler = endpoints[endpoint];
+
+    if (!handler) {
+      return NextResponse.json({ message: 'Endpoint not found' }, { status: 404 });
+    }
+
+    // Parse request body
+    const body = await request.json();
+    const { args } = body;
+
+    const result = await handler(...args);
+
+    return NextResponse.json({ result });
+  } catch (error) {
+    console.error('PayKit API Error:', error);
+    return NextResponse.json(
+      { message: error instanceof Error ? error.message : 'Internal server error' },
+      { status: 500 },
+    );
+  }
+}
+```
 
-### Next.js API Route
+### Next.js Webhooks (/api/paykit/webhooks/route.ts)
 
 ```typescript
 import { paykit } from '@/lib/paykit';
 import { NextRequest, NextResponse } from 'next/server';
 
 export async function POST(request: NextRequest) {
-  console.log('Polar webhook received');
+  const webhookSecret = process.env.POLAR_WEBHOOK_SECRET;
+
+  if (!webhookSecret) {
+    return NextResponse.json({ error: 'Webhook secret not configured' }, { status: 500 });
+  }
 
   const webhook = paykit.webhooks
-    .setup({ webhookSecret: process.env.POLAR_WEBHOOK_SECRET! })
-    .on('$checkoutCreated', async event => {
-      console.log('Checkout created:', event.data);
-    })
-    .on('$customerCreated', async event => {
+    .setup({ webhookSecret })
+    .on('customer.created', async event => {
       console.log('Customer created:', event.data);
     })
-    .on('$customerUpdated', async event => {
-      console.log('Customer updated:', event.data);
-    })
-    .on('$customerDeleted', async event => {
-      console.log('Customer deleted:', event.data);
-    })
-    .on('$subscriptionCreated', async event => {
+    .on('subscription.created', async event => {
       console.log('Subscription created:', event.data);
     })
-    .on('$subscriptionUpdated', async event => {
-      console.log('Subscription updated:', event.data);
-    })
-    .on('$subscriptionCancelled', async event => {
-      console.log('Subscription cancelled:', event.data);
+    .on('payment.created', async event => {
+      console.log('Payment created:', event.data);
     })
-    .on('$invoicePaid', async event => {
-      console.log('Payment received:', event.data);
+    .on('refund.created', async event => {
+      console.log('Refund created:', event.data);
     });
 
-  const headers = Object.fromEntries(request.headers.entries());
   const body = await request.text();
-  await webhook.handle({ body, headers });
+  const headers = Object.fromEntries(request.headers.entries());
+  await webhook.handle({ body, headers, fullUrl: request.url });
 
+  // Return immediately, processing happens in background
   return NextResponse.json({ success: true });
 }
 ```
 
-### Express.js Route
+### Express.js with Webhook Handler
 
 ```typescript
-import { paykit } from '@/lib/paykit';
+import { endpoints, paykit } from '@/lib/paykit';
+import { EndpointPath } from '@paykit-sdk/core';
 import express from 'express';
 
 const app = express();
-app.use(express.raw({ type: 'application/json' }));
 
-app.post('/api/webhooks/polar', async (req, res) => {
-  console.log('Polar webhook received');
-
-  const webhook = paykit.webhooks
-    .setup({ webhookSecret: process.env.POLAR_WEBHOOK_SECRET! })
-    .on('$checkoutCreated', async event => {
-      console.log('Checkout created:', event.data);
-    })
-    .on('$customerCreated', async event => {
-      console.log('Customer created:', event.data);
-    })
-    .on('$invoicePaid', async event => {
-      console.log('Payment received:', event.data);
-    });
-
-  const headers = req.headers;
-  const body = req.body;
-  await webhook.handle({ body, headers });
+// IMPORTANT: Webhook route must come BEFORE express.json() middleware
+// This ensures we get the raw body for signature verification
+app.post(
+  '/api/webhooks/polar',
+  express.raw({ type: 'application/json' }),
+  async (req, res) => {
+    try {
+      const webhookSecret = process.env.POLAR_WEBHOOK_SECRET;
+
+      if (!webhookSecret) {
+        return res.status(500).json({ error: 'Webhook secret not configured' });
+      }
+
+      const webhook = paykit.webhooks
+        .setup({ webhookSecret })
+        .on('customer.created', async event => {
+          console.log('Customer created:', event.data);
+        })
+        .on('subscription.created', async event => {
+          console.log('Subscription created:', event.data);
+        })
+        .on('payment.created', async event => {
+          console.log('Payment created:', event.data);
+        })
+        .on('refund.created', async event => {
+          console.log('Refund created:', event.data);
+        });
+
+      const body = req.body; // Raw buffer from express.raw()
+      const headers = req.headers;
+      await webhook.handle({ body, headers });
+
+      // Return immediately, processing happens in background
+      res.json({ success: true });
+    } catch (error) {
+      console.error('Webhook error:', error);
+      res.status(500).json({
+        message: error instanceof Error ? error.message : 'Webhook processing failed',
+      });
+    }
+  },
+);
 
-  res.json({ success: true });
-});
-```
+// Regular API routes use JSON middleware
+app.use(express.json());
 
-### Vite.js/Nuxt.js
+app.post('/api/paykit/*', async (req, res) => {
+  try {
+    const endpoint = req.path.replace('/api/paykit', '') as EndpointPath;
+    const handler = endpoints[endpoint];
 
-```typescript
-import { paykit } from '@/lib/paykit';
+    if (!handler) {
+      return res.status(404).json({ message: 'Endpoint not found' });
+    }
 
-export default defineEventHandler(async event => {
-  console.log('Polar webhook received');
+    const { args } = req.body;
+    const result = await handler(...args);
 
-  const webhook = paykit.webhooks
-    .setup({ webhookSecret: process.env.POLAR_WEBHOOK_SECRET! })
-    .on('$checkoutCreated', async event => {
-      console.log('Checkout created:', event.data);
-    })
-    .on('$customerCreated', async event => {
-      console.log('Customer created:', event.data);
-    })
-    .on('$invoicePaid', async event => {
-      console.log('Payment received:', event.data);
+    res.json({ result });
+  } catch (error) {
+    res.status(500).json({
+      message: error instanceof Error ? error.message : 'Internal server error',
     });
+  }
+});
 
-  const headers = getHeaders(event);
-  const body = await readBody(event);
-  await webhook.handle({ body, headers });
-
-  return { success: true };
+app.listen(3000, () => {
+  console.log('Server running on port 3000');
 });
 ```
 
-## Subscription Updates
-
-Polar requires specific update types:
+## Subscription Management
 
 ```typescript
-// Change product
-await paykit.subscriptions.update('sub_123', {
-  metadata: { productId: 'new-product-id' },
-});
-
-// Cancel at period end
+// Update subscription
 await paykit.subscriptions.update('sub_123', {
-  metadata: { cancelAtPeriodEnd: 'true' },
+  metadata: { plan: 'enterprise' },
 });
 
-// Cancel with reason
-await paykit.subscriptions.update('sub_123', {
-  metadata: {
-    cancelAtPeriodEnd: 'true',
-    customerCancellationReason: 'too_expensive',
-  },
-});
+// Cancel subscription
+await paykit.subscriptions.cancel('sub_123');
 ```
 
 ## Environment Variables
 
 ```bash
-POLAR_ACCESS_TOKEN=polar_oat_...
-POLAR_WEBHOOK_SECRET=your-webhook-secret
+POLAR_ACCESS_TOKEN=polar_at_...
+POLAR_WEBHOOK_SECRET=polar_wh_...
 ```
 
 ## Support
@@ -183,4 +199,4 @@ POLAR_WEBHOOK_SECRET=your-webhook-secret
 
 ## License
 
-GPL-3.0
+ISC

package/dist/index.d.mts

@@ -1,38 +1,8 @@
-import { PaykitProviderOptions, PayKitProvider, CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
-import { SDKOptions } from '@polar-sh/sdk';
+import { PolarOptions, PolarProvider } from './polar-provider.mjs';
+import '@paykit-sdk/core';
+import '@polar-sh/sdk';
 
-interface PolarConfig extends PaykitProviderOptions<SDKOptions> {
-}
-declare class PolarProvider implements PayKitProvider {
-    private config;
-    private polar;
-    private readonly productionURL;
-    private readonly sandboxURL;
-    constructor(config: PolarConfig);
-    /**
-     * Checkout management
-     */
-    createCheckout: (params: CreateCheckoutParams) => Promise<Checkout>;
-    retrieveCheckout: (id: string) => Promise<Checkout>;
-    /**
-     * Customer management
-     */
-    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
-    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
-    retrieveCustomer: (id: string) => Promise<Customer>;
-    /**
-     * Subscription management
-     */
-    cancelSubscription: (id: string) => Promise<null>;
-    retrieveSubscription: (id: string) => Promise<Subscription>;
-    updateSubscription: (id: string, params: UpdateSubscriptionParams) => Promise<Subscription>;
-    /**
-     * Webhook management
-     */
-    handleWebhook: (params: HandleWebhookParams) => Promise<WebhookEventPayload>;
-}
-
-declare const createPolar: (config: PolarConfig) => PolarProvider;
+declare const createPolar: (config: PolarOptions) => PolarProvider;
 declare const polar: () => PolarProvider;
 
 export { createPolar, polar };

package/dist/index.d.ts

@@ -1,38 +1,8 @@
-import { PaykitProviderOptions, PayKitProvider, CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
-import { SDKOptions } from '@polar-sh/sdk';
+import { PolarOptions, PolarProvider } from './polar-provider.js';
+import '@paykit-sdk/core';
+import '@polar-sh/sdk';
 
-interface PolarConfig extends PaykitProviderOptions<SDKOptions> {
-}
-declare class PolarProvider implements PayKitProvider {
-    private config;
-    private polar;
-    private readonly productionURL;
-    private readonly sandboxURL;
-    constructor(config: PolarConfig);
-    /**
-     * Checkout management
-     */
-    createCheckout: (params: CreateCheckoutParams) => Promise<Checkout>;
-    retrieveCheckout: (id: string) => Promise<Checkout>;
-    /**
-     * Customer management
-     */
-    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
-    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
-    retrieveCustomer: (id: string) => Promise<Customer>;
-    /**
-     * Subscription management
-     */
-    cancelSubscription: (id: string) => Promise<null>;
-    retrieveSubscription: (id: string) => Promise<Subscription>;
-    updateSubscription: (id: string, params: UpdateSubscriptionParams) => Promise<Subscription>;
-    /**
-     * Webhook management
-     */
-    handleWebhook: (params: HandleWebhookParams) => Promise<WebhookEventPayload>;
-}
-
-declare const createPolar: (config: PolarConfig) => PolarProvider;
+declare const createPolar: (config: PolarOptions) => PolarProvider;
 declare const polar: () => PolarProvider;
 
 export { createPolar, polar };