@smartlyio/oats-axios-adapter 4.0.2 → 4.0.3

package/dist/index.d.ts

@@ -0,0 +1,30 @@
+import * as runtime from '@smartlyio/oats-runtime';
+import { AxiosInstance } from 'axios';
+/**
+ * @deprecated By default axios suffixes query array parameter names with "[]".
+ * This is likely to break oats request validation.
+ * See https://github.com/axios/axios/issues/2840.
+ * Use `create()` instead.
+ */
+export declare const bind: runtime.client.ClientAdapter;
+/**
+ * @deprecated By default axios suffixes query array parameter names with "[]".
+ * This is likely to break oats request validation.
+ * See https://github.com/axios/axios/issues/2840.
+ * Use `create()` instead.
+ */
+export declare function withAxios(axiosInstance: AxiosInstance): runtime.client.ClientAdapter;
+export interface AxiosAdapterOptions {
+    axiosInstance: AxiosInstance;
+    /**
+     * Whether to preserve query array param names and do not suffix them with "[]".
+     * By default axios will append "[]" suffix which is likely to break oats request validation.
+     * See https://github.com/axios/axios/issues/2840.
+     * @default true
+     */
+    preserveQueryArrayParamNames: boolean;
+}
+/**
+ * @returns oats runtime client adapter.
+ */
+export declare function create({ axiosInstance, preserveQueryArrayParamNames }?: Partial<AxiosAdapterOptions>): runtime.client.ClientAdapter;

package/dist/index.js

@@ -0,0 +1,116 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = exports.withAxios = exports.bind = void 0;
+const runtime = require("@smartlyio/oats-runtime");
+const FormData = require("form-data");
+const assert = require("assert");
+const axios_1 = require("axios");
+const utils_1 = require("./src/utils");
+function toRequestData(data) {
+    if (data == null) {
+        return data;
+    }
+    if (data.contentType === 'application/json') {
+        return axiosToJson(data.value);
+    }
+    if (['application/x-www-form-urlencoded', 'multipart/form-data'].indexOf(data.contentType) >= 0) {
+        const form = new FormData();
+        Object.keys(data.value).forEach(key => {
+            const element = data.value[key];
+            if (element instanceof runtime.make.FormBinary) {
+                form.append(key, element.binary, element.options);
+            }
+            else {
+                form.append(key, element);
+            }
+        });
+        return form;
+    }
+    assert.fail('unknown content type for axios client ' + data.contentType);
+}
+function axiosToJson(data) {
+    if (data instanceof runtime.valueClass.ValueClass) {
+        return runtime.valueClass.toJSON(data);
+    }
+    return data;
+}
+/**
+ * @deprecated By default axios suffixes query array parameter names with "[]".
+ * This is likely to break oats request validation.
+ * See https://github.com/axios/axios/issues/2840.
+ * Use `create()` instead.
+ */
+exports.bind = createAxiosAdapter({
+    axiosInstance: axios_1.default,
+    preserveQueryArrayParamNames: false
+});
+/**
+ * @deprecated By default axios suffixes query array parameter names with "[]".
+ * This is likely to break oats request validation.
+ * See https://github.com/axios/axios/issues/2840.
+ * Use `create()` instead.
+ */
+function withAxios(axiosInstance) {
+    return createAxiosAdapter({ axiosInstance, preserveQueryArrayParamNames: false });
+}
+exports.withAxios = withAxios;
+/**
+ * @returns oats runtime client adapter.
+ */
+function create({ axiosInstance = axios_1.default, preserveQueryArrayParamNames = true } = {}) {
+    return createAxiosAdapter({ axiosInstance, preserveQueryArrayParamNames });
+}
+exports.create = create;
+function createAxiosAdapter({ axiosInstance, preserveQueryArrayParamNames }) {
+    return async (arg) => {
+        var _a;
+        if (arg.servers.length !== 1) {
+            return assert.fail('cannot decide which server to use from ' + arg.servers.join(', '));
+        }
+        const server = arg.servers[0];
+        const params = axiosToJson(arg.query);
+        const data = toRequestData(arg.body);
+        const url = server + arg.path;
+        const headers = Object.assign(Object.assign({}, arg.headers), (data instanceof FormData ? data.getHeaders() : {}));
+        const response = await axiosInstance.request({
+            method: arg.method,
+            headers,
+            url,
+            params,
+            paramsSerializer: preserveQueryArrayParamNames ? utils_1.urlSearchParamsSerializer : undefined,
+            data,
+            validateStatus: () => true
+        });
+        const contentType = getContentType(response);
+        return {
+            status: response.status,
+            value: {
+                contentType,
+                value: getResponseData(contentType, response)
+            },
+            headers: (_a = response.headers) !== null && _a !== void 0 ? _a : {}
+        };
+    };
+}
+function getContentType(response) {
+    const type = response.headers['content-type'];
+    if (!type) {
+        return runtime.noContentContentType;
+    }
+    if (response.status === 204) {
+        return 'text/plain';
+    }
+    return type.split(';')[0].trim();
+}
+function getResponseData(contentType, response) {
+    if (contentType === runtime.noContentContentType) {
+        if (!response.data) {
+            return null;
+        }
+    }
+    if (response.status === 204) {
+        return '';
+    }
+    return response.data;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,mDAAmD;AACnD,sCAAsC;AACtC,iCAAiC;AACjC,iCAAkE;AAClE,uCAAwD;AAExD,SAAS,aAAa,CAAC,IAAiD;IACtE,IAAI,IAAI,IAAI,IAAI,EAAE;QAChB,OAAO,IAAI,CAAC;KACb;IACD,IAAI,IAAI,CAAC,WAAW,KAAK,kBAAkB,EAAE;QAC3C,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KAChC;IACD,IAAI,CAAC,mCAAmC,EAAE,qBAAqB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;QAC/F,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC5B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,OAAO,YAAY,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE;gBAC9C,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;aACnD;iBAAM;gBACL,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;aAC3B;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;KACb;IACD,MAAM,CAAC,IAAI,CAAC,wCAAwC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,WAAW,CAAC,IAAS;IAC5B,IAAI,IAAI,YAAY,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE;QACjD,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KACxC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACU,QAAA,IAAI,GAAiC,kBAAkB,CAAC;IACnE,aAAa,EAAE,eAAW;IAC1B,4BAA4B,EAAE,KAAK;CACpC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,aAA4B;IACpD,OAAO,kBAAkB,CAAC,EAAE,aAAa,EAAE,4BAA4B,EAAE,KAAK,EAAE,CAAC,CAAC;AACpF,CAAC;AAFD,8BAEC;AAaD;;GAEG;AACH,SAAgB,MAAM,CAAC,EACrB,aAAa,GAAG,eAAW,EAC3B,4BAA4B,GAAG,IAAI,KACH,EAAE;IAClC,OAAO,kBAAkB,CAAC,EAAE,aAAa,EAAE,4BAA4B,EAAE,CAAC,CAAC;AAC7E,CAAC;AALD,wBAKC;AAED,SAAS,kBAAkB,CAAC,EAC1B,aAAa,EACb,4BAA4B,EACR;IACpB,OAAO,KAAK,EAAC,GAAG,EAAC,EAAE;;QACjB,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,OAAO,MAAM,CAAC,IAAI,CAAC,yCAAyC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACxF;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC;QAC9B,MAAM,OAAO,mCAAQ,GAAG,CAAC,OAAO,GAAK,CAAC,IAAI,YAAY,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAE,CAAC;QAC3F,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC;YAC3C,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,OAAO;YACP,GAAG;YACH,MAAM;YACN,gBAAgB,EAAE,4BAA4B,CAAC,CAAC,CAAC,iCAAyB,CAAC,CAAC,CAAC,SAAS;YACtF,IAAI;YACJ,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI;SAC3B,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO;YACL,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,KAAK,EAAE;gBACL,WAAW;gBACX,KAAK,EAAE,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC;aAC9C;YACD,OAAO,EAAE,MAAA,QAAQ,CAAC,OAAO,mCAAI,EAAE;SAChC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,QAA4B;IAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,CAAC,IAAI,EAAE;QACT,OAAO,OAAO,CAAC,oBAAoB,CAAC;KACrC;IACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;QAC3B,OAAO,YAAY,CAAC;KACrB;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AACnC,CAAC;AAED,SAAS,eAAe,CAAC,WAAmB,EAAE,QAA4B;IACxE,IAAI,WAAW,KAAK,OAAO,CAAC,oBAAoB,EAAE;QAChD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE;YAClB,OAAO,IAAI,CAAC;SACb;KACF;IACD,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE;QAC3B,OAAO,EAAE,CAAC;KACX;IACD,OAAO,QAAQ,CAAC,IAAI,CAAC;AACvB,CAAC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Use `URLSearchParams` instead of passing raw data to axios.
+ * Otherwise axios will suffix array query parameters with "[]".
+ * @see https://github.com/axios/axios/issues/2840
+ */
+export declare function urlSearchParamsSerializer(params: unknown): string;

package/dist/src/utils.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.urlSearchParamsSerializer = void 0;
+/**
+ * Use `URLSearchParams` instead of passing raw data to axios.
+ * Otherwise axios will suffix array query parameters with "[]".
+ * @see https://github.com/axios/axios/issues/2840
+ */
+function urlSearchParamsSerializer(params) {
+    if (typeof params !== 'object') {
+        return String(params);
+    }
+    if (params === null) {
+        return '';
+    }
+    if (params instanceof URLSearchParams) {
+        return params.toString();
+    }
+    const queryParams = new URLSearchParams();
+    Object.keys(params).forEach(key => {
+        const value = params[key];
+        for (const item of [].concat(value)) {
+            queryParams.append(key, String(item));
+        }
+    });
+    return queryParams.toString();
+}
+exports.urlSearchParamsSerializer = urlSearchParamsSerializer;
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,MAAe;IACvD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QAC9B,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;KACvB;IACD,IAAI,MAAM,KAAK,IAAI,EAAE;QACnB,OAAO,EAAE,CAAC;KACX;IACD,IAAI,MAAM,YAAY,eAAe,EAAE;QACrC,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;KAC1B;IACD,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC;IAC1C,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QAChC,MAAM,KAAK,GAAI,MAAkC,CAAC,GAAG,CAAC,CAAC;QACvD,KAAK,MAAM,IAAI,IAAK,EAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;YAClD,WAAW,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SACvC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;AAChC,CAAC;AAlBD,8DAkBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartlyio/oats-axios-adapter",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "license": "MIT",
   "description": "Axios adapter for Oats a Openapi3 based generator for typescript aware servers and clients",
   "private": false,
@@ -35,7 +35,7 @@
   ],
   "devDependencies": {
     "@jest/globals": "27.4.4",
-    "@smartlyio/oats-runtime": "^4.0.2",
+    "@smartlyio/oats-runtime": "^4.0.3",
     "@types/form-data": "2.5.0",
     "@types/node": "16.11.14",
     "axios": "0.24.0",
@@ -43,5 +43,5 @@
     "ts-jest": "27.1.2",
     "typescript": "4.5.4"
   },
-  "gitHead": "140ea78c4bb8bd34c7959941d4f9d771c289c30c"
+  "gitHead": "5897af3aa6bea0c602978a10816c577a6b051c90"
 }