sdk-nave-nodejs/README.md

Nave SDK for Node.js

## 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`