api-def 0.9.0 → 0.9.2

package/esm/RequestContext.js

@@ -1,170 +1,167 @@
-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";
-let contextIdCounter = 0;
-export default class RequestContext {
-    constructor(backend, host, config, computedPath, mocking) {
-        this.canceler = null;
-        this.response = undefined;
-        this.error = null;
-        this.cacheInfo = { cached: false, source: null };
-        this.cancelled = false;
-        this.backend = backend;
-        this.id = contextIdCounter++;
-        this.host = host;
-        this.computedConfig = config;
-        Utils.assign({}, this.computedConfig.headers);
-        this.computedPath = computedPath;
-        this.computedBaseUrl = host.baseUrl;
-        this.computedMethod = host.method;
-        this.key = this.generateKey();
-        this.stats = {
-            attempt: 0,
-            cached: false,
-        };
-        this.eventHandlers = {};
-        this.mocking = mocking;
-        this.validation = host.validation;
-        this.initMiddleware();
-        this.parseRequestBody();
-        this.computedRequestUrl = this.generateRequestUrl();
-    }
-    get method() {
-        return this.computedMethod;
-    }
-    get api() {
-        return this.host.api;
-    }
-    get baseUrl() {
-        return this.computedBaseUrl;
-    }
-    get responseType() {
-        return this.host.responseType;
-    }
-    initMiddleware() {
-        const { middleware } = this.api;
-        for (let i = 0; i < middleware.length; i++) {
-            const events = middleware[i];
-            const eventTypes = Object.keys(events);
-            for (let n = 0; n < eventTypes.length; n++) {
-                const eventType = eventTypes[n];
-                const eventHandlersForType = this.eventHandlers[eventType] || (this.eventHandlers[eventType] = []);
-                const middlewareEventHandlers = events[eventType];
-                if (middlewareEventHandlers) {
-                    eventHandlersForType.push(middlewareEventHandlers);
-                }
-            }
-        }
-    }
-    generateKey() {
-        let key = this.computedPath.trim();
-        if (this.computedConfig.queryString) {
-            key += "?" + this.computedConfig.queryString;
-        }
-        return key;
-    }
-    updateHeaders(newHeaders) {
-        this.computedConfig.headers = Utils.assign({}, this.computedConfig.headers, newHeaders);
-        this.parseRequestBody();
-        return this;
-    }
-    parseRequestBody() {
-        var _a;
-        if (this.computedConfig.body && this.computedConfig.headers) {
-            const contentTypeKey = Object.keys(this.computedConfig.headers).find(key => key.toLowerCase() === "content-type");
-            const contentType = contentTypeKey && ((_a = this.computedConfig.headers[contentTypeKey]) === null || _a === void 0 ? void 0 : _a.toString().split(";")[0].trim());
-            if (contentType === "application/x-www-form-urlencoded") {
-                const searchParams = new URLSearchParams();
-                for (const key of Object.keys(this.computedConfig.body)) {
-                    const value = this.computedConfig.body[key];
-                    searchParams.append(key, value === null || value === void 0 ? void 0 : value.toString());
-                }
-                this.parsedBody = searchParams;
-            }
-            else {
-                this.parsedBody = this.computedConfig.body;
-            }
-        }
-        else {
-            this.parsedBody = undefined;
-        }
-    }
-    getParsedBody() {
-        return this.parsedBody;
-    }
-    updateQuery(newQuery) {
-        this.computedConfig.queryObject = Utils.assign({}, this.computedConfig.queryObject, newQuery);
-        return this;
-    }
-    triggerEvent(eventType) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const eventHandlers = this.eventHandlers[eventType];
-            if (eventHandlers) {
-                for (let i = 0; i < eventHandlers.length; i++) {
-                    const eventHandler = eventHandlers[i];
-                    // eslint-disable-next-line no-await-in-loop
-                    const eventResult = yield eventHandler(this);
-                    if (eventResult) {
-                        return eventResult;
-                    }
-                }
-            }
-            return undefined;
-        });
-    }
-    addCanceller(canceler) {
-        this.canceler = canceler;
-    }
-    cancel() {
-        this.cancelled = true;
-        if (this.canceler) {
-            this.canceler();
-        }
-    }
-    get requestUrl() {
-        return this.computedRequestUrl;
-    }
-    get path() {
-        return this.computedPath;
-    }
-    updatePath(path) {
-        this.computedPath = path;
-        this.computedRequestUrl = this.generateRequestUrl();
-    }
-    updateBaseUrl(baseUrl) {
-        this.computedBaseUrl = baseUrl;
-        this.computedRequestUrl = this.generateRequestUrl();
-    }
-    updateMethod(method) {
-        this.computedMethod = method;
-    }
-    generateRequestUrl() {
-        let path = !this.baseUrl.endsWith("/")
-            ? this.baseUrl + "/"
-            : this.baseUrl;
-        path += this.computedPath.startsWith("/")
-            ? this.computedPath.substring(1)
-            : this.computedPath;
-        let origin = undefined;
-        if (typeof window !== "undefined") {
-            origin = window.origin;
-        }
-        if (!origin) {
-            if (path.indexOf("://") === -1) {
-                path = `https://${path}`;
-            }
-        }
-        const url = new URL(path, origin);
-        if (this.computedConfig.queryString) {
-            url.search = this.computedConfig.queryString;
-        }
-        return url;
-    }
-}
+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";
+let contextIdCounter = 0;
+export default class RequestContext {
+    constructor(backend, host, config, computedPath, mocking) {
+        this.canceler = null;
+        this.response = undefined;
+        this.error = null;
+        this.cacheInfo = { cached: false, source: null };
+        this.cancelled = false;
+        this.backend = backend;
+        this.id = contextIdCounter++;
+        this.host = host;
+        this.computedConfig = config;
+        Utils.assign({}, this.computedConfig.headers);
+        this.computedPath = computedPath;
+        this.computedBaseUrl = host.baseUrl;
+        this.computedMethod = host.method;
+        this.key = this.generateKey();
+        this.stats = {
+            attempt: 0,
+            cached: false,
+        };
+        this.eventHandlers = {};
+        this.mocking = mocking;
+        this.validation = host.validation;
+        this.initMiddleware();
+        this.parseRequestBody();
+        this.computedRequestUrl = this.generateRequestUrl();
+    }
+    get method() {
+        return this.computedMethod;
+    }
+    get api() {
+        return this.host.api;
+    }
+    get baseUrl() {
+        return this.computedBaseUrl;
+    }
+    get responseType() {
+        return this.host.responseType;
+    }
+    initMiddleware() {
+        const { middleware } = this.api;
+        for (let i = 0; i < middleware.length; i++) {
+            const events = middleware[i];
+            const eventTypes = Object.keys(events);
+            for (let n = 0; n < eventTypes.length; n++) {
+                const eventType = eventTypes[n];
+                const eventHandlersForType = this.eventHandlers[eventType] || (this.eventHandlers[eventType] = []);
+                const middlewareEventHandlers = events[eventType];
+                if (middlewareEventHandlers) {
+                    eventHandlersForType.push(middlewareEventHandlers);
+                }
+            }
+        }
+    }
+    generateKey() {
+        let key = this.computedPath.trim();
+        if (this.computedConfig.queryString) {
+            key += `?${this.computedConfig.queryString}`;
+        }
+        return key;
+    }
+    updateHeaders(newHeaders) {
+        this.computedConfig.headers = Utils.assign({}, this.computedConfig.headers, newHeaders);
+        this.parseRequestBody();
+        return this;
+    }
+    parseRequestBody() {
+        var _a;
+        if (this.computedConfig.body && this.computedConfig.headers) {
+            const contentTypeKey = Object.keys(this.computedConfig.headers).find((key) => key.toLowerCase() === "content-type");
+            const contentType = contentTypeKey && ((_a = this.computedConfig.headers[contentTypeKey]) === null || _a === void 0 ? void 0 : _a.toString().split(";")[0].trim());
+            if (contentType === "application/x-www-form-urlencoded") {
+                const searchParams = new URLSearchParams();
+                for (const key of Object.keys(this.computedConfig.body)) {
+                    const value = this.computedConfig.body[key];
+                    searchParams.append(key, value === null || value === void 0 ? void 0 : value.toString());
+                }
+                this.parsedBody = searchParams;
+            }
+            else {
+                this.parsedBody = this.computedConfig.body;
+            }
+        }
+        else {
+            this.parsedBody = undefined;
+        }
+    }
+    getParsedBody() {
+        return this.parsedBody;
+    }
+    updateQuery(newQuery) {
+        this.computedConfig.queryObject = Utils.assign({}, this.computedConfig.queryObject, newQuery);
+        this.computedRequestUrl = this.generateRequestUrl();
+        return this;
+    }
+    triggerEvent(eventType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventHandlers = this.eventHandlers[eventType];
+            if (eventHandlers) {
+                for (let i = 0; i < eventHandlers.length; i++) {
+                    const eventHandler = eventHandlers[i];
+                    // eslint-disable-next-line no-await-in-loop
+                    const eventResult = yield eventHandler(this);
+                    if (eventResult) {
+                        return eventResult;
+                    }
+                }
+            }
+            return undefined;
+        });
+    }
+    addCanceller(canceler) {
+        this.canceler = canceler;
+    }
+    cancel() {
+        this.cancelled = true;
+        if (this.canceler) {
+            this.canceler();
+        }
+    }
+    get requestUrl() {
+        return this.computedRequestUrl;
+    }
+    get path() {
+        return this.computedPath;
+    }
+    updatePath(path) {
+        this.computedPath = path;
+        this.computedRequestUrl = this.generateRequestUrl();
+    }
+    updateBaseUrl(baseUrl) {
+        this.computedBaseUrl = baseUrl;
+        this.computedRequestUrl = this.generateRequestUrl();
+    }
+    updateMethod(method) {
+        this.computedMethod = method;
+    }
+    generateRequestUrl() {
+        let path = !this.baseUrl.endsWith("/") ? `${this.baseUrl}/` : this.baseUrl;
+        path += this.computedPath.startsWith("/") ? this.computedPath.substring(1) : this.computedPath;
+        let origin = undefined;
+        if (typeof window !== "undefined") {
+            origin = window.origin;
+        }
+        if (!origin) {
+            if (path.indexOf("://") === -1) {
+                path = `https://${path}`;
+            }
+        }
+        const url = new URL(path, origin);
+        if (this.computedConfig.queryString) {
+            url.search = this.computedConfig.queryString;
+        }
+        return url;
+    }
+}

package/esm/RequestError.d.ts

@@ -1,30 +1,30 @@
-import { ApiResponse } from "./ApiTypes";
-import { EnumOf } from "./Utils";
-import RequestContext from "./RequestContext";
-export declare const RequestErrorCode: {
-    readonly MISC_UNKNOWN_ERROR: "misc/unknown-error";
-    readonly REQUEST_NETWORK_ERROR: "request/network-error";
-    readonly REQUEST_HOST_NAME_NOT_FOUND: "request/host-name-not-found";
-    readonly REQUEST_INVALID_STATUS: "request/invalid-status";
-    readonly REQUEST_INVALID_CONFIG: "request/invalid-config";
-    readonly REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type";
-    readonly VALIDATION_QUERY_VALIDATE_ERROR: "validation/query-validate-error";
-    readonly VALIDATION_PARAMS_VALIDATE_ERROR: "validation/params-validate-error";
-    readonly VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error";
-    readonly VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error";
-};
-export declare type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
-export interface RequestError extends Error {
-    isRequestError: true;
-    response: ApiResponse | undefined | null;
-    code: string;
-    attempts: number;
-}
-export declare const isRequestError: (error: Error) => error is RequestError;
-export interface RequestErrorConfig {
-    error: Error;
-    code: string;
-    context: RequestContext;
-    response?: ApiResponse | null;
-}
-export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;
+import { ApiResponse } from "./ApiTypes";
+import RequestContext from "./RequestContext";
+import { EnumOf } from "./Utils";
+export declare const RequestErrorCode: {
+    readonly MISC_UNKNOWN_ERROR: "misc/unknown-error";
+    readonly REQUEST_NETWORK_ERROR: "request/network-error";
+    readonly REQUEST_HOST_NAME_NOT_FOUND: "request/host-name-not-found";
+    readonly REQUEST_INVALID_STATUS: "request/invalid-status";
+    readonly REQUEST_INVALID_CONFIG: "request/invalid-config";
+    readonly REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type";
+    readonly VALIDATION_QUERY_VALIDATE_ERROR: "validation/query-validate-error";
+    readonly VALIDATION_PARAMS_VALIDATE_ERROR: "validation/params-validate-error";
+    readonly VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error";
+    readonly VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error";
+};
+export type RequestErrorCode = EnumOf<typeof RequestErrorCode>;
+export interface RequestError extends Error {
+    isRequestError: true;
+    response: ApiResponse | undefined | null;
+    code: string;
+    attempts: number;
+}
+export declare const isRequestError: (error: Error) => error is RequestError;
+export interface RequestErrorConfig {
+    error: Error;
+    code: string;
+    context: RequestContext;
+    response?: ApiResponse | null;
+}
+export declare const convertToRequestError: (config: RequestErrorConfig) => RequestError;

package/esm/RequestError.js

@@ -1,42 +1,42 @@
-export const RequestErrorCode = {
-    MISC_UNKNOWN_ERROR: "misc/unknown-error",
-    REQUEST_NETWORK_ERROR: "request/network-error",
-    REQUEST_HOST_NAME_NOT_FOUND: "request/host-name-not-found",
-    REQUEST_INVALID_STATUS: "request/invalid-status",
-    REQUEST_INVALID_CONFIG: "request/invalid-config",
-    REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type",
-    VALIDATION_QUERY_VALIDATE_ERROR: "validation/query-validate-error",
-    VALIDATION_PARAMS_VALIDATE_ERROR: "validation/params-validate-error",
-    VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error",
-    VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error",
-};
-export const isRequestError = (error) => {
-    return "isRequestError" in error;
-};
-export const convertToRequestError = (config) => {
-    const { error, context, response, code } = config;
-    const body = context.getParsedBody();
-    const resultError = Object.assign(error, {
-        name: "RequestError",
-        response: response,
-        code: code,
-        isRequestError: true,
-        attempts: context.stats.attempt,
-        request: {
-            url: context.requestUrl.href,
-            query: context.computedConfig.queryObject,
-            headers: context.computedConfig.headers,
-            body: body,
-        },
-    });
-    try {
-        Object.defineProperty(resultError, "message", { value: `Request failed${(response === null || response === void 0 ? void 0 : response.status) ? ` with status code ${response.status}` : ""} (${code})` });
-    }
-    catch (e) {
-        // ignore
-    }
-    delete resultError.config;
-    delete resultError.toJSON;
-    Object.setPrototypeOf(error, Error);
-    return resultError;
-};
+export const RequestErrorCode = {
+    MISC_UNKNOWN_ERROR: "misc/unknown-error",
+    REQUEST_NETWORK_ERROR: "request/network-error",
+    REQUEST_HOST_NAME_NOT_FOUND: "request/host-name-not-found",
+    REQUEST_INVALID_STATUS: "request/invalid-status",
+    REQUEST_INVALID_CONFIG: "request/invalid-config",
+    REQUEST_MISMATCH_RESPONSE_TYPE: "request/mismatch-response-type",
+    VALIDATION_QUERY_VALIDATE_ERROR: "validation/query-validate-error",
+    VALIDATION_PARAMS_VALIDATE_ERROR: "validation/params-validate-error",
+    VALIDATION_BODY_VALIDATE_ERROR: "validation/body-validate-error",
+    VALIDATION_RESPONSE_VALIDATE_ERROR: "validation/response-validate-error",
+};
+export const isRequestError = (error) => {
+    return "isRequestError" in error;
+};
+export const convertToRequestError = (config) => {
+    const { error, context, response, code } = config;
+    const body = context.getParsedBody();
+    const resultError = Object.assign(error, {
+        name: "RequestError",
+        response: response,
+        code: code,
+        isRequestError: true,
+        attempts: context.stats.attempt,
+        request: {
+            url: context.requestUrl.href,
+            query: context.computedConfig.queryObject,
+            headers: context.computedConfig.headers,
+            body: body,
+        },
+    });
+    try {
+        Object.defineProperty(resultError, "message", { value: `Request failed${(response === null || response === void 0 ? void 0 : response.status) ? ` with status code ${response.status}` : ""} [${code}]: ${resultError.message}` });
+    }
+    catch (e) {
+        // ignore
+    }
+    resultError.config = undefined;
+    resultError.toJSON = undefined;
+    Object.setPrototypeOf(error, Error);
+    return resultError;
+};

package/esm/Requester.d.ts

@@ -1,3 +1,3 @@
-import { ApiResponse, Body, Query, RequestConfig, RequestHost } from "./ApiTypes";
-import { EndpointMockingConfig } from "./MockingTypes";
-export declare const submit: <R, P extends string | undefined, Q extends Query, B extends Body | undefined>(host: RequestHost, config: RequestConfig<P, Q, B>, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined) => Promise<ApiResponse<R>>;
+import { ApiResponse, Body, Query, RequestConfig, RequestHost } from "./ApiTypes";
+import { EndpointMockingConfig } from "./MockingTypes";
+export declare const submit: <R, P extends string | undefined, Q extends Query, B extends Body | undefined>(host: RequestHost, config: RequestConfig<P, Q, B>, mocking: EndpointMockingConfig<R, P, Q, B> | null | undefined) => Promise<ApiResponse<R>>;