@yosle/tropipayjs 0.1.18 → 0.1.20

package/.nvmrc

@@ -1 +1 @@
-v18.16.1
+v20.10.0

package/README.md

@@ -47,8 +47,8 @@ or
 
 ## Setting up your app credentials
 
-![alt](https://github.com/yosle/tropipayjs/blob/master/docs/images/app-credentials-menu.png?raw=true)
-![alt](https://github.com/yosle/tropipayjs/blob/master/docs/images/confirmation-code-screen.png?raw=true)
+![alt](https://yosle.github.io/tropipayjs-docs/images/cred1.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

@@ -5,7 +5,7 @@
  *
  */
 import { Axios } from "axios";
-import { TropipayConfig, AccountBalance, Country, PaymentLink, mediationPaymentCardConfig, LoginResponse, AccountDeposits } from "../interfaces";
+import { TropipayConfig, AccountBalance, Country, PaymentLink, mediationPaymentCardConfig, LoginResponse } from "../interfaces";
 type ServerMode = "Development" | "Production";
 import { TropipayHooks } from "../hooks/TropipayHooks";
 import { PaymentCard } from "../paymentcard/PaymentCard";
@@ -22,12 +22,6 @@ export declare class Tropipay {
     depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
-    /**
-     * Get all deposits in this account.
-     * @returns A Promise of an Array of AccountDeposits or throws an Exception
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-     */
-    getDepositAccounts(): Promise<AccountDeposits[] | Error>;
     /**
      * Get the list of all supported countries by Tropipay.
      * @returns Array of Countries Data

package/constants/TropipayConstants.d.ts

@@ -1 +1,2 @@
 export type ServerMode = "Development" | "Production";
+export declare const MAX_IMAGE_SIZE_MB = 1;

package/index.d.ts

@@ -1,6 +1,7 @@
 import { Axios } from 'axios';
 
 type ServerMode$1 = "Development" | "Production";
+declare const MAX_IMAGE_SIZE_MB = 1;
 
 type AccountBalance = {
     balance: number;
@@ -62,6 +63,7 @@ interface PaymentLinkPayload {
     };
     directPayment: boolean;
     paymentMethods?: string[];
+    imageBase?: string;
 }
 interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;
@@ -301,12 +303,6 @@ declare class Tropipay {
     depositAccounts: DepositAccounts;
     constructor(config: TropipayConfig);
     login(): Promise<LoginResponse>;
-    /**
-     * Get all deposits in this account.
-     * @returns A Promise of an Array of AccountDeposits or throws an Exception
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-     */
-    getDepositAccounts(): Promise<AccountDeposits[] | Error>;
     /**
      * Get the list of all supported countries by Tropipay.
      * @returns Array of Countries Data
@@ -382,8 +378,36 @@ declare class ServerSideUtils {
         clientId: string;
         clientSecret: string;
     } | Tropipay, originalCurrencyAmount: string, bankOrderCode: string, signature: string): boolean;
+    /**
+     * Checks if the provided base64 string represents a square image.
+     *
+     * @param {string} base64String - The base64 string of the image
+     * @return {Promise<boolean>} A Promise that resolves to a boolean indicating whether the image is square
+     */
+    static isBase64ImageSquare(base64String: string): Promise<boolean>;
+    /**
+     * Takes a local file path and returns a base64 representation of the file content.
+     *
+     * @param {string} filepath - the path of the file to be converted to base64
+     * @return {Promise<string>} a Promise that resolves to the base64 representation of the file content
+     */
+    static fileToBase64(filepath: string): Promise<string>;
+    /**
+     * Get the base64 representation of a remote file from the given URL.
+     *
+     * @param {string} url - the URL of the file
+     * @return {Promise<string>} the base64 representation of the file
+     */
+    static getBase64FromFileUrl(url: string): Promise<string>;
+    /**
+     * Check if the base64 string represents a valid image and has a valid size
+     *
+     * @param {string} base64Image - the base64 image to be validated
+     * @return {Promise<string>} the valid base64 image
+     */
+    static isValidImage(base64Image: string): boolean;
 }
 
 declare const SERVER_MODE: ServerMode$1;
 
-export { AccountBalance, AccountDeposits, ClientSideUtils, Country, Deposit, DepositAccounts, HookEventType, HookTargetType, LoginError, LoginResponse, PaymentCard, PaymentLink, PaymentLinkPayload, SERVER_MODE, ServerMode$1 as ServerMode, ServerSideUtils, Tropipay, TropipayConfig, TropipayCredentials, TropipayHooks, UserHook, UserHookSubscribed, mediationPaymentCardConfig };
+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 };

package/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var axios = require('axios');
 var crypto = require('crypto');
+var fs = require('fs/promises');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -27,6 +28,7 @@ function _interopNamespace(e) {
 
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 var crypto__namespace = /*#__PURE__*/_interopNamespace(crypto);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 
 function handleExceptions(error) {
     if (error instanceof axios.AxiosError) {
@@ -452,29 +454,6 @@ class Tropipay {
             throw handleExceptions(error);
         }
     }
-    /**
-     * Get all deposits in this account.
-     * @returns A Promise of an Array of AccountDeposits or throws an Exception
-     * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-     */
-    async getDepositAccounts() {
-        if (!Tropipay.accessToken) {
-            await this.login();
-        }
-        try {
-            const deposits = await this.request.get("/api/v2/deposit_accounts", {
-                headers: {
-                    "Content-Type": "application/json",
-                    Authorization: `Bearer ${Tropipay.accessToken}`,
-                    Accept: "application/json",
-                },
-            });
-            return deposits.data;
-        }
-        catch (error) {
-            throw handleExceptions(error);
-        }
-    }
     /**
      * Get the list of all supported countries by Tropipay.
      * @returns Array of Countries Data
@@ -650,6 +629,8 @@ class ClientSideUtils {
     }
 }
 
+const MAX_IMAGE_SIZE_MB = 1;
+
 class ServerSideUtils {
     tropipay;
     constructor(tropipayInstance) {
@@ -673,6 +654,79 @@ class ServerSideUtils {
             .digest("hex");
         return localSignature === signature;
     }
+    /**
+     * Checks if the provided base64 string represents a square image.
+     *
+     * @param {string} base64String - The base64 string of the image
+     * @return {Promise<boolean>} A Promise that resolves to a boolean indicating whether the image is square
+     */
+    static async isBase64ImageSquare(base64String) {
+        return new Promise((resolve, reject) => {
+            const img = new Image();
+            img.onload = () => {
+                // Check if the image has a 1:1 aspect ratio
+                const isSquare = img.width === img.height;
+                resolve(isSquare);
+            };
+            img.onerror = (error) => {
+                reject(error);
+            };
+            img.src = base64String;
+        });
+    }
+    /**
+     * Takes a local file path and returns a base64 representation of the file content.
+     *
+     * @param {string} filepath - the path of the file to be converted to base64
+     * @return {Promise<string>} a Promise that resolves to the base64 representation of the file content
+     */
+    static async fileToBase64(filepath) {
+        const contents = await fs__default["default"].readFile(filepath);
+        let base64content = contents.toString("base64");
+        const ext = filepath.split(".").pop();
+        return `data:image/${ext};base64,` + base64content;
+    }
+    /**
+     * Get the base64 representation of a remote file from the given URL.
+     *
+     * @param {string} url - the URL of the file
+     * @return {Promise<string>} the base64 representation of the file
+     */
+    static async getBase64FromFileUrl(url) {
+        const response = await axios__default["default"].get(url, {
+            responseType: "arraybuffer",
+            maxRedirects: 5,
+        });
+        return Buffer.from(response.data, "binary").toString("base64");
+    }
+    /**
+     * Check if the base64 string represents a valid image and has a valid size
+     *
+     * @param {string} base64Image - the base64 image to be validated
+     * @return {Promise<string>} the valid base64 image
+     */
+    static isValidImage(base64Image) {
+        // Check if the base64 string represents a valid image and has a valid size
+        try {
+            const isBase64Image = base64Image.startsWith("data:image/");
+            if (!isBase64Image) {
+                console.error("Not a valid base64 image");
+                throw new Error("Not a valid base64 image");
+            }
+            // TODO: use constants intead of magic numbers here
+            const isSizeLessThan2MB = base64Image.length * 0.75 <= MAX_IMAGE_SIZE_MB * 1024 * 1024;
+            if (!isSizeLessThan2MB) {
+                console.error(`The image should be less than 2mb`);
+                throw new Error(`The image should be less than 2mb`);
+            }
+            // all is fine
+            return true;
+        }
+        catch (error) {
+            console.error("Error checking base64 image:", error);
+            throw new Error(`Error checking base64 image`);
+        }
+    }
 }
 
 const SERVER_MODE = "Development"; // Move the constant here
@@ -689,11 +743,14 @@ const SERVER_MODE = "Development"; // Move the constant here
  * @license MIT
  */
 if (typeof window !== "undefined") {
-    console.warn("DANGER This library should not be used client side, your credentials could be exposed");
+    const err_msg = `⚠️ **Warning:** The Tropipay SDK should only be instantiated server-side for security reasons. Using it client-side may lead to unexpected behavior and security vulnerabilities. YOUR CREDENTIALS COULD BE EXPOSED. Check https://yosle.github.io/tropipayjs-docs/guides/installation/ for more details.`;
+    console.error(err_msg);
+    throw new Error(err_msg);
 }
 
 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;

package/interfaces/index.d.ts

@@ -59,6 +59,7 @@ export interface PaymentLinkPayload {
     };
     directPayment: boolean;
     paymentMethods?: string[];
+    imageBase?: string;
 }
 export interface PaymentLink extends PaymentLinkPayload {
     expirationDate: string;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "vitest run",
     "_clear": "rimraf src/dist/*",
     "_tsc": "tsc",
     "_make-bundle": "rollup --config",
@@ -30,11 +30,13 @@
   },
   "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"
+    "typescript": "^5.0.4",
+    "vitest": "^1.2.2"
   },
   "funding": {
     "type": "individual",

package/paymentcard/paymentcard.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/rollup.config.js

@@ -9,7 +9,7 @@ const config = [
       format: "cjs",
       sourcemap: true,
     },
-    external: ["axios", "crypto"],
+    external: ["axios", "crypto", "fs/promises"],
     plugins: [typescript()],
   },
   {

package/src/api/TropipayAPI.ts

@@ -79,29 +79,6 @@ export class Tropipay {
     }
   }
 
-  /**
-   * Get all deposits in this account.
-   * @returns A Promise of an Array of AccountDeposits or throws an Exception
-   * @see https://tpp.stoplight.io/docs/tropipay-api-doc/b3A6OTgyOTQ1Mg-get-deposit-accounts-list
-   */
-  async getDepositAccounts(): Promise<AccountDeposits[] | Error> {
-    if (!Tropipay.accessToken) {
-      await this.login();
-    }
-    try {
-      const deposits = await this.request.get("/api/v2/deposit_accounts", {
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: `Bearer ${Tropipay.accessToken}`,
-          Accept: "application/json",
-        },
-      });
-      return deposits.data;
-    } catch (error) {
-      throw handleExceptions(error as any);
-    }
-  }
-
   /**
    * Get the list of all supported countries by Tropipay.
    * @returns Array of Countries Data

package/src/constants/TropipayConstants.ts

@@ -1 +1,2 @@
 export type ServerMode = "Development" | "Production";
+export const MAX_IMAGE_SIZE_MB = 1;

package/src/index.ts

@@ -10,14 +10,10 @@
  * @license MIT
  */
 
-import { DepositAccounts } from "./depositAccount/depositAccounts";
-
 if (typeof window !== "undefined") {
-  console.warn(
-    `⚠️ **Warning:** The Tropipay SDK should only be instantiated server-side for security reasons. 
-    Using it client-side may lead to unexpected behavior and security vulnerabilities. YOUR CREDENTIALS COULD BE EXPOSED. Check 
-    https://yosle.github.io/tropipayjs-docs/guides/installation/ for more details.`
-  );
+  const err_msg = `⚠️ **Warning:** The Tropipay SDK should only be instantiated server-side for security reasons. Using it client-side may lead to unexpected behavior and security vulnerabilities. YOUR CREDENTIALS COULD BE EXPOSED. Check https://yosle.github.io/tropipayjs-docs/guides/installation/ for more details.`;
+  console.error(err_msg);
+  throw new Error(err_msg);
 }
 
 export { Tropipay } from "./api/TropipayAPI";

package/src/interfaces/index.ts

@@ -86,6 +86,7 @@ export interface PaymentLinkPayload {
   };
   directPayment: boolean;
   paymentMethods?: string[];
+  imageBase?: string;
 }
 
 export interface PaymentLink extends PaymentLinkPayload {

package/src/paymentcard/paymentcard.spec.ts

@@ -0,0 +1,10 @@
+import { describe, expect, it } from "vitest";
+
+function sum(a: number, b: number) {
+  return a + b;
+}
+describe("dummy test", () => {
+  it("dummy test", () => {
+    expect(sum(1, 2)).toBe(3);
+  });
+});

package/src/utils/TropipayUtils.ts

@@ -1,7 +1,9 @@
 import * as crypto from "crypto";
 import { Tropipay } from "../api/TropipayAPI";
-import { AxiosError, AxiosResponse } from "axios";
 
+import axios from "axios";
+import fs from "fs/promises";
+import { MAX_IMAGE_SIZE_MB } from "../constants/TropipayConstants";
 export class ServerSideUtils {
   private tropipay: Tropipay;
   constructor(tropipayInstance: Tropipay) {
@@ -38,4 +40,87 @@ export class ServerSideUtils {
       .digest("hex");
     return localSignature === signature;
   }
+  /**
+   * Checks if the provided base64 string represents a square image.
+   *
+   * @param {string} base64String - The base64 string of the image
+   * @return {Promise<boolean>} A Promise that resolves to a boolean indicating whether the image is square
+   */
+  public static async isBase64ImageSquare(
+    base64String: string
+  ): Promise<boolean> {
+    return new Promise<boolean>((resolve, reject) => {
+      const img = new Image();
+
+      img.onload = () => {
+        // Check if the image has a 1:1 aspect ratio
+        const isSquare = img.width === img.height;
+        resolve(isSquare);
+      };
+
+      img.onerror = (error) => {
+        reject(error);
+      };
+
+      img.src = base64String;
+    });
+  }
+
+  /**
+   * Takes a local file path and returns a base64 representation of the file content.
+   *
+   * @param {string} filepath - the path of the file to be converted to base64
+   * @return {Promise<string>} a Promise that resolves to the base64 representation of the file content
+   */
+  public static async fileToBase64(filepath: string): Promise<string> {
+    const contents = await fs.readFile(filepath);
+    let base64content = contents.toString("base64");
+    const ext = filepath.split(".").pop();
+    return `data:image/${ext};base64,` + base64content;
+  }
+
+  /**
+   * Get the base64 representation of a remote file from the given URL.
+   *
+   * @param {string} url - the URL of the file
+   * @return {Promise<string>} the base64 representation of the file
+   */
+  public static async getBase64FromFileUrl(url: string): Promise<string> {
+    const response = await axios.get(url, {
+      responseType: "arraybuffer",
+      maxRedirects: 5,
+    });
+    return Buffer.from(response.data, "binary").toString("base64");
+  }
+
+  /**
+   * Check if the base64 string represents a valid image and has a valid size
+   *
+   * @param {string} base64Image - the base64 image to be validated
+   * @return {Promise<string>} the valid base64 image
+   */
+  public static isValidImage(base64Image: string): boolean {
+    // Check if the base64 string represents a valid image and has a valid size
+    try {
+      const isBase64Image = base64Image.startsWith("data:image/");
+      if (!isBase64Image) {
+        console.error("Not a valid base64 image");
+        throw new Error("Not a valid base64 image");
+      }
+
+      // TODO: use constants intead of magic numbers here
+      const isSizeLessThan2MB =
+        base64Image.length * 0.75 <= MAX_IMAGE_SIZE_MB * 1024 * 1024;
+
+      if (!isSizeLessThan2MB) {
+        console.error(`The image should be less than 2mb`);
+        throw new Error(`The image should be less than 2mb`);
+      }
+      // all is fine
+      return true;
+    } catch (error) {
+      console.error("Error checking base64 image:", error);
+      throw new Error(`Error checking base64 image`);
+    }
+  }
 }

package/src/utils/errors.ts

@@ -82,7 +82,7 @@ export function handleExceptions(
   }
 }
 
-class TropipayJSException extends Error {
+export class TropipayJSException extends Error {
   code: number; // Status code
   error: unknown;
   message: string;

package/utils/TropipayUtils.d.ts

@@ -14,4 +14,32 @@ export declare class ServerSideUtils {
         clientId: string;
         clientSecret: string;
     } | Tropipay, originalCurrencyAmount: string, bankOrderCode: string, signature: string): boolean;
+    /**
+     * Checks if the provided base64 string represents a square image.
+     *
+     * @param {string} base64String - The base64 string of the image
+     * @return {Promise<boolean>} A Promise that resolves to a boolean indicating whether the image is square
+     */
+    static isBase64ImageSquare(base64String: string): Promise<boolean>;
+    /**
+     * Takes a local file path and returns a base64 representation of the file content.
+     *
+     * @param {string} filepath - the path of the file to be converted to base64
+     * @return {Promise<string>} a Promise that resolves to the base64 representation of the file content
+     */
+    static fileToBase64(filepath: string): Promise<string>;
+    /**
+     * Get the base64 representation of a remote file from the given URL.
+     *
+     * @param {string} url - the URL of the file
+     * @return {Promise<string>} the base64 representation of the file
+     */
+    static getBase64FromFileUrl(url: string): Promise<string>;
+    /**
+     * Check if the base64 string represents a valid image and has a valid size
+     *
+     * @param {string} base64Image - the base64 image to be validated
+     * @return {Promise<string>} the valid base64 image
+     */
+    static isValidImage(base64Image: string): boolean;
 }

package/utils/errors.d.ts

@@ -8,10 +8,9 @@ export interface ErrorDetail {
     meta: unknown;
 }
 export declare function handleExceptions(error: AxiosError | Error): TropipayJSException;
-declare class TropipayJSException extends Error {
+export declare class TropipayJSException extends Error {
     code: number;
     error: unknown;
     message: string;
     constructor(message: string, code: number, data: unknown);
 }
-export {};