Adds Axios as http client (#362)

checkout · Oct 27, 2023 · 9927c57 · 9927c57
1 parent ca24797
commit 9927c57
Show file tree

Hide file tree

Showing 113 changed files with 13,773 additions and 13,589 deletions.
diff --git a/README.md b/README.md
@@ -67,7 +67,8 @@ const cko = new Checkout('...', {
     ..., //other authentication config
     host: "https://myProxyExample.com", // in case you need to use a custom host for tests
     timeout: 60000,   // HTTP request timout in ms
-    agent: new http.Agent({ keepAlive: true }) // custom HTTP agent
+    agent: new http.Agent({ keepAlive: true }), // custom HTTP agent
+    httpClient: 'axios' // specify axios httpClient, by default fetch. Optional
 });
 ```
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,58 +1,61 @@
 {
-    "name": "checkout-sdk-node",
-    "version": "2.2.5",
-    "description": "",
-    "main": "./dist/index.js",
-    "devDependencies": {
-        "@babel/cli": "^7.16.8",
-        "@babel/core": "^7.16.7",
-        "@babel/eslint-parser": "^7.16.5",
-        "@babel/eslint-plugin": "^7.16.5",
-        "@babel/node": "^7.16.8",
-        "@babel/preset-env": "^7.16.8",
-        "chai": "^4.3.4",
-        "codecov": "^3.8.2",
-        "eslint": "^8.34.0",
-        "eslint-config-airbnb": "^19.0.4",
-        "eslint-config-prettier": "^8.3.0",
-        "eslint-plugin-chai-friendly": "^0.7.1",
-        "eslint-plugin-import": "^2.22.1",
-        "eslint-plugin-prettier": "^3.4.0",
-        "esm": "^3.2.25",
-        "mocha": "^8.4.0",
-        "mocha-junit-reporter": "^2.0.0",
-        "nock": "^13.0.11",
-        "nyc": "^15.1.0",
-        "prettier": "^2.1.2",
-        "uuid": "^8.3.2"
-    },
-    "runkitExampleFilename": "example.js",
-    "scripts": {
-        "start": "nodemon --exec babel-node ./src/index.js",
-        "lint": "eslint --fix --ext .js src/",
-        "test": "nyc --reporter=html mocha --timeout 300000 'test/**/*.js' --require esm",
-        "posttest": "nyc report --reporter=json",
-        "test:watch": "mocha --timeout 300000  'test/**/*.js' --watch --require esm",
-        "build": "babel src --out-dir ./dist --source-maps",
-        "codecov": "codecov -f coverage/*.json",
-        "tsc": "tsc"
-    },
-    "dependencies": {
-        "form-data": "^4.0.0",
-        "node-fetch": "^2.6.12"
-    },
-    "babel": {
-        "presets": [
-            [
-                "@babel/preset-env",
-                {
-                    "targets": {
-                        "node": 6
-                    }
-                }
-            ]
-        ]
-    },
-    "author": "Ioan Ghisoi",
-    "license": "MIT"
+  "name": "checkout-sdk-node",
+  "version": "2.2.5",
+  "description": "",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@babel/cli": "^7.16.8",
+    "@babel/core": "^7.16.7",
+    "@babel/eslint-parser": "^7.16.5",
+    "@babel/eslint-plugin": "^7.16.5",
+    "@babel/node": "^7.16.8",
+    "@babel/preset-env": "^7.16.8",
+    "chai": "^4.3.4",
+    "codecov": "^3.8.2",
+    "eslint": "^8.34.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-chai-friendly": "^0.7.1",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-prettier": "^3.4.0",
+    "esm": "^3.2.25",
+    "mocha": "^8.4.0",
+    "mocha-junit-reporter": "^2.0.0",
+    "nock": "^13.0.11",
+    "nyc": "^15.1.0",
+    "prettier": "^2.1.2",
+    "uuid": "^8.3.2"
+  },
+  "runkitExampleFilename": "example.js",
+  "scripts": {
+    "start": "nodemon --exec babel-node ./src/index.js",
+    "lint": "eslint --fix --ext .js src/",
+    "test": "nyc --reporter=html mocha --timeout 300000 'test/**/*.js' --require esm",
+    "posttest": "nyc report --reporter=json",
+    "test:watch": "mocha --timeout 300000  'test/**/*.js' --watch --require esm",
+    "build": "babel src --out-dir ./dist --source-maps",
+    "codecov": "codecov -f coverage/*.json",
+    "tsc": "tsc"
+  },
+  "dependencies": {
+    "axios": "^0.27.2",
+    "form-data": "^4.0.0",
+    "node-fetch": "^2.6.12"
+  },
+  "babel": {
+    "presets": [
+      [
+        "@babel/preset-env",
+        {
+          "targets": {
+            "node": 6
+          }
+        }
+      ]
+    ]
+  },
+  "author": "Ioan Ghisoi",
+  "license": "MIT"
 }
diff --git a/src/Checkout.js b/src/Checkout.js
@@ -120,7 +120,7 @@ export default class Checkout {
         } else {
             // For MBC or NAS with static keys with declared vars
             auth = {
-                sk: determineSecretKey(key, options),
+                sk: determineSecretKey(key),
                 pk: determinePublicKey(options),
                 host: determineHost(determineSecretKey(key), options),
             };
@@ -132,6 +132,7 @@ export default class Checkout {
             agent: options && options.agent ? options.agent : undefined,
             headers: options && options.headers ? options.headers : {},
             access: undefined,
+            httpClient: options && options.httpClient ? options.httpClient : undefined,
         };
 
         this.payments = new ENDPOINTS.Payments(this.config);
@@ -170,4 +171,4 @@ export default class Checkout {
         this.financial = new ENDPOINTS.Financial(this.config);
         this.issuing = new ENDPOINTS.Issuing(this.config);
     }
-}
+}
diff --git a/src/api/access/access.js b/src/api/access/access.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { createAccessToken } from '../../services/http';
 
@@ -21,7 +20,11 @@ export default class Access {
      */
     async request(body) {
         try {
-            const response = await createAccessToken(this.config, fetch, body);
+            const response = await createAccessToken(
+                this.config,
+                this.config.httpClient,
+                body
+            );
             return await response.json;
         } catch (err) {
             const error = await determineError(err);

diff --git a/src/api/apm-specific/baloto.js b/src/api/apm-specific/baloto.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { post } from '../../services/http';
 
@@ -25,7 +24,7 @@ export default class Baloto {
     async succeed(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/baloto/payments/${id}/succeed`,
                 this.config,
                 this.config.sk
@@ -48,7 +47,7 @@ export default class Baloto {
     async expire(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/baloto/payments/${id}/expire`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/boleto.js b/src/api/apm-specific/boleto.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { post } from '../../services/http';
 
@@ -25,7 +24,7 @@ export default class Boleto {
     async succeed(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/boleto/payments/${id}/succeed`,
                 this.config,
                 this.config.sk
@@ -48,7 +47,7 @@ export default class Boleto {
     async expire(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/boleto/payments/${id}/expire`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/fawry.js b/src/api/apm-specific/fawry.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { put } from '../../services/http';
 
@@ -26,7 +25,7 @@ export default class Fawry {
     async approve(reference) {
         try {
             const response = await put(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/fawry/payments/${reference}/approval`,
                 this.config,
                 this.config.sk
@@ -49,7 +48,7 @@ export default class Fawry {
     async cancel(reference) {
         try {
             const response = await put(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/fawry/payments/${reference}/cancellation`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/giropay.js b/src/api/apm-specific/giropay.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { get } from '../../services/http';
 
@@ -24,7 +23,7 @@ export default class Giropay {
     async getEpsBanks() {
         try {
             const response = await get(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/giropay/eps/banks`,
                 this.config,
                 this.config.sk
@@ -46,7 +45,7 @@ export default class Giropay {
     async getBanks() {
         try {
             const response = await get(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/giropay/banks`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/ideal.js b/src/api/apm-specific/ideal.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { get } from '../../services/http';
 
@@ -22,7 +21,7 @@ export default class Ideal {
     async get() {
         try {
             const response = await get(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/ideal-external`,
                 this.config,
                 this.config.sk
@@ -43,7 +42,7 @@ export default class Ideal {
     async getIssuers() {
         try {
             const response = await get(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/ideal-external/issuers`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/klarna.js b/src/api/apm-specific/klarna.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { get, post } from '../../services/http';
 
@@ -24,7 +23,13 @@ export default class Klarna {
             ? `${this.config.host}/klarna-external/credit-sessions`
             : `${this.config.host}/klarna/credit-sessions`;
         try {
-            const response = await post(fetch, url, this.config, this.config.sk, body);
+            const response = await post(
+                this.config.httpClient,
+                url,
+                this.config,
+                this.config.sk,
+                body
+            );
             return await response.json;
         } catch (err) {
             const error = await determineError(err);
@@ -43,7 +48,12 @@ export default class Klarna {
             ? `${this.config.host}/klarna-external/credit-sessions/${id}`
             : `${this.config.host}/klarna/credit-sessions/${id}`;
         try {
-            const response = await get(fetch, url, this.config, this.config.sk);
+            const response = await get(
+                this.config.httpClient, 
+                url, 
+                this.config, 
+                this.config.sk
+            );
             return await response.json;
         } catch (err) {
             const error = await determineError(err);
@@ -63,7 +73,13 @@ export default class Klarna {
             ? `${this.config.host}/klarna-external/orders/${id}/captures`
             : `${this.config.host}/klarna/orders/${id}/captures`;
         try {
-            const response = await post(fetch, url, this.config, this.config.sk, body);
+            const response = await post(
+                this.config.httpClient, 
+                url, 
+                this.config, 
+                this.config.sk, 
+                body
+            );
             return await response.json;
         } catch (err) {
             const error = await determineError(err);
@@ -83,7 +99,13 @@ export default class Klarna {
             ? `${this.config.host}/klarna-external/orders/${id}/voids`
             : `${this.config.host}/klarna/orders/${id}/voids`;
         try {
-            const response = await post(fetch, url, this.config, this.config.sk, body);
+            const response = await post(
+                this.config.httpClient, 
+                url, 
+                this.config, 
+                this.config.sk, 
+                body
+            );
             return await response.json;
         } catch (err) {
             const error = await determineError(err);

diff --git a/src/api/apm-specific/oxxo.js b/src/api/apm-specific/oxxo.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { post } from '../../services/http';
 
@@ -25,7 +24,7 @@ export default class Oxxo {
     async succeed(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/oxxo/payments/${id}/succeed`,
                 this.config,
                 this.config.sk
@@ -48,7 +47,7 @@ export default class Oxxo {
     async expire(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/oxxo/payments/${id}/expire`,
                 this.config,
                 this.config.sk

diff --git a/src/api/apm-specific/pagofacil.js b/src/api/apm-specific/pagofacil.js
@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import { determineError } from '../../services/errors';
 import { post } from '../../services/http';
 
@@ -25,7 +24,7 @@ export default class PagoFacil {
     async succeed(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/pagofacil/payments/${id}/succeed`,
                 this.config,
                 this.config.sk
@@ -48,7 +47,7 @@ export default class PagoFacil {
     async expire(id) {
         try {
             const response = await post(
-                fetch,
+                this.config.httpClient,
                 `${this.config.host}/apms/pagofacil/payments/${id}/expire`,
                 this.config,
                 this.config.sk