@yosle/tropipayjs 0.1.21 → 0.1.23

package/index.d.ts

@@ -13,6 +13,7 @@ interface TropipayConfig {
     clientSecret: string;
     scopes?: string[];
     serverMode?: ServerMode$1;
+    customTropipayUrl?: string;
 }
 type TropipayCredentials = {
     clientId: string;
@@ -53,18 +54,22 @@ interface PaymentLinkPayload {
     urlFailed: string;
     urlNotification: string;
     serviceDate: string;
-    client: {
-        name: string;
-        lastName: string;
-        address: string;
-        phone: string;
-        email: string;
-        countryId: number;
+    client?: {
+        name?: string;
+        lastName?: string;
+        address?: string;
+        phone?: string;
+        email?: string;
+        countryId?: number;
+        countryIso?: string;
+        city: string;
+        postCode: string;
         termsAndConditions: boolean;
-    };
+    } | null;
     directPayment: boolean;
     paymentMethods?: string[];
     imageBase?: string;
+    saveToken?: boolean;
 }
 interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;
@@ -75,7 +80,7 @@ interface PaymentLink extends PaymentLinkPayload {
     shortUrl: string;
     paymentUrl: string;
 }
-interface mediationPaymentCardConfig {
+interface MediationPaymentCardConfig {
     amount: number;
     currency: "EUR" | "USD";
     concept: string;
@@ -196,7 +201,7 @@ declare class TropipayHooks {
      * @returns All subscribed hooks or empty Array if none exist.
      */
     list(eventType?: HookEventType): Promise<UserHookSubscribed[]>;
-    update(eventType: string, target: "web" | "email", value: string): Promise<any>;
+    update(eventType: HookEventType, target: "web" | "email", value: string): Promise<any>;
     delete(eventType: HookEventType, target: string): Promise<any>;
     events(): Promise<any>;
 }
@@ -217,7 +222,38 @@ declare class PaymentCard {
      * @returns Array of paymentlinks
      */
     list(): Promise<any>;
+    /**
+     * Retrieves a payment card with the specified ID.
+     *
+     * @param {string} id - The ID of the payment card to retrieve.
+     * @return {Promise<any>} A Promise that resolves to the payment card data.
+     * @throws {Error} If an error occurs while retrieving the payment card.
+     */
     get(id: string): Promise<any>;
+    /**
+     * Deletes a payment card with the specified ID. Its a LOGIC delete
+     * so this will delete the paymentcard from paymentcard list and
+     * disable shortUrl but not paymentUrl
+     * @param {string} id - The ID of the payment card to delete.
+     * @return {Promise<any>} A Promise that resolves to the deleted payment card data.
+     * @throws {Error} If an error occurs while deleting the payment card.
+     */
+    delete(id: string): Promise<any>;
+}
+
+declare class MediationPaymentCard {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * (ONLY FOR BUSINESS ACCOUNTS) Create a mediation paymentcard (an escrow payment link) with the specified options.
+     * This allows a payment to be made to persons belonging or not to the TropiPay platform with the
+     * particularity that the payment will be held in custody or retained until it is released with
+     * the approval of the payer.
+     * @param payload PaymentLinkPayload Object.
+     * @returns Promise<PaymentLink> or throws an Exception.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+     */
+    create(payload: MediationPaymentCardConfig): Promise<PaymentLink>;
 }
 
 interface DepositAccountConfig {
@@ -299,10 +335,12 @@ declare class Tropipay {
     request: Axios;
     static accessToken: string | null;
     static refreshToken: string | null;
+    static expiresIn: number | null;
     serverMode: ServerMode;
     hooks: TropipayHooks;
     paymentCards: PaymentCard;
     depositAccounts: DepositAccounts;
+    mediationPaymentCard: MediationPaymentCard;
     /**
      * Initializes a new instance of the Tropipay class.
      *
@@ -364,7 +402,7 @@ declare class Tropipay {
      * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
      * @param config Payload with the payment details
      */
-    createMediationPaymentCard(config: mediationPaymentCardConfig): Promise<PaymentLink>;
+    createMediationPaymentCard(config: MediationPaymentCardConfig): Promise<PaymentLink>;
 }
 declare class ClientSideUtils {
     constructor(tropipayInstance: Tropipay);
@@ -417,4 +455,4 @@ declare class ServerSideUtils {
 
 declare const SERVER_MODE: ServerMode$1;
 
-export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, DepositAccounts, HookEventType, HookTargetType, LoginError, LoginResponse, MAX_IMAGE_SIZE_MB, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };
+export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, HookEventType, HookTargetType, LoginError, LoginResponse, MAX_IMAGE_SIZE_MB, MediationPaymentCardConfig, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, UserHook, UserHookSubscribed };

package/index.js

@@ -36,10 +36,9 @@ function handleExceptions(error) {
             const axiosResponse = error.response;
             const errorMessage = axiosResponse.data?.error?.message || "An error occurred";
             switch (axiosResponse.status) {
+                case 400:
                 case 401:
-                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
                 case 403:
-                    return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
                 case 404:
                     return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
                 case 429:
@@ -257,6 +256,13 @@ class PaymentCard {
             throw new Error(`Could not retrieve PaymenCards list`);
         }
     }
+    /**
+     * Retrieves a payment card with the specified ID.
+     *
+     * @param {string} id - The ID of the payment card to retrieve.
+     * @return {Promise<any>} A Promise that resolves to the payment card data.
+     * @throws {Error} If an error occurs while retrieving the payment card.
+     */
     async get(id) {
         if (!Tropipay.accessToken) {
             await this.tropipay.login();
@@ -275,6 +281,69 @@ class PaymentCard {
             throw handleExceptions(error);
         }
     }
+    /**
+     * Deletes a payment card with the specified ID. Its a LOGIC delete
+     * so this will delete the paymentcard from paymentcard list and
+     * disable shortUrl but not paymentUrl
+     * @param {string} id - The ID of the payment card to delete.
+     * @return {Promise<any>} A Promise that resolves to the deleted payment card data.
+     * @throws {Error} If an error occurs while deleting the payment card.
+     */
+    async delete(id) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const paymentcard = await this.tropipay.request.delete(`/api/v2/paymentcards/`, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+                data: {
+                    cardId: id,
+                },
+            });
+            return paymentcard.data;
+        }
+        catch (error) {
+            throw handleExceptions(error);
+        }
+    }
+}
+
+class MediationPaymentCard {
+    tropipay;
+    constructor(tropipayInstance) {
+        this.tropipay = tropipayInstance;
+    }
+    /**
+     * (ONLY FOR BUSINESS ACCOUNTS) Create a mediation paymentcard (an escrow payment link) with the specified options.
+     * This allows a payment to be made to persons belonging or not to the TropiPay platform with the
+     * particularity that the payment will be held in custody or retained until it is released with
+     * the approval of the payer.
+     * @param payload PaymentLinkPayload Object.
+     * @returns Promise<PaymentLink> or throws an Exception.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+     */
+    async create(payload) {
+        if (!Tropipay.accessToken) {
+            await this.tropipay.login();
+        }
+        try {
+            const paylink = await this.tropipay.request.post("/api/v2/paymentcards/mediation", payload, {
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${Tropipay.accessToken}`,
+                    Accept: "application/json",
+                },
+            });
+            return paylink.data;
+        }
+        catch (error) {
+            throw handleExceptions(error);
+        }
+    }
 }
 
 class DepositAccounts {
@@ -412,10 +481,12 @@ class Tropipay {
     request;
     static accessToken;
     static refreshToken;
+    static expiresIn;
     serverMode;
     hooks;
     paymentCards;
     depositAccounts;
+    mediationPaymentCard;
     /**
      * Initializes a new instance of the Tropipay class.
      *
@@ -445,18 +516,39 @@ class Tropipay {
         this.clientId = config.clientId;
         this.clientSecret = config.clientSecret;
         this.serverMode = config.serverMode || "Development";
+        const tpp_env = this.serverMode === "Production"
+            ? "https://www.tropipay.com"
+            : "https://tropipay-dev.herokuapp.com";
         this.request = axios__default["default"].create({
-            baseURL: this.serverMode === "Production"
-                ? "https://www.tropipay.com"
-                : "https://tropipay-dev.herokuapp.com",
+            baseURL: config.customTropipayUrl || tpp_env,
             headers: {
                 "Content-Type": "application/json",
                 Accept: "application/json",
                 Authorization: `Bearer ${Tropipay.accessToken}`,
             },
         });
+        // Add request interceptor for Token expired
+        this.request.interceptors.request.use(async (config) => {
+            const currentTimestamp = Math.floor(Date.now() / 1000); // Current time in seconds
+            if (Tropipay.expiresIn && Tropipay.expiresIn < currentTimestamp) {
+                // Token has expired, attempt to refresh it
+                try {
+                    await this.login();
+                }
+                catch (error) {
+                    // Handle token refresh error
+                    Tropipay.accessToken = null;
+                    Tropipay.refreshToken = null;
+                    throw handleExceptions(error);
+                }
+            }
+            return config;
+        }, (error) => {
+            return Promise.reject(error);
+        });
         this.hooks = new TropipayHooks(this);
         this.paymentCards = new PaymentCard(this);
+        this.mediationPaymentCard = new MediationPaymentCard(this);
         this.depositAccounts = new DepositAccounts(this);
     }
     async login() {
@@ -489,11 +581,13 @@ class Tropipay {
             });
             Tropipay.accessToken = data.access_token;
             Tropipay.refreshToken = data.refresh_token;
+            Tropipay.expiresIn = data.expires_in;
             return data;
         }
         catch (error) {
             Tropipay.accessToken = null;
             Tropipay.refreshToken = null;
+            Tropipay.expiresIn = null;
             throw handleExceptions(error);
         }
     }
@@ -792,11 +886,8 @@ if (typeof window !== "undefined") {
 }
 
 exports.ClientSideUtils = ClientSideUtils;
-exports.DepositAccounts = DepositAccounts;
 exports.MAX_IMAGE_SIZE_MB = MAX_IMAGE_SIZE_MB;
-exports.PaymentCard = PaymentCard;
 exports.SERVER_MODE = SERVER_MODE;
 exports.ServerSideUtils = ServerSideUtils;
 exports.Tropipay = Tropipay;
-exports.TropipayHooks = TropipayHooks;
 //# sourceMappingURL=index.js.map

package/interfaces/countries/index.d.ts

@@ -1 +1 @@
-export type TropipayCountry = {};
+export type TropipayCountry = {};

package/interfaces/index.d.ts

@@ -9,6 +9,7 @@ export interface TropipayConfig {
     clientSecret: string;
     scopes?: string[];
     serverMode?: ServerMode;
+    customTropipayUrl?: string;
 }
 export type TropipayCredentials = {
     clientId: string;
@@ -49,18 +50,22 @@ export interface PaymentLinkPayload {
     urlFailed: string;
     urlNotification: string;
     serviceDate: string;
-    client: {
-        name: string;
-        lastName: string;
-        address: string;
-        phone: string;
-        email: string;
-        countryId: number;
+    client?: {
+        name?: string;
+        lastName?: string;
+        address?: string;
+        phone?: string;
+        email?: string;
+        countryId?: number;
+        countryIso?: string;
+        city: string;
+        postCode: string;
         termsAndConditions: boolean;
-    };
+    } | null;
     directPayment: boolean;
     paymentMethods?: string[];
     imageBase?: string;
+    saveToken?: boolean;
 }
 export interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;
@@ -71,7 +76,7 @@ export interface PaymentLink extends PaymentLinkPayload {
     shortUrl: string;
     paymentUrl: string;
 }
-export interface mediationPaymentCardConfig {
+export interface MediationPaymentCardConfig {
     amount: number;
     currency: "EUR" | "USD";
     concept: string;

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+};

package/mediationPaymentCard/MediationPaymentCard.d.ts

@@ -0,0 +1,17 @@
+import { Tropipay } from "../api/TropipayAPI";
+import { PaymentLink } from "../interfaces";
+import { MediationPaymentCardConfig } from "../interfaces";
+export default class MediationPaymentCard {
+    private tropipay;
+    constructor(tropipayInstance: Tropipay);
+    /**
+     * (ONLY FOR BUSINESS ACCOUNTS) Create a mediation paymentcard (an escrow payment link) with the specified options.
+     * This allows a payment to be made to persons belonging or not to the TropiPay platform with the
+     * particularity that the payment will be held in custody or retained until it is released with
+     * the approval of the payer.
+     * @param payload PaymentLinkPayload Object.
+     * @returns Promise<PaymentLink> or throws an Exception.
+     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/12a128ff971e4-creating-a-mediation-payment-card
+     */
+    create(payload: MediationPaymentCardConfig): Promise<PaymentLink>;
+}

package/package.json

@@ -1,46 +1,49 @@
-{
-  "name": "@yosle/tropipayjs",
-  "version": "0.1.21",
-  "description": "Javascript / Typescript SDK for the Tropipay API",
-  "main": "index.js",
-  "scripts": {
-    "test": "vitest run",
-    "_clear": "rimraf src/dist/*",
-    "_tsc": "tsc",
-    "_make-bundle": "rollup --config",
-    "build": "yarn _clear && yarn _tsc && yarn _make-bundle"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yosle/tropipayjs"
-  },
-  "keywords": [
-    "Javascript",
-    "Typescript",
-    "Tropipay",
-    "payments",
-    "gateway",
-    "API"
-  ],
-  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
-  "license": "MIT",
-  "dependencies": {
-    "axios": "^1.6.0",
-    "tslib": "^2.4.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-typescript": "^8.5.0",
-    "@types/tough-cookie": "^4.0.5",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.79.1",
-    "rollup-plugin-dts": "^4.2.2",
-    "run-s": "^0.0.0",
-    "typescript": "^5.0.4",
-    "vitest": "^1.2.2",
-    "@types/node": "^20.12.7"
-  },
-  "funding": {
-    "type": "individual",
-    "url": "https://tppay.me/l94qaa3h"
-  }
-}
+{
+  "name": "@yosle/tropipayjs",
+  "version": "0.1.23",
+  "description": "Javascript / Typescript SDK for the Tropipay API",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --passWithNoTests --updateSnapshot --coverage",
+    "_clear": "rimraf src/dist/*",
+    "_tsc": "tsc",
+    "_make-bundle": "rollup --config",
+    "build": "npm run _clear && npm run _tsc && npm run _make-bundle"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yosle/tropipayjs"
+  },
+  "keywords": [
+    "Javascript",
+    "Typescript",
+    "Tropipay",
+    "payments",
+    "gateway",
+    "API"
+  ],
+  "author": "Yosleivy Baez Acosta <yosle007@gmail.com>",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^8.5.0",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.7",
+    "@types/tough-cookie": "^4.0.5",
+    "babel-jest": "^29.7.0",
+    "jest": "^29.7.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.79.1",
+    "rollup-plugin-dts": "^4.2.2",
+    "run-s": "^0.0.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.5"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://tppay.me/l94qaa3h"
+  }
+}

package/paymentcard/PaymentCard.d.ts

@@ -1,7 +1,7 @@
 import { Tropipay } from "../api/TropipayAPI";
 import { PaymentLink } from "../interfaces";
 import { PaymentLinkPayload } from "../interfaces";
-export declare class PaymentCard {
+export default class PaymentCard {
     private tropipay;
     constructor(tropipayInstance: Tropipay);
     /**
@@ -17,5 +17,21 @@ export declare class PaymentCard {
      * @returns Array of paymentlinks
      */
     list(): Promise<any>;
+    /**
+     * Retrieves a payment card with the specified ID.
+     *
+     * @param {string} id - The ID of the payment card to retrieve.
+     * @return {Promise<any>} A Promise that resolves to the payment card data.
+     * @throws {Error} If an error occurs while retrieving the payment card.
+     */
     get(id: string): Promise<any>;
+    /**
+     * Deletes a payment card with the specified ID. Its a LOGIC delete
+     * so this will delete the paymentcard from paymentcard list and
+     * disable shortUrl but not paymentUrl
+     * @param {string} id - The ID of the payment card to delete.
+     * @return {Promise<any>} A Promise that resolves to the deleted payment card data.
+     * @throws {Error} If an error occurs while deleting the payment card.
+     */
+    delete(id: string): Promise<any>;
 }

package/paymentcard/paymentcard.spec.d.ts

@@ -1 +1 @@
-export {};
+declare function sum(a: number, b: number): number;

package/rollup.config.js

@@ -1,24 +1,24 @@
-// Contents of the file /rollup.config.js
-import typescript from "@rollup/plugin-typescript";
-import dts from "rollup-plugin-dts";
-const config = [
-  {
-    input: "dist/index.js",
-    output: {
-      file: "index.js",
-      format: "cjs",
-      sourcemap: true,
-    },
-    external: ["axios", "crypto", "fs/promises"],
-    plugins: [typescript()],
-  },
-  {
-    input: "dist/index.d.ts",
-    output: {
-      file: "index.d.ts",
-      format: "es",
-    },
-    plugins: [dts()],
-  },
-];
-export default config;
+// Contents of the file /rollup.config.js
+import typescript from "@rollup/plugin-typescript";
+import dts from "rollup-plugin-dts";
+const config = [
+  {
+    input: "dist/index.js",
+    output: {
+      file: "index.js",
+      format: "cjs",
+      sourcemap: true,
+    },
+    external: ["axios", "crypto", "fs/promises"],
+    plugins: [typescript()],
+  },
+  {
+    input: "dist/index.d.ts",
+    output: {
+      file: "index.d.ts",
+      format: "es",
+    },
+    plugins: [dts()],
+  },
+];
+export default config;