sdk-nave-nodejs 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Emilio Astarita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,99 @@
+## NodeJS SDK for Nave Payment Platform
+
+This is an unofficial SDK for integrating with the Nave Negocios platform using Node.js. It provides tools to manage orders, process payments, and handle authentication.  
+
+**Note**: This SDK is still under active development.
+
+
+Official Platform Website:
+https://navenegocios.ar/
+
+---
+
+## Install
+
+Ensure you have Node.js v14 or later installed. Then, run the following command to install the SDK:
+
+
+```
+npm install sdk-nave-nodejs
+```
+
+---
+
+
+## Usage example
+
+Below is an example of configuring and using the SDK:
+
+
+```typescript
+import {NaveClient} from "./NaveClient";
+
+const client = new NaveClient({
+    environment: 'testing',
+    // These following details must be provided by Nave
+    clientId: '',
+    clientSecret: '',
+    audience: '',
+    storeId: '',
+    platform: '',
+});
+
+// The client will automatically handle token provisioning and renewal.
+const orderResult = await client.createOrder({
+    order_id: generatedOrderId,
+    mobile: false,
+    callback_url: `https://example.com/order-pending/${generatedOrderId}`,
+    payment_request: {
+        transactions: [
+            {
+                products: [
+                    {
+                        id: 'PROD01',
+                        name: 'Camiseta',
+                        description: 'Camiseta Roja',
+                        quantity: 1,
+                        unit_price: {
+                            currency: 'ARS',
+                            value: '100',
+                        },
+                    },
+                ],
+                amount: {
+                    currency: 'ARS',
+                    value: '100',
+                },
+            },
+        ],
+        buyer: {
+            user_id: 'USER01',
+        },
+    },
+});
+
+
+const orderStatus = await client.getOrder(order.data.payment_request_id);
+
+console.log('Order status', orderStatus);
+
+---
+
+
+```
+
+## Integration tests
+
+There is a working example that runs against the testing environment and is enclosed in a Vitest test. You need to provide a valid `.env`
+file with your testing credentials at the root of the project.
+
+If you want to try it:
+
+1. Git clone this repo
+2. Install deps: `yarn install`
+3. Provide the `.env` file copying the `.env.example` format
+4. Run the suite `yarn run test`
+
+
+
+

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { NaveClient } from './lib/NaveClient';
+export { NaveClient };

package/dist/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NaveClient = void 0;
+const NaveClient_1 = require("./lib/NaveClient");
+Object.defineProperty(exports, "NaveClient", { enumerable: true, get: function () { return NaveClient_1.NaveClient; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,iDAA8C;AAErC,2FAFA,uBAAU,OAEA"}

package/dist/lib/NaveClient.d.ts

@@ -0,0 +1,27 @@
+import { BodyNaveCreateOrder, ResponseNaveCancelOrder, ResponseNaveCreateOrder, ResponseNaveGetOrder, ResponseNaveToken } from './client-types';
+export type Environment = 'production' | 'testing';
+export declare class NaveClient {
+    private readonly headers;
+    private baseUrls;
+    private clientId;
+    private clientSecret;
+    private audience;
+    private storeId;
+    private platform;
+    private token;
+    constructor({ audience, clientSecret, clientId, environment, storeId, platform, }: {
+        clientId: string;
+        clientSecret: string;
+        audience: string;
+        environment?: Environment;
+        storeId: string;
+        platform: string;
+    });
+    fetchNewToken(cache?: boolean): Promise<ResponseNaveToken>;
+    ensureToken(): Promise<ResponseNaveToken>;
+    createOrder(order: Omit<BodyNaveCreateOrder, 'store_id' | 'platform'>): Promise<ResponseNaveCreateOrder>;
+    getOrder(paymentRequestId: string): Promise<ResponseNaveGetOrder>;
+    cancelOrder(paymentId: string): Promise<ResponseNaveCancelOrder>;
+    private ecommerceRequest;
+    private request;
+}

package/dist/lib/NaveClient.js

@@ -0,0 +1,108 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NaveClient = void 0;
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const ENVIRONMENT_URLS = Object.freeze({
+    production: {
+        security: 'https://services.apinaranja.com',
+        ecommerce: 'https://api.ranty.io',
+    },
+    testing: {
+        security: 'https://homoservices.apinaranja.com',
+        ecommerce: 'https://e3-api.ranty.io',
+    },
+});
+class NaveClient {
+    headers = {};
+    baseUrls;
+    clientId;
+    clientSecret;
+    audience;
+    storeId;
+    platform;
+    token = null;
+    constructor({ audience, clientSecret, clientId, environment = 'testing', storeId, platform, }) {
+        this.baseUrls =
+            environment === 'production'
+                ? ENVIRONMENT_URLS.production
+                : ENVIRONMENT_URLS.testing;
+        this.audience = audience;
+        this.clientSecret = clientSecret;
+        this.clientId = clientId;
+        this.storeId = storeId;
+        this.platform = platform;
+        this.headers = {
+            'Content-Type': 'application/json',
+        };
+    }
+    async fetchNewToken(cache = true) {
+        return this.request({
+            method: 'POST',
+            baseUrl: this.baseUrls.security,
+            path: '/security-ms/api/security/auth0/b2b/m2msPrivate',
+            body: {
+                audience: this.audience,
+                client_id: this.clientId,
+                client_secret: this.clientSecret,
+                cache,
+            },
+        });
+    }
+    async ensureToken() {
+        if (!this.token || this.token.expires_in < Date.now()) {
+            this.token = await this.fetchNewToken();
+        }
+        return this.token;
+    }
+    async createOrder(order) {
+        return this.ecommerceRequest({
+            method: 'POST',
+            path: '/ecommerce/payment_request/external',
+            body: { ...order, store_id: this.storeId, platform: this.platform },
+        });
+    }
+    async getOrder(paymentRequestId) {
+        return this.ecommerceRequest({
+            method: 'GET',
+            path: `/api/payment_requests/${paymentRequestId}`,
+        });
+    }
+    async cancelOrder(paymentId) {
+        return this.ecommerceRequest({
+            method: 'GET',
+            path: `/api/payments/${paymentId}`,
+        });
+    }
+    ecommerceRequest = async (reqOptions) => {
+        await this.ensureToken();
+        if (!this.token) {
+            throw new Error('Token not found');
+        }
+        return this.request({
+            ...reqOptions,
+            baseUrl: this.baseUrls.ecommerce,
+            headers: { Authorization: `Bearer ${this.token.access_token}` },
+        });
+    };
+    request = async ({ method = 'GET', path, body, headers, newHeaders, baseUrl, }) => {
+        const url = `${baseUrl}${path}`;
+        const _headers = newHeaders
+            ? newHeaders
+            : { ...this.headers, ...headers };
+        const res = await (0, node_fetch_1.default)(url, {
+            method,
+            headers: _headers,
+            body: method !== 'GET' && body ? JSON.stringify(body) : undefined,
+        });
+        if (!res.ok) {
+            console.log(`Error (${res.status}) fetching ${url} \nwith ${method} \n and Body: ${JSON.stringify(body)} \n and Headers: ${JSON.stringify(_headers)}`);
+            throw new Error(await res.text());
+        }
+        return res.json();
+    };
+}
+exports.NaveClient = NaveClient;
+//# sourceMappingURL=NaveClient.js.map

package/dist/lib/NaveClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NaveClient.js","sourceRoot":"","sources":["../../src/lib/NaveClient.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA+B;AAmB/B,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,UAAU,EAAE;QACV,QAAQ,EAAE,iCAAiC;QAC3C,SAAS,EAAE,sBAAsB;KAClC;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,qCAAqC;QAC/C,SAAS,EAAE,yBAAyB;KACrC;CACF,CAAC,CAAC;AAWH,MAAa,UAAU;IACJ,OAAO,GAA2B,EAAE,CAAC;IAC9C,QAAQ,CAAkC;IAC1C,QAAQ,CAAS;IACjB,YAAY,CAAS;IACrB,QAAQ,CAAS;IACjB,OAAO,CAAS;IAChB,QAAQ,CAAS;IACjB,KAAK,GAA6B,IAAI,CAAC;IAE/C,YAAY,EACV,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,WAAW,GAAG,SAAS,EACvB,OAAO,EACP,QAAQ,GAQT;QACC,IAAI,CAAC,QAAQ;YACX,WAAW,KAAK,YAAY;gBAC1B,CAAC,CAAC,gBAAgB,CAAC,UAAU;gBAC7B,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG;YACb,cAAc,EAAE,kBAAkB;SACnC,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,KAAK,GAAG,IAAI;QACrC,OAAO,IAAI,CAAC,OAAO,CAAoB;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ;YAC/B,IAAI,EAAE,iDAAiD;YACvD,IAAI,EAAE;gBACJ,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,SAAS,EAAE,IAAI,CAAC,QAAQ;gBACxB,aAAa,EAAE,IAAI,CAAC,YAAY;gBAChC,KAAK;aACN;SACF,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,KAAK,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEM,KAAK,CAAC,WAAW,CACtB,KAAyD;QAEzD,OAAO,IAAI,CAAC,gBAAgB,CAA0B;YACpD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qCAAqC;YAC3C,IAAI,EAAE,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;SACpE,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,gBAAwB;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAuB;YACjD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,yBAAyB,gBAAgB,EAAE;SAClD,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB;QACxC,OAAO,IAAI,CAAC,gBAAgB,CAA0B;YACpD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,iBAAiB,SAAS,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB,GAAG,KAAK,EAC9B,UAA+C,EAC/C,EAAE;QACF,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAI;YACrB,GAAG,UAAU;YACb,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS;YAChC,OAAO,EAAE,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE;SAChE,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,OAAO,GAAG,KAAK,EAAK,EAC1B,MAAM,GAAG,KAAK,EACd,IAAI,EACJ,IAAI,EACJ,OAAO,EACP,UAAU,EACV,OAAO,GACY,EAAE,EAAE;QACvB,MAAM,GAAG,GAAG,GAAG,OAAO,GAAG,IAAI,EAAE,CAAC;QAChC,MAAM,QAAQ,GAA2B,UAAU;YACjD,CAAC,CAAC,UAAU;YACZ,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAK,EAAC,GAAG,EAAE;YAC3B,MAAM;YACN,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SAClE,CAAC,CAAC;QAEH,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,OAAO,CAAC,GAAG,CACT,UACE,GAAG,CAAC,MACN,cAAc,GAAG,WAAW,MAAM,iBAAiB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,oBAAoB,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CACtH,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,EAAgB,CAAC;IAClC,CAAC,CAAC;CACH;AA/HD,gCA+HC"}

package/dist/lib/client-types.d.ts

@@ -0,0 +1,105 @@
+export interface ResponseNaveToken {
+    access_token: string;
+    scope: string;
+    expires_in: number;
+    token_type: string;
+}
+export interface NaveBuyer {
+    user_id: string;
+    doc_type?: string;
+    doc_number?: string;
+    user_email?: string;
+    name?: string;
+    phone?: string;
+    billing_address?: NaveBillingAddress;
+}
+export type NaveBillingAddress = {
+    street_1: string;
+    street_2?: string;
+    city: string;
+    region: string;
+    country: string;
+    zip_code: string;
+};
+export type NaveProduct = {
+    id: string;
+    name: string;
+    description: string;
+    quantity: number;
+    unit_price: {
+        currency: string;
+        value: string;
+    };
+};
+export interface BodyNaveCreateOrder {
+    /**
+     * Platform identifier: Provided by Nave
+     */
+    platform: string;
+    /**
+     * Store identifier: Provided by Nave
+     */
+    store_id: string;
+    /**
+     * Where the user is redirected after payment
+     * @todo Report nave: this is not a good name for a redirect url :/
+     */
+    callback_url: string;
+    /**
+     * Order identifier in Merchant own platform
+     */
+    order_id: string;
+    /**
+     * Is mobile ?
+     */
+    mobile: boolean;
+    payment_request: {
+        transactions: {
+            products: NaveProduct[];
+            amount: {
+                currency: string;
+                value: string;
+            };
+        }[];
+        buyer: NaveBuyer;
+    };
+    /**
+     * How long it last the payment intention -- defaults 24 hours
+     */
+    duration_time?: number;
+}
+export interface ResponseNaveCreateOrder {
+    data: {
+        transaction_id: string;
+        qr_data: string;
+        payment_request_id: string;
+        checkout_url: string;
+        amount: {
+            currency: string;
+            value: string;
+        };
+        redirect_to: string;
+    };
+    success: boolean;
+    message: string;
+}
+export interface ResponseNaveGetOrder {
+    id: string;
+    external_payment_id: string;
+    payment_id: string | null;
+    order_id: string;
+    expiration_date: string;
+    status: 'APPROVED' | 'REJECTED' | 'CANCELLED' | 'REFUNDED' | 'PENDING';
+    payment_request_id: string;
+    payment_check_url: string;
+    additional_info: {
+        order_id: string;
+        callback_url: string;
+        mobile: boolean;
+        platform: string;
+    };
+}
+export interface ResponseNaveCancelOrder {
+    status: 'CANCELLING';
+    message: string;
+}

package/dist/lib/client-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=client-types.js.map

package/dist/lib/client-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-types.js","sourceRoot":"","sources":["../../src/lib/client-types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "sdk-nave-nodejs",
+  "description": "Nave SDK for Node.js",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "license": "MIT",
+  "files": ["dist", "README.md", "LICENCE"],
+  "scripts": {
+    "test": "vitest run",
+    "build": "tsc",
+    "clean": "rm -rf ./dist/*"
+  },
+  "author": "Emilio Astarita (https://github.com/emilioastarita/)",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:emilioastarita/sdk-nave-nodejs.git"
+  },
+  "keywords": [
+    "api",
+    "nave",
+    "navenegocios",
+    "checkout",
+    "payment",
+    "ipn",
+    "sdk",
+    "integration"
+  ],
+  "dependencies": {
+    "node-fetch": "^3.3.2"
+  },
+  "devDependencies": {
+    "@total-typescript/tsconfig": "^1.0.4",
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.13.14",
+    "dotenv": "^16.4.7",
+    "typescript": "^5.8.2",
+    "vitest": "^3.1.1"
+  }
+}