@paykit-sdk/polar 1.0.1 → 1.1.1-alpha.1

package/README.md

@@ -0,0 +1,81 @@
+# @paykit-sdk/polar
+
+Polar provider for PayKit
+
+## Quick Start
+
+```typescript
+import { PayKit } from '@paykit-sdk/core';
+import { polar, createPolar } from '@paykit-sdk/polar';
+
+// Method 1: Using environment variables
+const provider = polar(); // Ensure POLAR_ACCESS_TOKEN environment variable is set
+
+// Method 2: Direct configuration
+const provider = createPolar({
+  accessToken: process.env.POLAR_ACCESS_TOKEN,
+  server: 'sandbox', // or 'production'
+  debug: true,
+});
+
+const paykit = new PayKit(provider);
+
+// Create checkout
+const checkout = await paykit.checkouts.create({
+  item_id: 'product-id',
+  metadata: { plan: 'pro' },
+  provider_metadata: {
+    successUrl: 'https://your-app.com/success',
+  },
+});
+
+// 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);
+  });
+```
+
+## Subscription Updates
+
+Polar requires specific update types:
+
+```typescript
+// Change product
+await paykit.subscriptions.update('sub_123', {
+  metadata: { productId: 'new-product-id' },
+});
+
+// Cancel at period end
+await paykit.subscriptions.update('sub_123', {
+  metadata: { cancelAtPeriodEnd: 'true' },
+});
+
+// Cancel with reason
+await paykit.subscriptions.update('sub_123', {
+  metadata: {
+    cancelAtPeriodEnd: 'true',
+    customerCancellationReason: 'too_expensive',
+  },
+});
+```
+
+## Environment Variables
+
+```bash
+POLAR_ACCESS_TOKEN=polar_oat_...
+POLAR_WEBHOOK_SECRET=your-webhook-secret
+```
+
+## Support
+
+- [Polar Documentation](https://docs.polar.sh/)
+- [PayKit Issues](https://github.com/devodii/paykit/issues)
+
+## License
+
+ISC

package/dist/index.d.mts

@@ -1,9 +1,7 @@
-import { WithPaymentProviderConfig } from '@paykit-sdk/core/src/types';
-import { PayKitProvider } from '@paykit-sdk/core/src/paykit-provider';
-import { CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, WebhookEventPayload } from '@paykit-sdk/core/src/resources';
+import { PaykitProviderOptions, PayKitProvider, CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, $ExtWebhookHandlerConfig, WebhookEventPayload } from '@paykit-sdk/core';
 import { SDKOptions } from '@polar-sh/sdk';
 
-interface PolarConfig extends WithPaymentProviderConfig<Omit<SDKOptions, 'accessToken'>> {
+interface PolarConfig extends PaykitProviderOptions<SDKOptions> {
 }
 declare class PolarProvider implements PayKitProvider {
     private config;
@@ -25,16 +23,16 @@ declare class PolarProvider implements PayKitProvider {
     /**
      * Subscription management
      */
-    cancelSubscription: (id: string) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<null>;
     retrieveSubscription: (id: string) => Promise<Subscription>;
     updateSubscription: (id: string, params: UpdateSubscriptionParams) => Promise<Subscription>;
     /**
      * Webhook management
      */
-    handleWebhook: (payload: string, signature: string, secret: string) => Promise<WebhookEventPayload>;
+    handleWebhook: (params: $ExtWebhookHandlerConfig) => Promise<WebhookEventPayload>;
 }
 
-declare const createPolar: (config: WithPaymentProviderConfig<PolarConfig>) => PolarProvider;
+declare const createPolar: (config: PolarConfig) => PolarProvider;
 declare const polar: () => PolarProvider;
 
 export { createPolar, polar };

package/dist/index.d.ts

@@ -1,9 +1,7 @@
-import { WithPaymentProviderConfig } from '@paykit-sdk/core/src/types';
-import { PayKitProvider } from '@paykit-sdk/core/src/paykit-provider';
-import { CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, WebhookEventPayload } from '@paykit-sdk/core/src/resources';
+import { PaykitProviderOptions, PayKitProvider, CreateCheckoutParams, Checkout, CreateCustomerParams, Customer, UpdateCustomerParams, Subscription, UpdateSubscriptionParams, $ExtWebhookHandlerConfig, WebhookEventPayload } from '@paykit-sdk/core';
 import { SDKOptions } from '@polar-sh/sdk';
 
-interface PolarConfig extends WithPaymentProviderConfig<Omit<SDKOptions, 'accessToken'>> {
+interface PolarConfig extends PaykitProviderOptions<SDKOptions> {
 }
 declare class PolarProvider implements PayKitProvider {
     private config;
@@ -25,16 +23,16 @@ declare class PolarProvider implements PayKitProvider {
     /**
      * Subscription management
      */
-    cancelSubscription: (id: string) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<null>;
     retrieveSubscription: (id: string) => Promise<Subscription>;
     updateSubscription: (id: string, params: UpdateSubscriptionParams) => Promise<Subscription>;
     /**
      * Webhook management
      */
-    handleWebhook: (payload: string, signature: string, secret: string) => Promise<WebhookEventPayload>;
+    handleWebhook: (params: $ExtWebhookHandlerConfig) => Promise<WebhookEventPayload>;
 }
 
-declare const createPolar: (config: WithPaymentProviderConfig<PolarConfig>) => PolarProvider;
+declare const createPolar: (config: PolarConfig) => PolarProvider;
 declare const polar: () => PolarProvider;
 
 export { createPolar, polar };

package/dist/index.js

@@ -26,48 +26,65 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 
 // src/polar-provider.ts
-var import_resources2 = require("@paykit-sdk/core/src/resources");
+var import_core2 = require("@paykit-sdk/core");
 var import_sdk = require("@polar-sh/sdk");
+var import_webhooks = require("@polar-sh/sdk/webhooks");
 
 // lib/mapper.ts
-var import_resources = require("@paykit-sdk/core/src/resources/");
+var import_core = require("@paykit-sdk/core");
 var toPaykitCheckout = (checkout) => {
   return {
     id: checkout.id,
-    url: checkout.url,
-    cancel_url: void 0,
+    payment_url: checkout.url,
     customer_id: checkout.customerId,
-    mode: "payment",
-    success_url: checkout.successUrl,
+    session_type: checkout.subscriptionId ? "recurring" : "one_time",
     products: checkout.products.map((product) => ({ id: product.id, quantity: 1 })),
-    metadata: checkout.metadata
+    metadata: checkout.metadata ?? null,
+    currency: checkout.currency,
+    amount: checkout.amount
   };
 };
 var toPaykitCustomer = (customer) => {
   return { id: customer.id, email: customer.email, name: customer.name ?? void 0 };
 };
+var toPaykitSubscriptionStatus = (status) => {
+  if (status === "active") return "active";
+  if (status === "past_due" || status === "incomplete") return "past_due";
+  if (status === "canceled" || status === "unpaid") return "canceled";
+  if (status === "incomplete_expired") return "expired";
+  throw new Error(`Unhandled status: ${status}`);
+};
 var toPaykitSubscription = (subscription) => {
   return {
     id: subscription.id,
     customer_id: subscription.customerId,
-    status: (0, import_resources.toPaykitSubscriptionStatus)(subscription.status),
+    status: toPaykitSubscriptionStatus(subscription.status),
     current_period_start: new Date(subscription.currentPeriodStart),
     current_period_end: new Date(subscription.currentPeriodEnd)
   };
 };
+var toPaykitInvoice = (invoice) => {
+  return {
+    id: invoice.id,
+    amount: invoice.totalAmount,
+    currency: invoice.currency,
+    metadata: (0, import_core.stringifyObjectValues)(invoice.metadata ?? {}),
+    customer_id: invoice.customerId
+  };
+};
 
 // src/polar-provider.ts
 var PolarProvider = class {
   constructor(config) {
     this.config = config;
-    this.productionURL = "https://api.polar.sh";
-    this.sandboxURL = "https://api.sandbox.polar.sh";
+    this.productionURL = import_sdk.ServerList["production"];
+    this.sandboxURL = import_sdk.ServerList["sandbox"];
     /**
      * Checkout management
      */
     this.createCheckout = async (params) => {
-      const { metadata, success_url, price_id } = params;
-      const response = await this.polar.checkouts.create({ ...metadata && { metadata }, successUrl: success_url, products: [price_id] });
+      const { metadata, item_id, provider_metadata } = params;
+      const response = await this.polar.checkouts.create({ metadata, products: [item_id], ...provider_metadata });
       return toPaykitCheckout(response);
     };
     this.retrieveCheckout = async (id) => {
@@ -84,7 +101,10 @@ var PolarProvider = class {
     };
     this.updateCustomer = async (id, params) => {
       const { email, name, metadata } = params;
-      const response = await this.polar.customers.update({ id, customerUpdate: { email, name, ...metadata && { metadata } } });
+      const response = await this.polar.customers.update({
+        id,
+        customerUpdate: { ...email && { email }, ...name && { name }, ...metadata && { metadata } }
+      });
       return toPaykitCustomer(response);
     };
     this.retrieveCustomer = async (id) => {
@@ -95,31 +115,54 @@ var PolarProvider = class {
      * Subscription management
      */
     this.cancelSubscription = async (id) => {
-      const response = await this.polar.subscriptions.revoke({ id });
-      return toPaykitSubscription(response);
+      await this.polar.subscriptions.revoke({ id });
+      return null;
     };
     this.retrieveSubscription = async (id) => {
       const response = await this.polar.subscriptions.get({ id });
       return toPaykitSubscription(response);
     };
     this.updateSubscription = async (id, params) => {
-      const subscription = await this.retrieveSubscription(id);
-      return subscription;
+      const response = await this.polar.subscriptions.update({ id, subscriptionUpdate: { ...params.metadata } });
+      return toPaykitSubscription(response);
     };
     /**
      * Webhook management
      */
-    this.handleWebhook = async (payload, signature, secret) => {
-      const response = await this.polar.events.get({ id: payload });
-      return (0, import_resources2.toPaykitEvent)({
-        data: response,
-        created: new Date(response.timestamp).getTime(),
-        id: response.id,
-        type: response.name
-      });
+    this.handleWebhook = async (params) => {
+      const { body, headers, webhookSecret } = params;
+      const webhookHeaders = (0, import_core2.headersExtractor)(headers, ["webhook-id", "webhook-timestamp", "webhook-signature"]).reduce(
+        (acc, kv) => {
+          acc[kv.key] = Array.isArray(kv.value) ? kv.value.join(",") : kv.value;
+          return acc;
+        },
+        {}
+      );
+      console.log({ headers, webhookHeaders, webhookSecret, body });
+      const { data, type } = (0, import_webhooks.validateEvent)(body, webhookHeaders, webhookSecret);
+      const id = webhookHeaders["webhook-id"];
+      const timestamp = webhookHeaders["webhook-timestamp"];
+      if (type === "subscription.updated") {
+        return (0, import_core2.toPaykitEvent)({ type: "$subscriptionUpdated", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "subscription.created") {
+        return (0, import_core2.toPaykitEvent)({ type: "$subscriptionCreated", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "subscription.revoked") {
+        return (0, import_core2.toPaykitEvent)({ type: "$subscriptionCancelled", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "customer.created") {
+        return (0, import_core2.toPaykitEvent)({ type: "$customerCreated", created: parseInt(timestamp), id, data: toPaykitCustomer(data) });
+      } else if (type === "customer.updated") {
+        return (0, import_core2.toPaykitEvent)({ type: "$customerUpdated", created: parseInt(timestamp), id, data: toPaykitCustomer(data) });
+      } else if (type === "customer.deleted") {
+        return (0, import_core2.toPaykitEvent)({ type: "$customerDeleted", created: parseInt(timestamp), id, data: null });
+      } else if (type === "checkout.created") {
+        return (0, import_core2.toPaykitEvent)({ type: "$checkoutCreated", created: parseInt(timestamp), id, data: toPaykitCheckout(data) });
+      } else if (type === "order.created") {
+        return (0, import_core2.toPaykitEvent)({ type: "$invoicePaid", created: parseInt(timestamp), id, data: toPaykitInvoice(data) });
+      }
+      throw new Error(`Unhandled event type: ${type}`);
     };
-    const { apiKey, environment = "test", ...rest } = config;
-    this.polar = new import_sdk.Polar({ ...rest, accessToken: apiKey, serverURL: environment === "test" ? this.sandboxURL : this.productionURL });
+    const { accessToken, server, ...rest } = config;
+    this.polar = new import_sdk.Polar({ accessToken, serverURL: server === "sandbox" ? this.sandboxURL : this.productionURL, ...rest });
   }
 };
 
@@ -128,10 +171,10 @@ var createPolar = (config) => {
   return new PolarProvider(config);
 };
 var polar = () => {
-  const apiKey = process.env.POLAR_ACCESS_TOKEN;
+  const accessToken = process.env.POLAR_ACCESS_TOKEN;
   const isDev = process.env.NODE_ENV === "development";
-  if (!apiKey) throw new Error("POLAR_ACCESS_TOKEN is not set");
-  return createPolar({ apiKey, environment: isDev ? "test" : "live" });
+  if (!accessToken) throw new Error("POLAR_ACCESS_TOKEN is not set");
+  return createPolar({ debug: true, accessToken, server: isDev ? "sandbox" : "production" });
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.mjs

@@ -1,28 +1,37 @@
 // src/polar-provider.ts
 import {
-  toPaykitEvent
-} from "@paykit-sdk/core/src/resources";
-import { Polar } from "@polar-sh/sdk";
+  toPaykitEvent,
+  headersExtractor
+} from "@paykit-sdk/core";
+import { Polar, ServerList } from "@polar-sh/sdk";
+import { validateEvent } from "@polar-sh/sdk/webhooks";
 
 // lib/mapper.ts
 import {
-  toPaykitSubscriptionStatus
-} from "@paykit-sdk/core/src/resources/";
+  stringifyObjectValues
+} from "@paykit-sdk/core";
 var toPaykitCheckout = (checkout) => {
   return {
     id: checkout.id,
-    url: checkout.url,
-    cancel_url: void 0,
+    payment_url: checkout.url,
     customer_id: checkout.customerId,
-    mode: "payment",
-    success_url: checkout.successUrl,
+    session_type: checkout.subscriptionId ? "recurring" : "one_time",
     products: checkout.products.map((product) => ({ id: product.id, quantity: 1 })),
-    metadata: checkout.metadata
+    metadata: checkout.metadata ?? null,
+    currency: checkout.currency,
+    amount: checkout.amount
   };
 };
 var toPaykitCustomer = (customer) => {
   return { id: customer.id, email: customer.email, name: customer.name ?? void 0 };
 };
+var toPaykitSubscriptionStatus = (status) => {
+  if (status === "active") return "active";
+  if (status === "past_due" || status === "incomplete") return "past_due";
+  if (status === "canceled" || status === "unpaid") return "canceled";
+  if (status === "incomplete_expired") return "expired";
+  throw new Error(`Unhandled status: ${status}`);
+};
 var toPaykitSubscription = (subscription) => {
   return {
     id: subscription.id,
@@ -32,19 +41,28 @@ var toPaykitSubscription = (subscription) => {
     current_period_end: new Date(subscription.currentPeriodEnd)
   };
 };
+var toPaykitInvoice = (invoice) => {
+  return {
+    id: invoice.id,
+    amount: invoice.totalAmount,
+    currency: invoice.currency,
+    metadata: stringifyObjectValues(invoice.metadata ?? {}),
+    customer_id: invoice.customerId
+  };
+};
 
 // src/polar-provider.ts
 var PolarProvider = class {
   constructor(config) {
     this.config = config;
-    this.productionURL = "https://api.polar.sh";
-    this.sandboxURL = "https://api.sandbox.polar.sh";
+    this.productionURL = ServerList["production"];
+    this.sandboxURL = ServerList["sandbox"];
     /**
      * Checkout management
      */
     this.createCheckout = async (params) => {
-      const { metadata, success_url, price_id } = params;
-      const response = await this.polar.checkouts.create({ ...metadata && { metadata }, successUrl: success_url, products: [price_id] });
+      const { metadata, item_id, provider_metadata } = params;
+      const response = await this.polar.checkouts.create({ metadata, products: [item_id], ...provider_metadata });
       return toPaykitCheckout(response);
     };
     this.retrieveCheckout = async (id) => {
@@ -61,7 +79,10 @@ var PolarProvider = class {
     };
     this.updateCustomer = async (id, params) => {
       const { email, name, metadata } = params;
-      const response = await this.polar.customers.update({ id, customerUpdate: { email, name, ...metadata && { metadata } } });
+      const response = await this.polar.customers.update({
+        id,
+        customerUpdate: { ...email && { email }, ...name && { name }, ...metadata && { metadata } }
+      });
       return toPaykitCustomer(response);
     };
     this.retrieveCustomer = async (id) => {
@@ -72,31 +93,54 @@ var PolarProvider = class {
      * Subscription management
      */
     this.cancelSubscription = async (id) => {
-      const response = await this.polar.subscriptions.revoke({ id });
-      return toPaykitSubscription(response);
+      await this.polar.subscriptions.revoke({ id });
+      return null;
     };
     this.retrieveSubscription = async (id) => {
       const response = await this.polar.subscriptions.get({ id });
       return toPaykitSubscription(response);
     };
     this.updateSubscription = async (id, params) => {
-      const subscription = await this.retrieveSubscription(id);
-      return subscription;
+      const response = await this.polar.subscriptions.update({ id, subscriptionUpdate: { ...params.metadata } });
+      return toPaykitSubscription(response);
     };
     /**
      * Webhook management
      */
-    this.handleWebhook = async (payload, signature, secret) => {
-      const response = await this.polar.events.get({ id: payload });
-      return toPaykitEvent({
-        data: response,
-        created: new Date(response.timestamp).getTime(),
-        id: response.id,
-        type: response.name
-      });
+    this.handleWebhook = async (params) => {
+      const { body, headers, webhookSecret } = params;
+      const webhookHeaders = headersExtractor(headers, ["webhook-id", "webhook-timestamp", "webhook-signature"]).reduce(
+        (acc, kv) => {
+          acc[kv.key] = Array.isArray(kv.value) ? kv.value.join(",") : kv.value;
+          return acc;
+        },
+        {}
+      );
+      console.log({ headers, webhookHeaders, webhookSecret, body });
+      const { data, type } = validateEvent(body, webhookHeaders, webhookSecret);
+      const id = webhookHeaders["webhook-id"];
+      const timestamp = webhookHeaders["webhook-timestamp"];
+      if (type === "subscription.updated") {
+        return toPaykitEvent({ type: "$subscriptionUpdated", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "subscription.created") {
+        return toPaykitEvent({ type: "$subscriptionCreated", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "subscription.revoked") {
+        return toPaykitEvent({ type: "$subscriptionCancelled", created: parseInt(timestamp), id, data: toPaykitSubscription(data) });
+      } else if (type === "customer.created") {
+        return toPaykitEvent({ type: "$customerCreated", created: parseInt(timestamp), id, data: toPaykitCustomer(data) });
+      } else if (type === "customer.updated") {
+        return toPaykitEvent({ type: "$customerUpdated", created: parseInt(timestamp), id, data: toPaykitCustomer(data) });
+      } else if (type === "customer.deleted") {
+        return toPaykitEvent({ type: "$customerDeleted", created: parseInt(timestamp), id, data: null });
+      } else if (type === "checkout.created") {
+        return toPaykitEvent({ type: "$checkoutCreated", created: parseInt(timestamp), id, data: toPaykitCheckout(data) });
+      } else if (type === "order.created") {
+        return toPaykitEvent({ type: "$invoicePaid", created: parseInt(timestamp), id, data: toPaykitInvoice(data) });
+      }
+      throw new Error(`Unhandled event type: ${type}`);
     };
-    const { apiKey, environment = "test", ...rest } = config;
-    this.polar = new Polar({ ...rest, accessToken: apiKey, serverURL: environment === "test" ? this.sandboxURL : this.productionURL });
+    const { accessToken, server, ...rest } = config;
+    this.polar = new Polar({ accessToken, serverURL: server === "sandbox" ? this.sandboxURL : this.productionURL, ...rest });
   }
 };
 
@@ -105,10 +149,10 @@ var createPolar = (config) => {
   return new PolarProvider(config);
 };
 var polar = () => {
-  const apiKey = process.env.POLAR_ACCESS_TOKEN;
+  const accessToken = process.env.POLAR_ACCESS_TOKEN;
   const isDev = process.env.NODE_ENV === "development";
-  if (!apiKey) throw new Error("POLAR_ACCESS_TOKEN is not set");
-  return createPolar({ apiKey, environment: isDev ? "test" : "live" });
+  if (!accessToken) throw new Error("POLAR_ACCESS_TOKEN is not set");
+  return createPolar({ debug: true, accessToken, server: isDev ? "sandbox" : "production" });
 };
 export {
   createPolar,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paykit-sdk/polar",
-  "version": "1.0.1",
+  "version": "1.1.1-alpha.1",
   "description": "Polar provider for PayKit",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -10,7 +10,7 @@
   ],
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "rm -rf dist && npm run build"
   },
   "keywords": [
     "polar",
@@ -24,12 +24,12 @@
     "@polar-sh/sdk": "^0.33.0"
   },
   "peerDependencies": {
-    "@paykit-sdk/core": "^1.0.0"
+    "@paykit-sdk/core": "^1.1.1"
   },
   "devDependencies": {
+    "@paykit-sdk/core": "workspace:*",
     "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "@paykit-sdk/core": "workspace:*"
+    "typescript": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"