@yosle/tropipayjs 0.1.20 → 0.1.21

package/README.md

@@ -47,7 +47,7 @@ or
 
 ## Setting up your app credentials
 
-![alt](https://yosle.github.io/tropipayjs-docs/images/cred1.png)
+![alt](https://yosle.github.io/tropipayjs-docs/images/cred2.png)
 ![alt](https://yosle.github.io/tropipayjs-docs/images/cred3.png)
 
 In order to use the Tropipay API you'll need a client ID and a client secret. Sign up with your [Tropipay](www.tropipay.com) account, go to the App Menu->Applications and credentials. You'll be asked to enter a confirmation code (use 123456 in the test enviroment). _Make sure you test everything in the [test environment](https://tropipay-dev.herokuapp.com) first before using your real account._ Create an app and configure the client id an client secret for the app.

package/api/TropipayAPI.d.ts

@@ -13,13 +13,19 @@ import { DepositAccounts } from "../depositAccount/depositAccounts";
 export declare class Tropipay {
     readonly clientId: string;
     readonly clientSecret: string;
+    readonly scopes: String[];
     request: Axios;
-    static accessToken: string | undefined;
-    static refreshToken: string | undefined;
+    static accessToken: string | null;
+    static refreshToken: string | null;
     serverMode: ServerMode;
     hooks: TropipayHooks;
     paymentCards: PaymentCard;
     depositAccounts: DepositAccounts;
+    /**
+     * Initializes a new instance of the Tropipay class.
+     *
+     * @param {TropipayConfig} config - The configuration object.
+     */
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**

package/hooks/TropipayHooks.d.ts

@@ -25,7 +25,7 @@ export declare class TropipayHooks {
         value: string;
     }): Promise<any>;
     /**
-     * Get the sucbcribed hook info by his event type.
+     * Get the subscribed hook info by his event type.
      * If no event type is passed, it will return
      * all subscribed hooks or empty Array if none exist.
      * @param eventType or no params for retrieving all hooks

package/index.d.ts

@@ -11,6 +11,7 @@ type AccountBalance = {
 interface TropipayConfig {
     clientId: string;
     clientSecret: string;
+    scopes?: string[];
     serverMode?: ServerMode$1;
 }
 type TropipayCredentials = {
@@ -188,7 +189,7 @@ declare class TropipayHooks {
         value: string;
     }): Promise<any>;
     /**
-     * Get the sucbcribed hook info by his event type.
+     * Get the subscribed hook info by his event type.
      * If no event type is passed, it will return
      * all subscribed hooks or empty Array if none exist.
      * @param eventType or no params for retrieving all hooks
@@ -294,13 +295,19 @@ type ServerMode = "Development" | "Production";
 declare class Tropipay {
     readonly clientId: string;
     readonly clientSecret: string;
+    readonly scopes: String[];
     request: Axios;
-    static accessToken: string | undefined;
-    static refreshToken: string | undefined;
+    static accessToken: string | null;
+    static refreshToken: string | null;
     serverMode: ServerMode;
     hooks: TropipayHooks;
     paymentCards: PaymentCard;
     depositAccounts: DepositAccounts;
+    /**
+     * Initializes a new instance of the Tropipay class.
+     *
+     * @param {TropipayConfig} config - The configuration object.
+     */
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
     /**

package/index.js

@@ -42,8 +42,8 @@ function handleExceptions(error) {
                     return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
                 case 404:
                     return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
-                // case 429:
-                //   return new TooManyRequestsException(errorMessage);
+                case 429:
+                    return new TropipayJSException(`${errorMessage} Too many request or rate limited`, axiosResponse.status, axiosResponse.data.error);
                 default:
                     return new TropipayJSException(errorMessage, axiosResponse.status, axiosResponse.data.error);
             }
@@ -58,7 +58,7 @@ function handleExceptions(error) {
         }
     }
     else {
-        return new TropipayJSException(`jsbfvbsfvbf`, 500, null);
+        return new TropipayJSException("An Unknown error occurred", 500, null);
     }
 }
 class TropipayJSException extends Error {
@@ -120,7 +120,7 @@ class TropipayHooks {
         }
     }
     /**
-     * Get the sucbcribed hook info by his event type.
+     * Get the subscribed hook info by his event type.
      * If no event type is passed, it will return
      * all subscribed hooks or empty Array if none exist.
      * @param eventType or no params for retrieving all hooks
@@ -408,6 +408,7 @@ class DepositAccounts {
 class Tropipay {
     clientId;
     clientSecret;
+    scopes;
     request;
     static accessToken;
     static refreshToken;
@@ -415,7 +416,32 @@ class Tropipay {
     hooks;
     paymentCards;
     depositAccounts;
+    /**
+     * Initializes a new instance of the Tropipay class.
+     *
+     * @param {TropipayConfig} config - The configuration object.
+     */
     constructor(config) {
+        // use all scopes if none is passed
+        if (!config?.scopes) {
+            this.scopes = [
+                "ALLOW_GET_PROFILE_DATA",
+                "ALLOW_PAYMENT_IN",
+                "ALLOW_EXTERNAL_CHARGE",
+                "KYC3_FULL_ALLOW",
+                "ALLOW_PAYMENT_OUT",
+                "ALLOW_MARKET_PURCHASES",
+                "ALLOW_GET_BALANCE",
+                "ALLOW_GET_MOVEMENT_LIST",
+                "ALLOW_GET_CREDENTIAL",
+            ];
+        }
+        else {
+            this.scopes = config.scopes;
+        }
+        if (!config.clientId || !config.clientSecret) {
+            throw new TropipayJSException(`You must pass clientId and clientSecret in Tropipay constructor`, 400, null);
+        }
         this.clientId = config.clientId;
         this.clientSecret = config.clientSecret;
         this.serverMode = config.serverMode || "Development";
@@ -435,11 +461,26 @@ class Tropipay {
     }
     async login() {
         try {
+            if (Tropipay.refreshToken) {
+                const { data } = await this.request.post("/api/v2/access/token", {
+                    client_id: this.clientId,
+                    client_secret: this.clientSecret,
+                    grant_type: "refresh_token",
+                    refresh_token: Tropipay.refreshToken,
+                }, {
+                    headers: {
+                        "Content-Type": "application/json",
+                        Accept: "application/json",
+                    },
+                });
+                return data;
+            }
+            // normal credetials login
             const { data } = await this.request.post("/api/v2/access/token", {
                 client_id: this.clientId,
                 client_secret: this.clientSecret,
                 grant_type: "client_credentials",
-                scope: "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL",
+                scope: this.scopes.join(" "), // "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL",
             }, {
                 headers: {
                     "Content-Type": "application/json",
@@ -451,6 +492,8 @@ class Tropipay {
             return data;
         }
         catch (error) {
+            Tropipay.accessToken = null;
+            Tropipay.refreshToken = null;
             throw handleExceptions(error);
         }
     }

package/interfaces/index.d.ts

@@ -7,6 +7,7 @@ export type AccountBalance = {
 export interface TropipayConfig {
     clientId: string;
     clientSecret: string;
+    scopes?: string[];
     serverMode?: ServerMode;
 }
 export type TropipayCredentials = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.20",
+  "version": "0.1.21",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {
@@ -36,7 +36,8 @@
     "rollup-plugin-dts": "^4.2.2",
     "run-s": "^0.0.0",
     "typescript": "^5.0.4",
-    "vitest": "^1.2.2"
+    "vitest": "^1.2.2",
+    "@types/node": "^20.12.7"
   },
   "funding": {
     "type": "individual",

package/src/api/TropipayAPI.ts

@@ -20,19 +20,51 @@ type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
 import { PaymentCard } from "../paymentcard/PaymentCard";
 import { DepositAccounts } from "../depositAccount/depositAccounts";
-import { handleExceptions } from "../utils/errors";
+import { TropipayJSException, handleExceptions } from "../utils/errors";
 export class Tropipay {
   readonly clientId: string;
   readonly clientSecret: string;
+  readonly scopes: String[];
   public request: Axios;
-  public static accessToken: string | undefined;
-  public static refreshToken: string | undefined;
+  public static accessToken: string | null;
+  public static refreshToken: string | null;
   public serverMode: ServerMode;
   public hooks: TropipayHooks;
   public paymentCards: PaymentCard;
   public depositAccounts: DepositAccounts;
 
+  /**
+   * Initializes a new instance of the Tropipay class.
+   *
+   * @param {TropipayConfig} config - The configuration object.
+   */
+
   constructor(config: TropipayConfig) {
+    // use all scopes if none is passed
+    if (!config?.scopes) {
+      this.scopes = [
+        "ALLOW_GET_PROFILE_DATA",
+        "ALLOW_PAYMENT_IN",
+        "ALLOW_EXTERNAL_CHARGE",
+        "KYC3_FULL_ALLOW",
+        "ALLOW_PAYMENT_OUT",
+        "ALLOW_MARKET_PURCHASES",
+        "ALLOW_GET_BALANCE",
+        "ALLOW_GET_MOVEMENT_LIST",
+        "ALLOW_GET_CREDENTIAL",
+      ];
+    } else {
+      this.scopes = config.scopes;
+    }
+
+    if (!config.clientId || !config.clientSecret) {
+      throw new TropipayJSException(
+        `You must pass clientId and clientSecret in Tropipay constructor`,
+        400,
+        null
+      );
+    }
+
     this.clientId = config.clientId;
     this.clientSecret = config.clientSecret;
     this.serverMode = config.serverMode || "Development";
@@ -54,14 +86,33 @@ export class Tropipay {
 
   public async login() {
     try {
+      if (Tropipay.refreshToken) {
+        const { data } = await this.request.post<LoginResponse>(
+          "/api/v2/access/token",
+          {
+            client_id: this.clientId,
+            client_secret: this.clientSecret,
+            grant_type: "refresh_token",
+            refresh_token: Tropipay.refreshToken,
+          },
+          {
+            headers: {
+              "Content-Type": "application/json",
+              Accept: "application/json",
+            },
+          }
+        );
+        return data;
+      }
+
+      // normal credetials login
       const { data } = await this.request.post<LoginResponse>(
         "/api/v2/access/token",
         {
           client_id: this.clientId,
           client_secret: this.clientSecret,
           grant_type: "client_credentials",
-          scope:
-            "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL",
+          scope: this.scopes.join(" "), // "ALLOW_GET_PROFILE_DATA ALLOW_PAYMENT_IN ALLOW_EXTERNAL_CHARGE KYC3_FULL_ALLOW ALLOW_PAYMENT_OUT ALLOW_MARKET_PURCHASES ALLOW_GET_BALANCE ALLOW_GET_MOVEMENT_LIST ALLOW_GET_CREDENTIAL",
         },
         {
           headers: {
@@ -75,6 +126,8 @@ export class Tropipay {
       Tropipay.refreshToken = data.refresh_token;
       return data;
     } catch (error) {
+      Tropipay.accessToken = null;
+      Tropipay.refreshToken = null;
       throw handleExceptions(error as any);
     }
   }

package/src/hooks/TropipayHooks.ts

@@ -57,7 +57,7 @@ export class TropipayHooks {
     }
   }
   /**
-   * Get the sucbcribed hook info by his event type.
+   * Get the subscribed hook info by his event type.
    * If no event type is passed, it will return
    * all subscribed hooks or empty Array if none exist.
    * @param eventType or no params for retrieving all hooks

package/src/interfaces/index.ts

@@ -9,6 +9,7 @@ export type AccountBalance = {
 export interface TropipayConfig {
   clientId: string;
   clientSecret: string;
+  scopes?: string[];
   serverMode?: ServerMode;
 }
 

package/src/utils/errors.ts

@@ -57,8 +57,12 @@ export function handleExceptions(
             axiosResponse.status,
             axiosResponse.data.error
           );
-        // case 429:
-        //   return new TooManyRequestsException(errorMessage);
+        case 429:
+          return new TropipayJSException(
+            `${errorMessage} Too many request or rate limited`,
+            axiosResponse.status,
+            axiosResponse.data.error
+          );
         default:
           return new TropipayJSException(
             errorMessage,
@@ -78,7 +82,7 @@ export function handleExceptions(
       return new TropipayJSException("An error occurred", 500, null);
     }
   } else {
-    return new TropipayJSException(`jsbfvbsfvbf`, 500, null);
+    return new TropipayJSException("An Unknown error occurred", 500, null);
   }
 }