api-def 0.5.0 → 0.6.0-alpha3

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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

package/cjs/ApiUtils.d.ts

@@ -1,5 +1,7 @@
 import { AcceptableStatus, ApiResponse, 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,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAcceptableStatus = exports.parseResponseDataToObject = exports.isNetworkError = exports.isCancelledError = void 0;
+exports.inferResponseType = exports.isAcceptableStatus = exports.parseResponseDataToObject = exports.isNetworkError = exports.isCancelledError = void 0;
 var TextDecoding_1 = require("./TextDecoding");
 var isCancelledError = function (error) {
     return "isCancelledRequest" in error;
@@ -49,3 +49,12 @@ var isAcceptableStatus = function (status, acceptableStatus) {
     return (false);
 };
 exports.isAcceptableStatus = isAcceptableStatus;
+var JSON_CONTENT_TYPES = ["text/json", "application/json"];
+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";
+    }
+    return "text";
+};
+exports.inferResponseType = inferResponseType;

package/cjs/RequestError.d.ts

@@ -5,6 +5,7 @@ export declare const RequestErrorCode: {
     readonly REQUEST_NETWORK_ERROR: "request/network-error";
     readonly REQUEST_INVALID_STATUS: "request/invalid-status";
     readonly REQUEST_INVALID_CONFIG: "request/invalid-config";
+    readonly REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type";
 };
 export declare type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
 export interface RequestError extends Error {

package/cjs/RequestError.js

@@ -6,6 +6,7 @@ exports.RequestErrorCode = {
     REQUEST_NETWORK_ERROR: "request/network-error",
     REQUEST_INVALID_STATUS: "request/invalid-status",
     REQUEST_INVALID_CONFIG: "request/invalid-config",
+    REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type",
 };
 var isRequestError = function (error) {
     return "isRequestError" in error;

package/cjs/UtilTypes.d.ts

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

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

package/cjs/backend/AxiosRequestBackend.js

@@ -37,13 +37,17 @@ 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;
 };
 exports.isAxiosError = isAxiosError;
 var AxiosRequestBackend = /** @class */ (function () {
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     function AxiosRequestBackend(axiosLibrary) {
+        this.id = "axios";
         axios = axiosLibrary;
     }
     AxiosRequestBackend.prototype.extractResponseFromError = function (error) {
@@ -58,7 +62,16 @@ 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];
             });
         });

package/cjs/backend/FetchRequestBackend.d.ts

@@ -2,12 +2,11 @@ import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./Req
 import { ApiResponse } from "../ApiTypes";
 import RequestContext from "../RequestContext";
 import { Fetch } from "../Utils";
-import { ResponseType } from "../ApiConstants";
 export default class FetchRequestBackend implements RequestBackend<Response> {
     fetch: (((input: RequestInfo, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
+    readonly id = "fetch";
     constructor(fetchLibrary?: Fetch);
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;
-    inferResponseType(response: Response): ResponseType;
     convertResponse<T>(context: RequestContext, response: Response & {
         __text?: string;
     }, error?: boolean): Promise<ApiResponse<T>>;

package/cjs/backend/FetchRequestBackend.js

@@ -54,6 +54,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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() {
@@ -64,6 +66,7 @@ var FetchError = /** @class */ (function (_super) {
 var FetchRequestBackend = /** @class */ (function () {
     function FetchRequestBackend(fetchLibrary) {
         this.fetch = Utils_1.getGlobalFetch();
+        this.id = "fetch";
         if (fetchLibrary !== undefined) {
             this.fetch = fetchLibrary;
         }
@@ -80,20 +83,21 @@ var FetchRequestBackend = /** @class */ (function () {
             });
         });
     };
-    FetchRequestBackend.prototype.inferResponseType = function (response) {
-        var contentType = response.headers.get("Content-Type");
-        if (contentType === null || contentType === void 0 ? void 0 : contentType.startsWith("json")) {
-            return "json";
-        }
-        return "text";
-    };
     FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, responseType, _a, error_1, status;
+            var data, inferredResponseType, responseType, _a, error_1, status;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        responseType = error ? this.inferResponseType(response) : context.responseType;
+                        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]);
@@ -147,7 +151,11 @@ var FetchRequestBackend = /** @class */ (function () {
         path += context.computedPath.startsWith("/")
             ? context.computedPath.substring(1)
             : context.computedPath;
-        var url = new URL(path);
+        var origin = undefined;
+        if (typeof window !== "undefined") {
+            origin = window.origin;
+        }
+        var url = new URL(path, origin);
         if (computedConfig.query) {
             var queryKeys = Object.keys(computedConfig.query);
             for (var i = 0; i < queryKeys.length; i++) {

package/cjs/backend/MockRequestBackend.d.ts

@@ -2,6 +2,7 @@ import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./Req
 import { ApiResponse } from "../ApiTypes";
 import RequestContext from "../RequestContext";
 export default class MockRequestBackend implements RequestBackend<ApiResponse> {
+    readonly id = "mock";
     convertResponse<T>(context: RequestContext, response: ApiResponse, error?: boolean): Promise<ApiResponse<T>>;
     extractResponseFromError(error: Error): Promise<ApiResponse | null | undefined>;
     private runRequest;

package/cjs/backend/MockRequestBackend.js

@@ -41,6 +41,7 @@ var Utils_1 = require("../Utils");
 var RequestError_1 = require("../RequestError");
 var MockRequestBackend = /** @class */ (function () {
     function MockRequestBackend() {
+        this.id = "mock";
     }
     MockRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {

package/cjs/backend/RequestBackend.d.ts

@@ -8,6 +8,7 @@ export interface RequestBackendErrorInfo {
     code: string;
 }
 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>>;
     extractResponseFromError(error: Error): Promise<R | null | 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/ApiUtils.d.ts

@@ -1,5 +1,7 @@
 import { AcceptableStatus, ApiResponse, 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

@@ -42,3 +42,11 @@ export var isAcceptableStatus = function (status, acceptableStatus) {
     }
     return (false);
 };
+var JSON_CONTENT_TYPES = ["text/json", "application/json"];
+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";
+    }
+    return "text";
+};

package/esm/RequestError.d.ts

@@ -5,6 +5,7 @@ export declare const RequestErrorCode: {
     readonly REQUEST_NETWORK_ERROR: "request/network-error";
     readonly REQUEST_INVALID_STATUS: "request/invalid-status";
     readonly REQUEST_INVALID_CONFIG: "request/invalid-config";
+    readonly REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type";
 };
 export declare type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
 export interface RequestError extends Error {

package/esm/RequestError.js

@@ -3,6 +3,7 @@ export var RequestErrorCode = {
     REQUEST_NETWORK_ERROR: "request/network-error",
     REQUEST_INVALID_STATUS: "request/invalid-status",
     REQUEST_INVALID_CONFIG: "request/invalid-config",
+    REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type",
 };
 export var isRequestError = function (error) {
     return "isRequestError" in error;

package/esm/UtilTypes.d.ts

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

package/esm/UtilTypes.js

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

package/esm/backend/AxiosRequestBackend.d.ts

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

package/esm/backend/AxiosRequestBackend.js

@@ -34,12 +34,16 @@ 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;
 };
 var AxiosRequestBackend = /** @class */ (function () {
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
     function AxiosRequestBackend(axiosLibrary) {
+        this.id = "axios";
         axios = axiosLibrary;
     }
     AxiosRequestBackend.prototype.extractResponseFromError = function (error) {
@@ -54,7 +58,16 @@ 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];
             });
         });

package/esm/backend/FetchRequestBackend.d.ts

@@ -2,12 +2,11 @@ import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./Req
 import { ApiResponse } from "../ApiTypes";
 import RequestContext from "../RequestContext";
 import { Fetch } from "../Utils";
-import { ResponseType } from "../ApiConstants";
 export default class FetchRequestBackend implements RequestBackend<Response> {
     fetch: (((input: RequestInfo, init?: RequestInit | undefined) => Promise<Response>) & typeof fetch) | undefined;
+    readonly id = "fetch";
     constructor(fetchLibrary?: Fetch);
     extractResponseFromError(error: Error): Promise<Response | null | undefined>;
-    inferResponseType(response: Response): ResponseType;
     convertResponse<T>(context: RequestContext, response: Response & {
         __text?: string;
     }, error?: boolean): Promise<ApiResponse<T>>;

package/esm/backend/FetchRequestBackend.js

@@ -52,6 +52,8 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 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() {
@@ -62,6 +64,7 @@ var FetchError = /** @class */ (function (_super) {
 var FetchRequestBackend = /** @class */ (function () {
     function FetchRequestBackend(fetchLibrary) {
         this.fetch = getGlobalFetch();
+        this.id = "fetch";
         if (fetchLibrary !== undefined) {
             this.fetch = fetchLibrary;
         }
@@ -78,20 +81,21 @@ var FetchRequestBackend = /** @class */ (function () {
             });
         });
     };
-    FetchRequestBackend.prototype.inferResponseType = function (response) {
-        var contentType = response.headers.get("Content-Type");
-        if (contentType === null || contentType === void 0 ? void 0 : contentType.startsWith("json")) {
-            return "json";
-        }
-        return "text";
-    };
     FetchRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, responseType, _a, error_1, status;
+            var data, inferredResponseType, responseType, _a, error_1, status;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        responseType = error ? this.inferResponseType(response) : context.responseType;
+                        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]);
@@ -145,7 +149,11 @@ var FetchRequestBackend = /** @class */ (function () {
         path += context.computedPath.startsWith("/")
             ? context.computedPath.substring(1)
             : context.computedPath;
-        var url = new URL(path);
+        var origin = undefined;
+        if (typeof window !== "undefined") {
+            origin = window.origin;
+        }
+        var url = new URL(path, origin);
         if (computedConfig.query) {
             var queryKeys = Object.keys(computedConfig.query);
             for (var i = 0; i < queryKeys.length; i++) {

package/esm/backend/MockRequestBackend.d.ts

@@ -2,6 +2,7 @@ import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./Req
 import { ApiResponse } from "../ApiTypes";
 import RequestContext from "../RequestContext";
 export default class MockRequestBackend implements RequestBackend<ApiResponse> {
+    readonly id = "mock";
     convertResponse<T>(context: RequestContext, response: ApiResponse, error?: boolean): Promise<ApiResponse<T>>;
     extractResponseFromError(error: Error): Promise<ApiResponse | null | undefined>;
     private runRequest;

package/esm/backend/MockRequestBackend.js

@@ -39,6 +39,7 @@ import { delayThenReturn, randInt } from "../Utils";
 import { convertToRequestError, RequestErrorCode } from "../RequestError";
 var MockRequestBackend = /** @class */ (function () {
     function MockRequestBackend() {
+        this.id = "mock";
     }
     MockRequestBackend.prototype.convertResponse = function (context, response, error) {
         return __awaiter(this, void 0, void 0, function () {

package/esm/backend/RequestBackend.d.ts

@@ -8,6 +8,7 @@ export interface RequestBackendErrorInfo {
     code: string;
 }
 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>>;
     extractResponseFromError(error: Error): Promise<R | null | 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,12 +1,11 @@
 {
   "name": "api-def",
-  "version": "0.5.0",
+  "version": "0.6.0-alpha3",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",
   "sideEffects": false,
-  "type": "module",
   "scripts": {
     "test": "npm run test:types && npm run test:lint && npm run test:unit",
     "test:unit": "cross-env NODE_ENV=test jest",