api-def 0.8.2 → 0.8.4

package/cjs/ApiTypes.d.ts

@@ -21,10 +21,16 @@ interface QueryHandling {
     parse: QueryParse;
     stringify: QueryStringify;
 }
+export interface RetryOptions {
+    maxAttempts: number;
+    shouldRetry?: (error: Error) => boolean;
+    minDelay?: number;
+    maxDelay?: number;
+}
 export interface BaseRequestConfig {
     cache?: number | boolean;
     lock?: RequestLock;
-    retry?: number | false;
+    retry?: number | false | RetryOptions;
     headers?: Readonly<Headers>;
     acceptableStatus?: AcceptableStatus[];
     /**

package/cjs/RequestError.d.ts

@@ -13,6 +13,7 @@ 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 {

package/cjs/RequestError.js

@@ -20,6 +20,7 @@ var convertToRequestError = function (config) {
         response: response,
         code: code,
         isRequestError: true,
+        attempts: context.stats.attempt,
         request: {
             url: context.getRequestUrl().href,
             query: context.computedConfig.queryObject,

package/cjs/Requester.js

@@ -48,7 +48,6 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.submit = void 0;
-var ApiUtils = require("./ApiUtils");
 var ApiUtils_1 = require("./ApiUtils");
 var RequestContext_1 = require("./RequestContext");
 var ApiConstants_1 = require("./ApiConstants");
@@ -105,29 +104,38 @@ var submit = function (host, config, mocking) { return __awaiter(void 0, void 0,
     });
 }); };
 exports.submit = submit;
+var parseRetryOptions = function (retryConfig) {
+    if (retryConfig && typeof retryConfig === "object") {
+        return retryConfig;
+    }
+    if (typeof retryConfig === "number") {
+        return { maxAttempts: retryConfig };
+    }
+    return { maxAttempts: 0 };
+};
 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) {
+    var beforeSendEventResult, retryOptions, internalRetryOptions, performRequest, response;
+    var _a, _b, _c;
+    return __generator(this, function (_d) {
+        switch (_d.label) {
             case 0: return [4 /*yield*/, context.triggerEvent(ApiConstants_1.RequestEvent.BeforeSend)];
             case 1:
-                beforeSendEventResult = _b.sent();
+                beforeSendEventResult = _d.sent();
                 if (beforeSendEventResult &&
                     beforeSendEventResult.type === ApiConstants_1.EventResultType.Respond) {
                     return [2 /*return*/, (context.response = beforeSendEventResult.response)];
                 }
-                maxRetries = ((_a = context.computedConfig) === null || _a === void 0 ? void 0 : _a.retry) || 0;
-                retryOpts = {
-                    retries: maxRetries,
+                retryOptions = parseRetryOptions((_a = context.computedConfig) === null || _a === void 0 ? void 0 : _a.retry);
+                internalRetryOptions = {
+                    retries: retryOptions.maxAttempts,
                     // assume most users won't want to tune the delay between retries
-                    minTimeout: 1 * 1000,
-                    maxTimeout: 5 * 1000,
+                    minTimeout: (_b = retryOptions.minDelay) !== null && _b !== void 0 ? _b : 200,
+                    maxTimeout: (_c = retryOptions.maxDelay) !== null && _c !== void 0 ? _c : 1000,
                     randomize: true,
                 };
                 context.stats.attempt = 0;
                 performRequest = function (fnBail, attemptCount) { return __awaiter(void 0, void 0, void 0, function () {
-                    var _a, promise, canceler, response_1, parsedResponse, rawError_1, error, errorEventResult, shouldNaturallyRetry, forceRetry, unrecoverableErrorEventResult;
+                    var _a, promise, canceler, response_1, parsedResponse, rawError_1, error, errorEventResult, forceRetry, unrecoverableErrorEventResult;
                     return __generator(this, function (_b) {
                         switch (_b.label) {
                             case 0:
@@ -169,14 +177,14 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                                 if ((errorEventResult === null || errorEventResult === void 0 ? void 0 : errorEventResult.type) === ApiConstants_1.EventResultType.Respond) {
                                     return [2 /*return*/, errorEventResult.response];
                                 }
-                                shouldNaturallyRetry = ApiUtils.isNetworkError(error);
-                                if (shouldNaturallyRetry) {
-                                    throw error;
-                                }
                                 forceRetry = (errorEventResult === null || errorEventResult === void 0 ? void 0 : errorEventResult.type) === ApiConstants_1.EventResultType.Retry;
                                 if (forceRetry) {
                                     return [2 /*return*/, performRequest(fnBail, attemptCount)];
                                 }
+                                // allow retry logic to handle
+                                if (!retryOptions.shouldRetry || retryOptions.shouldRetry(error)) {
+                                    throw error;
+                                }
                                 return [4 /*yield*/, context.triggerEvent(ApiConstants_1.RequestEvent.UnrecoverableError)];
                             case 7:
                                 unrecoverableErrorEventResult = _b.sent();
@@ -191,9 +199,9 @@ var makeRequest = function (context) { return __awaiter(void 0, void 0, void 0,
                         }
                     });
                 }); };
-                return [4 /*yield*/, (0, retry_1.default)(performRequest, retryOpts)];
+                return [4 /*yield*/, (0, retry_1.default)(performRequest, internalRetryOptions)];
             case 2:
-                response = _b.sent();
+                response = _d.sent();
                 return [2 /*return*/, (response)];
         }
     });

package/cjs/backend/FetchRequestBackend.js

@@ -163,7 +163,7 @@ var FetchRequestBackend = /** @class */ (function () {
         }, {});
         var url = context.getRequestUrl();
         var promise = this.fetch(url.href, {
-            method: context.method,
+            method: context.method.toUpperCase(),
             body: bodyJsonify ? JSON.stringify(body) : body,
             headers: parsedHeaders,
             mode: "cors",

package/esm/ApiTypes.d.ts

@@ -21,10 +21,16 @@ interface QueryHandling {
     parse: QueryParse;
     stringify: QueryStringify;
 }
+export interface RetryOptions {
+    maxAttempts: number;
+    shouldRetry?: (error: Error) => boolean;
+    minDelay?: number;
+    maxDelay?: number;
+}
 export interface BaseRequestConfig {
     cache?: number | boolean;
     lock?: RequestLock;
-    retry?: number | false;
+    retry?: number | false | RetryOptions;
     headers?: Readonly<Headers>;
     acceptableStatus?: AcceptableStatus[];
     /**

package/esm/RequestError.d.ts

@@ -13,6 +13,7 @@ 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 {

package/esm/RequestError.js

@@ -16,6 +16,7 @@ export const convertToRequestError = (config) => {
         response: response,
         code: code,
         isRequestError: true,
+        attempts: context.stats.attempt,
         request: {
             url: context.getRequestUrl().href,
             query: context.computedConfig.queryObject,

package/esm/Requester.js

@@ -7,7 +7,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as ApiUtils from "./ApiUtils";
 import { inferResponseType, isAcceptableStatus, isNetworkError } from "./ApiUtils";
 import RequestContext from "./RequestContext";
 import { EventResultType, RequestEvent } from "./ApiConstants";
@@ -59,19 +58,28 @@ export const submit = (host, config, mocking) => __awaiter(void 0, void 0, void
         }
     }
 });
+const parseRetryOptions = (retryConfig) => {
+    if (retryConfig && typeof retryConfig === "object") {
+        return retryConfig;
+    }
+    if (typeof retryConfig === "number") {
+        return { maxAttempts: retryConfig };
+    }
+    return { maxAttempts: 0 };
+};
 const makeRequest = (context) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a;
+    var _a, _b, _c;
     const beforeSendEventResult = yield context.triggerEvent(RequestEvent.BeforeSend);
     if (beforeSendEventResult &&
         beforeSendEventResult.type === EventResultType.Respond) {
         return (context.response = beforeSendEventResult.response);
     }
-    const maxRetries = ((_a = context.computedConfig) === null || _a === void 0 ? void 0 : _a.retry) || 0;
-    const retryOpts = {
-        retries: maxRetries,
+    const retryOptions = parseRetryOptions((_a = context.computedConfig) === null || _a === void 0 ? void 0 : _a.retry);
+    const internalRetryOptions = {
+        retries: retryOptions.maxAttempts,
         // assume most users won't want to tune the delay between retries
-        minTimeout: 1 * 1000,
-        maxTimeout: 5 * 1000,
+        minTimeout: (_b = retryOptions.minDelay) !== null && _b !== void 0 ? _b : 200,
+        maxTimeout: (_c = retryOptions.maxDelay) !== null && _c !== void 0 ? _c : 1000,
         randomize: true,
     };
     context.stats.attempt = 0;
@@ -105,15 +113,19 @@ const makeRequest = (context) => __awaiter(void 0, void 0, void 0, function* ()
                 return errorEventResult.response;
             }
             // allow retry logic to handle network errors
-            const shouldNaturallyRetry = ApiUtils.isNetworkError(error);
-            if (shouldNaturallyRetry) {
-                throw error;
-            }
+            //const shouldNaturallyRetry = ApiUtils.isNetworkError(error);
+            //if (shouldNaturallyRetry) {
+            //  throw error;
+            //}
             // if we have an event that tells us to retry, we must do it
             const forceRetry = (errorEventResult === null || errorEventResult === void 0 ? void 0 : errorEventResult.type) === EventResultType.Retry;
             if (forceRetry) {
                 return performRequest(fnBail, attemptCount);
             }
+            // allow retry logic to handle
+            if (!retryOptions.shouldRetry || retryOptions.shouldRetry(error)) {
+                throw error;
+            }
             // error is unrecoverable, bail
             const unrecoverableErrorEventResult = yield context.triggerEvent(RequestEvent.UnrecoverableError);
             if (unrecoverableErrorEventResult) {
@@ -124,11 +136,11 @@ const makeRequest = (context) => __awaiter(void 0, void 0, void 0, function* ()
             fnBail(error);
         }
     });
-    const response = yield retry(performRequest, retryOpts);
+    const response = yield retry(performRequest, internalRetryOptions);
     return (response);
 });
 const parseResponse = (context, response, error) => __awaiter(void 0, void 0, void 0, function* () {
-    var _b;
+    var _d;
     if (response) {
         const parsedResponse = yield context.backend.convertResponse(context, response);
         // lowercase all header names
@@ -153,7 +165,7 @@ const parseResponse = (context, response, error) => __awaiter(void 0, void 0, vo
                 if (parsedResponse.data &&
                     typeof parsedResponse.data === "object") {
                     const data = response.data;
-                    if (((_b = data.constructor) === null || _b === void 0 ? void 0 : _b.name) === "ArrayBuffer") {
+                    if (((_d = data.constructor) === null || _d === void 0 ? void 0 : _d.name) === "ArrayBuffer") {
                         try {
                             const decodedData = (response.data = textDecode(data));
                             response.data = JSON.parse(decodedData);

package/esm/backend/FetchRequestBackend.js

@@ -94,7 +94,7 @@ export default class FetchRequestBackend {
         }, {});
         const url = context.getRequestUrl();
         const promise = this.fetch(url.href, {
-            method: context.method,
+            method: context.method.toUpperCase(),
             body: bodyJsonify ? JSON.stringify(body) : body,
             headers: parsedHeaders,
             mode: "cors",

package/package.json

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