awesome-node-checkout 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.1.0] - 2026-09-27
+
+### Added
+- **Security**: Added `buildPaymentRequest` hook in `createCheckoutRouter` options to build payment requests securely server-side (preventing clients from tampering with amounts and order parameters). Resolves #3.
+- **Security**: Added mount-time warning when `createCheckoutRouter` is used without `buildPaymentRequest`.
+- **Validation**: Added input validation on `POST /:provider` when `buildPaymentRequest` is not configured (requires finite positive number `amount` and non-empty `currency`).
+- **Gating**: Gated `POST /:provider/refund` behind `options.refund` (returns 404 unless explicitly configured with optional middleware).
+- **Hooks**: Added `onBeforeExecute` and dedicated `middleware` support in `options.execute` for `POST /:provider/execute`.
+- **Examples**: Added reference Express implementation under `examples/express` demonstrating SQLite store, Handlebars UI, and full checkout flow.
+
+## [1.0.2] - 2026-04-23
+
+### Changed
+- Removed compiled `dist/` artifacts from git tracking.
+- Added GitHub Actions publish workflow.
+- Updated dependencies.
+
+## [1.0.1] - 2026-04-13
+
+### Fixed
+- Satispay provider warning at construction time when `webhookPublicKey` is not configured.
+- PayPal refund implementation and security improvements.
+
+## [1.0.0] - 2026-03-30
+
+### Added
+- Initial release of `awesome-node-checkout`.
+- Framework-agnostic `CheckoutConfigurator`.
+- PayPal, Nexi, and Satispay providers.
+- Express adapter with `createCheckoutRouter`.

package/README.md

@@ -68,12 +68,40 @@ import { createCheckoutRouter } from 'awesome-node-checkout/express';
 const app = express();
 app.use(express.json());
 
-// Mounts all checkout routes under /checkout
-app.use('/checkout', createCheckoutRouter(checkout));
+// Mount checkout routes with secure server-side request builder
+app.use(
+  '/checkout',
+  createCheckoutRouter(checkout, {
+    // Recommended: verify order and compute amount on the server
+    buildPaymentRequest: async (req) => {
+      const order = await myOrderService.getOrder(req.body.orderId);
+      return {
+        amount: order.totalAmount,
+        currency: order.currency, // e.g. 'EUR'
+        orderId: order.id,
+        returnUrl: 'https://myapp.com/payment/success',
+        cancelUrl: 'https://myapp.com/payment/cancel',
+        description: `Order #${order.id}`,
+      };
+    },
+    // Opt-in: mount POST /:provider/refund protected by admin middleware
+    refund: {
+      middleware: [requireAdminAuth],
+    },
+    // Optional: guard execution before capturing payment
+    execute: {
+      onBeforeExecute: async (req, paymentId) => {
+        // Verify payment belongs to current session or user
+      },
+    },
+  }),
+);
 
 app.listen(3000);
 ```
 
+> **Security Note**: Never trust client-sent amounts directly. Always define `buildPaymentRequest` so the payment amount and order parameters are derived server-side. If `buildPaymentRequest` is omitted, the router will issue a warning at mount time and validate that client bodies contain positive finite amounts and valid currencies.
+
 ### With Fastify (or any other framework)
 
 Use the `CheckoutConfigurator` methods directly in your own routes:
@@ -92,16 +120,22 @@ fastify.post('/checkout/:provider/webhook', async (req, reply) => {
 
 ---
 
+## Example Application
+
+A full-featured reference implementation using Express 5, SQLite (`ITransactionStore`), and Handlebars is available in [examples/express](./examples/express).
+
+---
+
 ## Routes (Express adapter)
 
-| Method | Path                        | Description                      |
-|--------|-----------------------------|----------------------------------|
-| POST   | `/:provider`                | Create a payment                 |
-| POST   | `/:provider/execute`        | Execute/capture a payment        |
-| GET    | `/:provider/redirect`       | Handle provider redirect callback|
-| GET    | `/:provider/:id`            | Get payment details              |
-| POST   | `/:provider/refund`         | Refund a payment                 |
-| POST   | `/:provider/webhook`        | Handle provider webhook          |
+| Method | Path                        | Description                                                    |
+|--------|-----------------------------|----------------------------------------------------------------|
+| POST   | `/:provider`                | Create a payment (server-built or validated)                  |
+| POST   | `/:provider/execute`        | Execute/capture a payment (supports `onBeforeExecute`)         |
+| GET    | `/:provider/redirect`       | Handle provider redirect callback                             |
+| GET    | `/:provider/:id`            | Get payment details                                            |
+| POST   | `/:provider/refund`         | Refund a payment (*opt-in*: mounted only when `refund` option is set)|
+| POST   | `/:provider/webhook`        | Handle provider webhook                                        |
 
 ---
 

package/dist/abstract/base-payment-provider.abstract.d.ts

@@ -0,0 +1,30 @@
+import { IPaymentProvider, PaymentFlow } from '../interfaces/payment-provider.interface';
+import { PaymentRequest } from '../models/payment-request.model';
+import { PaymentResult } from '../models/payment-result.model';
+/**
+ * Convenience base class for building custom payment providers.
+ * Provides the `errorResult` helper to normalize error handling.
+ *
+ * Usage:
+ * ```typescript
+ * export class MyProvider extends BasePaymentProvider {
+ *   readonly name = 'myprovider';
+ *   readonly flow = 'redirect' as const;
+ *   // ... implement abstract methods
+ * }
+ * ```
+ */
+export declare abstract class BasePaymentProvider implements IPaymentProvider {
+    abstract readonly name: string;
+    abstract readonly flow: PaymentFlow;
+    abstract createPayment(request: PaymentRequest): Promise<PaymentResult>;
+    abstract executePayment(paymentId: string, data?: Record<string, string>): Promise<PaymentResult>;
+    abstract getPaymentDetails(paymentId: string): Promise<PaymentResult>;
+    abstract refundPayment(paymentId: string, amount?: number): Promise<PaymentResult>;
+    /**
+     * Helper to produce a normalized error PaymentResult.
+     * Extracts message from Error instances automatically.
+     */
+    protected errorResult(error: unknown, fallback?: string): PaymentResult;
+}
+//# sourceMappingURL=base-payment-provider.abstract.d.ts.map

package/dist/abstract/base-payment-provider.abstract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-payment-provider.abstract.d.ts","sourceRoot":"","sources":["../../src/abstract/base-payment-provider.abstract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,0CAA0C,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AAE/D;;;;;;;;;;;;GAYG;AACH,8BAAsB,mBAAoB,YAAW,gBAAgB;IACnE,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAEpC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IACvE,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;IACjG,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IACrE,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAElF;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,SAAkB,GAAG,aAAa;CAIjF"}

package/dist/abstract/base-payment-provider.abstract.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasePaymentProvider = void 0;
+/**
+ * Convenience base class for building custom payment providers.
+ * Provides the `errorResult` helper to normalize error handling.
+ *
+ * Usage:
+ * ```typescript
+ * export class MyProvider extends BasePaymentProvider {
+ *   readonly name = 'myprovider';
+ *   readonly flow = 'redirect' as const;
+ *   // ... implement abstract methods
+ * }
+ * ```
+ */
+class BasePaymentProvider {
+    /**
+     * Helper to produce a normalized error PaymentResult.
+     * Extracts message from Error instances automatically.
+     */
+    errorResult(error, fallback = 'Unknown error') {
+        const message = error instanceof Error ? error.message : fallback;
+        return { success: false, error: message };
+    }
+}
+exports.BasePaymentProvider = BasePaymentProvider;
+//# sourceMappingURL=base-payment-provider.abstract.js.map

package/dist/abstract/base-payment-provider.abstract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-payment-provider.abstract.js","sourceRoot":"","sources":["../../src/abstract/base-payment-provider.abstract.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;;;;GAYG;AACH,MAAsB,mBAAmB;IASvC;;;OAGG;IACO,WAAW,CAAC,KAAc,EAAE,QAAQ,GAAG,eAAe;QAC9D,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;QAClE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IAC5C,CAAC;CACF;AAjBD,kDAiBC"}

package/dist/adapters/express/index.d.ts

@@ -0,0 +1,65 @@
+import { Router, Request, RequestHandler } from 'express';
+import { CheckoutConfigurator } from '../../checkout-configurator';
+import { PaymentRequest } from '../../models/payment-request.model';
+export interface ExpressCheckoutOptions {
+    /**
+     * Middleware applied to ALL checkout routes (e.g. API key auth).
+     * Webhooks are typically public — use `publicPaths` to exclude them.
+     */
+    middleware?: RequestHandler[];
+    /**
+     * Route suffixes that bypass `middleware` (e.g. [':provider/webhook']).
+     * Matched against the path suffix after the mount point.
+     */
+    publicPaths?: string[];
+    /**
+     * Builds the PaymentRequest on the server (amount from your own order), ignoring the client body.
+     */
+    buildPaymentRequest?: (req: Request) => PaymentRequest | Promise<PaymentRequest>;
+    /**
+     * Configuration for POST /:provider/refund.
+     * If omitted, the refund route is NOT mounted (returns 404).
+     */
+    refund?: {
+        middleware?: RequestHandler[];
+    };
+    /**
+     * Configuration for POST /:provider/execute.
+     */
+    execute?: {
+        middleware?: RequestHandler[];
+        onBeforeExecute?: (req: Request, paymentId: string) => void | Promise<void>;
+    };
+}
+/**
+ * Creates an Express Router with all checkout endpoints pre-wired.
+ *
+ * Routes mounted:
+ * ```
+ * POST   /:provider              → createPayment
+ * POST   /:provider/execute      → executePayment
+ * GET    /:provider/redirect     → handleRedirect  (must come before /:provider/:id)
+ * GET    /:provider/:id          → getPaymentDetails
+ * POST   /:provider/refund       → refundPayment (only if options.refund is configured)
+ * POST   /:provider/webhook      → handleWebhook
+ * ```
+ *
+ * Usage:
+ * ```typescript
+ * import { createCheckoutRouter } from 'awesome-node-checkout/express';
+ * app.use('/checkout', createCheckoutRouter(checkout, {
+ *   buildPaymentRequest: async (req) => {
+ *     const order = await getOrder(req.body.orderId);
+ *     return {
+ *       amount: order.total,
+ *       currency: 'EUR',
+ *       orderId: order.id,
+ *       returnUrl: 'https://example.com/success',
+ *       cancelUrl: 'https://example.com/cancel',
+ *     };
+ *   },
+ * }));
+ * ```
+ */
+export declare function createCheckoutRouter(checkout: CheckoutConfigurator, options?: ExpressCheckoutOptions): Router;
+//# sourceMappingURL=index.d.ts.map

package/dist/adapters/express/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAY,cAAc,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAEpE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAE9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEjF;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;KAC/B,CAAC;IAEF;;OAEG;IACH,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;QAC9B,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC7E,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,oBAAoB,EAC9B,OAAO,GAAE,sBAA2B,GACnC,MAAM,CAsIR"}

package/dist/adapters/express/index.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCheckoutRouter = createCheckoutRouter;
+const express_1 = require("express");
+const errors_1 = require("../../models/errors");
+/**
+ * Creates an Express Router with all checkout endpoints pre-wired.
+ *
+ * Routes mounted:
+ * ```
+ * POST   /:provider              → createPayment
+ * POST   /:provider/execute      → executePayment
+ * GET    /:provider/redirect     → handleRedirect  (must come before /:provider/:id)
+ * GET    /:provider/:id          → getPaymentDetails
+ * POST   /:provider/refund       → refundPayment (only if options.refund is configured)
+ * POST   /:provider/webhook      → handleWebhook
+ * ```
+ *
+ * Usage:
+ * ```typescript
+ * import { createCheckoutRouter } from 'awesome-node-checkout/express';
+ * app.use('/checkout', createCheckoutRouter(checkout, {
+ *   buildPaymentRequest: async (req) => {
+ *     const order = await getOrder(req.body.orderId);
+ *     return {
+ *       amount: order.total,
+ *       currency: 'EUR',
+ *       orderId: order.id,
+ *       returnUrl: 'https://example.com/success',
+ *       cancelUrl: 'https://example.com/cancel',
+ *     };
+ *   },
+ * }));
+ * ```
+ */
+function createCheckoutRouter(checkout, options = {}) {
+    const router = (0, express_1.Router)();
+    if (!options.buildPaymentRequest) {
+        console.warn('[awesome-node-checkout] createCheckoutRouter: the client body decides the amount; set buildPaymentRequest');
+    }
+    // Apply shared middleware (skipping public paths)
+    if (options.middleware?.length) {
+        const publicPaths = options.publicPaths ?? [];
+        router.use((req, res, next) => {
+            const providerParam = String(req.params?.provider ?? '');
+            const isPublic = publicPaths.some((p) => req.path.endsWith(p) || req.path.includes(p.replace(':provider', providerParam)));
+            if (isPublic)
+                return next();
+            // Chain all middleware in sequence
+            const handlers = options.middleware;
+            const run = (i) => {
+                if (i >= handlers.length)
+                    return next();
+                handlers[i](req, res, () => run(i + 1));
+            };
+            run(0);
+        });
+    }
+    // ---- POST /:provider — create payment ------------------------------------
+    router.post('/:provider', async (req, res) => {
+        try {
+            let paymentRequest;
+            if (options.buildPaymentRequest) {
+                paymentRequest = await options.buildPaymentRequest(req);
+            }
+            else {
+                const body = req.body;
+                const amount = body?.amount;
+                const currency = body?.currency;
+                if (typeof amount !== 'number' ||
+                    !Number.isFinite(amount) ||
+                    amount <= 0 ||
+                    typeof currency !== 'string' ||
+                    currency.trim() === '') {
+                    return res.status(400).json({
+                        success: false,
+                        error: 'Invalid payment request: amount must be a positive number and currency is required',
+                    });
+                }
+                paymentRequest = body;
+            }
+            const result = await checkout.createPayment(String(req.params.provider), paymentRequest);
+            res.status(result.success ? 201 : 400).json(result);
+        }
+        catch (err) {
+            sendError(res, err);
+        }
+    });
+    // ---- POST /:provider/execute — execute payment ---------------------------
+    const executeHandlers = [];
+    if (options.execute?.middleware?.length) {
+        executeHandlers.push(...options.execute.middleware);
+    }
+    router.post('/:provider/execute', ...executeHandlers, async (req, res) => {
+        try {
+            const { paymentId, data } = req.body;
+            if (options.execute?.onBeforeExecute) {
+                await options.execute.onBeforeExecute(req, paymentId);
+            }
+            const result = await checkout.executePayment(String(req.params.provider), paymentId, data);
+            res.status(result.success ? 200 : 400).json(result);
+        }
+        catch (err) {
+            sendError(res, err);
+        }
+    });
+    // ---- POST /:provider/refund — refund payment (opt-in) --------------------
+    if (options.refund) {
+        const refundHandlers = [];
+        if (options.refund.middleware?.length) {
+            refundHandlers.push(...options.refund.middleware);
+        }
+        router.post('/:provider/refund', ...refundHandlers, async (req, res) => {
+            try {
+                const { paymentId, amount } = req.body;
+                const result = await checkout.refundPayment(String(req.params.provider), paymentId, amount);
+                res.status(result.success ? 200 : 400).json(result);
+            }
+            catch (err) {
+                sendError(res, err);
+            }
+        });
+    }
+    // ---- POST /:provider/webhook — handle webhook ----------------------------
+    router.post('/:provider/webhook', async (req, res) => {
+        try {
+            const result = await checkout.handleWebhook(String(req.params.provider), req.body, req.headers);
+            res.status(result.success ? 200 : 400).json(result);
+        }
+        catch (err) {
+            sendError(res, err);
+        }
+    });
+    // ---- GET /:provider/redirect — handle redirect callback ------------------
+    // NOTE: must be defined BEFORE /:provider/:id to avoid "redirect" being
+    // treated as a paymentId.
+    router.get('/:provider/redirect', async (req, res) => {
+        try {
+            const result = await checkout.handleRedirect(String(req.params.provider), req.query);
+            res.status(result.success ? 200 : 400).json(result);
+        }
+        catch (err) {
+            sendError(res, err);
+        }
+    });
+    // ---- GET /:provider/:id — get payment details ----------------------------
+    router.get('/:provider/:id', async (req, res) => {
+        try {
+            const result = await checkout.getPaymentDetails(String(req.params.provider), String(req.params.id));
+            res.status(result.success ? 200 : 404).json(result);
+        }
+        catch (err) {
+            sendError(res, err);
+        }
+    });
+    return router;
+}
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+function sendError(res, err) {
+    if (err instanceof errors_1.CheckoutError) {
+        const statusMap = {
+            PROVIDER_NOT_FOUND: 404,
+            WEBHOOK_NOT_SUPPORTED: 422,
+            REDIRECT_NOT_SUPPORTED: 422,
+        };
+        const status = statusMap[err.code] ?? 400;
+        res.status(status).json({ success: false, error: err.message, code: err.code });
+    }
+    else {
+        const message = err instanceof Error ? err.message : 'Internal server error';
+        res.status(500).json({ success: false, error: message });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/adapters/express/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/adapters/express/index.ts"],"names":[],"mappings":";;AAsEA,oDAyIC;AA/MD,qCAAoE;AAEpE,gDAAoD;AAsCpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAgB,oBAAoB,CAClC,QAA8B,EAC9B,UAAkC,EAAE;IAEpC,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IAExB,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,CACV,2GAA2G,CAC5G,CAAC;IACJ,CAAC;IAED,kDAAkD;IAClD,IAAI,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;QAC9C,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAC5B,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,IAAI,EAAE,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CACtC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,CACjF,CAAC;YACF,IAAI,QAAQ;gBAAE,OAAO,IAAI,EAAE,CAAC;YAC5B,mCAAmC;YACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAW,CAAC;YACrC,MAAM,GAAG,GAAG,CAAC,CAAS,EAAQ,EAAE;gBAC9B,IAAI,CAAC,IAAI,QAAQ,CAAC,MAAM;oBAAE,OAAO,IAAI,EAAE,CAAC;gBACxC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC1C,CAAC,CAAC;YACF,GAAG,CAAC,CAAC,CAAC,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC9D,IAAI,CAAC;YACH,IAAI,cAA8B,CAAC;YACnC,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;gBAChC,cAAc,GAAG,MAAM,OAAO,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;YAC1D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;gBACtB,MAAM,MAAM,GAAG,IAAI,EAAE,MAAM,CAAC;gBAC5B,MAAM,QAAQ,GAAG,IAAI,EAAE,QAAQ,CAAC;gBAChC,IACE,OAAO,MAAM,KAAK,QAAQ;oBAC1B,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;oBACxB,MAAM,IAAI,CAAC;oBACX,OAAO,QAAQ,KAAK,QAAQ;oBAC5B,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EACtB,CAAC;oBACD,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;wBAC1B,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,oFAAoF;qBAC5F,CAAC,CAAC;gBACL,CAAC;gBACD,cAAc,GAAG,IAAI,CAAC;YACxB,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,cAAc,CAAC,CAAC;YACzF,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6EAA6E;IAC7E,MAAM,eAAe,GAAqB,EAAE,CAAC;IAC7C,IAAI,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;QACxC,eAAe,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,GAAG,eAAe,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QAC1F,IAAI,CAAC;YACH,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,IAAyC,CAAC;YAC1E,IAAI,OAAO,CAAC,OAAO,EAAE,eAAe,EAAE,CAAC;gBACrC,MAAM,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACxD,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC3F,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6EAA6E;IAC7E,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,cAAc,GAAqB,EAAE,CAAC;QAC5C,IAAI,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;YACtC,cAAc,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,mBAAmB,EAAE,GAAG,cAAc,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;YACxF,IAAI,CAAC;gBACH,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,IAA8C,CAAC;gBACjF,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;gBAC5F,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACtD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACtE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CACzC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC3B,GAAG,CAAC,IAAI,EACR,GAAG,CAAC,OAAiC,CACtC,CAAC;YACF,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6EAA6E;IAC7E,wEAAwE;IACxE,0BAA0B;IAC1B,MAAM,CAAC,GAAG,CAAC,qBAAqB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACtE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,cAAc,CAC1C,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAC3B,GAAG,CAAC,KAA+B,CACpC,CAAC;YACF,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,6EAA6E;IAC7E,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,EAAE;QACjE,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YACpG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E,SAAS,SAAS,CAAC,GAAa,EAAE,GAAY;IAC5C,IAAI,GAAG,YAAY,sBAAa,EAAE,CAAC;QACjC,MAAM,SAAS,GAA2B;YACxC,kBAAkB,EAAE,GAAG;YACvB,qBAAqB,EAAE,GAAG;YAC1B,sBAAsB,EAAE,GAAG;SAC5B,CAAC;QACF,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;QAC1C,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAClF,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB,CAAC;QAC7E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3D,CAAC;AACH,CAAC"}

package/dist/checkout-configurator.d.ts

@@ -0,0 +1,66 @@
+import { IPaymentProvider } from './interfaces/payment-provider.interface';
+import { PaymentRequest } from './models/payment-request.model';
+import { PaymentResult, WebhookResult } from './models/payment-result.model';
+import { CheckoutConfig } from './models/checkout-config.model';
+import { CheckoutEventBus } from './events/checkout-event-bus';
+/**
+ * Main entry point for awesome-node-checkout.
+ *
+ * Usage (framework-agnostic):
+ * ```typescript
+ * const checkout = new CheckoutConfigurator();
+ * checkout
+ *   .registerProvider(new PayPalProvider({ clientId, clientSecret }))
+ *   .registerProvider(new NexiProvider({ merchantId, macKey }))
+ *   .registerProvider(new SatispayProvider({ keyId, privateKey }));
+ *
+ * // Use directly in any framework
+ * const result = await checkout.createPayment('paypal', request);
+ * ```
+ *
+ * Usage with Express adapter:
+ * ```typescript
+ * import { createCheckoutRouter } from 'awesome-node-checkout/express';
+ * app.use('/checkout', createCheckoutRouter(checkout));
+ * ```
+ */
+export declare class CheckoutConfigurator {
+    private readonly config;
+    private readonly providers;
+    /** Event bus — subscribe to payment lifecycle events */
+    readonly events: CheckoutEventBus;
+    constructor(config?: CheckoutConfig);
+    /** Emits an event only when `config.emitEvents` is not explicitly `false`. */
+    private emit;
+    /**
+     * Register a payment provider. Chainable.
+     * @throws CheckoutError if a provider with the same name is already registered.
+     */
+    registerProvider(provider: IPaymentProvider): this;
+    /**
+     * Retrieve a registered provider by name.
+     * @throws CheckoutError if the provider is not found.
+     */
+    getProvider(name: string): IPaymentProvider;
+    /** Returns the names of all registered providers */
+    getRegisteredProviders(): string[];
+    /** Create a new payment via the specified provider */
+    createPayment(providerName: string, request: PaymentRequest): Promise<PaymentResult>;
+    /** Execute/capture a previously created payment */
+    executePayment(providerName: string, paymentId: string, data?: Record<string, string>): Promise<PaymentResult>;
+    /** Retrieve the current status and details of a payment */
+    getPaymentDetails(providerName: string, paymentId: string): Promise<PaymentResult>;
+    /** Issue a full or partial refund */
+    refundPayment(providerName: string, paymentId: string, amount?: number): Promise<PaymentResult>;
+    /**
+     * Handle an incoming webhook from the provider.
+     * @throws CheckoutError if the provider does not support webhooks.
+     */
+    handleWebhook(providerName: string, body: Record<string, unknown>, headers: Record<string, string>): Promise<WebhookResult>;
+    /**
+     * Handle the redirect callback from the provider (query params).
+     * @throws CheckoutError if the provider does not support redirect handling.
+     */
+    handleRedirect(providerName: string, query: Record<string, string>): Promise<PaymentResult>;
+}
+//# sourceMappingURL=checkout-configurator.d.ts.map

package/dist/checkout-configurator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkout-configurator.d.ts","sourceRoot":"","sources":["../src/checkout-configurator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,yCAAyC,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,gBAAgB,EAA2C,MAAM,6BAA6B,CAAC;AAExG;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,oBAAoB;IAMnB,OAAO,CAAC,QAAQ,CAAC,MAAM;IALnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA4C;IAEtE,wDAAwD;IACxD,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAA0B;gBAE9B,MAAM,GAAE,cAAmB;IAExD,8EAA8E;YAChE,IAAI;IASlB;;;OAGG;IACH,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI;IAalD;;;OAGG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB;IAY3C,oDAAoD;IACpD,sBAAsB,IAAI,MAAM,EAAE;IAIlC,sDAAsD;IAChD,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAa1F,mDAAmD;IAC7C,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC5B,OAAO,CAAC,aAAa,CAAC;IAYzB,2DAA2D;IACrD,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKxF,qCAAqC;IAC/B,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC;IAYzB;;;OAGG;IACG,aAAa,CACjB,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC9B,OAAO,CAAC,aAAa,CAAC;IAoBzB;;;OAGG;IACG,cAAc,CAClB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAC5B,OAAO,CAAC,aAAa,CAAC;CAkB1B"}

package/dist/checkout-configurator.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CheckoutConfigurator = void 0;
+const errors_1 = require("./models/errors");
+const checkout_event_bus_1 = require("./events/checkout-event-bus");
+/**
+ * Main entry point for awesome-node-checkout.
+ *
+ * Usage (framework-agnostic):
+ * ```typescript
+ * const checkout = new CheckoutConfigurator();
+ * checkout
+ *   .registerProvider(new PayPalProvider({ clientId, clientSecret }))
+ *   .registerProvider(new NexiProvider({ merchantId, macKey }))
+ *   .registerProvider(new SatispayProvider({ keyId, privateKey }));
+ *
+ * // Use directly in any framework
+ * const result = await checkout.createPayment('paypal', request);
+ * ```
+ *
+ * Usage with Express adapter:
+ * ```typescript
+ * import { createCheckoutRouter } from 'awesome-node-checkout/express';
+ * app.use('/checkout', createCheckoutRouter(checkout));
+ * ```
+ */
+class CheckoutConfigurator {
+    constructor(config = {}) {
+        this.config = config;
+        this.providers = new Map();
+        /** Event bus — subscribe to payment lifecycle events */
+        this.events = new checkout_event_bus_1.CheckoutEventBus();
+    }
+    /** Emits an event only when `config.emitEvents` is not explicitly `false`. */
+    async emit(event, data) {
+        if (this.config.emitEvents !== false) {
+            await this.events.emit(event, data);
+        }
+    }
+    /**
+     * Register a payment provider. Chainable.
+     * @throws CheckoutError if a provider with the same name is already registered.
+     */
+    registerProvider(provider) {
+        const key = provider.name.toLowerCase();
+        if (this.providers.has(key)) {
+            throw new errors_1.CheckoutError(`Provider '${provider.name}' is already registered`, 'PROVIDER_ALREADY_REGISTERED', provider.name);
+        }
+        this.providers.set(key, provider);
+        return this;
+    }
+    /**
+     * Retrieve a registered provider by name.
+     * @throws CheckoutError if the provider is not found.
+     */
+    getProvider(name) {
+        const provider = this.providers.get(name.toLowerCase());
+        if (!provider) {
+            throw new errors_1.CheckoutError(`Payment provider '${name}' not found. Did you call registerProvider()?`, 'PROVIDER_NOT_FOUND', name);
+        }
+        return provider;
+    }
+    /** Returns the names of all registered providers */
+    getRegisteredProviders() {
+        return Array.from(this.providers.keys());
+    }
+    /** Create a new payment via the specified provider */
+    async createPayment(providerName, request) {
+        const provider = this.getProvider(providerName);
+        const result = await provider.createPayment(request);
+        await this.emit(result.success ? 'payment.created' : 'payment.failed', {
+            provider: providerName,
+            paymentId: result.paymentId,
+            orderId: request.orderId,
+            status: result.status,
+            error: result.error,
+        });
+        return result;
+    }
+    /** Execute/capture a previously created payment */
+    async executePayment(providerName, paymentId, data) {
+        const provider = this.getProvider(providerName);
+        const result = await provider.executePayment(paymentId, data);
+        await this.emit(result.success ? 'payment.completed' : 'payment.failed', {
+            provider: providerName,
+            paymentId,
+            status: result.status,
+            error: result.error,
+        });
+        return result;
+    }
+    /** Retrieve the current status and details of a payment */
+    async getPaymentDetails(providerName, paymentId) {
+        const provider = this.getProvider(providerName);
+        return provider.getPaymentDetails(paymentId);
+    }
+    /** Issue a full or partial refund */
+    async refundPayment(providerName, paymentId, amount) {
+        const provider = this.getProvider(providerName);
+        const result = await provider.refundPayment(paymentId, amount);
+        await this.emit('payment.refunded', {
+            provider: providerName,
+            paymentId,
+            status: result.status,
+            error: result.error,
+        });
+        return result;
+    }
+    /**
+     * Handle an incoming webhook from the provider.
+     * @throws CheckoutError if the provider does not support webhooks.
+     */
+    async handleWebhook(providerName, body, headers) {
+        const provider = this.getProvider(providerName);
+        if (!provider.handleWebhook) {
+            throw new errors_1.CheckoutError(`Provider '${providerName}' does not support webhook handling`, 'WEBHOOK_NOT_SUPPORTED', providerName);
+        }
+        const result = await provider.handleWebhook(body, headers);
+        await this.emit('webhook.received', {
+            provider: providerName,
+            paymentId: result.paymentId,
+            status: result.status,
+            error: result.error,
+            data: body,
+        });
+        return result;
+    }
+    /**
+     * Handle the redirect callback from the provider (query params).
+     * @throws CheckoutError if the provider does not support redirect handling.
+     */
+    async handleRedirect(providerName, query) {
+        const provider = this.getProvider(providerName);
+        if (!provider.handleRedirect) {
+            throw new errors_1.CheckoutError(`Provider '${providerName}' does not support redirect handling`, 'REDIRECT_NOT_SUPPORTED', providerName);
+        }
+        const result = await provider.handleRedirect(query);
+        await this.emit(result.success ? 'payment.completed' : 'payment.failed', {
+            provider: providerName,
+            paymentId: result.paymentId,
+            status: result.status,
+            error: result.error,
+        });
+        return result;
+    }
+}
+exports.CheckoutConfigurator = CheckoutConfigurator;
+//# sourceMappingURL=checkout-configurator.js.map