api-def 0.8.0 → 0.8.2

package/cjs/Api.d.ts

@@ -12,6 +12,7 @@ export interface ApiInfo {
     readonly middleware?: RequestMiddleware[];
     readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
     readonly mocking?: ApiMockingConfig;
+    readonly requestBackend?: RequestBackend;
 }
 export declare class Api implements ApiInfo {
     readonly baseUrl: string;
@@ -19,9 +20,11 @@ export declare class Api implements ApiInfo {
     readonly middleware: RequestMiddleware[];
     readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
     readonly mocking?: ApiMockingConfig;
+    readonly requestBackend: RequestBackend;
     protected readonly endpoints: Record<string, Endpoint>;
     constructor(info: ApiInfo);
     endpoint(): EndpointBuilder;
+    getRequestBackend(): RequestBackend;
     getConfig(): BaseRequestConfig;
     private hotRequest;
     get: <R = unknown>(path: string, config: RequestConfig) => Promise<ApiResponse<R>>;

package/cjs/Api.js

@@ -83,12 +83,16 @@ var HotRequestHost = /** @class */ (function () {
     HotRequestHost.prototype.computePath = function (path, config) {
         return path.startsWith("/") ? path : "/".concat(path);
     };
+    HotRequestHost.prototype.getRequestBackend = function () {
+        return this.api.getRequestBackend();
+    };
     return HotRequestHost;
 }());
+var defaultBackendMessageShown = false;
 var Api = /** @class */ (function () {
     function Api(info) {
         var _this = this;
-        var _a;
+        var _a, _b;
         this.endpoints = {};
         this.hotRequest = function (requestMethod) { return function (path, config) { return __awaiter(_this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -109,10 +113,27 @@ var Api = /** @class */ (function () {
         this.endpoints = {};
         this.config = info.config;
         this.mocking = (_a = info.mocking) !== null && _a !== void 0 ? _a : undefined;
+        var requestBackend = (_b = info.requestBackend) !== null && _b !== void 0 ? _b : (0, exports.getRequestBackend)();
+        if (!requestBackend) {
+            throw new Error("[api-def] No request backend provided in either Api options or globally, use `setRequestBackend()` to set one or pass one via `requestBackend`");
+        }
+        this.requestBackend = requestBackend;
+        if (!info.requestBackend) {
+            if (process.env.NODE_ENV === "development") {
+                if ((0, exports.isRequestBackendDefault)() && !defaultBackendMessageShown) {
+                    defaultBackendMessageShown = true;
+                    // eslint-disable-next-line
+                    console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
+                }
+            }
+        }
     }
     Api.prototype.endpoint = function () {
         return new EndpointBuilder_1.default(this);
     };
+    Api.prototype.getRequestBackend = function () {
+        return this.requestBackend;
+    };
     Api.prototype.getConfig = function () {
         return ((typeof this.config === "function" ? this.config() : this.config) ||
             {});

package/cjs/ApiTypes.d.ts

@@ -1,6 +1,7 @@
 import RequestContext from "./RequestContext";
 import { Api } from "./Api";
 import { CacheSource, EventResultType, RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
+import RequestBackend from "./backend/RequestBackend";
 export declare type AcceptableStatus = number | [min: number, max: number];
 export declare type Headers = Record<string, string | number | boolean | null | undefined>;
 export declare type Params = string;
@@ -82,6 +83,7 @@ export interface RequestHost {
     readonly responseType: ResponseType | undefined;
     computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
     computePath(path: string, config: RequestConfig): string;
+    getRequestBackend(): RequestBackend;
 }
 export interface CancelledRequestError extends Error {
     isCancelledRequest: true;

package/cjs/Endpoint.d.ts

@@ -2,6 +2,7 @@ import { Api } from "./Api";
 import { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost } from "./ApiTypes";
 import * as Mocking from "./MockingTypes";
 import { RequestMethod, ResponseType } from "./ApiConstants";
+import RequestBackend from "./backend/RequestBackend";
 export interface EndpointConfig<R, P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined> {
     readonly id: string;
     readonly method: RequestMethod;
@@ -44,4 +45,5 @@ export default class Endpoint<R = any, P extends Params | undefined = Params | u
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
     computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    getRequestBackend(): RequestBackend;
 }

package/cjs/Endpoint.js

@@ -37,8 +37,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var Requester = require("./Requester");
-var ApiTypes_1 = require("./ApiTypes");
-var Utils = require("./Utils");
 var RequestConfig_1 = require("./RequestConfig");
 var Endpoint = /** @class */ (function () {
     function Endpoint(api, info) {
@@ -94,18 +92,15 @@ var Endpoint = /** @class */ (function () {
         configurable: true
     });
     Endpoint.prototype.computeConfig = function (config) {
-        var _a;
         var apiDefaults = this.api.getConfig();
-        var computedConfig = Utils.assign((_a = {},
-            _a[ApiTypes_1.COMPUTED_CONFIG_SYMBOL] = true,
-            _a), apiDefaults, this.config, config);
         return (0, RequestConfig_1.computeRequestConfig)([
             apiDefaults,
             this.config,
             config,
         ]);
-        delete computedConfig.queryParser;
-        return computedConfig;
+    };
+    Endpoint.prototype.getRequestBackend = function () {
+        return this.api.getRequestBackend();
     };
     return Endpoint;
 }());

package/cjs/Requester.js

@@ -51,7 +51,6 @@ exports.submit = void 0;
 var ApiUtils = require("./ApiUtils");
 var ApiUtils_1 = require("./ApiUtils");
 var RequestContext_1 = require("./RequestContext");
-var Api = require("./Api");
 var ApiConstants_1 = require("./ApiConstants");
 var retry_1 = require("./util/retry");
 var MockRequestBackend_1 = require("./backend/MockRequestBackend");
@@ -66,10 +65,7 @@ var submit = function (host, config, mocking) { return __awaiter(void 0, void 0,
         switch (_a.label) {
             case 0:
                 computedConfig = host.computeConfig(config);
-                backend = mocking ? MOCK_REQUEST_BACKEND : Api.getRequestBackend();
-                if (!backend) {
-                    throw new Error("[api-def] Please specify a backend you wish to use, this can be done either with 'setRequestBackend()'");
-                }
+                backend = mocking ? MOCK_REQUEST_BACKEND : host.getRequestBackend();
                 context = new RequestContext_1.default(backend, host, computedConfig, host.computePath(host.path, config), mocking);
                 key = context.key;
                 lock = (context.computedConfig || {}).lock;
@@ -109,21 +105,12 @@ var submit = function (host, config, mocking) { return __awaiter(void 0, void 0,
     });
 }); };
 exports.submit = submit;
-var defaultBackendMessageShown = false;
 var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0, function () {
     var beforeSendEventResult, maxRetries, retryOpts, performRequest, response;
     var _a;
     return __generator(this, function (_b) {
         switch (_b.label) {
-            case 0:
-                if (process.env.NODE_ENV === "development") {
-                    if (Api.isRequestBackendDefault() && !defaultBackendMessageShown) {
-                        defaultBackendMessageShown = true;
-                        // eslint-disable-next-line
-                        console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
-                    }
-                }
-                return [4 /*yield*/, context.triggerEvent(ApiConstants_1.RequestEvent.BeforeSend)];
+            case 0: return [4 /*yield*/, context.triggerEvent(ApiConstants_1.RequestEvent.BeforeSend)];
             case 1:
                 beforeSendEventResult = _b.sent();
                 if (beforeSendEventResult &&

package/cjs/Utils.d.ts

@@ -2,6 +2,7 @@ export declare const assign: typeof Object["assign"];
 export declare const padNumber: (stringOrNumber: string | number, maxLength: number) => string;
 export declare type EnumOf<T extends Record<string, any>> = T[keyof T];
 export declare type Fetch = typeof window.fetch;
+export declare const getGlobal: () => any;
 export declare const getGlobalFetch: () => Fetch | undefined;
 export declare const noop: () => void;
 /**

package/cjs/Utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.randInt = exports.delayThenReturn = exports.noop = exports.getGlobalFetch = exports.padNumber = exports.assign = void 0;
+exports.randInt = exports.delayThenReturn = exports.noop = exports.getGlobalFetch = exports.getGlobal = exports.padNumber = exports.assign = void 0;
 // polyfill from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign
 exports.assign = Object.assign || function (target, varArgs) {
     if (target === null || target === undefined) {
@@ -28,14 +28,22 @@ var padNumber = function (stringOrNumber, maxLength) {
         : "0".repeat(maxLength - string.length) + string;
 };
 exports.padNumber = padNumber;
-var getGlobalFetch = function () {
-    if (typeof global !== "undefined" && typeof global.fetch === "function") {
-        return global.fetch;
+var getGlobal = function () {
+    if (typeof global !== "undefined") {
+        return global;
+    }
+    if (typeof window !== "undefined") {
+        return window;
     }
-    if (typeof window === "undefined") {
-        return undefined;
+    return undefined;
+};
+exports.getGlobal = getGlobal;
+var getGlobalFetch = function () {
+    var global = (0, exports.getGlobal)();
+    if (global && typeof global.fetch === "function") {
+        return global.fetch.bind(global);
     }
-    return window.fetch.bind(window);
+    return undefined;
 };
 exports.getGlobalFetch = getGlobalFetch;
 // eslint-disable-next-line @typescript-eslint/no-empty-function

package/cjs/backend/FetchRequestBackend.js

@@ -67,6 +67,10 @@ var FetchRequestBackend = /** @class */ (function () {
         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) {

package/esm/Api.d.ts

@@ -12,6 +12,7 @@ export interface ApiInfo {
     readonly middleware?: RequestMiddleware[];
     readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
     readonly mocking?: ApiMockingConfig;
+    readonly requestBackend?: RequestBackend;
 }
 export declare class Api implements ApiInfo {
     readonly baseUrl: string;
@@ -19,9 +20,11 @@ export declare class Api implements ApiInfo {
     readonly middleware: RequestMiddleware[];
     readonly config?: BaseRequestConfig | (() => BaseRequestConfig);
     readonly mocking?: ApiMockingConfig;
+    readonly requestBackend: RequestBackend;
     protected readonly endpoints: Record<string, Endpoint>;
     constructor(info: ApiInfo);
     endpoint(): EndpointBuilder;
+    getRequestBackend(): RequestBackend;
     getConfig(): BaseRequestConfig;
     private hotRequest;
     get: <R = unknown>(path: string, config: RequestConfig) => Promise<ApiResponse<R>>;

package/esm/Api.js

@@ -46,10 +46,14 @@ class HotRequestHost {
     computePath(path, config) {
         return path.startsWith("/") ? path : `/${path}`;
     }
+    getRequestBackend() {
+        return this.api.getRequestBackend();
+    }
 }
+let defaultBackendMessageShown = false;
 export class Api {
     constructor(info) {
-        var _a;
+        var _a, _b;
         this.endpoints = {};
         this.hotRequest = (requestMethod) => (path, config) => __awaiter(this, void 0, void 0, function* () {
             return (yield Requester.submit(new HotRequestHost(this, path, requestMethod), config, null));
@@ -65,10 +69,27 @@ export class Api {
         this.endpoints = {};
         this.config = info.config;
         this.mocking = (_a = info.mocking) !== null && _a !== void 0 ? _a : undefined;
+        const requestBackend = (_b = info.requestBackend) !== null && _b !== void 0 ? _b : getRequestBackend();
+        if (!requestBackend) {
+            throw new Error("[api-def] No request backend provided in either Api options or globally, use `setRequestBackend()` to set one or pass one via `requestBackend`");
+        }
+        this.requestBackend = requestBackend;
+        if (!info.requestBackend) {
+            if (process.env.NODE_ENV === "development") {
+                if (isRequestBackendDefault() && !defaultBackendMessageShown) {
+                    defaultBackendMessageShown = true;
+                    // eslint-disable-next-line
+                    console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
+                }
+            }
+        }
     }
     endpoint() {
         return new EndpointBuilder(this);
     }
+    getRequestBackend() {
+        return this.requestBackend;
+    }
     getConfig() {
         return ((typeof this.config === "function" ? this.config() : this.config) ||
             {});

package/esm/ApiTypes.d.ts

@@ -1,6 +1,7 @@
 import RequestContext from "./RequestContext";
 import { Api } from "./Api";
 import { CacheSource, EventResultType, RequestEvent, RequestMethod, ResponseType } from "./ApiConstants";
+import RequestBackend from "./backend/RequestBackend";
 export declare type AcceptableStatus = number | [min: number, max: number];
 export declare type Headers = Record<string, string | number | boolean | null | undefined>;
 export declare type Params = string;
@@ -82,6 +83,7 @@ export interface RequestHost {
     readonly responseType: ResponseType | undefined;
     computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
     computePath(path: string, config: RequestConfig): string;
+    getRequestBackend(): RequestBackend;
 }
 export interface CancelledRequestError extends Error {
     isCancelledRequest: true;

package/esm/Endpoint.d.ts

@@ -2,6 +2,7 @@ import { Api } from "./Api";
 import { ApiResponse, BaseRequestConfig, Body, ComputedRequestConfig, Params, Query, RequestConfig, RequestHost } from "./ApiTypes";
 import * as Mocking from "./MockingTypes";
 import { RequestMethod, ResponseType } from "./ApiConstants";
+import RequestBackend from "./backend/RequestBackend";
 export interface EndpointConfig<R, P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined> {
     readonly id: string;
     readonly method: RequestMethod;
@@ -44,4 +45,5 @@ export default class Endpoint<R = any, P extends Params | undefined = Params | u
     computePath(path: string, request: RequestConfig): string;
     get baseUrl(): string;
     computeConfig<P extends Params | undefined, Q extends Query | undefined, B extends Body | undefined>(config: RequestConfig<P, Q, B>): ComputedRequestConfig<P, Q, B>;
+    getRequestBackend(): RequestBackend;
 }

package/esm/Endpoint.js

@@ -8,8 +8,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as Requester from "./Requester";
-import { COMPUTED_CONFIG_SYMBOL, } from "./ApiTypes";
-import * as Utils from "./Utils";
 import { computeRequestConfig } from "./RequestConfig";
 export default class Endpoint {
     constructor(api, info) {
@@ -59,15 +57,13 @@ export default class Endpoint {
     }
     computeConfig(config) {
         const apiDefaults = this.api.getConfig();
-        const computedConfig = Utils.assign({
-            [COMPUTED_CONFIG_SYMBOL]: true,
-        }, apiDefaults, this.config, config);
         return computeRequestConfig([
             apiDefaults,
             this.config,
             config,
         ]);
-        delete computedConfig.queryParser;
-        return computedConfig;
+    }
+    getRequestBackend() {
+        return this.api.getRequestBackend();
     }
 }

package/esm/Requester.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import * as ApiUtils from "./ApiUtils";
 import { inferResponseType, isAcceptableStatus, isNetworkError } from "./ApiUtils";
 import RequestContext from "./RequestContext";
-import * as Api from "./Api";
 import { EventResultType, RequestEvent } from "./ApiConstants";
 import retry from "./util/retry";
 import MockRequestBackend from "./backend/MockRequestBackend";
@@ -21,10 +20,7 @@ const runningOperations = {};
 const MOCK_REQUEST_BACKEND = new MockRequestBackend();
 export const submit = (host, config, mocking) => __awaiter(void 0, void 0, void 0, function* () {
     const computedConfig = host.computeConfig(config);
-    const backend = mocking ? MOCK_REQUEST_BACKEND : Api.getRequestBackend();
-    if (!backend) {
-        throw new Error("[api-def] Please specify a backend you wish to use, this can be done either with 'setRequestBackend()'");
-    }
+    const backend = mocking ? MOCK_REQUEST_BACKEND : host.getRequestBackend();
     const context = new RequestContext(backend, host, computedConfig, host.computePath(host.path, config), mocking);
     const { key } = context;
     // don't do this -- should only be for GET requests anyway and should be opt-in
@@ -63,16 +59,8 @@ export const submit = (host, config, mocking) => __awaiter(void 0, void 0, void
         }
     }
 });
-let defaultBackendMessageShown = false;
 const makeRequest = (context) => __awaiter(void 0, void 0, void 0, function* () {
     var _a;
-    if (process.env.NODE_ENV === "development") {
-        if (Api.isRequestBackendDefault() && !defaultBackendMessageShown) {
-            defaultBackendMessageShown = true;
-            // eslint-disable-next-line
-            console.warn("[api-def] Using default fetch backend, you can use a different one with 'setRequestBackend()' (dev only message)");
-        }
-    }
     const beforeSendEventResult = yield context.triggerEvent(RequestEvent.BeforeSend);
     if (beforeSendEventResult &&
         beforeSendEventResult.type === EventResultType.Respond) {

package/esm/Utils.d.ts

@@ -2,6 +2,7 @@ export declare const assign: typeof Object["assign"];
 export declare const padNumber: (stringOrNumber: string | number, maxLength: number) => string;
 export declare type EnumOf<T extends Record<string, any>> = T[keyof T];
 export declare type Fetch = typeof window.fetch;
+export declare const getGlobal: () => any;
 export declare const getGlobalFetch: () => Fetch | undefined;
 export declare const noop: () => void;
 /**

package/esm/Utils.js

@@ -24,14 +24,21 @@ export const padNumber = (stringOrNumber, maxLength) => {
         ? string
         : "0".repeat(maxLength - string.length) + string;
 };
-export const getGlobalFetch = () => {
-    if (typeof global !== "undefined" && typeof global.fetch === "function") {
-        return global.fetch;
+export const getGlobal = () => {
+    if (typeof global !== "undefined") {
+        return global;
+    }
+    if (typeof window !== "undefined") {
+        return window;
     }
-    if (typeof window === "undefined") {
-        return undefined;
+    return undefined;
+};
+export const getGlobalFetch = () => {
+    const global = getGlobal();
+    if (global && typeof global.fetch === "function") {
+        return global.fetch.bind(global);
     }
-    return window.fetch.bind(window);
+    return undefined;
 };
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 export const noop = () => {

package/esm/backend/FetchRequestBackend.js

@@ -8,7 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as Utils from "../Utils";
-import { getGlobalFetch } from "../Utils";
+import { getGlobal, getGlobalFetch } from "../Utils";
 import { inferResponseType } from "../ApiUtils";
 class FetchError extends Error {
 }
@@ -18,6 +18,10 @@ export default class FetchRequestBackend {
         this.id = "fetch";
         if (fetchLibrary !== undefined) {
             this.fetch = fetchLibrary;
+            // otherwise window throws illegal invocation
+            if (fetchLibrary === getGlobalFetch()) {
+                this.fetch = fetchLibrary.bind(getGlobal());
+            }
         }
     }
     extractResponseFromError(error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-def",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Typed API definitions with middleware support",
   "main": "cjs/index.js",
   "types": "esm/index.d.ts",