api-def 0.6.0-alpha9 → 0.6.2-alpha.1

package/esm/backend/AxiosRequestBackend.d.ts

@@ -1,13 +1,13 @@
-import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
+import RequestBackend, { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
 import { ApiResponse } from "../ApiTypes";
 import type { AxiosError, AxiosResponse } from "axios";
 import RequestContext from "../RequestContext";
-export declare const isAxiosError: (error: Error) => error is AxiosError<any>;
+export declare const isAxiosError: (error: Error) => error is AxiosError<unknown, any>;
 export default class AxiosRequestBackend implements RequestBackend<AxiosResponse> {
     readonly id = "axios";
     constructor(axiosLibrary: any);
     extractResponseFromError(error: Error): Promise<AxiosResponse | null | undefined>;
-    convertResponse<T>(context: RequestContext, response: AxiosResponse): Promise<ApiResponse<T>>;
+    convertResponse<T>(context: RequestContext, response: AxiosResponse): Promise<ConvertedApiResponse<T>>;
     makeRequest(context: RequestContext): RequestOperation<AxiosResponse>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

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,18 +56,13 @@ var AxiosRequestBackend = /** @class */ (function () {
     };
     AxiosRequestBackend.prototype.convertResponse = function (context, response) {
         return __awaiter(this, void 0, void 0, function () {
-            var contentType, inferredResponseType;
             return __generator(this, function (_a) {
-                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 + "' (from 'Content-Type' of '" + contentType + "')"),
-                        code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                    });
-                }
-                return [2 /*return*/, response];
+                return [2 /*return*/, {
+                        data: response.data,
+                        headers: response.headers,
+                        status: response.status,
+                        __lowercaseHeaders: response._lowerCaseResponseHeaders,
+                    }];
             });
         });
     };
@@ -80,7 +73,7 @@ var AxiosRequestBackend = /** @class */ (function () {
             method: context.method,
             baseURL: context.baseUrl,
             url: context.computedPath,
-            data: computedConfig.body || {},
+            data: context.getParsedBody() || {},
             params: computedConfig.query || {},
             headers: computedConfig.headers || {},
             responseType: context.responseType,

package/esm/backend/FetchRequestBackend.d.ts

@@ -1,15 +1,15 @@
-import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
+import RequestBackend, { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
 import { ApiResponse } from "../ApiTypes";
 import RequestContext from "../RequestContext";
 import { Fetch } from "../Utils";
 export default class FetchRequestBackend implements RequestBackend<Response> {
-    fetch: (((input: RequestInfo, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
+    fetch: (((input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
     readonly id = "fetch";
     constructor(fetchLibrary?: Fetch);
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;
     convertResponse<T>(context: RequestContext, response: Response & {
         __text?: string;
-    }, error?: boolean): Promise<ApiResponse<T>>;
+    }): Promise<ConvertedApiResponse<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,59 +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, contentType, 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:
                         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 + "' (from 'Content-Type' of '" + contentType + "')"),
-                                code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
-                            });
-                        }
-                        _b.label = 1;
-                    case 1:
-                        _b.trys.push([1, 8, , 9]);
-                        if (!!response.__text) return [3 /*break*/, 3];
+                        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 + "'"), {
+                        throw Object.assign(new Error("[api-def] Invalid '".concat(context.responseType, "' response, got: '").concat(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,
+                        }];
                 }
             });
         });
@@ -172,7 +159,8 @@ var FetchRequestBackend = /** @class */ (function () {
         var abortSignal = abortController ? abortController.signal : undefined;
         var softAbort = false;
         var responded = false;
-        var bodyJsonify = computedConfig.body !== null && typeof computedConfig.body === "object";
+        var body = context.getParsedBody();
+        var bodyJsonify = body !== null && typeof body === "object";
         var headers = Utils.assign({
             // logic from axios
             "Content-Type": bodyJsonify ? "application/json;charset=utf-8" : "application/x-www-form-urlencoded",
@@ -186,7 +174,7 @@ var FetchRequestBackend = /** @class */ (function () {
         }, {});
         var promise = this.fetch(url.href, {
             method: context.method,
-            body: bodyJsonify ? JSON.stringify(computedConfig.body) : computedConfig.body,
+            body: bodyJsonify ? JSON.stringify(body) : body,
             headers: parsedHeaders,
             mode: "cors",
             signal: abortSignal,

package/esm/backend/MockRequestBackend.js

@@ -63,7 +63,7 @@ var MockRequestBackend = /** @class */ (function () {
     MockRequestBackend.prototype.runRequest = function (context) {
         var _a, _b, _c, _d;
         return __awaiter(this, void 0, void 0, function () {
-            var mockingFunc, req, res, delay, delayMs, min, max, _e;
+            var mockingFunc, req, res, delay, delayMs, min, max, _e, parsedHeaders;
             return __generator(this, function (_f) {
                 switch (_f.label) {
                     case 0:
@@ -75,13 +75,14 @@ var MockRequestBackend = /** @class */ (function () {
                             });
                         }
                         req = {
-                            body: context.computedConfig.body,
+                            body: context.getParsedBody(),
                             params: (_b = context.computedConfig.params) !== null && _b !== void 0 ? _b : {},
                             query: context.computedConfig.query,
                             headers: (_c = context.computedConfig.headers) !== null && _c !== void 0 ? _c : {},
                         };
                         res = {
                             statusCode: -1,
+                            headers: {},
                             response: undefined,
                             status: function (statusCode) {
                                 res.statusCode = statusCode;
@@ -89,6 +90,9 @@ var MockRequestBackend = /** @class */ (function () {
                             },
                             send: function (response) {
                                 res.response = response;
+                                if (response && typeof response === "object") {
+                                    res.headers["Content-Type"] = "application/json";
+                                }
                                 return res;
                             },
                         };
@@ -125,8 +129,12 @@ var MockRequestBackend = /** @class */ (function () {
                                 code: RequestErrorCode.REQUEST_INVALID_CONFIG,
                             });
                         }
+                        parsedHeaders = Object.keys(res.headers).reduce(function (parsedHeaders, key) {
+                            parsedHeaders[key] = res.headers[key].toString();
+                            return parsedHeaders;
+                        }, {});
                         return [2 /*return*/, {
-                                headers: {},
+                                headers: parsedHeaders,
                                 data: res.response,
                                 status: res.statusCode,
                             }];

package/esm/backend/RequestBackend.d.ts

@@ -7,10 +7,13 @@ export interface RequestOperation<R> {
 export interface RequestBackendErrorInfo {
     code: string;
 }
+export declare type ConvertedApiResponse<T> = ApiResponse<T> & {
+    __lowercaseHeaders?: any;
+};
 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<ConvertedApiResponse<T>>;
     extractResponseFromError(error: Error): Promise<R | null | undefined>;
     getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
 }

package/esm/cache/Caching.d.ts

@@ -6,5 +6,5 @@ export interface CacheEntry {
     data: any;
     expiry: number | null;
 }
-export declare const setCachedItem: <T>(key: string, value: T, expiry?: number | undefined) => Promise<T>;
+export declare const setCachedItem: <T>(key: string, value: T, expiry?: number) => Promise<T>;
 export declare const getCachedItem: <T = any>(key: string) => Promise<T | undefined>;

package/esm/middleware/LoggingMiddleware.js

@@ -28,12 +28,12 @@ var diagnoseError = function (error) {
     var _a = error.response, status = _a.status, data = _a.data;
     var code = data === null || data === void 0 ? void 0 : data.code;
     return {
-        message: "responded with " + status + (code ? " (" + code + ")" : ""),
+        message: "responded with ".concat(status).concat(code ? " (".concat(code, ")") : ""),
         response: error.response,
     };
 };
 var formatTime = function (time) {
-    return Utils.padNumber(time.getHours(), 2) + ":" + Utils.padNumber(time.getMinutes(), 2) + ":" + Utils.padNumber(time.getSeconds(), 2) + "." + Utils.padNumber(time.getMilliseconds(), 3);
+    return "".concat(Utils.padNumber(time.getHours(), 2), ":").concat(Utils.padNumber(time.getMinutes(), 2), ":").concat(Utils.padNumber(time.getSeconds(), 2), ".").concat(Utils.padNumber(time.getMilliseconds(), 3));
 };
 var log = function (context, type, message, config, objects) {
     if (typeof config.predicate === "function" && !config.predicate()) {
@@ -43,10 +43,10 @@ var log = function (context, type, message, config, objects) {
     var color = COLOR_MAP[type];
     var timestamp = formatTime(new Date());
     var args = [
-        "%cnetwork %c[" + context.api.name + "] " + context.method.toUpperCase() + " " + computedPath + " %c" + message + " %c@ " + timestamp,
+        "%cnetwork %c[".concat(context.api.name, "] ").concat(context.method.toUpperCase(), " ").concat(computedPath, " %c").concat(message, " %c@ ").concat(timestamp),
         "color:gray",
         "color:auto",
-        "color:" + color,
+        "color:".concat(color),
         "color:gray",
     ];
     /* eslint-disable-next-line no-console */
@@ -66,18 +66,18 @@ var LoggingMiddleware = function (config) {
         _a[RequestEvent.Success] = function (context) {
             var _a;
             var cacheSource = context.cacheInfo.source;
-            log(context, LogType.Success, "responded with " + ((_a = context.response) === null || _a === void 0 ? void 0 : _a.status) + (cacheSource ? " (cached by " + cacheSource + ")" : ""), config);
+            log(context, LogType.Success, "responded with ".concat((_a = context.response) === null || _a === void 0 ? void 0 : _a.status).concat(cacheSource ? " (cached by ".concat(cacheSource, ")") : ""), config);
         },
         _a[RequestEvent.Error] = function (context) {
             if (context.error) {
                 var _a = diagnoseError(context.error), error = _a.error, message = _a.message;
-                log(context, LogType.Warn, "error on attempt " + context.stats.attempt + " - " + message, config, { error: error });
+                log(context, LogType.Warn, "error on attempt ".concat(context.stats.attempt, " - ").concat(message), config, { error: error });
             }
         },
         _a[RequestEvent.UnrecoverableError] = function (context) {
             if (context.error) {
                 var _a = diagnoseError(context.error), error = _a.error, message = _a.message;
-                log(context, LogType.Error, "failed - " + message, config, {
+                log(context, LogType.Error, "failed - ".concat(message), config, {
                     error: error,
                 });
             }

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "api-def",
-  "version": "0.6.0-alpha9",
+  "version": "0.6.2-alpha.1",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",
   "sideEffects": false,
   "scripts": {
+    "prepublishOnly": "npm run test && npm run build",
     "test": "npm run test:types && npm run test:lint && npm run test:unit",
-    "test:unit": "cross-env NODE_ENV=test jest",
+    "test:unit": "ava",
     "test:lint": "npm run lint:strict",
     "test:types": "tsc --noEmit -p .",
     "example:start": "cd example && npm run start",
@@ -45,19 +46,30 @@
     "cjs/"
   ],
   "repository": "https://github.com/Censkh/api-def",
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "files": [
+      "src/tests/**/*.test.ts"
+    ],
+    "nodeArguments": [
+      "--require=@esbuild-kit/cjs-loader"
+    ]
+  },
   "devDependencies": {
     "@babel/preset-env": "7.14.8",
     "@babel/preset-typescript": "7.14.5",
+    "@esbuild-kit/cjs-loader": "2.4.0",
     "@types/axios": "0.14.0",
-    "@types/jest": "26.0.24",
     "@types/node": "16.4.6",
     "@typescript-eslint/eslint-plugin": "4.28.5",
     "@typescript-eslint/parser": "4.28.5",
+    "ava": "5.0.1",
     "cross-env": "7.0.3",
     "eslint": "7.31.0",
     "eslint-watch": "7.0.0",
-    "jest": "27.0.6",
     "npm-run-all": "4.1.5",
-    "typescript": "4.3.5"
+    "typescript": "4.8.4"
   }
 }

package/CHANGELOG.md

@@ -1,71 +0,0 @@
-# 0.6.0
-
-## Breaking Changes
-
-- axios will enforce `ResponseType`
-
-## Features
-
-- add `ResponseOf`, `QueryOf`, `BodyOf`, `ParamsOf` to quickly get types from endpoints
-- new `queryParser` config option to allow custom query string parsing
-
-## Fixes
-
-- absolute paths as `baseUrl` is now supported in fetch backend
-- don't re-use same requests based upon URL to allow for concurrent POST requests
-
-# 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