@paykit-sdk/comgate 1.0.0

package/README.md

@@ -0,0 +1,199 @@
+# @paykit-sdk/comgate
+
+Comgate provider for PayKit
+
+## Quick Start
+
+```typescript
+import { createEndpointHandlers, PayKit } from '@paykit-sdk/core';
+import { comgate, createComgate } from '@paykit-sdk/comgate';
+
+// Method 1: Using environment variables
+const provider = comgate(); // Ensure COMGATE_MERCHANT, COMGATE_SECRET, COMGATE_SANDBOX environment variables are set
+
+// Method 2: Direct configuration
+const provider = createComgate({
+  merchant: 'mer_',
+  isSandbox: true,
+  secret: 'xxx'
+});
+
+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: process.env.COMGATE_SECRET })
+    .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/comgate', express.raw({ type: 'application/json' }), async (req, res) => {
+  try {
+    const webhookSecret = process.env.COMGATE_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);
+      })
+      .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');
+});
+```
+
+## Subscription Management
+
+```typescript
+// Update subscription
+await paykit.subscriptions.update('sub_123', {
+  metadata: { plan: 'enterprise' },
+});
+
+// Cancel subscription
+await paykit.subscriptions.cancel('sub_123');
+```
+
+## Environment Variables
+
+```bash
+COMGATE_MERCHANT=mer_...
+COMGATE_SECRET=xxx...
+COMGATE_SANDBOX=false
+```
+
+## Support
+
+- [Congate Documentation](https://apidoc.comgate.cz/)
+
+## License
+
+GPL-3.0

package/dist/comgate-provider.d.mts

@@ -0,0 +1,50 @@
+import { PaykitProviderOptions, AbstractPayKitProvider, PayKitProvider, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreatePaymentSchema, Payment, UpdatePaymentSchema, CapturePaymentSchema, CreateRefundSchema, Refund, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface ComgateOptions extends PaykitProviderOptions {
+    /**
+     * The merchant ID
+     */
+    merchant: string;
+    /**
+     * The secret key
+     */
+    secret: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+}
+declare class ComgateProvider extends AbstractPayKitProvider implements PayKitProvider {
+    private readonly opts;
+    readonly providerName = "comgate";
+    private baseUrl;
+    private _client;
+    constructor(opts: ComgateOptions);
+    private _throwOnError;
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    retrieveCheckout: (id: string) => Promise<Checkout>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    updatePayment: (_id: string, _params: UpdatePaymentSchema) => Promise<Payment>;
+    deletePayment: (id: string) => Promise<null>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    capturePayment: (id: string, params: CapturePaymentSchema) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Creates a refund for a paid payment
+     */
+    createRefund: (params: CreateRefundSchema) => Promise<Refund>;
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    retrieveSubscription: (id: string) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    handleWebhook: ({ body: rawBody, headers }: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type ComgateOptions, ComgateProvider };

package/dist/comgate-provider.d.ts

@@ -0,0 +1,50 @@
+import { PaykitProviderOptions, AbstractPayKitProvider, PayKitProvider, CreateCheckoutSchema, Checkout, UpdateCheckoutSchema, CreateCustomerParams, Customer, UpdateCustomerParams, CreatePaymentSchema, Payment, UpdatePaymentSchema, CapturePaymentSchema, CreateRefundSchema, Refund, CreateSubscriptionSchema, Subscription, UpdateSubscriptionSchema, HandleWebhookParams, WebhookEventPayload } from '@paykit-sdk/core';
+
+interface ComgateOptions extends PaykitProviderOptions {
+    /**
+     * The merchant ID
+     */
+    merchant: string;
+    /**
+     * The secret key
+     */
+    secret: string;
+    /**
+     * Whether to use the sandbox environment
+     */
+    isSandbox: boolean;
+}
+declare class ComgateProvider extends AbstractPayKitProvider implements PayKitProvider {
+    private readonly opts;
+    readonly providerName = "comgate";
+    private baseUrl;
+    private _client;
+    constructor(opts: ComgateOptions);
+    private _throwOnError;
+    createCheckout: (params: CreateCheckoutSchema) => Promise<Checkout>;
+    updateCheckout: (id: string, params: UpdateCheckoutSchema) => Promise<Checkout>;
+    deleteCheckout: (id: string) => Promise<null>;
+    retrieveCheckout: (id: string) => Promise<Checkout>;
+    createCustomer: (params: CreateCustomerParams) => Promise<Customer>;
+    retrieveCustomer: (id: string) => Promise<Customer | null>;
+    updateCustomer: (id: string, params: UpdateCustomerParams) => Promise<Customer>;
+    deleteCustomer: (id: string) => Promise<null>;
+    createPayment: (params: CreatePaymentSchema) => Promise<Payment>;
+    updatePayment: (_id: string, _params: UpdatePaymentSchema) => Promise<Payment>;
+    deletePayment: (id: string) => Promise<null>;
+    retrievePayment: (id: string) => Promise<Payment | null>;
+    capturePayment: (id: string, params: CapturePaymentSchema) => Promise<Payment>;
+    cancelPayment: (id: string) => Promise<Payment>;
+    /**
+     * Creates a refund for a paid payment
+     */
+    createRefund: (params: CreateRefundSchema) => Promise<Refund>;
+    createSubscription: (params: CreateSubscriptionSchema) => Promise<Subscription>;
+    deleteSubscription: (id: string) => Promise<null>;
+    updateSubscription: (id: string, params: UpdateSubscriptionSchema) => Promise<Subscription>;
+    retrieveSubscription: (id: string) => Promise<Subscription>;
+    cancelSubscription: (id: string) => Promise<Subscription>;
+    handleWebhook: ({ body: rawBody, headers }: HandleWebhookParams) => Promise<Array<WebhookEventPayload>>;
+}
+
+export { type ComgateOptions, ComgateProvider };