@yosle/tropipayjs 0.1.5 → 0.1.6

package/LICENSE

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (c) 2022 Yosleivy Baez Acosta.
+
+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

@@ -1,22 +1,29 @@
-TropipayJS -Typescript/Javascript SDK for Tropipay Payments API
+TropipayJS - Typescript/Javascript SDK for Tropipay Payments API
 ===========
+![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
 ![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white) 
 ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)
 ![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)
-![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
+![RollupJS](https://img.shields.io/badge/RollupJS-ef3335?style=for-the-badge&logo=rollup.js&logoColor=white)
 
-TropiPay is an electronic wallet that allows you to execute the most common financial operations of the day to day. This is an SDK for Typescript and Javacript that helps you build integrations with the Tropipay platform in an easier way. Can save you a lot of time and effort implementing all the API features. You can use this library with CommonJS system (like node + express) or ES6 module system (NextJS).
+TropiPay is an electronic wallet that allows you to execute the most common financial operations of the day to day. This is SDK for Typescript and Javacript that helps you build integrations with the Tropipay platform in an easier way. Can save you a lot of time and effort implementing all the API features. You can use this library with CommonJS system (node + express) or ES6 module system (NextJS).
 
-## Project status
-This library is still under development so using it in the live (real account) isn't recommended yet.
 
 # Table of Contents
-* [Getting started](#getting-started)
-* [Setting up your credentials](#setting-up-your-app-credentials)
-* [Documentation](#documentation)
-* [Examples](#examples)
-* [Contribute and Help](#contributing-and-help)
-
+- [TropipayJS - Typescript/Javascript SDK for Tropipay Payments API](#tropipayjs---typescriptjavascript-sdk-for-tropipay-payments-api)
+- [Table of Contents](#table-of-contents)
+  - [About the project](#about-the-project)
+- [Getting started](#getting-started)
+  - [Setting up your app credentials](#setting-up-your-app-credentials)
+  - [Usage](#usage)
+    - [CommonJS](#commonjs)
+    - [ES6](#es6)
+    - [Initialize the Tropipay class](#initialize-the-tropipay-class)
+    - [Generating a Payment Link](#generating-a-payment-link)
+- [Contributing](#contributing)
+- [License](#license)
+## About the project
+This library is a community effort still under development so use caution if you're planing to use it in production. Tropipay may make some changes on the API Specification in the future. Use the [test environment](https://tropipay-dev.herokuapp.com) to make sure everything is working as expected.
 # Getting started
 You can use npm or yarn to install this package:
 
@@ -27,11 +34,13 @@ or
 ```yarn add @yosle/tropipayjs```
 
 ## Setting up your app credentials
-![alt](/docs/images/app-credentials-menu.png)
-![alt](/docs/images/confirmation-code-screen.png)
+
+![alt]([/docs/images/app-credentials-menu.png](https://github.com/yosle/tropipayjs/blob/master/docs/images/app-credentials-menu.png))
+![alt]([/docs/images/confirmation-code-screen.png](https://github.com/yosle/tropipayjs/blob/master/docs/images/confirmation-code-screen.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 enviroment](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.
 
-## How to use
+## Usage
 The Tropipay instance, allows you to access all the method available in the API. This Object is meant to be used *only in server side*. Do not use the Tropipay object on the client side (browser). This would expose your app credentials (the client secret of your account). You can create an endpoint at your back-end using express and consume it in your front-end, or use SSR if you're using NextJS.
 
 ### CommonJS 
@@ -47,22 +56,60 @@ import { Tropipay } from '@yosle/tropipayjs'
 const tpp = new Tropipay("yourclientidhere",
     "yourclientsecrethere")
 ```
-## Generating a Payment Link
+### Generating a Payment Link
 ```javascript
+/*
+* Example Payload
+*/
+const payload = await tpp.createPayLink({
+        reference: "my-paylink-1",
+        concept: "Bicycle",
+        favorite: "true",
+        amount: 3000,
+        currency: "EUR",
+        description: "Two wheels",
+        singleUse: "true",
+        reasonId: 4,
+        expirationDays: 1,
+        lang: "es",
+        urlSuccess: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+        urlFailed: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+        urlNotification: "https://webhook.site/680826a5-199e-4455-babc-f47b7f26ee7e",
+        serviceDate: "2021-08-20",
+        client: {
+            name: "John",
+            lastName: "McClane",
+            address: "Ave. Guadí 232, Barcelona, Barcelona",
+            phone: "+34645553333",
+            email: "client@email.com",
+            countryId: 1,
+            termsAndConditions: "true"
+        },
+        directPayment: "true"
+    })
+    
+// Use inside an async function
 const paylink = await tpp.createPayLink(payload)
+console.log(paylink.shortUrl)
 ```
 
-# Documentation
-Examples using express + nodejs and NextJS will be added soon.
+For more examples, please refer to the [Documentation](https://github.com/yosle/tropipayjs/blob/master/docs/)
 
 # Contributing
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+   
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. 
 
-Please make sure to update tests as appropriate.
+You can also make a small [donation to the author](https://tppay.me/l94qaa3h) of the library.
+# License
+Distributed under the MIT License. See `LICENSE.txt` for more information.
 
-You can also make a small [donation to the author](https://tppay.me/l94qaa3h).
-## License
-[MIT License](https://choosealicense.com/licenses/mit/)
 
 
 

package/docs/README.MD

@@ -0,0 +1,4 @@
+Documentation
+=============
+
+This will be added eventually.

package/index.d.ts

@@ -38,8 +38,8 @@ interface PaymentLink extends PaymentLinkPayload {
 }
 
 /**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and
- * ES6 modules are supported.
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
  * @author Yosleivy Baez Acosta
  *
  */
@@ -99,7 +99,7 @@ declare class Tropipay {
      * @returns
      */
     profile(): Promise<any>;
-    getRates(payload?: {
+    rates(payload?: {
         currencyFrom: string;
     }): Promise<any>;
 }

package/index.js

@@ -9,8 +9,8 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
 
 /**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and
- * ES6 modules are supported.
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ *
  * @author Yosleivy Baez Acosta
  *
  */
@@ -42,7 +42,7 @@ class Tropipay {
                 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: "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',
@@ -55,7 +55,6 @@ class Tropipay {
         }
         catch (error) {
             if (axios__default["default"].isAxiosError(error)) {
-                // 👇️ error: AxiosError<any, any>
                 throw new Error("Conection error: " + error.message);
             }
             throw new Error("Could not obtain the access token from credentials ");
@@ -82,7 +81,7 @@ class Tropipay {
             return paylink.data;
         }
         catch (error) {
-            throw new Error(`Could not obtain the access tokemn with the given credentials.`);
+            throw new Error(`Could not obtain the access token with the given credentials.`);
         }
     }
     /**
@@ -189,7 +188,7 @@ class Tropipay {
             throw new Error(`Could not retrieve movements list ${error}`);
         }
     }
-    async getRates(payload = { currencyFrom: "EUR" }) {
+    async rates(payload = { currencyFrom: "EUR" }) {
         console.log(payload);
         if (!this.accessToken) {
             await this.login();

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@yosle/tropipayjs",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Javascript / Typescript SDK for the Tropipay API",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "_clear": "rimraf build/compiled/*",
+    "_clear": "rimraf src/dist/*",
     "_tsc": "tsc",
     "_make-bundle": "rollup --config",
     "build": "run-s _clear _tsc _make-bundle"

package/src/globals.d.ts

@@ -0,0 +1,74 @@
+type LoginResponse = {
+    access_token: string,
+    refresh_token: string
+    token_type: "Bearer",
+    expires_in: number,
+    scope: string
+}
+
+type LoginError = {
+    error: string
+}
+
+type Country = {
+        id: number,
+        name: string,
+        sepaZone: boolean,
+        state: number,
+        slug: string,
+        slugn: number,
+        callingCode: number,
+        isDestination: boolean,
+        isRisky: boolean,
+        currentCurrency: string | null,
+        createdAt: string,
+        updatedAt: string,
+        isFavorite: boolean,
+        position: any
+
+}
+
+type Deposit = {
+    id: number,
+    accountNumber: string,
+    alias: string,
+    swift: string,
+    type: number,
+    country: number | null,
+    firstName: string,
+    default: null,
+    state: number,
+    userId: string,
+    countryDestinationId: number,
+    lastName: string,
+    documentNumber: number,
+    userRelationTypeId: number,
+    city: string,
+    postalCode: string,
+    address: string,
+    phone: string,
+    checked: boolean,
+    province: string,
+    beneficiaryType: number,
+    relatedUserId: null | string,
+    currency: string,
+    correspondent?: any,
+    location: any,
+    office: any,
+    officeValue: any,
+    paymentType: number,
+    paymentEntityBeneficiaryId: number,
+    paymentEntityAccountId: number,
+    verified: any,
+    paymentEntityInfo: any,
+    documentTypeId: any,
+    documentExpirationDate: Date,
+    createdAt: Date<string>,
+    updatedAt: Date<string>,
+    countryDestination: Country
+}
+
+type AccountDeposits = {
+   count: number,
+   rows:  Deposit[]
+}

package/{index.ts → src/index.ts}

@@ -1,6 +1,6 @@
 /**
- * Tropipayjs is a Typescript/Javascript library for the Tropipay API. CommonJs and 
- * ES6 modules are supported.
+ * Tropipayjs is a Typescript/Javascript library for the Tropipay API.
+ * 
  * @author Yosleivy Baez Acosta
  * 
  */
@@ -48,7 +48,7 @@ export class Tropipay {
                 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: "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',
@@ -61,9 +61,8 @@ export class Tropipay {
             return data
         } catch (error) {
             if (axios.isAxiosError(error)) {
-                // 👇️ error: AxiosError<any, any>
                 throw new Error("Conection error: " + error.message);
-            }
+                }
             throw new Error("Could not obtain the access token from credentials ");
 
         }
@@ -89,7 +88,7 @@ export class Tropipay {
             })
             return paylink.data as PaymentLink
         } catch (error) {
-            throw new Error(`Could not obtain the access tokemn with the given credentials.`);
+            throw new Error(`Could not obtain the access token with the given credentials.`);
 
         }
     }
@@ -203,7 +202,7 @@ export class Tropipay {
         }
     }
 
-    async getRates(payload = {currencyFrom: "EUR"}) {
+    async rates(payload = {currencyFrom: "EUR"}) {
         console.log(payload)
         if (!this.accessToken) {
             await this.login()

package/src/interfaces/paymentlink/index.d.ts

@@ -0,0 +1,36 @@
+export interface PaymentLinkPayload {
+    reference: string;
+    concept: string;
+    favorite: boolean;
+    amount: number;
+    currency: string;
+    description: string;
+    singleUse: boolean;
+    reasonId: number;
+    expirationDays: number;
+    lang: string;
+    urlSuccess: string;
+    urlFailed: string;
+    urlNotification: string;
+    serviceDate: string;
+    client: {
+        name: string;
+        lastName: string;
+        address: string;
+        phone: string;
+        email: string;
+        countryId: number;
+        termsAndConditions: boolean;
+    };
+    directPayment: boolean;
+    paymentMethods?: string[];
+}
+export interface PaymentLink extends PaymentLinkPayload {
+    expirationDate: string;
+    hasClient: boolean;
+    updatedAt: string;
+    createdAt: string;
+    qrImage: string;
+    shortUrl: string;
+    paymentUrl: string;
+}

package/tsconfig.json

@@ -23,7 +23,7 @@
     // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
     /* Modules */
     "module": "esnext", /* Specify what module code is generated. */
-    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "rootDir": "./src", /* Specify the root folder within your source files. */
     "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
     // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
     // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
@@ -44,7 +44,7 @@
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     "sourceMap": true, /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "dist/", /* Specify an output folder for all emitted files. */
+    "outDir": "./dist", /* Specify an output folder for all emitted files. */
     "removeComments": false, /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */