@paykit-sdk/gopay 1.0.0

package/README.md

@@ -0,0 +1,185 @@
+# @paykit-sdk/gopay
+
+Stripe provider for PayKit
+
+## Quick Start
+
+```typescript
+import { createEndpointHandlers, PayKit } from '@paykit-sdk/core';
+import { gopay, createGopay } from '@paykit-sdk/gopay';
+
+// Method 1: Using environment variables
+const provider = gopay(); // Ensure GOPAY_CLIENT_ID, GOPAY_CLIENT_SECRET, GOPAY_GO_ID, GOPAY_SANDBOX, GOPAY_WEBHOOK_URL   environment variables are set
+
+// Method 2: Direct configuration
+const provider = createGopay({
+  clientId: 'sk_test_...',
+  clientSecret: 'clsec_...',
+  goId: 'go...',
+  isSandbox: true,
+  webhookUrl: 'http://localhost:8080/api/paykit/webhook',
+});
+
+export const paykit = new PayKit(provider);
+export const endpoints = createEndpointHandlers(paykit);
+```
+
+### Next.js Catch All API Route (/api/paykit/[...endpoint]/route.ts)
+
+```typescript
+import { paykit } from '@/lib/paykit';
+import { EndpointPath } from '@paykit-sdk/core';
+
+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 Webhooks (/api/paykit/webhooks/route.ts)
+
+```typescript
+import { paykit } from '@/lib/paykit';
+import { NextRequest } from 'next/server';
+
+export async function POST(request: NextRequest) {
+  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);
+    });
+    .on('invoice.generated', async event => {
+      console.log('Invoice generated:', event.data);
+    });
+
+  const body = await request.text();
+  const headers = Object.fromEntries(request.headers.entries());
+  const url = request.url
+  await webhook.handle({ body, headers, fullUrl: url });
+
+  // Return immediately, processing happens in background
+  return NextResponse.json({ success: true });
+}
+```
+
+### Express.js with Webhook Handler
+
+```typescript
+import { paykit, endpoints } from '@/lib/paykit';
+import { createEndpointHandlers, EndpointPath } from '@paykit-sdk/core';
+import express from 'express';
+
+const app = express();
+
+// IMPORTANT: Webhook route must come BEFORE express.json() middleware
+// This ensures we get the raw body for signature verification
+app.post('/api/webhooks/gopay', express.raw({ type: 'application/json' }), async (req, res) => {
+  try {
+    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);
+      })
+      .on('invoice.generated', async event => {
+        console.log('Invoice generated:', event.data);
+      });
+
+    const body = req.body; // Raw buffer from express.raw()
+    const headers = req.headers;
+    const url = request.url;
+    await webhook.handle({ body, headers, fullUrl: url });
+
+    // 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',
+    });
+  }
+});
+
+// Regular API routes use JSON middleware
+app.use(express.json());
+
+app.post('/api/paykit/*', async (req, res) => {
+  try {
+    const endpoint = req.path.replace('/api/paykit', '') as EndpointPath;
+    const handler = endpoints[endpoint];
+
+    if (!handler) {
+      return res.status(404).json({ message: 'Endpoint not found' });
+    }
+
+    const { args } = req.body;
+    const result = await handler(...args);
+
+    res.json({ result });
+  } catch (error) {
+    res.status(500).json({
+      message: error instanceof Error ? error.message : 'Internal server error',
+    });
+  }
+});
+
+app.listen(3000, () => {
+  console.log('Server running on port 3000');
+});
+```
+
+## Environment Variables
+
+```bash
+GOPAY_CLIENT_ID=sk_test_...
+GOPAY_CLIENT_SECRET=clsec_...
+GOPAY_GO_ID=go...
+GOPAY_SANDBOX=true
+GOPAY_WEBHOOK_URL=http://localhost:8080/api/paykit/webhook
+```
+
+## Support
+
+- [Gopay Documentation](https://doc.gopay.com/)
+
+## License
+
+ISC

package/dist/controllers/auth.d.mts

@@ -0,0 +1,19 @@
+import { GoPayOptions } from '../gopay-provider.mjs';
+import '@paykit-sdk/core';
+
+declare class AuthController {
+    private opts;
+    private _client;
+    private _accessToken;
+    constructor(opts: GoPayOptions & {
+        baseUrl: string;
+    });
+    getAccessToken: () => Promise<string>;
+    getAuthHeaders: () => Promise<{
+        Authorization: string;
+        'Content-Type': string;
+        Accept: string;
+    }>;
+}
+
+export { AuthController };

package/dist/controllers/auth.d.ts

@@ -0,0 +1,19 @@
+import { GoPayOptions } from '../gopay-provider.js';
+import '@paykit-sdk/core';
+
+declare class AuthController {
+    private opts;
+    private _client;
+    private _accessToken;
+    constructor(opts: GoPayOptions & {
+        baseUrl: string;
+    });
+    getAccessToken: () => Promise<string>;
+    getAuthHeaders: () => Promise<{
+        Authorization: string;
+        'Content-Type': string;
+        Accept: string;
+    }>;
+}
+
+export { AuthController };

package/dist/controllers/auth.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var core = require('@paykit-sdk/core');
+
+// src/controllers/auth.ts
+var AuthController = class {
+  constructor(opts) {
+    this.opts = opts;
+    const debug = opts.debug ?? true;
+    this._client = new core.HTTPClient({ baseUrl: this.opts.baseUrl, headers: {}, retryOptions: { max: 3, baseDelay: 1e3, debug } });
+  }
+  _client;
+  _accessToken = null;
+  getAccessToken = async () => {
+    if (this._accessToken) {
+      const [token, , expiryStr] = this._accessToken.split("::paykit::");
+      const expiry = parseInt(expiryStr || "0", 10);
+      if (expiry > Date.now()) return token;
+    }
+    const credentials = Buffer.from(`${this.opts.clientId}:${this.opts.clientSecret}`).toString("base64");
+    const response = await this._client.post("/oauth2/token", {
+      headers: { Authorization: `Basic ${credentials}`, "Content-Type": "application/x-www-form-urlencoded" },
+      body: new URLSearchParams({ grant_type: "client_credentials", scope: "payment-all" }).toString()
+    });
+    if (!response.ok || !response.value.access_token) {
+      throw new core.OperationFailedError("getAccessToken", "gopay", {
+        cause: new Error("Failed to obtain GoPay access token")
+      });
+    }
+    const expiryTime = Date.now() + (response.value.expires_in - 300) * 1e3;
+    const accessToken = `${response.value.access_token}::paykit::${expiryTime}`;
+    this._accessToken = accessToken;
+    return accessToken;
+  };
+  getAuthHeaders = async () => {
+    const token = await this.getAccessToken();
+    return { Authorization: `Bearer ${token}`, "Content-Type": "application/json", Accept: "application/json" };
+  };
+};
+
+exports.AuthController = AuthController;

package/dist/controllers/auth.mjs

@@ -0,0 +1,39 @@
+import { HTTPClient, OperationFailedError } from '@paykit-sdk/core';
+
+// src/controllers/auth.ts
+var AuthController = class {
+  constructor(opts) {
+    this.opts = opts;
+    const debug = opts.debug ?? true;
+    this._client = new HTTPClient({ baseUrl: this.opts.baseUrl, headers: {}, retryOptions: { max: 3, baseDelay: 1e3, debug } });
+  }
+  _client;
+  _accessToken = null;
+  getAccessToken = async () => {
+    if (this._accessToken) {
+      const [token, , expiryStr] = this._accessToken.split("::paykit::");
+      const expiry = parseInt(expiryStr || "0", 10);
+      if (expiry > Date.now()) return token;
+    }
+    const credentials = Buffer.from(`${this.opts.clientId}:${this.opts.clientSecret}`).toString("base64");
+    const response = await this._client.post("/oauth2/token", {
+      headers: { Authorization: `Basic ${credentials}`, "Content-Type": "application/x-www-form-urlencoded" },
+      body: new URLSearchParams({ grant_type: "client_credentials", scope: "payment-all" }).toString()
+    });
+    if (!response.ok || !response.value.access_token) {
+      throw new OperationFailedError("getAccessToken", "gopay", {
+        cause: new Error("Failed to obtain GoPay access token")
+      });
+    }
+    const expiryTime = Date.now() + (response.value.expires_in - 300) * 1e3;
+    const accessToken = `${response.value.access_token}::paykit::${expiryTime}`;
+    this._accessToken = accessToken;
+    return accessToken;
+  };
+  getAuthHeaders = async () => {
+    const token = await this.getAccessToken();
+    return { Authorization: `Bearer ${token}`, "Content-Type": "application/json", Accept: "application/json" };
+  };
+};
+
+export { AuthController };

package/dist/gopay-provider.d.mts

@@ -0,0 +1,58 @@
+import { PaykitProviderOptions, AbstractPayKitProvider, PayKitProvider, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, CreatePaymentSchema, Payment, CapturePaymentSchema, UpdatePaymentSchema, CreateRefundSchema, Refund, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface GoPayOptions extends PaykitProviderOptions {
+    /**
+     * The client ID for the GoPay API
+     */
+    clientId: string;
+    /**
+     * The client secret for the GoPay API
+     */
+    clientSecret: string;
+    /**
+     * The GoID for the GoPay API
+     */
+    goId: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+    /**
+     * The webhook URL for the GoPay API
+     */
+    webhookUrl: string;
+}
+declare class GoPayProvider extends AbstractPayKitProvider implements PayKitProvider {
+    private readonly opts;
+    readonly providerName = "gopay";
+    private _client;
+    private baseUrl;
+    private authController;
+    constructor(opts: GoPayOptions);
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    retrieveCheckout: (id: string) => Promise<Checkout | null>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    retrieveSubscription: (id: string) => Promise<Subscription | null>;
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    deletePayment: (id: string) => Promise<null>;
+    capturePayment: (id: string, params: CapturePaymentSchema) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Update payment - not supported by GoPay
+     */
+    updatePayment: (id: string, params: UpdatePaymentSchema) => Promise<Payment>;
+    createRefund(params: CreateRefundSchema): Promise<Refund>;
+    handleWebhook: (payload: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type GoPayOptions, GoPayProvider };

package/dist/gopay-provider.d.ts

@@ -0,0 +1,58 @@
+import { PaykitProviderOptions, AbstractPayKitProvider, PayKitProvider, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, CreatePaymentSchema, Payment, CapturePaymentSchema, UpdatePaymentSchema, CreateRefundSchema, Refund, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface GoPayOptions extends PaykitProviderOptions {
+    /**
+     * The client ID for the GoPay API
+     */
+    clientId: string;
+    /**
+     * The client secret for the GoPay API
+     */
+    clientSecret: string;
+    /**
+     * The GoID for the GoPay API
+     */
+    goId: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+    /**
+     * The webhook URL for the GoPay API
+     */
+    webhookUrl: string;
+}
+declare class GoPayProvider extends AbstractPayKitProvider implements PayKitProvider {
+    private readonly opts;
+    readonly providerName = "gopay";
+    private _client;
+    private baseUrl;
+    private authController;
+    constructor(opts: GoPayOptions);
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    retrieveCheckout: (id: string) => Promise<Checkout | null>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    retrieveSubscription: (id: string) => Promise<Subscription | null>;
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    deletePayment: (id: string) => Promise<null>;
+    capturePayment: (id: string, params: CapturePaymentSchema) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Update payment - not supported by GoPay
+     */
+    updatePayment: (id: string, params: UpdatePaymentSchema) => Promise<Payment>;
+    createRefund(params: CreateRefundSchema): Promise<Refund>;
+    handleWebhook: (payload: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type GoPayOptions, GoPayProvider };