api-def 0.9.0 → 0.9.2

package/esm/backend/AxiosRequestBackend.js

@@ -1,62 +1,62 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-let axios;
-export const isAxiosError = (error) => {
-    return "isAxiosError" in error;
-};
-export default class AxiosRequestBackend {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    constructor(axiosLibrary) {
-        this.id = "axios";
-        axios = axiosLibrary;
-    }
-    extractResponseFromError(error) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (isAxiosError(error)) {
-                return error.response ? error.response : null;
-            }
-            return undefined;
-        });
-    }
-    convertResponse(context, response) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return {
-                method: context.method,
-                url: response.request.res.responseUrl,
-                data: response.data,
-                headers: response.headers,
-                status: response.status,
-                __lowercaseHeaders: response._lowerCaseResponseHeaders,
-            };
-        });
-    }
-    makeRequest(context) {
-        const { computedConfig } = context;
-        const url = context.requestUrl;
-        let canceler = null;
-        const promise = axios({
-            method: context.method,
-            url: url.href,
-            data: context.getParsedBody(),
-            headers: computedConfig.headers || {},
-            responseType: context.responseType,
-            cancelToken: new axios.CancelToken((cancellerFunc) => {
-                canceler = cancellerFunc;
-            }),
-        });
-        return {
-            promise: promise,
-            canceler: () => canceler && canceler(),
-        };
-    }
-    getErrorInfo(error, response) {
-        return undefined;
-    }
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+let axios;
+export const isAxiosError = (error) => {
+    return "isAxiosError" in error;
+};
+export default class AxiosRequestBackend {
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    constructor(axiosLibrary) {
+        this.id = "axios";
+        axios = axiosLibrary;
+    }
+    extractResponseFromError(error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (isAxiosError(error)) {
+                return error.response ? error.response : null;
+            }
+            return undefined;
+        });
+    }
+    convertResponse(context, response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                method: context.method,
+                url: response.request.res.responseUrl,
+                data: response.data,
+                headers: response.headers,
+                status: response.status,
+                __lowercaseHeaders: response._lowerCaseResponseHeaders,
+            };
+        });
+    }
+    makeRequest(context) {
+        const { computedConfig } = context;
+        const url = context.requestUrl;
+        let canceler = null;
+        const promise = axios({
+            method: context.method,
+            url: url.href,
+            data: context.getParsedBody(),
+            headers: computedConfig.headers || {},
+            responseType: context.responseType,
+            cancelToken: new axios.CancelToken((cancellerFunc) => {
+                canceler = cancellerFunc;
+            }),
+        });
+        return {
+            promise: promise,
+            canceler: () => canceler === null || canceler === void 0 ? void 0 : canceler(),
+        };
+    }
+    getErrorInfo(error, response) {
+        return undefined;
+    }
+}

package/esm/backend/FetchRequestBackend.d.ts

@@ -1,15 +1,15 @@
-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 | 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;
-    }): Promise<ConvertedApiResponse<T>>;
-    makeRequest(context: RequestContext): RequestOperation<Response>;
-    getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
-}
+import { ApiResponse } from "../ApiTypes";
+import RequestContext from "../RequestContext";
+import { Fetch } from "../Utils";
+import RequestBackend, { ConvertedApiResponse, RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
+export default class FetchRequestBackend implements RequestBackend<Response> {
+    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;
+    }): Promise<ConvertedApiResponse<T>>;
+    makeRequest(context: RequestContext): RequestOperation<Response>;
+    getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
+}

package/esm/backend/FetchRequestBackend.js

@@ -1,126 +1,136 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import * as Utils from "../Utils";
-import { getGlobal, getGlobalFetch } from "../Utils";
-import { inferResponseType } from "../ApiUtils";
-class FetchError extends Error {
-}
-export default class FetchRequestBackend {
-    constructor(fetchLibrary) {
-        this.fetch = getGlobalFetch();
-        this.id = "fetch";
-        if (fetchLibrary !== undefined) {
-            this.fetch = fetchLibrary;
-            // otherwise window throws illegal invocation
-            if (fetchLibrary === getGlobalFetch()) {
-                this.fetch = fetchLibrary.bind(getGlobal());
-            }
-        }
-    }
-    extractResponseFromError(error) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if ("response" in error) {
-                const fetchError = error;
-                return fetchError.response ? fetchError.response : null;
-            }
-            return undefined;
-        });
-    }
-    convertResponse(context, response) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const contentType = response.headers.get("Content-Type");
-            const responseType = inferResponseType(contentType);
-            if (!response.__text) {
-                response.__text = yield response.clone().text();
-            }
-            let data = response.__text;
-            const { status, headers } = response;
-            try {
-                if (responseType === "arraybuffer") {
-                    data = yield response.clone().arrayBuffer();
-                }
-                else if (responseType === "json") {
-                    data = JSON.parse(response.__text);
-                }
-            }
-            catch (error) {
-                throw Object.assign(new Error(`[api-def] Invalid '${context.responseType}' response, got: '${response.__text}'`), {
-                    response,
-                });
-            }
-            const processedHeaders = {};
-            headers.forEach((value, key) => {
-                processedHeaders[key] = value;
-            });
-            return {
-                __lowercaseHeaders: processedHeaders,
-                method: context.method,
-                url: response.url,
-                data: data,
-                status: status,
-                headers: processedHeaders,
-            };
-        });
-    }
-    makeRequest(context) {
-        if (!this.fetch) {
-            throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
-        }
-        const { computedConfig } = context;
-        // abort controller is a newer feature than fetch
-        const abortController = AbortController && new AbortController();
-        const abortSignal = abortController ? abortController.signal : undefined;
-        let softAbort = false;
-        let responded = false;
-        const body = context.getParsedBody();
-        const bodyJsonify = body !== null && typeof body === "object";
-        const headers = Utils.assign({
-            // logic from axios
-            "Content-Type": bodyJsonify ? "application/json;charset=utf-8" : "application/x-www-form-urlencoded",
-        }, computedConfig.headers);
-        const parsedHeaders = Object.keys(headers).reduce((parsedHeaders, key) => {
-            const value = headers[key];
-            if (value !== undefined) {
-                parsedHeaders[key] = value;
-            }
-            return parsedHeaders;
-        }, {});
-        const url = context.requestUrl;
-        const promise = this.fetch(url.href, {
-            method: context.method.toUpperCase(),
-            body: bodyJsonify ? JSON.stringify(body) : body,
-            headers: parsedHeaders,
-            mode: "cors",
-            signal: abortSignal,
-        }).then((response) => {
-            responded = true;
-            if (!response.ok) {
-                const error = new FetchError("Fetch failed");
-                error.response = response;
-                throw error;
-            }
-            if (softAbort) {
-                throw new Error("[api-def] Request was aborted");
-            }
-            return response;
-        });
-        return {
-            promise: promise,
-            canceler: abortSignal
-                ? () => !responded && abortController.abort()
-                : () => {
-                    softAbort = true;
-                },
-        };
-    }
-    getErrorInfo(error, response) {
-        return undefined;
-    }
-}
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { inferResponseType } from "../ApiUtils";
+import { RequestErrorCode, convertToRequestError } from "../RequestError";
+import * as Utils from "../Utils";
+import { getGlobal, getGlobalFetch } from "../Utils";
+class FetchError extends Error {
+}
+export default class FetchRequestBackend {
+    constructor(fetchLibrary) {
+        this.fetch = getGlobalFetch();
+        this.id = "fetch";
+        if (fetchLibrary !== undefined) {
+            this.fetch = fetchLibrary;
+            // otherwise window throws illegal invocation
+            if (fetchLibrary === getGlobalFetch()) {
+                this.fetch = fetchLibrary.bind(getGlobal());
+            }
+        }
+    }
+    extractResponseFromError(error) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if ("response" in error) {
+                const fetchError = error;
+                return fetchError.response ? fetchError.response : null;
+            }
+            return undefined;
+        });
+    }
+    convertResponse(context, response) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const { status, headers } = response;
+            const processedHeaders = {};
+            headers.forEach((value, key) => {
+                processedHeaders[key] = value;
+            });
+            const convertedResponse = {
+                __lowercaseHeaders: processedHeaders,
+                method: context.method,
+                url: response.url,
+                data: undefined,
+                status: status,
+                headers: processedHeaders,
+            };
+            const responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : inferResponseType(response.headers.get("Content-Type"));
+            let text;
+            let data;
+            try {
+                if (responseType === "arraybuffer") {
+                    data = yield response.arrayBuffer();
+                }
+                else if (responseType === "json") {
+                    text = yield response.text();
+                    data = JSON.parse(text);
+                }
+                else {
+                    data = response.text();
+                }
+            }
+            catch (error) {
+                throw convertToRequestError({
+                    error: Object.assign(new Error(`[api-def] Failed to parse response as '${responseType}'${text ? `, got: ${text}` : ""}`), {
+                        cause: error,
+                    }),
+                    code: RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                    context: context,
+                    response: convertedResponse,
+                });
+            }
+            convertedResponse.data = data;
+            return convertedResponse;
+        });
+    }
+    makeRequest(context) {
+        if (!this.fetch) {
+            throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
+        }
+        const { computedConfig } = context;
+        // abort controller is a newer feature than fetch
+        const abortController = AbortController && new AbortController();
+        const abortSignal = abortController ? abortController.signal : undefined;
+        let softAbort = false;
+        let responded = false;
+        const body = context.getParsedBody();
+        const bodyJsonify = body !== null && typeof body === "object";
+        const headers = Utils.assign({
+            // logic from axios
+            "Content-Type": bodyJsonify ? "application/json;charset=utf-8" : "application/x-www-form-urlencoded",
+        }, computedConfig.headers);
+        const parsedHeaders = Object.keys(headers).reduce((parsedHeaders, key) => {
+            const value = headers[key];
+            if (value !== undefined) {
+                parsedHeaders[key] = value;
+            }
+            return parsedHeaders;
+        }, {});
+        const url = context.requestUrl;
+        const promise = this.fetch(url.href, {
+            method: context.method.toUpperCase(),
+            body: bodyJsonify ? JSON.stringify(body) : body,
+            headers: parsedHeaders,
+            mode: "cors",
+            signal: abortSignal,
+        }).then((response) => {
+            responded = true;
+            if (!response.ok) {
+                const error = new FetchError("Fetch failed");
+                error.response = response;
+                throw error;
+            }
+            if (softAbort) {
+                throw new Error("[api-def] Request was aborted");
+            }
+            return response;
+        });
+        return {
+            promise: promise,
+            canceler: abortSignal
+                ? () => !responded && abortController.abort()
+                : () => {
+                    softAbort = true;
+                },
+        };
+    }
+    getErrorInfo(error, response) {
+        return undefined;
+    }
+}

package/esm/backend/MockRequestBackend.d.ts

@@ -1,11 +1,11 @@
-import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
-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;
-    makeRequest(context: RequestContext): RequestOperation<ApiResponse>;
-    getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
-}
+import { ApiResponse } from "../ApiTypes";
+import RequestContext from "../RequestContext";
+import RequestBackend, { RequestBackendErrorInfo, RequestOperation } from "./RequestBackend";
+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;
+    makeRequest(context: RequestContext): RequestOperation<ApiResponse>;
+    getErrorInfo(error: Error, response: ApiResponse | undefined | null): RequestBackendErrorInfo | undefined;
+}