@patalink/node-api-client 1.0.0

package/README.md

@@ -0,0 +1 @@
+# patalink_node_api_client

package/dist/index.d.mts

@@ -0,0 +1,55 @@
+interface PaymentRequest {
+    amount: number;
+    currency?: string;
+    paymentMethod: 'MTN' | 'Airtel' | 'PesaPal';
+    phoneNumber?: string;
+    customerName?: string;
+    customerEmail?: string;
+}
+interface PaymentResponse {
+    transactionId: string;
+    status: 'pending' | 'success' | 'failed';
+    providerRef?: string;
+    redirectUrl?: string;
+    message?: string;
+}
+interface TransactionStatus {
+    id: string;
+    status: 'pending' | 'success' | 'failed';
+    amount: number;
+    currency: string;
+    paymentMethod: string;
+    createdAt: string;
+    completedAt?: string;
+    providerRef?: string;
+}
+interface ClientConfig {
+    apiKey: string;
+    encryptionKey: string;
+    timeout?: number;
+}
+declare class PataLinkClient {
+    private apiKey;
+    private encryptionKey;
+    private timeout;
+    constructor(config: ClientConfig);
+    /**
+     * Encrypt payment data before sending to API
+     */
+    private encrypt;
+    /**
+     * Make authenticated request to API
+     */
+    private request;
+    /**
+     * Create a payment
+     */
+    createPayment(request: PaymentRequest): Promise<PaymentResponse>;
+    /**
+     * Get transaction status
+     */
+    getTransactionStatus(transactionId: string): Promise<TransactionStatus>;
+}
+declare function createClient(config: ClientConfig): PataLinkClient;
+
+export { type ClientConfig, type PaymentRequest, type PaymentResponse, type TransactionStatus, createClient, PataLinkClient as default };

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+interface PaymentRequest {
+    amount: number;
+    currency?: string;
+    paymentMethod: 'MTN' | 'Airtel' | 'PesaPal';
+    phoneNumber?: string;
+    customerName?: string;
+    customerEmail?: string;
+}
+interface PaymentResponse {
+    transactionId: string;
+    status: 'pending' | 'success' | 'failed';
+    providerRef?: string;
+    redirectUrl?: string;
+    message?: string;
+}
+interface TransactionStatus {
+    id: string;
+    status: 'pending' | 'success' | 'failed';
+    amount: number;
+    currency: string;
+    paymentMethod: string;
+    createdAt: string;
+    completedAt?: string;
+    providerRef?: string;
+}
+interface ClientConfig {
+    apiKey: string;
+    encryptionKey: string;
+    timeout?: number;
+}
+declare class PataLinkClient {
+    private apiKey;
+    private encryptionKey;
+    private timeout;
+    constructor(config: ClientConfig);
+    /**
+     * Encrypt payment data before sending to API
+     */
+    private encrypt;
+    /**
+     * Make authenticated request to API
+     */
+    private request;
+    /**
+     * Create a payment
+     */
+    createPayment(request: PaymentRequest): Promise<PaymentResponse>;
+    /**
+     * Get transaction status
+     */
+    getTransactionStatus(transactionId: string): Promise<TransactionStatus>;
+}
+declare function createClient(config: ClientConfig): PataLinkClient;
+
+export { type ClientConfig, type PaymentRequest, type PaymentResponse, type TransactionStatus, createClient, PataLinkClient as default };

package/dist/index.js

@@ -0,0 +1,244 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createClient: () => createClient,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var CryptoJS = __toESM(require("crypto-js"));
+var BASE_URL = "http://localhost:3001";
+var PataLinkClient = class {
+  constructor(config) {
+    if (!config.apiKey) throw new Error("API key is required");
+    if (!config.encryptionKey) throw new Error("Encryption key is required");
+    this.apiKey = config.apiKey;
+    this.encryptionKey = config.encryptionKey;
+    this.timeout = config.timeout || 3e4;
+  }
+  /**
+   * Encrypt payment data before sending to API
+   */
+  encrypt(data) {
+    const dataString = JSON.stringify(data);
+    const keyWA = CryptoJS.enc.Base64.parse(this.encryptionKey);
+    const iv = CryptoJS.lib.WordArray.random(16);
+    const ivHex = iv.toString(CryptoJS.enc.Hex);
+    const ivWA = CryptoJS.enc.Hex.parse(ivHex);
+    const encrypted = CryptoJS.AES.encrypt(dataString, keyWA, {
+      iv: ivWA,
+      mode: CryptoJS.mode.CBC,
+      padding: CryptoJS.pad.Pkcs7
+    });
+    const encryptedBase64 = encrypted.ciphertext.toString(CryptoJS.enc.Base64);
+    const hmac = CryptoJS.HmacSHA256(dataString, keyWA).toString();
+    return {
+      encrypted: encryptedBase64,
+      iv: ivHex,
+      hmac
+    };
+  }
+  /**
+   * Make authenticated request to API
+   */
+  async request(endpoint, options = {}) {
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await fetch(`${BASE_URL}${endpoint}`, {
+        ...options,
+        headers: {
+          "Authorization": `Bearer ${this.apiKey}`,
+          "Content-Type": "application/json",
+          ...options.headers
+        },
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (!response.ok) {
+        const error = await response.json();
+        throw new Error(error.message || `HTTP ${response.status}`);
+      }
+      return await response.json();
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new Error("Request timeout");
+      }
+      throw error;
+    }
+  }
+  /**
+   * Create a payment
+   */
+  async createPayment(request) {
+    if (!request.amount) throw new Error("amount is required");
+    if (!request.paymentMethod) throw new Error("paymentMethod is required");
+    if (request.paymentMethod !== "PesaPal" && !request.phoneNumber) {
+      throw new Error("phoneNumber is required for mobile money payments");
+    }
+    if (request.amount < 100) {
+      throw new Error("Amount must be at least 100 RWF");
+    }
+    if (request.amount > 2e6 && request.paymentMethod !== "PesaPal") {
+      throw new Error("Mobile Money limit is 2,000,000 RWF");
+    }
+    const paymentData = {
+      amount: request.amount,
+      currency: request.currency || "RWF",
+      paymentMethod: request.paymentMethod,
+      supporterPhoneNumber: request.phoneNumber || "",
+      supporterName: request.customerName || "",
+      supporterEmail: request.customerEmail || ""
+    };
+    const encryptedPayload = this.encrypt(paymentData);
+    const response = await this.request("/api/pay", {
+      method: "POST",
+      headers: {
+        "x-encrypted": "true"
+      },
+      body: JSON.stringify(encryptedPayload)
+    });
+    return response;
+  }
+  /**
+   * Get transaction status
+   */
+  async getTransactionStatus(transactionId) {
+    if (!transactionId) throw new Error("transactionId is required");
+    return await this.request(`/api/pay/${transactionId}`, {
+      method: "GET"
+    });
+  }
+  /**
+   * Poll for transaction completion
+   */
+  // async waitForCompletion(
+  //   transactionId: string,
+  //   options?: {
+  //     maxAttempts?: number;
+  //     interval?: number;
+  //     onProgress?: (attempt: number, status: string) => void;
+  //   }
+  // ): Promise<TransactionStatus> {
+  //   const maxAttempts = options?.maxAttempts || 60;
+  //   const interval = options?.interval || 2000;
+  //   let attempts = 0;
+  //   while (attempts < maxAttempts) {
+  //     attempts++;
+  //     options?.onProgress?.(attempts, 'checking');
+  //     const status = await this.getTransactionStatus(transactionId);
+  //     if (status.status === 'success' || status.status === 'failed') {
+  //       return status;
+  //     }
+  //     // Wait before next attempt
+  //     await new Promise(resolve => setTimeout(resolve, interval));
+  //   }
+  //   throw new Error('Transaction timeout - still pending after maximum attempts');
+  // }
+  /**
+   * List all transactions for this account
+   */
+  // async listTransactions(options?: {
+  //   limit?: number;
+  //   offset?: number;
+  //   status?: 'pending' | 'success' | 'failed';
+  // }): Promise<{ transactions: TransactionStatus[]; total: number }> {
+  //   const params = new URLSearchParams();
+  //   if (options?.limit) params.append('limit', options.limit.toString());
+  //   if (options?.offset) params.append('offset', options.offset.toString());
+  //   if (options?.status) params.append('status', options.status);
+  //   const query = params.toString();
+  //   const endpoint = `/v1/transactions${query ? `?${query}` : ''}`;
+  //   return this.request<{ transactions: TransactionStatus[]; total: number }>(endpoint, {
+  //     method: 'GET'
+  //   });
+  // }
+  /**
+   * Rotate encryption key (generates new key, revokes old one after 24h)
+   */
+  // async rotateEncryptionKey(): Promise<{ newEncryptionKey: string; message: string }> {
+  //   return this.request<{ newEncryptionKey: string; message: string }>('/v1/keys/rotate', {
+  //     method: 'POST'
+  //   });
+  // }
+  /**
+   * Get account information
+   */
+  // async getAccountInfo(): Promise<{
+  //   id: string;
+  //   email: string;
+  //   walletBalance: number;
+  //   pendingBalance: number;
+  //   availableBalance: number;
+  // }> {
+  //   return this.request('/v1/account', { method: 'GET' });
+  // }
+  /**
+   * Initiate withdrawal
+   */
+  // async createWithdrawal(request: {
+  //   amount: number;
+  //   phoneNumber: string;
+  //   network: 'MTN' | 'Airtel';
+  // }): Promise<{ withdrawalId: string; status: string; message: string }> {
+  //   if (!request.amount) throw new Error('amount is required');
+  //   if (!request.phoneNumber) throw new Error('phoneNumber is required');
+  //   if (request.amount < 100) throw new Error('Minimum withdrawal is 100 RWF');
+  //   if (request.amount > 2000000) throw new Error('Maximum withdrawal is 2,000,000 RWF');
+  //   return this.request('/v1/withdrawals', {
+  //     method: 'POST',
+  //     body: JSON.stringify(request)
+  //   });
+  // }
+  /**
+   * List withdrawals
+   */
+  // async listWithdrawals(options?: {
+  //   limit?: number;
+  //   offset?: number;
+  // }): Promise<{ withdrawals: any[]; total: number }> {
+  //   const params = new URLSearchParams();
+  //   if (options?.limit) params.append('limit', options.limit.toString());
+  //   if (options?.offset) params.append('offset', options.offset.toString());
+  //   const query = params.toString();
+  //   const endpoint = `/v1/withdrawals${query ? `?${query}` : ''}`;
+  //   return this.request(endpoint, { method: 'GET' });
+  // }
+};
+function createClient(config) {
+  return new PataLinkClient(config);
+}
+var index_default = PataLinkClient;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createClient
+});

package/dist/index.mjs

@@ -0,0 +1,209 @@
+// src/index.ts
+import * as CryptoJS from "crypto-js";
+var BASE_URL = "http://localhost:3001";
+var PataLinkClient = class {
+  constructor(config) {
+    if (!config.apiKey) throw new Error("API key is required");
+    if (!config.encryptionKey) throw new Error("Encryption key is required");
+    this.apiKey = config.apiKey;
+    this.encryptionKey = config.encryptionKey;
+    this.timeout = config.timeout || 3e4;
+  }
+  /**
+   * Encrypt payment data before sending to API
+   */
+  encrypt(data) {
+    const dataString = JSON.stringify(data);
+    const keyWA = CryptoJS.enc.Base64.parse(this.encryptionKey);
+    const iv = CryptoJS.lib.WordArray.random(16);
+    const ivHex = iv.toString(CryptoJS.enc.Hex);
+    const ivWA = CryptoJS.enc.Hex.parse(ivHex);
+    const encrypted = CryptoJS.AES.encrypt(dataString, keyWA, {
+      iv: ivWA,
+      mode: CryptoJS.mode.CBC,
+      padding: CryptoJS.pad.Pkcs7
+    });
+    const encryptedBase64 = encrypted.ciphertext.toString(CryptoJS.enc.Base64);
+    const hmac = CryptoJS.HmacSHA256(dataString, keyWA).toString();
+    return {
+      encrypted: encryptedBase64,
+      iv: ivHex,
+      hmac
+    };
+  }
+  /**
+   * Make authenticated request to API
+   */
+  async request(endpoint, options = {}) {
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await fetch(`${BASE_URL}${endpoint}`, {
+        ...options,
+        headers: {
+          "Authorization": `Bearer ${this.apiKey}`,
+          "Content-Type": "application/json",
+          ...options.headers
+        },
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (!response.ok) {
+        const error = await response.json();
+        throw new Error(error.message || `HTTP ${response.status}`);
+      }
+      return await response.json();
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new Error("Request timeout");
+      }
+      throw error;
+    }
+  }
+  /**
+   * Create a payment
+   */
+  async createPayment(request) {
+    if (!request.amount) throw new Error("amount is required");
+    if (!request.paymentMethod) throw new Error("paymentMethod is required");
+    if (request.paymentMethod !== "PesaPal" && !request.phoneNumber) {
+      throw new Error("phoneNumber is required for mobile money payments");
+    }
+    if (request.amount < 100) {
+      throw new Error("Amount must be at least 100 RWF");
+    }
+    if (request.amount > 2e6 && request.paymentMethod !== "PesaPal") {
+      throw new Error("Mobile Money limit is 2,000,000 RWF");
+    }
+    const paymentData = {
+      amount: request.amount,
+      currency: request.currency || "RWF",
+      paymentMethod: request.paymentMethod,
+      supporterPhoneNumber: request.phoneNumber || "",
+      supporterName: request.customerName || "",
+      supporterEmail: request.customerEmail || ""
+    };
+    const encryptedPayload = this.encrypt(paymentData);
+    const response = await this.request("/api/pay", {
+      method: "POST",
+      headers: {
+        "x-encrypted": "true"
+      },
+      body: JSON.stringify(encryptedPayload)
+    });
+    return response;
+  }
+  /**
+   * Get transaction status
+   */
+  async getTransactionStatus(transactionId) {
+    if (!transactionId) throw new Error("transactionId is required");
+    return await this.request(`/api/pay/${transactionId}`, {
+      method: "GET"
+    });
+  }
+  /**
+   * Poll for transaction completion
+   */
+  // async waitForCompletion(
+  //   transactionId: string,
+  //   options?: {
+  //     maxAttempts?: number;
+  //     interval?: number;
+  //     onProgress?: (attempt: number, status: string) => void;
+  //   }
+  // ): Promise<TransactionStatus> {
+  //   const maxAttempts = options?.maxAttempts || 60;
+  //   const interval = options?.interval || 2000;
+  //   let attempts = 0;
+  //   while (attempts < maxAttempts) {
+  //     attempts++;
+  //     options?.onProgress?.(attempts, 'checking');
+  //     const status = await this.getTransactionStatus(transactionId);
+  //     if (status.status === 'success' || status.status === 'failed') {
+  //       return status;
+  //     }
+  //     // Wait before next attempt
+  //     await new Promise(resolve => setTimeout(resolve, interval));
+  //   }
+  //   throw new Error('Transaction timeout - still pending after maximum attempts');
+  // }
+  /**
+   * List all transactions for this account
+   */
+  // async listTransactions(options?: {
+  //   limit?: number;
+  //   offset?: number;
+  //   status?: 'pending' | 'success' | 'failed';
+  // }): Promise<{ transactions: TransactionStatus[]; total: number }> {
+  //   const params = new URLSearchParams();
+  //   if (options?.limit) params.append('limit', options.limit.toString());
+  //   if (options?.offset) params.append('offset', options.offset.toString());
+  //   if (options?.status) params.append('status', options.status);
+  //   const query = params.toString();
+  //   const endpoint = `/v1/transactions${query ? `?${query}` : ''}`;
+  //   return this.request<{ transactions: TransactionStatus[]; total: number }>(endpoint, {
+  //     method: 'GET'
+  //   });
+  // }
+  /**
+   * Rotate encryption key (generates new key, revokes old one after 24h)
+   */
+  // async rotateEncryptionKey(): Promise<{ newEncryptionKey: string; message: string }> {
+  //   return this.request<{ newEncryptionKey: string; message: string }>('/v1/keys/rotate', {
+  //     method: 'POST'
+  //   });
+  // }
+  /**
+   * Get account information
+   */
+  // async getAccountInfo(): Promise<{
+  //   id: string;
+  //   email: string;
+  //   walletBalance: number;
+  //   pendingBalance: number;
+  //   availableBalance: number;
+  // }> {
+  //   return this.request('/v1/account', { method: 'GET' });
+  // }
+  /**
+   * Initiate withdrawal
+   */
+  // async createWithdrawal(request: {
+  //   amount: number;
+  //   phoneNumber: string;
+  //   network: 'MTN' | 'Airtel';
+  // }): Promise<{ withdrawalId: string; status: string; message: string }> {
+  //   if (!request.amount) throw new Error('amount is required');
+  //   if (!request.phoneNumber) throw new Error('phoneNumber is required');
+  //   if (request.amount < 100) throw new Error('Minimum withdrawal is 100 RWF');
+  //   if (request.amount > 2000000) throw new Error('Maximum withdrawal is 2,000,000 RWF');
+  //   return this.request('/v1/withdrawals', {
+  //     method: 'POST',
+  //     body: JSON.stringify(request)
+  //   });
+  // }
+  /**
+   * List withdrawals
+   */
+  // async listWithdrawals(options?: {
+  //   limit?: number;
+  //   offset?: number;
+  // }): Promise<{ withdrawals: any[]; total: number }> {
+  //   const params = new URLSearchParams();
+  //   if (options?.limit) params.append('limit', options.limit.toString());
+  //   if (options?.offset) params.append('offset', options.offset.toString());
+  //   const query = params.toString();
+  //   const endpoint = `/v1/withdrawals${query ? `?${query}` : ''}`;
+  //   return this.request(endpoint, { method: 'GET' });
+  // }
+};
+function createClient(config) {
+  return new PataLinkClient(config);
+}
+var index_default = PataLinkClient;
+export {
+  createClient,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@patalink/node-api-client",
+  "version": "1.0.0",
+  "description": "Official PataLink API client - Simple, secure payment integration",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "patalink",
+    "payment",
+    "mtn",
+    "airtel",
+    "pesapal",
+    "rwanda",
+    "mobile-money"
+  ],
+  "author": "PataLink",
+  "license": "MIT",
+  "peerDependencies": {
+    "crypto-js": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/crypto-js": "^4.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "crypto-js": "^4.2.0"
+  }
+}