api-def 0.6.0-alpha1 → 0.6.0-alpha10

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.js

@@ -23,7 +23,8 @@ var parseResponseDataToObject = function (response) {
                 response.data = JSON.parse(decodedData);
             }
             catch (e) {
-                console.warn("Couldn't parse array buffer content to JSON response", e);
+                // eslint-disable-next-line
+                console.warn("[api-def] Couldn't parse array buffer content to JSON response", e);
             }
         }
     }

package/cjs/Requester.js

@@ -60,7 +60,7 @@ 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 +71,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 +118,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)");
                     }
                 }

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

@@ -62,14 +62,16 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var inferredResponseType;
+            var contentType, inferredResponseType;
             return __generator(this, function (_a) {
-                inferredResponseType = ApiUtils_1.inferResponseType(response.headers["Content-Type"]);
+                contentType = response.headers["content-type"];
+                inferredResponseType = ApiUtils_1.inferResponseType(contentType);
                 // 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 + "'"),
+                        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: response,
                     });
                 }
                 return [2 /*return*/, response];
@@ -90,6 +92,7 @@ var AxiosRequestBackend = /** @class */ (function () {
             cancelToken: new axios.CancelToken(function (cancellerFunc) {
                 canceler = cancellerFunc;
             }),
+            paramsSerializer: context.computedConfig.queryParser,
         });
         return {
             promise: promise,

package/cjs/backend/FetchRequestBackend.js

@@ -85,29 +85,36 @@ var FetchRequestBackend = /** @class */ (function () {
     };
     FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, inferredResponseType, responseType, _a, error_1, status;
+            var data, contentType, inferredResponseType, responseType, _a, status, headers, error_1;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        inferredResponseType = ApiUtils_1.inferResponseType(response.headers.get("Content-Type"));
+                        contentType = response.headers.get("Content-Type");
+                        inferredResponseType = ApiUtils_1.inferResponseType(contentType);
                         responseType = error ? inferredResponseType : context.responseType;
+                        if (!!response.__text) return [3 /*break*/, 2];
+                        _a = response;
+                        return [4 /*yield*/, response.clone().text()];
+                    case 1:
+                        _a.__text = _b.sent();
+                        _b.label = 2;
+                    case 2:
+                        status = response.status, headers = response.headers;
                         // 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 + "'"),
+                                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: {
+                                    data: response.__text,
+                                    status: status,
+                                    headers: headers,
+                                },
                             });
                         }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, , 9]);
-                        if (!!response.__text) return [3 /*break*/, 3];
-                        _a = response;
-                        return [4 /*yield*/, response.clone().text()];
-                    case 2:
-                        _a.__text = _b.sent();
                         _b.label = 3;
                     case 3:
+                        _b.trys.push([3, 8, , 9]);
                         if (!(responseType === ApiConstants_1.ResponseType.Text)) return [3 /*break*/, 4];
                         data = response.__text;
                         return [3 /*break*/, 7];
@@ -128,13 +135,11 @@ var FetchRequestBackend = /** @class */ (function () {
                         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 9: return [2 /*return*/, {
+                            data: data,
+                            status: status,
+                            headers: headers,
+                        }];
                 }
             });
         });
@@ -157,10 +162,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 +213,6 @@ var FetchRequestBackend = /** @class */ (function () {
             canceler: abortSignal
                 ? function () { return !responded && abortController.abort(); }
                 : function () {
-                    console.warn("Request aborted");
                     softAbort = true;
                 },
         };

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.js

@@ -18,7 +18,8 @@ export var parseResponseDataToObject = function (response) {
                 response.data = JSON.parse(decodedData);
             }
             catch (e) {
-                console.warn("Couldn't parse array buffer content to JSON response", e);
+                // eslint-disable-next-line
+                console.warn("[api-def] Couldn't parse array buffer content to JSON response", e);
             }
         }
     }

package/esm/Requester.js

@@ -57,7 +57,7 @@ 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 +68,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 +114,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)");
                     }
                 }

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

@@ -58,14 +58,16 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var inferredResponseType;
+            var contentType, inferredResponseType;
             return __generator(this, function (_a) {
-                inferredResponseType = inferResponseType(response.headers["Content-Type"]);
+                contentType = response.headers["content-type"];
+                inferredResponseType = inferResponseType(contentType);
                 // 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 + "'"),
+                        error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
                         code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                        response: response,
                     });
                 }
                 return [2 /*return*/, response];
@@ -86,6 +88,7 @@ var AxiosRequestBackend = /** @class */ (function () {
             cancelToken: new axios.CancelToken(function (cancellerFunc) {
                 canceler = cancellerFunc;
             }),
+            paramsSerializer: context.computedConfig.queryParser,
         });
         return {
             promise: promise,

package/esm/backend/FetchRequestBackend.js

@@ -83,29 +83,36 @@ var FetchRequestBackend = /** @class */ (function () {
     };
     FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, inferredResponseType, responseType, _a, error_1, status;
+            var data, contentType, inferredResponseType, responseType, _a, status, headers, error_1;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        inferredResponseType = inferResponseType(response.headers.get("Content-Type"));
+                        contentType = response.headers.get("Content-Type");
+                        inferredResponseType = inferResponseType(contentType);
                         responseType = error ? inferredResponseType : context.responseType;
+                        if (!!response.__text) return [3 /*break*/, 2];
+                        _a = response;
+                        return [4 /*yield*/, response.clone().text()];
+                    case 1:
+                        _a.__text = _b.sent();
+                        _b.label = 2;
+                    case 2:
+                        status = response.status, headers = response.headers;
                         // 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 + "'"),
+                                error: new Error("[api-def] Expected '" + context.responseType + "' response, got '" + inferredResponseType + "' (from 'Content-Type' of '" + contentType + "')"),
                                 code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                                response: {
+                                    data: response.__text,
+                                    status: status,
+                                    headers: headers,
+                                },
                             });
                         }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, , 9]);
-                        if (!!response.__text) return [3 /*break*/, 3];
-                        _a = response;
-                        return [4 /*yield*/, response.clone().text()];
-                    case 2:
-                        _a.__text = _b.sent();
                         _b.label = 3;
                     case 3:
+                        _b.trys.push([3, 8, , 9]);
                         if (!(responseType === ResponseType.Text)) return [3 /*break*/, 4];
                         data = response.__text;
                         return [3 /*break*/, 7];
@@ -126,13 +133,11 @@ var FetchRequestBackend = /** @class */ (function () {
                         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 9: return [2 /*return*/, {
+                            data: data,
+                            status: status,
+                            headers: headers,
+                        }];
                 }
             });
         });
@@ -155,10 +160,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 +211,6 @@ var FetchRequestBackend = /** @class */ (function () {
             canceler: abortSignal
                 ? function () { return !responded && abortController.abort(); }
                 : function () {
-                    console.warn("Request aborted");
                     softAbort = true;
                 },
         };

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-alpha10",
   "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