api-def 0.9.0 → 0.9.2

package/cjs/backend/FetchRequestBackend.js

@@ -1,197 +1,202 @@
-"use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-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());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var Utils = require("../Utils");
-var Utils_1 = require("../Utils");
-var ApiUtils_1 = require("../ApiUtils");
-var FetchError = /** @class */ (function (_super) {
-    __extends(FetchError, _super);
-    function FetchError() {
-        return _super !== null && _super.apply(this, arguments) || this;
-    }
-    return FetchError;
-}(Error));
-var FetchRequestBackend = /** @class */ (function () {
-    function FetchRequestBackend(fetchLibrary) {
-        this.fetch = (0, Utils_1.getGlobalFetch)();
-        this.id = "fetch";
-        if (fetchLibrary !== undefined) {
-            this.fetch = fetchLibrary;
-            // otherwise window throws illegal invocation
-            if (fetchLibrary === (0, Utils_1.getGlobalFetch)()) {
-                this.fetch = fetchLibrary.bind((0, Utils_1.getGlobal)());
-            }
-        }
-    }
-    FetchRequestBackend.prototype.extractResponseFromError = function (error) {
-        return __awaiter(this, void 0, void 0, function () {
-            var fetchError;
-            return __generator(this, function (_a) {
-                if ("response" in error) {
-                    fetchError = error;
-                    return [2 /*return*/, fetchError.response ? fetchError.response : null];
-                }
-                return [2 /*return*/, undefined];
-            });
-        });
-    };
-    FetchRequestBackend.prototype.convertResponse = function (context, response) {
-        return __awaiter(this, void 0, void 0, function () {
-            var contentType, responseType, _a, data, status, headers, error_1, processedHeaders;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        contentType = response.headers.get("Content-Type");
-                        responseType = (0, ApiUtils_1.inferResponseType)(contentType);
-                        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:
-                        data = response.__text;
-                        status = response.status, headers = response.headers;
-                        _b.label = 3;
-                    case 3:
-                        _b.trys.push([3, 7, , 8]);
-                        if (!(responseType === "arraybuffer")) return [3 /*break*/, 5];
-                        return [4 /*yield*/, response.clone().arrayBuffer()];
-                    case 4:
-                        data = _b.sent();
-                        return [3 /*break*/, 6];
-                    case 5:
-                        if (responseType === "json") {
-                            data = JSON.parse(response.__text);
-                        }
-                        _b.label = 6;
-                    case 6: return [3 /*break*/, 8];
-                    case 7:
-                        error_1 = _b.sent();
-                        throw Object.assign(new Error("[api-def] Invalid '".concat(context.responseType, "' response, got: '").concat(response.__text, "'")), {
-                            response: response,
-                        });
-                    case 8:
-                        processedHeaders = {};
-                        headers.forEach(function (value, key) {
-                            processedHeaders[key] = value;
-                        });
-                        return [2 /*return*/, {
-                                __lowercaseHeaders: processedHeaders,
-                                method: context.method,
-                                url: response.url,
-                                data: data,
-                                status: status,
-                                headers: processedHeaders,
-                            }];
-                }
-            });
-        });
-    };
-    FetchRequestBackend.prototype.makeRequest = function (context) {
-        if (!this.fetch) {
-            throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
-        }
-        var computedConfig = context.computedConfig;
-        // abort controller is a newer feature than fetch
-        var abortController = AbortController && new AbortController();
-        var abortSignal = abortController ? abortController.signal : undefined;
-        var softAbort = false;
-        var responded = false;
-        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",
-        }, computedConfig.headers);
-        var parsedHeaders = Object.keys(headers).reduce(function (parsedHeaders, key) {
-            var value = headers[key];
-            if (value !== undefined) {
-                parsedHeaders[key] = value;
-            }
-            return parsedHeaders;
-        }, {});
-        var url = context.requestUrl;
-        var promise = this.fetch(url.href, {
-            method: context.method.toUpperCase(),
-            body: bodyJsonify ? JSON.stringify(body) : body,
-            headers: parsedHeaders,
-            mode: "cors",
-            signal: abortSignal,
-        }).then(function (response) {
-            responded = true;
-            if (!response.ok) {
-                var 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
-                ? function () { return !responded && abortController.abort(); }
-                : function () {
-                    softAbort = true;
-                },
-        };
-    };
-    FetchRequestBackend.prototype.getErrorInfo = function (error, response) {
-        return undefined;
-    };
-    return FetchRequestBackend;
-}());
-exports.default = FetchRequestBackend;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+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());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ApiUtils_1 = require("../ApiUtils");
+var RequestError_1 = require("../RequestError");
+var Utils = require("../Utils");
+var Utils_1 = require("../Utils");
+var FetchError = /** @class */ (function (_super) {
+    __extends(FetchError, _super);
+    function FetchError() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return FetchError;
+}(Error));
+var FetchRequestBackend = /** @class */ (function () {
+    function FetchRequestBackend(fetchLibrary) {
+        this.fetch = (0, Utils_1.getGlobalFetch)();
+        this.id = "fetch";
+        if (fetchLibrary !== undefined) {
+            this.fetch = fetchLibrary;
+            // otherwise window throws illegal invocation
+            if (fetchLibrary === (0, Utils_1.getGlobalFetch)()) {
+                this.fetch = fetchLibrary.bind((0, Utils_1.getGlobal)());
+            }
+        }
+    }
+    FetchRequestBackend.prototype.extractResponseFromError = function (error) {
+        return __awaiter(this, void 0, void 0, function () {
+            var fetchError;
+            return __generator(this, function (_a) {
+                if ("response" in error) {
+                    fetchError = error;
+                    return [2 /*return*/, fetchError.response ? fetchError.response : null];
+                }
+                return [2 /*return*/, undefined];
+            });
+        });
+    };
+    FetchRequestBackend.prototype.convertResponse = function (context, response) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var status, headers, processedHeaders, convertedResponse, responseType, text, data, error_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        status = response.status, headers = response.headers;
+                        processedHeaders = {};
+                        headers.forEach(function (value, key) {
+                            processedHeaders[key] = value;
+                        });
+                        convertedResponse = {
+                            __lowercaseHeaders: processedHeaders,
+                            method: context.method,
+                            url: response.url,
+                            data: undefined,
+                            status: status,
+                            headers: processedHeaders,
+                        };
+                        responseType = (_a = context.responseType) !== null && _a !== void 0 ? _a : (0, ApiUtils_1.inferResponseType)(response.headers.get("Content-Type"));
+                        _b.label = 1;
+                    case 1:
+                        _b.trys.push([1, 7, , 8]);
+                        if (!(responseType === "arraybuffer")) return [3 /*break*/, 3];
+                        return [4 /*yield*/, response.arrayBuffer()];
+                    case 2:
+                        data = _b.sent();
+                        return [3 /*break*/, 6];
+                    case 3:
+                        if (!(responseType === "json")) return [3 /*break*/, 5];
+                        return [4 /*yield*/, response.text()];
+                    case 4:
+                        text = _b.sent();
+                        data = JSON.parse(text);
+                        return [3 /*break*/, 6];
+                    case 5:
+                        data = response.text();
+                        _b.label = 6;
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
+                        error_1 = _b.sent();
+                        throw (0, RequestError_1.convertToRequestError)({
+                            error: Object.assign(new Error("[api-def] Failed to parse response as '".concat(responseType, "'").concat(text ? ", got: ".concat(text) : "")), {
+                                cause: error_1,
+                            }),
+                            code: RequestError_1.RequestErrorCode.REQUEST_MISMATCH_RESPONSE_TYPE,
+                            context: context,
+                            response: convertedResponse,
+                        });
+                    case 8:
+                        convertedResponse.data = data;
+                        return [2 /*return*/, convertedResponse];
+                }
+            });
+        });
+    };
+    FetchRequestBackend.prototype.makeRequest = function (context) {
+        if (!this.fetch) {
+            throw new Error("[api-def] No fetch impl was provided to FetchRequestBackend");
+        }
+        var computedConfig = context.computedConfig;
+        // abort controller is a newer feature than fetch
+        var abortController = AbortController && new AbortController();
+        var abortSignal = abortController ? abortController.signal : undefined;
+        var softAbort = false;
+        var responded = false;
+        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",
+        }, computedConfig.headers);
+        var parsedHeaders = Object.keys(headers).reduce(function (parsedHeaders, key) {
+            var value = headers[key];
+            if (value !== undefined) {
+                parsedHeaders[key] = value;
+            }
+            return parsedHeaders;
+        }, {});
+        var url = context.requestUrl;
+        var promise = this.fetch(url.href, {
+            method: context.method.toUpperCase(),
+            body: bodyJsonify ? JSON.stringify(body) : body,
+            headers: parsedHeaders,
+            mode: "cors",
+            signal: abortSignal,
+        }).then(function (response) {
+            responded = true;
+            if (!response.ok) {
+                var 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
+                ? function () { return !responded && abortController.abort(); }
+                : function () {
+                    softAbort = true;
+                },
+        };
+    };
+    FetchRequestBackend.prototype.getErrorInfo = function (error, response) {
+        return undefined;
+    };
+    return FetchRequestBackend;
+}());
+exports.default = FetchRequestBackend;

package/cjs/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;
+}