@trayio/axios 0.0.1-beta

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Tray.io, Inc
+
+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/dist/http/AxiosHttpClient.d.ts

@@ -0,0 +1,14 @@
+import * as TE from 'fp-ts/TaskEither';
+import { HttpClient } from '@trayio/commons/http/HttpClient';
+import { HttpMethod, HttpRequest, HttpResponse } from '@trayio/commons/http/Http';
+import FormData = require('form-data');
+import { FileStorage } from '@trayio/commons/file/File';
+export declare class AxiosHttpClient implements HttpClient {
+    private readonly fileStorage;
+    constructor(fileStorage?: FileStorage);
+    execute(method: HttpMethod, url: string, request: HttpRequest): TE.TaskEither<Error, HttpResponse>;
+    private axiosErrorToHttpResponse;
+    private axiosResponseToHttpResponse;
+    appendFields: (formData: FormData) => (fields: Record<string, string>) => FormData;
+}
+//# sourceMappingURL=AxiosHttpClient.d.ts.map

package/dist/http/AxiosHttpClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosHttpClient.d.ts","sourceRoot":"","sources":["../../src/http/AxiosHttpClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAEN,UAAU,EACV,WAAW,EAEX,YAAY,EAEZ,MAAM,2BAA2B,CAAC;AAGnC,OAAO,QAAQ,GAAG,QAAQ,WAAW,CAAC,CAAC;AACvC,OAAO,EAAQ,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAK9D,qBAAa,eAAgB,YAAW,UAAU;IAEhD,OAAO,CAAC,QAAQ,CAAC,WAAW;gBAAX,WAAW,GAAE,WAAqC;IAGpE,OAAO,CACN,MAAM,EAAE,UAAU,EAClB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,GAClB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC;IAkFrC,OAAO,CAAC,wBAAwB;IAchC,OAAO,CAAC,2BAA2B;IAUnC,YAAY,aAAc,QAAQ,cAAc,OAAO,MAAM,EAAE,MAAM,CAAC,cAKpE;CACF"}

package/dist/http/AxiosHttpClient.js

@@ -0,0 +1,96 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxiosHttpClient = void 0;
+const Http_1 = require("@trayio/commons/http/Http");
+const Task_1 = require("@trayio/commons/task/Task");
+const axios_1 = __importDefault(require("axios"));
+const FormData = require("form-data");
+const NodeFsFileStorage_1 = require("@trayio/commons/file/NodeFsFileStorage");
+const BufferExtensions_1 = require("@trayio/commons/buffer/BufferExtensions");
+class AxiosHttpClient {
+    constructor(fileStorage = new NodeFsFileStorage_1.NodeFsFileStorage()) {
+        this.fileStorage = fileStorage;
+        this.appendFields = (formData) => (fields) => {
+            Object.entries(fields).forEach(([key, value]) => {
+                formData.append(key, value);
+            });
+            return formData;
+        };
+    }
+    execute(method, url, request) {
+        /*
+          Removes default headers so that we control what we send to the server, without this, it sends default content-type and accept headers,
+          the caller of this HttpClient interface is responsible of deciding the values of these headers, axios shouldn't try to be smart
+          and derive these from the body or even set defaults.
+        */
+        axios_1.default.defaults.headers.common = {};
+        axios_1.default.defaults.headers.get = {};
+        axios_1.default.defaults.headers.post = {};
+        axios_1.default.defaults.headers.put = {};
+        axios_1.default.defaults.headers.patch = {};
+        axios_1.default.defaults.headers.delete = {};
+        const finalUrl = Object.entries(request.pathParams).reduce((acc, [key, value]) => acc.replace(`:${key}`, encodeURIComponent(value)), url);
+        const headers = Object.entries(request.headers).reduce((acc, [key, value]) => {
+            const newValue = typeof value === 'string' ? value : value.join(', ');
+            return Object.assign(Object.assign({}, acc), { [key.toLowerCase()]: newValue });
+        }, {});
+        let axiosConfig;
+        if (headers['content-type'] &&
+            headers['content-type'].includes(Http_1.HttpContentType.MultipartRequestBody)) {
+            const formData = new FormData();
+            this.appendFields(formData)(request.body.fields);
+            const { files } = request.body;
+            Object.keys(files).forEach((key) => {
+                var _a;
+                const file = files[key];
+                formData.append(key, file.content, {
+                    filename: (_a = file.metadata.name) !== null && _a !== void 0 ? _a : file.key,
+                    contentType: file.metadata.contentType,
+                });
+            });
+            axiosConfig = {
+                url: finalUrl,
+                method: method.toString(),
+                data: formData,
+                responseType: 'stream',
+                headers,
+                params: request.queryString,
+            };
+            return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => (0, axios_1.default)(axiosConfig)
+                .then(this.axiosResponseToHttpResponse)
+                .catch(this.axiosErrorToHttpResponse.bind(this)));
+        }
+        axiosConfig = {
+            url: finalUrl,
+            method: method.toString(),
+            data: request.body,
+            responseType: 'stream',
+            headers,
+            params: request.queryString,
+        };
+        return (0, Task_1.createTaskEitherFromPromiseWithSimpleError)(() => (0, axios_1.default)(axiosConfig)
+            .then(this.axiosResponseToHttpResponse)
+            .catch(this.axiosErrorToHttpResponse.bind(this)));
+    }
+    axiosErrorToHttpResponse(axiosError) {
+        if (axiosError.response !== undefined) {
+            return this.axiosResponseToHttpResponse(axiosError.response);
+        }
+        return {
+            headers: {},
+            statusCode: 500,
+            body: BufferExtensions_1.BufferExtensions.arrayBufferToReadable(new ArrayBuffer(0)),
+        };
+    }
+    axiosResponseToHttpResponse(axiosResponse) {
+        return {
+            headers: axiosResponse.headers,
+            statusCode: axiosResponse.status,
+            body: axiosResponse.data,
+        };
+    }
+}
+exports.AxiosHttpClient = AxiosHttpClient;

package/dist/http/AxiosHttpClient.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AxiosHttpClient.unit.test.d.ts.map

package/dist/http/AxiosHttpClient.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AxiosHttpClient.unit.test.d.ts","sourceRoot":"","sources":["../../src/http/AxiosHttpClient.unit.test.ts"],"names":[],"mappings":""}

package/dist/http/AxiosHttpClient.unit.test.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const HttpClient_abstract_test_1 = require("@trayio/commons/http/HttpClient.abstract.test");
+const AxiosHttpClient_1 = require("./AxiosHttpClient");
+describe('AxiosHttpClient Tests', () => {
+    (0, HttpClient_abstract_test_1.httpClientTest)(new AxiosHttpClient_1.AxiosHttpClient());
+});

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@trayio/axios",
+  "version": "0.0.1-beta",
+  "description": "Axios extensions and implementations",
+  "exports": {
+    "./*": "./dist/*.js"
+  },
+  "author": "Tray.io",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.x"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@trayio/commons": "0.0.1-beta",
+    "axios": "1.6.0",
+    "form-data": "4.0.0"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/*"
+      ]
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "stableVersion": "2.15.0"
+}