coffee-pay-sdk 1.0.0

package/README.md

@@ -0,0 +1,142 @@
+# COFFEE-PAY SDK for Node.js
+
+Node.js SDK to integrate with the **COFFEE-PAY** payment gateway easily and securely using TypeScript/JavaScript.
+
+[![npm version](https://img.shields.io/npm/v/coffee-pay-sdk)](https://www.npmjs.com/package/coffee-pay-sdk)
+[![license](https://img.shields.io/npm/l/coffee-pay-sdk)](https://github.com/coffee-pay/sdk-nodejs/blob/main/LICENSE)
+
+---
+
+## ✨ Features
+
+- 🔐 **Automatic JWT Authentication**: Handles `apiKey` and `apiSecret` encryption automatically.
+- 🧾 **Subscription Management**: Full CRUD support for subscription plans.
+- 🛡️ **Web Signing Utilities**: Easy signature generation for secure web payment buttons.
+- 🧠 **Fully Typed**: Built with TypeScript for excellent developer experience.
+- ⚙️ **Modern**: Compatible with Node.js v18+.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install coffee-pay-sdk
+# or
+yarn add coffee-pay-sdk
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Initialize the Client
+
+The SDK automatically handles JWT token generation (valid for 30s) for every request.
+
+```typescript
+import { CoffeeSDK } from 'coffee-pay-sdk';
+
+const coffee = new CoffeeSDK({
+  apiKey: 'YOUR_API_KEY',
+  apiSecret: 'YOUR_API_SECRET',
+  // baseUrl: 'https://staging.coffee-pay.co/api/v1' // Optional: default is production
+});
+```
+
+### 2. Manage Subscription Plans (CRUD)
+
+```typescript
+// List plans
+const plans = await coffee.subscriptionsPlans.list(10, 1);
+
+// Create a new plan
+const newPlan = await coffee.subscriptionsPlans.create({
+  name: 'Monthly Premium',
+  description: 'Pro access',
+  price: 25000,
+  currencyId: '...', // Bogota UUID
+  interval: 'monthly',
+  accountId: '...',
+  billingDay: 1,
+  freeDays: 0,
+  status: true,
+  source: 'API'
+});
+
+// Get by ID
+const plan = await coffee.subscriptionsPlans.get('PLAN_ID');
+
+// Update plan
+await coffee.subscriptionsPlans.update('PLAN_ID', {
+  description: 'Updated description'
+});
+
+// Delete plan
+await coffee.subscriptionsPlans.delete('PLAN_ID');
+```
+
+### 3. Consult Currencies
+
+```typescript
+// List currencies
+const currencies = await coffee.currencies.list(10, 1);
+
+// Get currency by ID
+const currency = await coffee.currencies.get('CURRENCY_ID');
+```
+
+### 4. Signing for Web Payments
+
+Use this utility to sign requests made from the browser (e.g., for payment buttons).
+
+```typescript
+import { CryptoUtils } from 'coffee-pay-sdk';
+
+const accountKey = "YOUR_ACCOUNT_KEY";
+const integrityKey = "YOUR_INTEGRITY_KEY";
+const timestamp = Math.floor(Date.now() / 1000);
+
+const signature = CryptoUtils.generateWebSignature(accountKey, integrityKey, timestamp);
+```
+
+---
+
+## 🛠️ API Reference
+
+### `CoffeeSDK`
+
+| Option | Type | Description |
+| --- | --- | --- |
+| `apiKey` | `string` | Your Coffee-Pay API Key. |
+| `apiSecret` | `string` | Your Coffee-Pay API Secret. |
+| `baseUrl` | `string` | (Optional) API endpoint URL. |
+| `timeout` | `number` | (Optional) Request timeout in ms (default: 30000). |
+
+### `subscriptionsPlans`
+
+| Method | Description |
+| --- | --- |
+| `list(limit, page)` | Returns a paginated list of plans. |
+| `create(data)` | Creates a new plan. |
+| `get(id)` | Retrieves a plan by ID. |
+| `update(id, data)` | Partially updates a plan. |
+| `delete(id)` | Deletes a plan. |
+
+### `currencies`
+
+| Method | Description |
+| --- | --- |
+| `list(limit, page)` | Returns a list of supported currencies. |
+| `get(id)` | Retrieves detailed information for a specific currency. |
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+---
+
+## 📝 License
+
+MIT © [Coffee-Pay](https://coffee-pay.co)

package/dist/client.d.ts

@@ -0,0 +1,10 @@
+import { CoffeeConfig } from './types';
+import { SubscriptionsPlans } from './resources/subscriptions-plans';
+import { Currencies } from './resources/currencies';
+export declare class CoffeeSDK {
+    private axiosInstance;
+    private config;
+    subscriptionsPlans: SubscriptionsPlans;
+    currencies: Currencies;
+    constructor(config: CoffeeConfig);
+}

package/dist/client.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoffeeSDK = void 0;
+const axios_1 = __importDefault(require("axios"));
+const auth_1 = require("./utils/auth");
+const subscriptions_plans_1 = require("./resources/subscriptions-plans");
+const currencies_1 = require("./resources/currencies");
+class CoffeeSDK {
+    axiosInstance;
+    config;
+    subscriptionsPlans;
+    currencies;
+    constructor(config) {
+        this.config = config;
+        this.axiosInstance = axios_1.default.create({
+            baseURL: config.baseUrl || 'https://production.coffee-pay.co/api/v1',
+            timeout: config.timeout || 30000,
+        });
+        // Add interceptor to include JWT token in every request
+        this.axiosInstance.interceptors.request.use((config) => {
+            const token = auth_1.AuthUtils.generateJWT(this.config.apiKey, this.config.apiSecret);
+            config.headers.Authorization = `Bearer ${token}`;
+            return config;
+        });
+        this.subscriptionsPlans = new subscriptions_plans_1.SubscriptionsPlans(this.axiosInstance);
+        this.currencies = new currencies_1.Currencies(this.axiosInstance);
+    }
+}
+exports.CoffeeSDK = CoffeeSDK;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './client';
+export * from './types';
+export { CryptoUtils } from './utils/crypto';
+export { AuthUtils } from './utils/auth';
+export { Currencies } from './resources/currencies';

package/dist/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Currencies = exports.AuthUtils = exports.CryptoUtils = void 0;
+__exportStar(require("./client"), exports);
+__exportStar(require("./types"), exports);
+var crypto_1 = require("./utils/crypto");
+Object.defineProperty(exports, "CryptoUtils", { enumerable: true, get: function () { return crypto_1.CryptoUtils; } });
+var auth_1 = require("./utils/auth");
+Object.defineProperty(exports, "AuthUtils", { enumerable: true, get: function () { return auth_1.AuthUtils; } });
+var currencies_1 = require("./resources/currencies");
+Object.defineProperty(exports, "Currencies", { enumerable: true, get: function () { return currencies_1.Currencies; } });

package/dist/resources/currencies.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+import { ApiResponse, Currency, ListResponse } from '../types';
+export declare class Currencies {
+    private axios;
+    constructor(axios: AxiosInstance);
+    /**
+     * Retrieves a list of currencies.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    list(limit?: number, page?: number): Promise<ListResponse<Currency>>;
+    /**
+     * Retrieves a currency by ID.
+     */
+    get(id: string): Promise<ApiResponse<Currency>>;
+}

package/dist/resources/currencies.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Currencies = void 0;
+class Currencies {
+    axios;
+    constructor(axios) {
+        this.axios = axios;
+    }
+    /**
+     * Retrieves a list of currencies.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    async list(limit = 100, page = 1) {
+        const response = await this.axios.get('/admin/currencies', {
+            params: { limit, page },
+        });
+        return response.data;
+    }
+    /**
+     * Retrieves a currency by ID.
+     */
+    async get(id) {
+        const response = await this.axios.get(`/admin/currencies/${id}`);
+        return response.data;
+    }
+}
+exports.Currencies = Currencies;

package/dist/resources/subscriptions-plans.d.ts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from 'axios';
+import { ApiResponse, CreateSubscriptionPlanDto, ListResponse, SubscriptionPlan, UpdateSubscriptionPlanDto } from '../types';
+export declare class SubscriptionsPlans {
+    private axios;
+    constructor(axios: AxiosInstance);
+    /**
+     * Retrieves a list of subscription plans.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    list(limit?: number, page?: number): Promise<ListResponse<SubscriptionPlan>>;
+    /**
+     * Creates a new subscription plan.
+     */
+    create(data: CreateSubscriptionPlanDto): Promise<ApiResponse<SubscriptionPlan>>;
+    /**
+     * Retrieves a subscription plan by ID.
+     */
+    get(id: string): Promise<ApiResponse<SubscriptionPlan>>;
+    /**
+     * Updates an existing subscription plan.
+     */
+    update(id: string, data: UpdateSubscriptionPlanDto): Promise<ApiResponse<SubscriptionPlan>>;
+    /**
+     * Deletes a subscription plan by ID.
+     */
+    delete(id: string): Promise<ApiResponse<any>>;
+}

package/dist/resources/subscriptions-plans.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionsPlans = void 0;
+class SubscriptionsPlans {
+    axios;
+    constructor(axios) {
+        this.axios = axios;
+    }
+    /**
+     * Retrieves a list of subscription plans.
+     * @param limit Number of items to retrieve (default: 100)
+     * @param page Page number (default: 1)
+     */
+    async list(limit = 100, page = 1) {
+        const response = await this.axios.get('/subscriptions-plans', {
+            params: { limit, page },
+        });
+        return response.data;
+    }
+    /**
+     * Creates a new subscription plan.
+     */
+    async create(data) {
+        const response = await this.axios.post('/subscriptions-plans', data);
+        return response.data;
+    }
+    /**
+     * Retrieves a subscription plan by ID.
+     */
+    async get(id) {
+        const response = await this.axios.get(`/subscriptions-plans/${id}`);
+        return response.data;
+    }
+    /**
+     * Updates an existing subscription plan.
+     */
+    async update(id, data) {
+        const response = await this.axios.patch(`/subscriptions-plans/${id}`, data);
+        return response.data;
+    }
+    /**
+     * Deletes a subscription plan by ID.
+     */
+    async delete(id) {
+        const response = await this.axios.delete(`/subscriptions-plans/${id}`);
+        return response.data;
+    }
+}
+exports.SubscriptionsPlans = SubscriptionsPlans;

package/dist/types/index.d.ts

@@ -0,0 +1,82 @@
+export interface CoffeeConfig {
+    apiKey: string;
+    apiSecret: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+export interface AuthPayload {
+    iss: string;
+    jti: string;
+    iat: number;
+    exp: number;
+}
+export interface SubscriptionPlan {
+    id: string;
+    accountId: string;
+    name: string;
+    reference: string;
+    description: string;
+    price: number;
+    currencyId: string;
+    interval: 'daily' | 'weekly' | 'monthly' | 'yearly';
+    intervalCount: number;
+    billingDay: number;
+    freeDays: number;
+    allowProrate: boolean;
+    redirectUrl: string;
+    urlBack: string;
+    source: string;
+    status: boolean;
+    isDeleted: boolean;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ApiResponse<T> {
+    error: boolean;
+    data: T;
+    message: string;
+}
+export interface ListResponse<T> {
+    error: boolean;
+    data: T[];
+    message: string;
+    options: {
+        total: number;
+        page: number;
+        limit: number;
+    };
+}
+export interface CreateSubscriptionPlanDto {
+    name: string;
+    description: string;
+    price: number;
+    currencyId: string;
+    interval: 'daily' | 'weekly' | 'monthly' | 'yearly';
+    accountId: string;
+    billingDay: number;
+    freeDays: number;
+    status: boolean;
+    source: string;
+    intervalCount?: number;
+    reference?: string;
+    allowProrate?: boolean;
+    redirectUrl?: string;
+    urlBack?: string;
+}
+export type UpdateSubscriptionPlanDto = Partial<CreateSubscriptionPlanDto>;
+export interface Currency {
+    id: string;
+    isoCode: string;
+    tim: number;
+    symbol: string;
+    decimalSeparator: string;
+    thousandSeparator: string;
+    visaCode: string;
+    isDeleted: boolean;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/auth.d.ts

@@ -0,0 +1,3 @@
+export declare class AuthUtils {
+    static generateJWT(apiKey: string, apiSecret: string): string;
+}

package/dist/utils/auth.js

@@ -0,0 +1,65 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthUtils = void 0;
+const crypto = __importStar(require("crypto-js"));
+const uuid_1 = require("uuid");
+class AuthUtils {
+    static generateJWT(apiKey, apiSecret) {
+        const header = { alg: 'HS256', typ: 'JWT' };
+        const now = Math.floor(Date.now() / 1000);
+        const payload = {
+            iss: apiKey,
+            jti: (0, uuid_1.v4)(),
+            iat: now,
+            exp: now + 30, // 30 seconds expiration as requested
+        };
+        const base64url = (source) => {
+            let encodedSource = typeof source === 'string'
+                ? crypto.enc.Base64.stringify(crypto.enc.Utf8.parse(source))
+                : crypto.enc.Base64.stringify(source);
+            return encodedSource
+                .replace(/=+$/, '')
+                .replace(/\+/g, '-')
+                .replace(/\//g, '_');
+        };
+        const encodedHeader = base64url(JSON.stringify(header));
+        const encodedPayload = base64url(JSON.stringify(payload));
+        const signatureSource = `${encodedHeader}.${encodedPayload}`;
+        const signature = base64url(crypto.HmacSHA256(signatureSource, apiSecret));
+        return `${encodedHeader}.${encodedPayload}.${signature}`;
+    }
+}
+exports.AuthUtils = AuthUtils;

package/dist/utils/crypto.d.ts

@@ -0,0 +1,7 @@
+export declare class CryptoUtils {
+    /**
+     * Generates a signature for web payment requests using accountKey and integrityKey.
+     * This matches the logic provided in the requirements.
+     */
+    static generateWebSignature(accountKey: string, integrityKey: string, timestamp: number): string;
+}

package/dist/utils/crypto.js

@@ -0,0 +1,49 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CryptoUtils = void 0;
+const crypto = __importStar(require("crypto-js"));
+class CryptoUtils {
+    /**
+     * Generates a signature for web payment requests using accountKey and integrityKey.
+     * This matches the logic provided in the requirements.
+     */
+    static generateWebSignature(accountKey, integrityKey, timestamp) {
+        const dataToSign = `${accountKey}${timestamp}${integrityKey}`;
+        const hash = crypto.SHA256(dataToSign);
+        return hash.toString(crypto.enc.Hex);
+    }
+}
+exports.CryptoUtils = CryptoUtils;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "coffee-pay-sdk",
+  "version": "1.0.0",
+  "description": "Node.js SDK for Coffee-Pay payment gateway",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "coffee-pay",
+    "payments",
+    "sdk",
+    "nodejs",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/coffee-pay-co/node-sdk.git"
+  },
+  "author": "Coffee-Pay",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.13.4",
+    "crypto-js": "^4.2.0",
+    "uuid": "^13.0.0"
+  },
+  "devDependencies": {
+    "@types/crypto-js": "^4.2.2",
+    "@types/node": "^25.2.1",
+    "@types/uuid": "^10.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}