hirallpay-node 1.0.0

package/README.md

@@ -0,0 +1,49 @@
+# HirallPay Node.js SDK
+
+The official Node.js library for the HirallPay API.
+
+## Installation
+
+```bash
+npm install hirallpay-node
+```
+
+## Usage
+
+```javascript
+import HirallPay from 'hirallpay-node';
+
+const client = new HirallPay({
+  apiKey: 'HirallPay_pk_sandbox_...',
+  environment: 'sandbox'
+});
+
+// Initiate Payment
+const payment = await client.payments.initiate({
+  amount: 1000,
+  phone: '254712345678'
+});
+
+console.log(payment);
+```
+
+## Publishing (For Maintainers)
+
+To publish this package to npm:
+
+1.  **Build the project**:
+    ```bash
+    npm run build
+    ```
+
+2.  **Login to npm** (if not already logged in):
+    ```bash
+    npm login
+    ```
+
+3.  **Publish**:
+    ```bash
+    npm publish --access public
+    ```
+
+**Note:** Ensure you have updated the `version` in `package.json` before publishing a new release.

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { Payments } from './resources/payments';
+export interface HirallPayConfig {
+    apiKey: string;
+    environment?: 'sandbox' | 'live';
+    timeout?: number;
+}
+import { Webhooks } from './resources/webhooks';
+export declare class HirallPay {
+    private client;
+    payments: Payments;
+    webhooks: Webhooks;
+    constructor(config: HirallPayConfig);
+}
+export default HirallPay;

package/dist/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HirallPay = void 0;
+const axios_1 = __importDefault(require("axios"));
+const payments_1 = require("./resources/payments");
+const webhooks_1 = require("./resources/webhooks");
+class HirallPay {
+    constructor(config) {
+        const baseURL = config.environment === 'live'
+            ? 'https://api.hirallpay.com/api/v1'
+            : 'https://hirallpay.allantoo.site/api/v1';
+        this.client = axios_1.default.create({
+            baseURL,
+            timeout: config.timeout || 10000,
+            headers: {
+                'Authorization': `Bearer ${config.apiKey}`,
+                'Content-Type': 'application/json',
+                'User-Agent': 'HirallPay-Node/1.0.0'
+            }
+        });
+        this.payments = new payments_1.Payments(this.client);
+        this.webhooks = new webhooks_1.Webhooks();
+    }
+}
+exports.HirallPay = HirallPay;
+exports.default = HirallPay;

package/dist/resources/payments.d.ts

@@ -0,0 +1,28 @@
+import { AxiosInstance } from 'axios';
+export interface InitiatePaymentParams {
+    amount: number;
+    phone: string;
+    reference?: string;
+    callback_url?: string;
+    metadata?: Record<string, any>;
+}
+export interface InitiatePaymentResponse {
+    id: string;
+    status: string;
+    provider: string;
+    raw_response: any;
+}
+export declare class Payments {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * Initiate a payment (STK Push)
+     * @param params Payment parameters
+     */
+    initiate(params: InitiatePaymentParams): Promise<InitiatePaymentResponse>;
+    /**
+     * Get payment details
+     * @param id Payment ID
+     */
+    get(id: string): Promise<any>;
+}

package/dist/resources/payments.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Payments = void 0;
+class Payments {
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Initiate a payment (STK Push)
+     * @param params Payment parameters
+     */
+    async initiate(params) {
+        const response = await this.client.post('/payments', params);
+        return response.data;
+    }
+    /**
+     * Get payment details
+     * @param id Payment ID
+     */
+    async get(id) {
+        const response = await this.client.get(`/payments/${id}`);
+        return response.data;
+    }
+}
+exports.Payments = Payments;

package/dist/resources/webhooks.d.ts

@@ -0,0 +1,9 @@
+export declare class Webhooks {
+    /**
+     * Verify the webhook signature
+     * @param payload The raw request body
+     * @param signature The signature from the X-HirallPay-Signature header
+     * @param secret The webhook signing secret
+     */
+    verifySignature(payload: string, signature: string, secret: string): boolean;
+}

package/dist/resources/webhooks.js

@@ -0,0 +1,51 @@
+"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.Webhooks = void 0;
+const crypto = __importStar(require("crypto"));
+class Webhooks {
+    /**
+     * Verify the webhook signature
+     * @param payload The raw request body
+     * @param signature The signature from the X-HirallPay-Signature header
+     * @param secret The webhook signing secret
+     */
+    verifySignature(payload, signature, secret) {
+        const hmac = crypto.createHmac('sha256', secret);
+        const digest = hmac.update(payload).digest('hex');
+        return signature === digest;
+    }
+}
+exports.Webhooks = Webhooks;

package/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "hirallpay-node",
+    "version": "1.0.0",
+    "description": "Official Node.js SDK for HirallPay Integration",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": [
+        "hirallpay",
+        "payments",
+        "mpesa",
+        "sdk"
+    ],
+    "author": "HirallPay Engineering",
+    "license": "MIT",
+    "devDependencies": {
+        "typescript": "^5.0.0",
+        "@types/node": "^20.0.0"
+    },
+    "dependencies": {
+        "axios": "^1.6.0"
+    }
+}

package/src/index.ts

@@ -0,0 +1,37 @@
+import axios, { AxiosInstance } from 'axios';
+import { Payments } from './resources/payments';
+
+export interface HirallPayConfig {
+    apiKey: string;
+    environment?: 'sandbox' | 'live';
+    timeout?: number;
+}
+
+import { Webhooks } from './resources/webhooks';
+
+export class HirallPay {
+    private client: AxiosInstance;
+    public payments: Payments;
+    public webhooks: Webhooks;
+
+    constructor(config: HirallPayConfig) {
+        const baseURL = config.environment === 'live'
+            ? 'https://api.hirallpay.com/api/v1'
+            : 'https://hirallpay.allantoo.site/api/v1';
+
+        this.client = axios.create({
+            baseURL,
+            timeout: config.timeout || 10000,
+            headers: {
+                'Authorization': `Bearer ${config.apiKey}`,
+                'Content-Type': 'application/json',
+                'User-Agent': 'HirallPay-Node/1.0.0'
+            }
+        });
+
+        this.payments = new Payments(this.client);
+        this.webhooks = new Webhooks();
+    }
+}
+
+export default HirallPay;

package/src/resources/payments.ts

@@ -0,0 +1,42 @@
+import { AxiosInstance } from 'axios';
+
+export interface InitiatePaymentParams {
+    amount: number;
+    phone: string;
+    reference?: string;
+    callback_url?: string;
+    metadata?: Record<string, any>;
+}
+
+export interface InitiatePaymentResponse {
+    id: string;
+    status: string;
+    provider: string;
+    raw_response: any;
+}
+
+export class Payments {
+    private client: AxiosInstance;
+
+    constructor(client: AxiosInstance) {
+        this.client = client;
+    }
+
+    /**
+     * Initiate a payment (STK Push)
+     * @param params Payment parameters
+     */
+    async initiate(params: InitiatePaymentParams): Promise<InitiatePaymentResponse> {
+        const response = await this.client.post('/payments', params);
+        return response.data;
+    }
+
+    /**
+     * Get payment details
+     * @param id Payment ID
+     */
+    async get(id: string): Promise<any> {
+        const response = await this.client.get(`/payments/${id}`);
+        return response.data;
+    }
+}

package/src/resources/webhooks.ts

@@ -0,0 +1,15 @@
+import * as crypto from 'crypto';
+
+export class Webhooks {
+    /**
+     * Verify the webhook signature
+     * @param payload The raw request body
+     * @param signature The signature from the X-HirallPay-Signature header
+     * @param secret The webhook signing secret
+     */
+    verifySignature(payload: string, signature: string, secret: string): boolean {
+        const hmac = crypto.createHmac('sha256', secret);
+        const digest = hmac.update(payload).digest('hex');
+        return signature === digest;
+    }
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "module": "commonjs",
+        "declaration": true,
+        "outDir": "./dist",
+        "strict": true,
+        "esModuleInterop": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.test.ts"
+    ]
+}