@paykit-sdk/paystack 1.0.1 → 1.2.1

package/README.md

@@ -0,0 +1,154 @@
+# @paykit-sdk/paystack
+
+Paystack provider for PayKit.
+
+## Installation
+
+```bash
+npm install @paykit-sdk/paystack
+# or
+pnpm add @paykit-sdk/paystack
+```
+
+## Quick Start
+
+```typescript
+import { createEndpointHandlers, PayKit } from '@paykit-sdk/core';
+import { paystack } from '@paykit-sdk/paystack';
+
+export const paykit = new PayKit(paystack());
+export const endpoints = createEndpointHandlers(paykit);
+```
+
+Or with direct config:
+
+```typescript
+import { PayKit } from '@paykit-sdk/core';
+import { createPaystack } from '@paykit-sdk/paystack';
+
+export const paykit = new PayKit(
+  createPaystack({
+    secretKey: 'sk_test_...',
+    isSandbox: true,
+  }),
+);
+```
+
+## Environment Variables
+
+```bash
+PAYSTACK_SECRET_KEY=sk_test_...
+```
+
+`isSandbox` is inferred from `NODE_ENV` — set `NODE_ENV=production` for live mode.
+
+## Next.js API Route
+
+```typescript
+// app/api/paykit/[...endpoint]/route.ts
+import { endpoints } from '@/lib/paykit';
+import { EndpointPath } from '@paykit-sdk/core';
+import { NextRequest, NextResponse } from 'next/server';
+
+export async function POST(
+  request: NextRequest,
+  { params }: { params: Promise<{ endpoint: string[] }> },
+) {
+  const { endpoint: endpointArray } = await params;
+  const endpoint = ('/' + endpointArray.join('/')) as EndpointPath;
+  const handler = endpoints[endpoint];
+
+  if (!handler) {
+    return NextResponse.json(
+      { message: 'Not found' },
+      { status: 404 },
+    );
+  }
+
+  const { args } = await request.json();
+  const result = await handler(...args);
+  return NextResponse.json({ result });
+}
+```
+
+## Webhooks
+
+Paystack sends signed POST requests. Pass your webhook secret to verify signatures.
+
+```typescript
+// app/api/paykit/webhooks/route.ts
+import { paykit } from '@/lib/paykit';
+import { NextRequest, NextResponse } from 'next/server';
+
+export async function POST(request: NextRequest) {
+  const body = await request.text();
+
+  const webhook = paykit.webhooks
+    .setup({ webhookSecret: process.env.PAYSTACK_SECRET_KEY! })
+    .on('payment.created', async event => {
+      /* charge.success — pending authorization */
+    })
+    .on('payment.updated', async event => {
+      /* charge.dispute.create — pre-auth hold updated */
+    })
+    .on('payment.failed', async event => {
+      /* charge.failed */
+    })
+    .on('invoice.generated', async event => {
+      /* invoice.payment_failed or invoice.update */
+    })
+    .on('customer.created', async event => {
+      /* customeridentification.success */
+    })
+    .on('customer.updated', async event => {
+      /* customeridentification.failed */
+    })
+    .on('subscription.created', async event => {
+      /* subscription.create */
+    })
+    .on('subscription.canceled', async event => {
+      /* subscription.disable */
+    });
+
+  await webhook.handle({
+    body,
+    headersAsObject: Object.fromEntries(request.headers),
+    fullUrl: request.url,
+  });
+
+  return NextResponse.json({ received: true });
+}
+```
+
+## Checkout
+
+Paystack requires an email customer and amount/currency in `provider_metadata`:
+
+```typescript
+const checkout = await paykit.checkouts.create({
+  customer: { email: 'user@example.com' },
+  item_id: 'plan_pro',
+  session_type: 'one_time',
+  quantity: 1,
+  success_url: 'https://example.com/success',
+  provider_metadata: {
+    amount: 50000, // in kobo (NGN) or smallest currency unit
+    currency: 'NGN',
+  },
+});
+
+// Redirect user to checkout.payment_url
+```
+
+## Documentation
+
+Full docs at [docs.usepaykit.com/providers/paystack](https://docs.usepaykit.com/providers/paystack).
+
+## Support
+
+- [Paystack Documentation](https://paystack.com/docs)
+- [PayKit Issues](https://github.com/usepaykit/paykit-sdk/issues)
+
+## License
+
+ISC

package/dist/index.js

@@ -4086,11 +4086,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -4130,9 +4136,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/dist/index.mjs

@@ -4084,11 +4084,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -4128,9 +4134,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/dist/paystack-provider.js

@@ -4086,11 +4086,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -4130,9 +4136,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/dist/paystack-provider.mjs

@@ -4084,11 +4084,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -4128,9 +4134,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/dist/utils/mapper.js

@@ -41,11 +41,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -85,9 +91,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/dist/utils/mapper.mjs

@@ -39,11 +39,17 @@ var Payment$inboundSchema = (data, overridePaymentUrl) => {
     itemId = paykitMeta.item_id ?? null;
   }
   const status = paystackStatusMap[data.status] ?? "pending";
+  let customer = null;
+  if (data.customer?.email) {
+    customer = { email: data.customer.email };
+  } else if (data.customer?.id) {
+    customer = { id: data.customer.id };
+  }
   return {
     id: data.reference,
     amount: data.amount,
     currency: data.currency,
-    customer: data.customer?.email ? { email: data.customer.email } : null,
+    customer,
     status,
     metadata,
     item_id: itemId,
@@ -83,9 +89,15 @@ var Checkout$inboundSchema = (init, transaction) => {
       type = parsed.type ?? null;
     }
   }
+  let customer = null;
+  if (transaction.customer?.email) {
+    customer = { email: transaction.customer.email };
+  } else if (transaction.customer?.id) {
+    customer = { id: transaction.customer.id };
+  }
   return {
     id: init.reference,
-    customer: transaction.customer?.email ? { email: transaction.customer.email } : null,
+    customer,
     payment_url: init.authorization_url,
     metadata: Object.keys(metadata).length > 0 ? metadata : null,
     session_type: type ?? "one_time",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paykit-sdk/paystack",
-  "version": "1.0.1",
+  "version": "1.2.1",
   "description": "Paystack provider for PayKit",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -8,6 +8,9 @@
   "files": [
     "dist"
   ],
+  "paykit": {
+    "type": "provider"
+  },
   "scripts": {
     "build": "tsup"
   },
@@ -20,7 +23,7 @@
   "author": "Emmanuel Odii",
   "license": "ISC",
   "peerDependencies": {
-    "@paykit-sdk/core": ">=1.1.103"
+    "@paykit-sdk/core": ">=1.2.2"
   },
   "devDependencies": {
     "@paykit-sdk/core": "workspace:*",