@ps-aux/api-client-axios 0.0.2 → 0.0.3

package/dist/AxiosOpenApiHttpClient.d.ts

@@ -1,3 +1,3 @@
 import { AxiosInstance } from 'axios';
 import { HttpClient } from './mytyp';
-export declare const createApiClient: (axios: AxiosInstance) => HttpClient;
+export declare const createApiClient: (axios: AxiosInstance, platformType: 'browser' | 'node') => HttpClient;

package/dist/convertFormData.d.ts

@@ -1 +1,2 @@
-export declare const convertToFormData: (payload: Record<string, any>) => FormData;
+import { PlatformHelper } from "./platform/types";
+export declare const convertToFormData: (payload: Record<string, any>, platform: PlatformHelper) => FormData;

package/dist/index.esm.js

@@ -1,5 +1,7 @@
 import { partition, fromPairs } from 'rambda';
 import { flatten as flatten$1 } from 'flat';
+import NodeFormData from 'form-data';
+import stream from 'stream';
 
 // Use this file also as a symlink for http-client.eta file
 const ContentType = {
@@ -41,10 +43,10 @@ const objectToParams = (obj) => {
     return res;
 };
 
-const convertToFormData = (payload) => {
-    const formData = new FormData();
+const convertToFormData = (payload, platform) => {
+    const formData = platform.newFormData();
     const addProp = (key, val) => {
-        if (Array.isArray(val) || val instanceof FileList) {
+        if (Array.isArray(val) || platform.isFileList(val)) {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore - seems that FileList is iterable despite the warning
             // TODO change to other iteration method if this is not true
@@ -54,22 +56,73 @@ const convertToFormData = (payload) => {
         }
         else if (typeof val === 'object' &&
             val != null &&
-            !(val instanceof File)) {
-            throw new Error('Object serialization into FormData not supported');
+            !platform.isFile(val)) {
+            throw new Error(`Object serialization into FormData not supported for object: ${val}`);
         }
         else {
-            formData.append(key, val);
+            if (platform.isFile(val)) {
+                const { file, name } = platform.getFileAndName(val);
+                formData.append(key, file, name);
+            }
+            else {
+                formData.append(key, val);
+            }
         }
     };
     Object.entries(payload).forEach(([key, val]) => addProp(key, val));
     return formData;
 };
 
-const createApiClient = (axios) => {
+class BrowserPlatFormHelper {
+    constructor() {
+        this.isFile = obj => obj instanceof File;
+        this.getFileAndName = (obj) => {
+            if (!(obj instanceof File))
+                throw new Error(`Obj ${obj} is not a file`);
+            return {
+                file: obj,
+                name: obj.name
+            };
+        };
+        this.isFileList = obj => obj instanceof FileList;
+        // @ts-ignore
+        this.newFormData = () => new FormData();
+    }
+}
+
+class NodePlatFormHelper {
+    constructor() {
+        this.isFile = obj => {
+            if (typeof obj !== 'object')
+                return false;
+            const { file, name } = obj;
+            return typeof name === 'string' &&
+                (Buffer.isBuffer(file)
+                    || file instanceof stream.Readable);
+        };
+        this.getFileAndName = (obj) => {
+            if (!this.isFile(obj))
+                throw new Error(`Obj ${obj} is not a file`);
+            return {
+                file: obj.file,
+                name: obj.name,
+            };
+        };
+        this.isFileList = obj => {
+            // No FileList in node?
+            return false;
+        };
+        // @ts-ignore
+        this.newFormData = () => new NodeFormData();
+    }
+}
+
+const createApiClient = (axios, platformType) => {
+    const platform = platformType === 'node' ? new NodePlatFormHelper() : new BrowserPlatFormHelper();
     return {
         request: (req) => {
             const { query, type, body } = req;
-            const data = type === ContentType.FormData ? convertToFormData(body) : body;
+            const data = type === ContentType.FormData ? convertToFormData(body, platform) : body;
             return axios
                 .request({
                 method: req.method,

package/dist/index.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('rambda'), require('flat')) :
-    typeof define === 'function' && define.amd ? define(['exports', 'rambda', 'flat'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.MyLibrary = {}, global.rambda, global.flat));
-})(this, (function (exports, rambda, flat) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('rambda'), require('flat'), require('form-data'), require('stream')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'rambda', 'flat', 'form-data', 'stream'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.MyLibrary = {}, global.rambda, global.flat, global.NodeFormData, global.stream));
+})(this, (function (exports, rambda, flat, NodeFormData, stream) { 'use strict';
 
     // Use this file also as a symlink for http-client.eta file
     const ContentType = {
@@ -44,10 +44,10 @@
         return res;
     };
 
-    const convertToFormData = (payload) => {
-        const formData = new FormData();
+    const convertToFormData = (payload, platform) => {
+        const formData = platform.newFormData();
         const addProp = (key, val) => {
-            if (Array.isArray(val) || val instanceof FileList) {
+            if (Array.isArray(val) || platform.isFileList(val)) {
                 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore - seems that FileList is iterable despite the warning
                 // TODO change to other iteration method if this is not true
@@ -57,22 +57,73 @@
             }
             else if (typeof val === 'object' &&
                 val != null &&
-                !(val instanceof File)) {
-                throw new Error('Object serialization into FormData not supported');
+                !platform.isFile(val)) {
+                throw new Error(`Object serialization into FormData not supported for object: ${val}`);
             }
             else {
-                formData.append(key, val);
+                if (platform.isFile(val)) {
+                    const { file, name } = platform.getFileAndName(val);
+                    formData.append(key, file, name);
+                }
+                else {
+                    formData.append(key, val);
+                }
             }
         };
         Object.entries(payload).forEach(([key, val]) => addProp(key, val));
         return formData;
     };
 
-    const createApiClient = (axios) => {
+    class BrowserPlatFormHelper {
+        constructor() {
+            this.isFile = obj => obj instanceof File;
+            this.getFileAndName = (obj) => {
+                if (!(obj instanceof File))
+                    throw new Error(`Obj ${obj} is not a file`);
+                return {
+                    file: obj,
+                    name: obj.name
+                };
+            };
+            this.isFileList = obj => obj instanceof FileList;
+            // @ts-ignore
+            this.newFormData = () => new FormData();
+        }
+    }
+
+    class NodePlatFormHelper {
+        constructor() {
+            this.isFile = obj => {
+                if (typeof obj !== 'object')
+                    return false;
+                const { file, name } = obj;
+                return typeof name === 'string' &&
+                    (Buffer.isBuffer(file)
+                        || file instanceof stream.Readable);
+            };
+            this.getFileAndName = (obj) => {
+                if (!this.isFile(obj))
+                    throw new Error(`Obj ${obj} is not a file`);
+                return {
+                    file: obj.file,
+                    name: obj.name,
+                };
+            };
+            this.isFileList = obj => {
+                // No FileList in node?
+                return false;
+            };
+            // @ts-ignore
+            this.newFormData = () => new NodeFormData();
+        }
+    }
+
+    const createApiClient = (axios, platformType) => {
+        const platform = platformType === 'node' ? new NodePlatFormHelper() : new BrowserPlatFormHelper();
         return {
             request: (req) => {
                 const { query, type, body } = req;
-                const data = type === ContentType.FormData ? convertToFormData(body) : body;
+                const data = type === ContentType.FormData ? convertToFormData(body, platform) : body;
                 return axios
                     .request({
                     method: req.method,

package/dist/platform/browser.d.ts

@@ -0,0 +1,10 @@
+import { PlatformHelper } from "./types";
+export declare class BrowserPlatFormHelper implements PlatformHelper {
+    isFile: (obj: any) => boolean;
+    getFileAndName: (obj: any) => {
+        file: File;
+        name: string;
+    };
+    isFileList: (obj: any) => boolean;
+    newFormData: () => any;
+}

package/dist/platform/index.d.ts

@@ -0,0 +1,2 @@
+export { BrowserPlatFormHelper } from "./browser";
+export { NodePlatFormHelper } from "./node";

package/dist/platform/node.d.ts

@@ -0,0 +1,10 @@
+import { PlatformHelper } from './types';
+export declare class NodePlatFormHelper implements PlatformHelper {
+    isFile: (obj: any) => boolean;
+    getFileAndName: (obj: any) => {
+        file: any;
+        name: any;
+    };
+    isFileList: (obj: any) => boolean;
+    newFormData: () => FormData;
+}

package/dist/platform/types.d.ts

@@ -0,0 +1,9 @@
+export type PlatformHelper = {
+    newFormData: () => FormData;
+    isFile: (obj: any) => boolean;
+    getFileAndName: (obj: any) => {
+        file: any;
+        name: string;
+    };
+    isFileList: (obj: any) => boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ps-aux/api-client-axios",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -10,13 +10,12 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@types/axios": "^0.14.0",
-    "axios": "^1.6.0",
+    "axios": "^1.5.0",
     "flat": "5.0.2",
+    "form-data": "^4.0.0",
     "rambda": "^8.5.0"
   },
   "devDependencies": {
-    "@types/axios": "^0.14.0",
     "rollup": "^4.1.4",
     "rollup-plugin-typescript2": "^0.36.0"
   }

package/src/AxiosOpenApiHttpClient.ts

@@ -1,17 +1,22 @@
-import {AxiosInstance} from 'axios'
-import {ContentType, HttpClient} from './mytyp'
-import {serializeQuery} from './serializeQuery'
-import {convertToFormData} from './convertFormData'
+import { AxiosInstance } from 'axios'
+import { ContentType, HttpClient } from './mytyp'
+import { serializeQuery } from './serializeQuery'
+import { convertToFormData } from './convertFormData'
+import { BrowserPlatFormHelper, NodePlatFormHelper } from './platform'
+import { PlatformHelper } from './platform/types'
 
 export const createApiClient = (
     axios: AxiosInstance,
+    platformType: 'browser' | 'node',
 ): HttpClient => {
+    const platform: PlatformHelper = platformType === 'node' ? new NodePlatFormHelper() : new BrowserPlatFormHelper()
     return {
         request: (req) => {
-            const {query, type, body} = req
+            const { query, type, body } = req
+
 
             const data =
-                type === ContentType.FormData ? convertToFormData(body) : body
+                type === ContentType.FormData ? convertToFormData(body, platform) : body
 
             return axios
                 .request({

package/src/convertFormData.ts

@@ -1,9 +1,11 @@
+import {PlatformHelper} from "./platform/types";
 
 
-export const convertToFormData = (payload: Record<string, any>): FormData => {
-    const formData = new FormData()
+export const convertToFormData = (payload: Record<string, any>, platform: PlatformHelper): FormData => {
+    const formData = platform.newFormData()
+
     const addProp = (key: string, val: any) => {
-        if (Array.isArray(val) || val instanceof FileList) {
+        if (Array.isArray(val) || platform.isFileList(val)) {
             // eslint-disable-next-line @typescript-eslint/ban-ts-comment
             // @ts-ignore - seems that FileList is iterable despite the warning
             // TODO change to other iteration method if this is not true
@@ -13,11 +15,16 @@ export const convertToFormData = (payload: Record<string, any>): FormData => {
         } else if (
             typeof val === 'object' &&
             val != null &&
-            !(val instanceof File)
+            !platform.isFile(val)
         ) {
-            throw new Error('Object serialization into FormData not supported')
+            throw new Error(`Object serialization into FormData not supported for object: ${val}`)
         } else {
-            formData.append(key, val)
+            if (platform.isFile(val)) {
+                const {file, name} = platform.getFileAndName(val)
+                formData.append(key, file, name)
+            } else {
+                formData.append(key, val)
+            }
         }
     }
 

package/src/platform/browser.ts

@@ -0,0 +1,22 @@
+import {PlatformHelper} from "./types";
+
+export class BrowserPlatFormHelper implements PlatformHelper {
+
+    isFile = obj =>
+        obj instanceof File
+
+    getFileAndName = (obj) => {
+        if (!(obj instanceof File))
+            throw new Error(`Obj ${obj} is not a file`)
+        return {
+            file: obj,
+            name: obj.name
+        }
+    }
+
+
+    isFileList = obj =>
+        obj instanceof FileList
+    // @ts-ignore
+    newFormData = () => new FormData()
+}

package/src/platform/index.ts

@@ -0,0 +1,3 @@
+export {BrowserPlatFormHelper} from "./browser";
+export {NodePlatFormHelper} from "./node";
+

package/src/platform/node.ts

@@ -0,0 +1,34 @@
+import { PlatformHelper } from './types'
+import NodeFormData from 'form-data'
+import stream from 'stream'
+
+export class NodePlatFormHelper implements PlatformHelper {
+
+    isFile = obj => {
+        if (typeof obj !== 'object')
+            return false
+
+        const { file, name } = obj
+
+        return typeof name === 'string' &&
+            (Buffer.isBuffer(file)
+                || file instanceof stream.Readable)
+    }
+
+    getFileAndName = (obj) => {
+        if (!this.isFile(obj))
+            throw new Error(`Obj ${obj} is not a file`)
+        return {
+            file: obj.file,
+            name: obj.name,
+        }
+    }
+
+
+    isFileList = obj => {
+        // No FileList in node?
+        return false
+    }
+    // @ts-ignore
+    newFormData = (): FormData => new NodeFormData()
+}

package/src/platform/types.ts

@@ -0,0 +1,9 @@
+export type PlatformHelper = {
+    newFormData: () => FormData
+    isFile: (obj: any) => boolean,
+    getFileAndName: (obj: any) => {
+        file: any,
+        name: string
+    }
+    isFileList: (obj: any) => boolean
+}

package/tsconfig.json

@@ -1,3 +1,9 @@
 {
+  "compilerOptions": {
+    "moduleResolution": "node"
+  },
   "extends": "../../tsconfig.json",
+  "include": [
+    "src/**/*.ts"
+  ]
 }

package/dist/api-client-axios/src/AxiosOpenApiHttpClient.d.ts

@@ -1,3 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { HttpClient } from './mytyp';
-export declare const createApiClient: (axios: AxiosInstance) => HttpClient;

package/dist/api-client-axios/src/convertFormData.d.ts

@@ -1 +0,0 @@
-export declare const convertToFormData: (payload: Record<string, any>) => FormData;

package/dist/api-client-axios/src/index.d.ts

@@ -1 +0,0 @@
-export { createApiClient } from './AxiosOpenApiHttpClient';

package/dist/api-client-axios/src/mytyp.d.ts

@@ -1,21 +0,0 @@
-export type ContentType = {};
-export type RequestParams = {
-    fileDownload?: boolean;
-};
-export declare const ContentType: {
-    Json: string;
-    FormData: string;
-};
-export type Request = {
-    path: string;
-    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
-    format?: 'json';
-    query?: any;
-    body?: any;
-    type?: string;
-    secure?: boolean;
-    fileDownload?: boolean;
-};
-export type HttpClient<Any = any> = {
-    request: <Data, A = any>(req: Request) => Promise<Data>;
-};

package/dist/api-client-axios/src/serializeQuery.d.ts

@@ -1 +0,0 @@
-export declare const serializeQuery: (obj: object) => string;

package/dist/is-even/index.d.ts

@@ -1 +0,0 @@
-export declare const isEven: (x: number) => boolean;

package/dist/tests/foo.test.d.ts

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

package/dist/tests/go.d.ts

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