api-def 0.6.0-alpha1 → 0.6.0-alpha12

package/cjs/ApiTypes.d.ts

@@ -4,7 +4,7 @@ import { CacheSource, EventResultType, RequestEvent, RequestMethod, ResponseType
 export declare type AcceptableStatus = number | [min: number, max: number];
 export declare type Headers = Record<string, string | number | boolean | null | undefined>;
 export declare type Params = string;
-export declare type Query = Record<string, string | number | boolean | undefined | null>;
+export declare type Query = Record<string, any>;
 export declare type Body = string | number | Record<string, any>;
 export interface ApiResponse<T = any> {
     status: number;
@@ -17,6 +17,7 @@ export interface BaseRequestConfig {
     retry?: number | false;
     headers?: Readonly<Headers>;
     acceptableStatus?: AcceptableStatus[];
+    queryParser?: (query: any) => string;
 }
 export declare type RequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (P extends undefined ? {
     params?: never;

package/cjs/ApiUtils.d.ts

@@ -1,7 +1,6 @@
-import { AcceptableStatus, ApiResponse, CancelledRequestError } from "./ApiTypes";
+import { AcceptableStatus, CancelledRequestError } from "./ApiTypes";
 import { ResponseType } from "./ApiConstants";
 export declare const isCancelledError: (error: Error) => error is CancelledRequestError;
 export declare const isNetworkError: (error: Error) => boolean;
-export declare const parseResponseDataToObject: (response: ApiResponse) => void;
 export declare const isAcceptableStatus: (status: number, acceptableStatus?: AcceptableStatus[] | undefined) => boolean;
 export declare const inferResponseType: (contentType: string | null | undefined) => ResponseType;

package/cjs/ApiUtils.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.inferResponseType = exports.isAcceptableStatus = exports.parseResponseDataToObject = exports.isNetworkError = exports.isCancelledError = void 0;
-var TextDecoding_1 = require("./TextDecoding");
+exports.inferResponseType = exports.isAcceptableStatus = exports.isNetworkError = exports.isCancelledError = void 0;
 var isCancelledError = function (error) {
     return "isCancelledRequest" in error;
 };
@@ -13,22 +12,6 @@ var isNetworkError = function (error) {
         ((_a = error.constructor) === null || _a === void 0 ? void 0 : _a.name) === "NetworkError");
 };
 exports.isNetworkError = isNetworkError;
-var parseResponseDataToObject = function (response) {
-    if (response.data &&
-        typeof response.data === "object") {
-        var data = response.data;
-        if (data.constructor && data.constructor.name === "ArrayBuffer") {
-            try {
-                var decodedData = (response.data = TextDecoding_1.textDecode(data));
-                response.data = JSON.parse(decodedData);
-            }
-            catch (e) {
-                console.warn("Couldn't parse array buffer content to JSON response", e);
-            }
-        }
-    }
-};
-exports.parseResponseDataToObject = parseResponseDataToObject;
 var DEFAULT_ACCEPTABLE_STATUS = [[200, 299], 304];
 var isAcceptableStatus = function (status, acceptableStatus) {
     var acceptable = acceptableStatus !== null && acceptableStatus !== void 0 ? acceptableStatus : DEFAULT_ACCEPTABLE_STATUS;
@@ -49,11 +32,21 @@ var isAcceptableStatus = function (status, acceptableStatus) {
     return (false);
 };
 exports.isAcceptableStatus = isAcceptableStatus;
+var TEXT_CONTENT_TYPES = ["text/plain"];
 var JSON_CONTENT_TYPES = ["text/json", "application/json"];
+var ARRRAY_BUFFER_CONTENT_TYPES = ["application/octet-stream"];
 var inferResponseType = function (contentType) {
     var contentTypePart = contentType === null || contentType === void 0 ? void 0 : contentType.split(";")[0].trim();
-    if (contentTypePart && JSON_CONTENT_TYPES.includes(contentTypePart)) {
-        return "json";
+    if (contentTypePart) {
+        if (TEXT_CONTENT_TYPES.includes(contentTypePart)) {
+            return "text";
+        }
+        else if (JSON_CONTENT_TYPES.includes(contentTypePart)) {
+            return "json";
+        }
+        else if (ARRRAY_BUFFER_CONTENT_TYPES.includes(contentTypePart)) {
+            return "arraybuffer";
+        }
     }
     return "text";
 };

package/cjs/Requester.js

@@ -56,11 +56,12 @@ var ApiConstants_1 = require("./ApiConstants");
 var retry_1 = require("./util/retry");
 var MockRequestBackend_1 = require("./backend/MockRequestBackend");
 var RequestError_1 = require("./RequestError");
+var TextDecoding_1 = require("./TextDecoding");
 var locks = {};
 var runningOperations = {};
 var MOCK_REQUEST_BACKEND = new MockRequestBackend_1.default();
 var submit = function (host, config, mocking) { return __awaiter(void 0, void 0, void 0, function () {
-    var computedConfig, backend, context, key, sameRequest, lock, lockedContext, response, successEventResult, error_1;
+    var computedConfig, backend, context, key, lock, lockedContext, response, successEventResult, error_1;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
@@ -71,10 +72,6 @@ var submit = function (host, config, mocking) { return __awaiter(void 0, void 0,
                 }
                 context = new RequestContext_1.default(backend, host, computedConfig, host.computePath(host.path, config), mocking);
                 key = context.key;
-                sameRequest = runningOperations[key];
-                if (sameRequest) {
-                    return [2 /*return*/, sameRequest];
-                }
                 lock = (context.computedConfig || {}).lock;
                 if (lock) {
                     lockedContext = locks[lock];
@@ -122,6 +119,7 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                 if (process.env.NODE_ENV === "development") {
                     if (Api.isRequestBackendDefault() && !defaultBackendMessageShown) {
                         defaultBackendMessageShown = true;
+                        // eslint-disable-next-line
                         console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
                     }
                 }
@@ -177,10 +175,6 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                                 error = _b.sent();
                                 context.error = error;
                                 context.response = error.response;
-                                // transform array buffer responses to objs
-                                if (context.response) {
-                                    ApiUtils.parseResponseDataToObject(context.response);
-                                }
                                 return [4 /*yield*/, context.triggerEvent(ApiConstants_1.RequestEvent.Error)];
                             case 6:
                                 errorEventResult = _b.sent();
@@ -217,16 +211,46 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 var parseResponse = function (context, response, error) { return __awaiter(void 0, void 0, void 0, function () {
-    var parsedResponse;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
+    var parsedResponse, contentType, inferredResponseType, data, decodedData;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
                 if (!response) return [3 /*break*/, 2];
-                return [4 /*yield*/, context.backend.convertResponse(context, response, error)];
+                return [4 /*yield*/, context.backend.convertResponse(context, response)];
             case 1:
-                parsedResponse = _a.sent();
-                if (parsedResponse) {
-                    ApiUtils.parseResponseDataToObject(parsedResponse);
+                parsedResponse = _b.sent();
+                contentType = response.headers["Content-Type"];
+                inferredResponseType = ApiUtils_1.inferResponseType(contentType);
+                if (!error) {
+                    // expand to array buffer once we support that in inferResponseType
+                    if (inferredResponseType === "text" && context.responseType === "json") {
+                        throw RequestError_1.convertToRequestError({
+                            error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
+                            code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                            response: parsedResponse,
+                        });
+                    }
+                    // transform arrayBuffer to json
+                    if (inferredResponseType === "arraybuffer" && context.responseType === "json") {
+                        if (parsedResponse.data &&
+                            typeof parsedResponse.data === "object") {
+                            data = response.data;
+                            if (((_a = data.constructor) === null || _a === void 0 ? void 0 : _a.name) === "ArrayBuffer") {
+                                try {
+                                    decodedData = (response.data = TextDecoding_1.textDecode(data));
+                                    response.data = JSON.parse(decodedData);
+                                }
+                                catch (e) {
+                                    throw RequestError_1.convertToRequestError({
+                                        error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
+                                        code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                                        response: parsedResponse,
+                                    });
+                                }
+                            }
+                        }
+                    }
                 }
                 return [2 /*return*/, parsedResponse];
             case 2: return [2 /*return*/, response];

package/cjs/UtilTypes.d.ts

@@ -0,0 +1,5 @@
+import Endpoint from "./Endpoint";
+export declare type ResponseOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<infer R, any, any, any> ? R : never;
+export declare type ParamsOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, infer P, any, any> ? P : never;
+export declare type QueryOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, any, infer Q, any> ? Q : never;
+export declare type BodyOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, any, any, infer B> ? B : never;

package/cjs/UtilTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/backend/AxiosRequestBackend.js

@@ -37,8 +37,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isAxiosError = void 0;
-var ApiUtils_1 = require("../ApiUtils");
-var RequestError_1 = require("../RequestError");
 var axios;
 var isAxiosError = function (error) {
     return "isAxiosError" in error;
@@ -62,16 +60,7 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var inferredResponseType;
             return __generator(this, function (_a) {
-                inferredResponseType = ApiUtils_1.inferResponseType(response.headers["Content-Type"]);
-                // expand to array buffer once we support that in inferResponseType
-                if (inferredResponseType === "text" && context.responseType === "json") {
-                    throw RequestError_1.convertToRequestError({
-                        error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "'"),
-                        code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                    });
-                }
                 return [2 /*return*/, response];
             });
         });
@@ -90,6 +79,7 @@ var AxiosRequestBackend = /** @class */ (function () {
             cancelToken: new axios.CancelToken(function (cancellerFunc) {
                 canceler = cancellerFunc;
             }),
+            paramsSerializer: context.computedConfig.queryParser,
         });
         return {
             promise: promise,

package/cjs/backend/FetchRequestBackend.d.ts

@@ -9,7 +9,7 @@ export default class FetchRequestBackend implements RequestBackend<Response> {
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;
     convertResponse<T>(context: RequestContext, response: Response & {
         __text?: string;
-    }, error?: boolean): Promise<ApiResponse<T>>;
+    }): Promise<ApiResponse<T>>;
     makeRequest(context: RequestContext): RequestOperation<Response>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

package/cjs/backend/FetchRequestBackend.js

@@ -55,7 +55,6 @@ var Utils = require("../Utils");
 var Utils_1 = require("../Utils");
 var ApiConstants_1 = require("../ApiConstants");
 var ApiUtils_1 = require("../ApiUtils");
-var RequestError_1 = require("../RequestError");
 var FetchError = /** @class */ (function (_super) {
     __extends(FetchError, _super);
     function FetchError() {
@@ -83,58 +82,47 @@ var FetchRequestBackend = /** @class */ (function () {
             });
         });
     };
-    FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
+    FetchRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, inferredResponseType, responseType, _a, error_1, status;
+            var contentType, responseType, _a, data, status, headers, error_1;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        inferredResponseType = ApiUtils_1.inferResponseType(response.headers.get("Content-Type"));
-                        responseType = error ? inferredResponseType : context.responseType;
-                        // expand to array buffer once we support that in inferResponseType
-                        if (inferredResponseType === "text" && context.responseType === "json") {
-                            throw RequestError_1.convertToRequestError({
-                                error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "'"),
-                                code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                            });
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, , 9]);
-                        if (!!response.__text) return [3 /*break*/, 3];
+                        contentType = response.headers.get("Content-Type");
+                        responseType = ApiUtils_1.inferResponseType(contentType);
+                        if (!!response.__text) return [3 /*break*/, 2];
                         _a = response;
                         return [4 /*yield*/, response.clone().text()];
-                    case 2:
+                    case 1:
                         _a.__text = _b.sent();
+                        _b.label = 2;
+                    case 2:
+                        data = response.__text;
+                        status = response.status, headers = response.headers;
                         _b.label = 3;
                     case 3:
-                        if (!(responseType === ApiConstants_1.ResponseType.Text)) return [3 /*break*/, 4];
-                        data = response.__text;
-                        return [3 /*break*/, 7];
-                    case 4:
-                        if (!(responseType === ApiConstants_1.ResponseType.ArrayBuffer)) return [3 /*break*/, 6];
+                        _b.trys.push([3, 7, , 8]);
+                        if (!(responseType === ApiConstants_1.ResponseType.ArrayBuffer)) return [3 /*break*/, 5];
                         return [4 /*yield*/, response.clone().arrayBuffer()];
-                    case 5:
+                    case 4:
                         data = _b.sent();
-                        return [3 /*break*/, 7];
-                    case 6:
+                        return [3 /*break*/, 6];
+                    case 5:
                         if (responseType === ApiConstants_1.ResponseType.Json) {
                             data = JSON.parse(response.__text);
                         }
-                        _b.label = 7;
-                    case 7: return [3 /*break*/, 9];
-                    case 8:
+                        _b.label = 6;
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
                         error_1 = _b.sent();
                         throw Object.assign(new Error("[api-def] Invalid '" + context.responseType + "' response, got: '" + response.__text + "'"), {
                             response: response,
                         });
-                    case 9:
-                        status = response.status;
-                        return [2 /*return*/, {
-                                data: data,
-                                status: status,
-                                headers: response.headers,
-                            }];
+                    case 8: return [2 /*return*/, {
+                            data: data,
+                            status: status,
+                            headers: headers,
+                        }];
                 }
             });
         });
@@ -157,10 +145,15 @@ var FetchRequestBackend = /** @class */ (function () {
         }
         var url = new URL(path, origin);
         if (computedConfig.query) {
-            var queryKeys = Object.keys(computedConfig.query);
-            for (var i = 0; i < queryKeys.length; i++) {
-                var key = queryKeys[i];
-                url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+            if (context.computedConfig.queryParser) {
+                url.search = context.computedConfig.queryParser(computedConfig.query);
+            }
+            else {
+                var queryKeys = Object.keys(computedConfig.query);
+                for (var i = 0; i < queryKeys.length; i++) {
+                    var key = queryKeys[i];
+                    url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+                }
             }
         }
         // abort controller is a newer feature than fetch
@@ -203,7 +196,6 @@ var FetchRequestBackend = /** @class */ (function () {
             canceler: abortSignal
                 ? function () { return !responded && abortController.abort(); }
                 : function () {
-                    console.warn("Request aborted");
                     softAbort = true;
                 },
         };

package/cjs/backend/RequestBackend.d.ts

@@ -10,7 +10,7 @@ export interface RequestBackendErrorInfo {
 export default interface RequestBackend<R = any> {
     readonly id: string;
     makeRequest(context: RequestContext): RequestOperation<R>;
-    convertResponse<T>(context: RequestContext, response: R, error?: boolean): Promise<ApiResponse<T>>;
+    convertResponse<T>(context: RequestContext, response: R): Promise<ApiResponse<T>>;
     extractResponseFromError(error: Error): Promise<R | null | undefined>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

package/cjs/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./Api";
 export * from "./ApiTypes";
+export * from "./UtilTypes";
 export * from "./ApiConstants";
 export { isRequestError } from "./RequestError";
 export { clearCache, setCacheBackend } from "./cache/Caching";

package/cjs/index.js

@@ -14,6 +14,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoggingMiddleware = exports.CacheMiddleware = exports.FetchRequestBackend = exports.AxiosRequestBackend = exports.LocaleForageCacheBackend = exports.LocalStorageCacheBackend = exports.setCacheBackend = exports.clearCache = exports.isRequestError = void 0;
 __exportStar(require("./Api"), exports);
 __exportStar(require("./ApiTypes"), exports);
+__exportStar(require("./UtilTypes"), exports);
 __exportStar(require("./ApiConstants"), exports);
 var RequestError_1 = require("./RequestError");
 Object.defineProperty(exports, "isRequestError", { enumerable: true, get: function () { return RequestError_1.isRequestError; } });

package/esm/ApiTypes.d.ts

@@ -4,7 +4,7 @@ import { CacheSource, EventResultType, RequestEvent, RequestMethod, ResponseType
 export declare type AcceptableStatus = number | [min: number, max: number];
 export declare type Headers = Record<string, string | number | boolean | null | undefined>;
 export declare type Params = string;
-export declare type Query = Record<string, string | number | boolean | undefined | null>;
+export declare type Query = Record<string, any>;
 export declare type Body = string | number | Record<string, any>;
 export interface ApiResponse<T = any> {
     status: number;
@@ -17,6 +17,7 @@ export interface BaseRequestConfig {
     retry?: number | false;
     headers?: Readonly<Headers>;
     acceptableStatus?: AcceptableStatus[];
+    queryParser?: (query: any) => string;
 }
 export declare type RequestConfig<P extends Params | undefined = Params | undefined, Q extends Query | undefined = Query | undefined, B extends Body | undefined = Body | undefined> = (P extends undefined ? {
     params?: never;

package/esm/ApiUtils.d.ts

@@ -1,7 +1,6 @@
-import { AcceptableStatus, ApiResponse, CancelledRequestError } from "./ApiTypes";
+import { AcceptableStatus, CancelledRequestError } from "./ApiTypes";
 import { ResponseType } from "./ApiConstants";
 export declare const isCancelledError: (error: Error) => error is CancelledRequestError;
 export declare const isNetworkError: (error: Error) => boolean;
-export declare const parseResponseDataToObject: (response: ApiResponse) => void;
 export declare const isAcceptableStatus: (status: number, acceptableStatus?: AcceptableStatus[] | undefined) => boolean;
 export declare const inferResponseType: (contentType: string | null | undefined) => ResponseType;

package/esm/ApiUtils.js

@@ -1,4 +1,3 @@
-import { textDecode } from "./TextDecoding";
 export var isCancelledError = function (error) {
     return "isCancelledRequest" in error;
 };
@@ -8,21 +7,6 @@ export var isNetworkError = function (error) {
         error.message === "Network Error" ||
         ((_a = error.constructor) === null || _a === void 0 ? void 0 : _a.name) === "NetworkError");
 };
-export var parseResponseDataToObject = function (response) {
-    if (response.data &&
-        typeof response.data === "object") {
-        var data = response.data;
-        if (data.constructor && data.constructor.name === "ArrayBuffer") {
-            try {
-                var decodedData = (response.data = textDecode(data));
-                response.data = JSON.parse(decodedData);
-            }
-            catch (e) {
-                console.warn("Couldn't parse array buffer content to JSON response", e);
-            }
-        }
-    }
-};
 var DEFAULT_ACCEPTABLE_STATUS = [[200, 299], 304];
 export var isAcceptableStatus = function (status, acceptableStatus) {
     var acceptable = acceptableStatus !== null && acceptableStatus !== void 0 ? acceptableStatus : DEFAULT_ACCEPTABLE_STATUS;
@@ -42,11 +26,21 @@ export var isAcceptableStatus = function (status, acceptableStatus) {
     }
     return (false);
 };
+var TEXT_CONTENT_TYPES = ["text/plain"];
 var JSON_CONTENT_TYPES = ["text/json", "application/json"];
+var ARRRAY_BUFFER_CONTENT_TYPES = ["application/octet-stream"];
 export var inferResponseType = function (contentType) {
     var contentTypePart = contentType === null || contentType === void 0 ? void 0 : contentType.split(";")[0].trim();
-    if (contentTypePart && JSON_CONTENT_TYPES.includes(contentTypePart)) {
-        return "json";
+    if (contentTypePart) {
+        if (TEXT_CONTENT_TYPES.includes(contentTypePart)) {
+            return "text";
+        }
+        else if (JSON_CONTENT_TYPES.includes(contentTypePart)) {
+            return "json";
+        }
+        else if (ARRRAY_BUFFER_CONTENT_TYPES.includes(contentTypePart)) {
+            return "arraybuffer";
+        }
     }
     return "text";
 };

package/esm/Requester.js

@@ -46,18 +46,19 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 import * as ApiUtils from "./ApiUtils";
-import { isAcceptableStatus, isNetworkError } from "./ApiUtils";
+import { inferResponseType, isAcceptableStatus, isNetworkError } from "./ApiUtils";
 import RequestContext from "./RequestContext";
 import * as Api from "./Api";
 import { EventResultType, RequestEvent } from "./ApiConstants";
 import retry from "./util/retry";
 import MockRequestBackend from "./backend/MockRequestBackend";
 import { convertToRequestError, isRequestError, RequestErrorCode } from "./RequestError";
+import { textDecode } from "./TextDecoding";
 var locks = {};
 var runningOperations = {};
 var MOCK_REQUEST_BACKEND = new MockRequestBackend();
 export var submit = function (host, config, mocking) { return __awaiter(void 0, void 0, void 0, function () {
-    var computedConfig, backend, context, key, sameRequest, lock, lockedContext, response, successEventResult, error_1;
+    var computedConfig, backend, context, key, lock, lockedContext, response, successEventResult, error_1;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
@@ -68,10 +69,6 @@ export var submit = function (host, config, mocking) { return __awaiter(void 0,
                 }
                 context = new RequestContext(backend, host, computedConfig, host.computePath(host.path, config), mocking);
                 key = context.key;
-                sameRequest = runningOperations[key];
-                if (sameRequest) {
-                    return [2 /*return*/, sameRequest];
-                }
                 lock = (context.computedConfig || {}).lock;
                 if (lock) {
                     lockedContext = locks[lock];
@@ -118,6 +115,7 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                 if (process.env.NODE_ENV === "development") {
                     if (Api.isRequestBackendDefault() && !defaultBackendMessageShown) {
                         defaultBackendMessageShown = true;
+                        // eslint-disable-next-line
                         console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
                     }
                 }
@@ -173,10 +171,6 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                                 error = _b.sent();
                                 context.error = error;
                                 context.response = error.response;
-                                // transform array buffer responses to objs
-                                if (context.response) {
-                                    ApiUtils.parseResponseDataToObject(context.response);
-                                }
                                 return [4 /*yield*/, context.triggerEvent(RequestEvent.Error)];
                             case 6:
                                 errorEventResult = _b.sent();
@@ -213,16 +207,46 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
     });
 }); };
 var parseResponse = function (context, response, error) { return __awaiter(void 0, void 0, void 0, function () {
-    var parsedResponse;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
+    var parsedResponse, contentType, inferredResponseType, data, decodedData;
+    var _a;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
             case 0:
                 if (!response) return [3 /*break*/, 2];
-                return [4 /*yield*/, context.backend.convertResponse(context, response, error)];
+                return [4 /*yield*/, context.backend.convertResponse(context, response)];
             case 1:
-                parsedResponse = _a.sent();
-                if (parsedResponse) {
-                    ApiUtils.parseResponseDataToObject(parsedResponse);
+                parsedResponse = _b.sent();
+                contentType = response.headers["Content-Type"];
+                inferredResponseType = inferResponseType(contentType);
+                if (!error) {
+                    // expand to array buffer once we support that in inferResponseType
+                    if (inferredResponseType === "text" && context.responseType === "json") {
+                        throw convertToRequestError({
+                            error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
+                            code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                            response: parsedResponse,
+                        });
+                    }
+                    // transform arrayBuffer to json
+                    if (inferredResponseType === "arraybuffer" && context.responseType === "json") {
+                        if (parsedResponse.data &&
+                            typeof parsedResponse.data === "object") {
+                            data = response.data;
+                            if (((_a = data.constructor) === null || _a === void 0 ? void 0 : _a.name) === "ArrayBuffer") {
+                                try {
+                                    decodedData = (response.data = textDecode(data));
+                                    response.data = JSON.parse(decodedData);
+                                }
+                                catch (e) {
+                                    throw convertToRequestError({
+                                        error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
+                                        code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                                        response: parsedResponse,
+                                    });
+                                }
+                            }
+                        }
+                    }
                 }
                 return [2 /*return*/, parsedResponse];
             case 2: return [2 /*return*/, response];

package/esm/UtilTypes.d.ts

@@ -0,0 +1,5 @@
+import Endpoint from "./Endpoint";
+export declare type ResponseOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<infer R, any, any, any> ? R : never;
+export declare type ParamsOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, infer P, any, any> ? P : never;
+export declare type QueryOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, any, infer Q, any> ? Q : never;
+export declare type BodyOf<E extends Endpoint<any, any, any, any>> = E extends Endpoint<any, any, any, infer B> ? B : never;

package/esm/UtilTypes.js

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

package/esm/backend/AxiosRequestBackend.js

@@ -34,8 +34,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { inferResponseType } from "../ApiUtils";
-import { convertToRequestError, RequestErrorCode } from "../RequestError";
 var axios;
 export var isAxiosError = function (error) {
     return "isAxiosError" in error;
@@ -58,16 +56,7 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var inferredResponseType;
             return __generator(this, function (_a) {
-                inferredResponseType = inferResponseType(response.headers["Content-Type"]);
-                // expand to array buffer once we support that in inferResponseType
-                if (inferredResponseType === "text" && context.responseType === "json") {
-                    throw convertToRequestError({
-                        error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "'"),
-                        code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                    });
-                }
                 return [2 /*return*/, response];
             });
         });
@@ -86,6 +75,7 @@ var AxiosRequestBackend = /** @class */ (function () {
             cancelToken: new axios.CancelToken(function (cancellerFunc) {
                 canceler = cancellerFunc;
             }),
+            paramsSerializer: context.computedConfig.queryParser,
         });
         return {
             promise: promise,

package/esm/backend/FetchRequestBackend.d.ts

@@ -9,7 +9,7 @@ export default class FetchRequestBackend implements RequestBackend<Response> {
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;
     convertResponse<T>(context: RequestContext, response: Response & {
         __text?: string;
-    }, error?: boolean): Promise<ApiResponse<T>>;
+    }): Promise<ApiResponse<T>>;
     makeRequest(context: RequestContext): RequestOperation<Response>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

package/esm/backend/FetchRequestBackend.js

@@ -53,7 +53,6 @@ import * as Utils from "../Utils";
 import { getGlobalFetch } from "../Utils";
 import { ResponseType } from "../ApiConstants";
 import { inferResponseType } from "../ApiUtils";
-import { convertToRequestError, RequestErrorCode } from "../RequestError";
 var FetchError = /** @class */ (function (_super) {
     __extends(FetchError, _super);
     function FetchError() {
@@ -81,58 +80,47 @@ var FetchRequestBackend = /** @class */ (function () {
             });
         });
     };
-    FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
+    FetchRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, inferredResponseType, responseType, _a, error_1, status;
+            var contentType, responseType, _a, data, status, headers, error_1;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        inferredResponseType = inferResponseType(response.headers.get("Content-Type"));
-                        responseType = error ? inferredResponseType : context.responseType;
-                        // expand to array buffer once we support that in inferResponseType
-                        if (inferredResponseType === "text" && context.responseType === "json") {
-                            throw convertToRequestError({
-                                error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "'"),
-                                code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                            });
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, , 9]);
-                        if (!!response.__text) return [3 /*break*/, 3];
+                        contentType = response.headers.get("Content-Type");
+                        responseType = inferResponseType(contentType);
+                        if (!!response.__text) return [3 /*break*/, 2];
                         _a = response;
                         return [4 /*yield*/, response.clone().text()];
-                    case 2:
+                    case 1:
                         _a.__text = _b.sent();
+                        _b.label = 2;
+                    case 2:
+                        data = response.__text;
+                        status = response.status, headers = response.headers;
                         _b.label = 3;
                     case 3:
-                        if (!(responseType === ResponseType.Text)) return [3 /*break*/, 4];
-                        data = response.__text;
-                        return [3 /*break*/, 7];
-                    case 4:
-                        if (!(responseType === ResponseType.ArrayBuffer)) return [3 /*break*/, 6];
+                        _b.trys.push([3, 7, , 8]);
+                        if (!(responseType === ResponseType.ArrayBuffer)) return [3 /*break*/, 5];
                         return [4 /*yield*/, response.clone().arrayBuffer()];
-                    case 5:
+                    case 4:
                         data = _b.sent();
-                        return [3 /*break*/, 7];
-                    case 6:
+                        return [3 /*break*/, 6];
+                    case 5:
                         if (responseType === ResponseType.Json) {
                             data = JSON.parse(response.__text);
                         }
-                        _b.label = 7;
-                    case 7: return [3 /*break*/, 9];
-                    case 8:
+                        _b.label = 6;
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
                         error_1 = _b.sent();
                         throw Object.assign(new Error("[api-def] Invalid '" + context.responseType + "' response, got: '" + response.__text + "'"), {
                             response: response,
                         });
-                    case 9:
-                        status = response.status;
-                        return [2 /*return*/, {
-                                data: data,
-                                status: status,
-                                headers: response.headers,
-                            }];
+                    case 8: return [2 /*return*/, {
+                            data: data,
+                            status: status,
+                            headers: headers,
+                        }];
                 }
             });
         });
@@ -155,10 +143,15 @@ var FetchRequestBackend = /** @class */ (function () {
         }
         var url = new URL(path, origin);
         if (computedConfig.query) {
-            var queryKeys = Object.keys(computedConfig.query);
-            for (var i = 0; i < queryKeys.length; i++) {
-                var key = queryKeys[i];
-                url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+            if (context.computedConfig.queryParser) {
+                url.search = context.computedConfig.queryParser(computedConfig.query);
+            }
+            else {
+                var queryKeys = Object.keys(computedConfig.query);
+                for (var i = 0; i < queryKeys.length; i++) {
+                    var key = queryKeys[i];
+                    url.searchParams.append(key, ((_a = computedConfig.query[key]) === null || _a === void 0 ? void 0 : _a.toString()) || "");
+                }
             }
         }
         // abort controller is a newer feature than fetch
@@ -201,7 +194,6 @@ var FetchRequestBackend = /** @class */ (function () {
             canceler: abortSignal
                 ? function () { return !responded && abortController.abort(); }
                 : function () {
-                    console.warn("Request aborted");
                     softAbort = true;
                 },
         };

package/esm/backend/RequestBackend.d.ts

@@ -10,7 +10,7 @@ export interface RequestBackendErrorInfo {
 export default interface RequestBackend<R = any> {
     readonly id: string;
     makeRequest(context: RequestContext): RequestOperation<R>;
-    convertResponse<T>(context: RequestContext, response: R, error?: boolean): Promise<ApiResponse<T>>;
+    convertResponse<T>(context: RequestContext, response: R): Promise<ApiResponse<T>>;
     extractResponseFromError(error: Error): Promise<R | null | undefined>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

package/esm/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./Api";
 export * from "./ApiTypes";
+export * from "./UtilTypes";
 export * from "./ApiConstants";
 export { isRequestError } from "./RequestError";
 export { clearCache, setCacheBackend } from "./cache/Caching";

package/esm/index.js

@@ -2,6 +2,7 @@
 "use strict";
 export * from "./Api";
 export * from "./ApiTypes";
+export * from "./UtilTypes";
 export * from "./ApiConstants";
 export { isRequestError } from "./RequestError";
 export { clearCache, setCacheBackend } from "./cache/Caching";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.6.0-alpha1",
+  "version": "0.6.0-alpha12",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",

package/CHANGELOG.md

@@ -1,65 +0,0 @@
-# 0.6.0
-
-## Breaking Changes
-
-- axios will enforce ResponseType
-
-### Fixes
-
-- absolute paths as `baseUrl` is now supported in fetch backend
-
-# 0.5.0
-
-## Breaking Changes
-
-- Undocumented mocking API has been overhauled 
-
-## Changes
-
-- Add mocking!
-  - Restructured mocking so that mocks are defined on the endpoint level (documentation updated)
-- Add `acceptableStatus` to specify which status codes are considered successful
-- Extend retry logic to use exponential back-off, rather than retrying immediately
-- Support for additional hot-request methods:
-  - PUT, DELETE
-  
-# 0.4.1
-
-- fix fetch backend not working with unbound fetch
-- add better error handling on parse
-
-# 0.4.0
-
-## Breaking Changes
-
-- Move config values from options object up one layer
-- In config `retries` -> `retry`
-- `defaults` -> `config`
-
-## Changes
-
-- Remove need for enum imports
-- Make `name` and `description` optional in endpoint definition 
-
-# 0.3.11
-
-## Changes
-
-- Make fetch backend default if fetch is present
-- Fix fetch backends text response type support
-
-# 0.3.0
-
-## Features
-
-- allow defaults to be a function on api
-- add content type header in fetch backend to match axios backend
-- remove `flatted`
-- polyfill object.assign for ie
-- change retry logic so that if a middleware event responds with Retry we always attempt a retry
-
-# 0.2.5
-
-## Changes
-
-- Remove `window` usages to allow node support