@ps-aux/api-client-axios 0.0.9-rc-7 → 0.0.9-rc-9

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ps-aux/api-client-axios",
-  "version": "0.0.9-rc-7",
+  "version": "0.0.9-rc-9",
   "main": "dist/node.js",
   "module": "dist/node.esm.js",
   "browser": "dist/browser.esm.js",
-  "types": "dist/api-client-axios/src/node.d.ts",
+  "types": "dist/node.d.ts",
   "scripts": {
     "build": "rollup -c",
     "pub": "npm run build && npm --access public publish",

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

@@ -1,7 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { HttpClient } from './t';
-import { PlatformHelper } from './platform/types';
-import { UrlConverter } from '@ps-aux/api-client-common/src';
-export declare const noOpUrlConverter: () => UrlConverter;
-export declare const springBootUrlConverter: () => UrlConverter;
-export declare const createHttpClient: (axios: AxiosInstance, platform: PlatformHelper, urlConverter?: UrlConverter) => HttpClient;

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

@@ -1,4 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { HttpClient } from './t';
-export declare const createHttpClient: (axios: AxiosInstance, urlConverter?: import("@ps-aux/api-client-common/src").UrlConverter) => HttpClient;
-export * from './commonExports';

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

@@ -1,3 +0,0 @@
-export { UrlConverter } from '@ps-aux/api-client-common';
-export { HttpClient, Request, RequestParams } from './t';
-export { springBootUrlConverter, noOpUrlConverter } from './AxiosOpenApiHttpClient';

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

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

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

@@ -1,4 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { HttpClient } from './t';
-export declare const createHttpClient: (axios: AxiosInstance, urlConverter?: import("@ps-aux/api-client-common/src").UrlConverter) => HttpClient;
-export * from './commonExports';

package/dist/api-client-axios/src/platform/browser.d.ts

@@ -1,10 +0,0 @@
-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: () => FormData;
-}

package/dist/api-client-axios/src/platform/foo.d.ts

@@ -1 +0,0 @@
-export { BrowserPlatFormHelper as Platform } from './browser';

package/dist/api-client-axios/src/platform/node.d.ts

@@ -1,10 +0,0 @@
-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/api-client-axios/src/platform/types.d.ts

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

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

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

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

@@ -1,9 +0,0 @@
-export { serializeQueryForSpringBoot } from './serializeQueryForSpringBoot';
-export { serializeQueryWithQs } from './serializeQueryWithQs';
-export type UrlConverter = (req: {
-    path: string;
-    query?: Record<string, unknown>;
-}) => {
-    url: string;
-    params?: any;
-};

package/dist/api-client-common/src/serializeQueryForSpringBoot.d.ts

@@ -1,5 +0,0 @@
-/**
- *  Brings the 1st level to the 0th level.
- *  Flats the object by nesting with '.' path separator.
- */
-export declare const serializeQueryForSpringBoot: (obj: object) => string;

package/dist/api-client-common/src/serializeQueryWithQs.d.ts

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

package/src/AxiosOpenApiHttpClient.ts

@@ -1,78 +0,0 @@
-import { AxiosInstance } from 'axios'
-import { convertToFormData } from './convertFormData'
-import { PlatformHelper } from './platform/types'
-import {
-    serializeQueryForSpringBoot,
-    UrlConverter,
-    PromiseHttpClient,
-    ContentType,
-    getFileNameFromContentDispositionHeader,
-} from '@ps-aux/api-client-common'
-
-
-export const noOpUrlConverter: () => UrlConverter = () => ({ query, path }) => {
-    return {
-        url: path,
-        params: query,
-    }
-}
-
-export const springBootUrlConverter: () => UrlConverter = () => ({ query, path }) => {
-
-    return {
-        url: path + (query ? `?${serializeQueryForSpringBoot(query)}` : ''),
-        params: undefined,
-    }
-}
-
-
-export const createHttpClient = (
-    axios: AxiosInstance,
-    platform: PlatformHelper,
-    urlConverter: UrlConverter = noOpUrlConverter(),
-): PromiseHttpClient => {
-
-    return {
-        request: (req) => {
-            const { query, type, body } = req
-
-            const isBlobResponse = req.format === 'document'
-
-            const data =
-                type === ContentType.FormData ? convertToFormData(body, platform) : body
-
-            const headers: Record<string, string> = {}
-            if (type) {
-                headers['Content-Type'] = type
-            }
-            return axios
-                .request({
-                    method: req.method,
-                    // url: req.path + (query ? `?${serializeQueryForNestJs(query)}` : ''),
-                    // params: req.query, // TODO make this customizable as different behaviour might be needed with different APIs
-                    // url: req.path,
-                    ...urlConverter(req),
-                    data,
-                    headers,
-                    responseType: isBlobResponse ? platform.getFileAxiosResponseType() : 'json',
-                })
-                .then(r => {
-                    const { data } = r
-                    if (isBlobResponse) {
-                        const contDist = r.headers['content-disposition']
-                        const fileName = getFileNameFromContentDispositionHeader(contDist)
-
-                        const type = r.headers['content-type']
-
-                        return new File([data as Blob], fileName, {
-                            type,
-                        })
-                    }
-
-                    return data
-                })
-        },
-    }
-}
-
-

package/src/browser.ts

@@ -1,11 +0,0 @@
-import { AxiosInstance } from 'axios'
-import { createHttpClient as create, noOpUrlConverter } from './AxiosOpenApiHttpClient'
-import { BrowserPlatFormHelper } from './platform/browser'
-import { PromiseHttpClient, UrlConverter } from './commonExports'
-
-
-export const createHttpClient = (axios: AxiosInstance, urlConverter: UrlConverter = noOpUrlConverter()): PromiseHttpClient => {
-    return create(axios, new BrowserPlatFormHelper(), urlConverter)
-}
-
-export * from './commonExports'

package/src/commonExports.ts

@@ -1,2 +0,0 @@
-export { UrlConverter, PromiseHttpClient, ContentType } from '@ps-aux/api-client-common'
-export { springBootUrlConverter, noOpUrlConverter } from './AxiosOpenApiHttpClient'

package/src/convertFormData.ts

@@ -1,33 +0,0 @@
-import {PlatformHelper} from "./platform/types";
-
-
-export const convertToFormData = (payload: Record<string, any>, platform: PlatformHelper): FormData => {
-    const formData = platform.newFormData()
-
-    const addProp = (key: string, val: any) => {
-        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
-            for (const valItem of val) {
-                addProp(key, valItem)
-            }
-        } else if (
-            typeof val === 'object' &&
-            val != null &&
-            !platform.isFile(val)
-        ) {
-            throw new Error(`Object serialization into FormData not supported for object: ${val}`)
-        } else {
-            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
-}

package/src/node.ts

@@ -1,10 +0,0 @@
-import { AxiosInstance } from 'axios'
-import { createHttpClient as create, noOpUrlConverter } from './AxiosOpenApiHttpClient'
-import { NodePlatFormHelper } from './platform/node'
-import { PromiseHttpClient, UrlConverter } from './commonExports'
-
-export const createHttpClient = (axios: AxiosInstance, urlConverter: UrlConverter = noOpUrlConverter()): PromiseHttpClient => {
-    return create(axios, new NodePlatFormHelper(), urlConverter)
-}
-
-export * from './commonExports'

package/src/platform/browser.ts

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

package/src/platform/node.ts

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

package/src/platform/types.ts

@@ -1,11 +0,0 @@
-export type PlatformHelper = {
-    newFormData: () => FormData
-    isFile: (obj: any) => boolean,
-    getFileAndName: (obj: any) => {
-        file: any,
-        name: string
-    }
-    isFileList: (obj: any) => boolean
-
-    getFileAxiosResponseType: () => 'blob' | 'arraybuffer'
-}

package/test/my.spec.ts

@@ -1,22 +0,0 @@
-import { AxiosApi } from '@ps-aux/api-client-api-testing/apis/axios/client'
-import Axios from 'axios'
-import { createHttpClient } from '../src/AxiosOpenApiHttpClient'
-import { NodePlatFormHelper } from '../src/platform/node'
-import { createHttpServer, MirroredReqRes } from '../../helpers/http-server'
-
-const Api = (url: string) =>
-    new AxiosApi(createHttpClient(Axios.create({ baseURL: url }), new NodePlatFormHelper()))
-
-it('test', async () => {
-
-    const server = createHttpServer()
-    const { url } = await server.start()
-    const api = Api(url)
-
-    try {
-        await api.app.getHello({ name: 'world' })
-        expect(server.lastRequest().url).toBe('/api/hello?name=world')
-    } finally {
-        await server.stop()
-    }
-})