api-def 0.6.0-alpha6 → 0.6.0-alpha9

package/CHANGELOG.md

@@ -7,6 +7,7 @@
 ## Features
 
 - add `ResponseOf`, `QueryOf`, `BodyOf`, `ParamsOf` to quickly get types from endpoints
+- new `queryParser` config option to allow custom query string parsing
 
 ## Fixes
 

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

@@ -118,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,13 +62,14 @@ 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,
                     });
                 }
@@ -90,6 +91,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,16 +85,17 @@ 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, error_1, status;
             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;
                         // 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,
                             });
                         }
@@ -157,10 +158,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 +209,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

@@ -114,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,13 +58,14 @@ 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,
                     });
                 }
@@ -86,6 +87,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,16 +83,17 @@ 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, error_1, status;
             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;
                         // 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,
                             });
                         }
@@ -155,10 +156,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 +207,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-alpha6",
+  "version": "0.6.0-alpha9",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",