@vpmedia/simplify 1.5.3 → 1.6.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/simplify
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.5.3)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.6.0)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
 [![Node.js CI](https://github.com/vpmedia/simplify/actions/workflows/ci.yml/badge.svg)](https://github.com/vpmedia/simplify/actions/workflows/ci.yml)
 
 @vpmedia/simplify TBD

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.5.3",
+  "version": "1.6.0",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",

package/src/const/http_status.js

@@ -0,0 +1,64 @@
+export const HTTP_100_CONTINUE = 100;
+export const HTTP_101_SWITCHING_PROTOCOLS = 101;
+export const HTTP_102_PROCESSING = 102;
+export const HTTP_103_EARLY_HINTS = 103;
+export const HTTP_200_OK = 200;
+export const HTTP_201_CREATED = 201;
+export const HTTP_202_ACCEPTED = 202;
+export const HTTP_203_NON_AUTHORITATIVE_INFORMATION = 203;
+export const HTTP_204_NO_CONTENT = 204;
+export const HTTP_205_RESET_CONTENT = 205;
+export const HTTP_206_PARTIAL_CONTENT = 206;
+export const HTTP_207_MULTI_STATUS = 207;
+export const HTTP_208_ALREADY_REPORTED = 208;
+export const HTTP_226_IM_USED = 226;
+export const HTTP_300_MULTIPLE_CHOICES = 300;
+export const HTTP_301_MOVED_PERMANENTLY = 301;
+export const HTTP_302_FOUND = 302;
+export const HTTP_303_SEE_OTHER = 303;
+export const HTTP_304_NOT_MODIFIED = 304;
+export const HTTP_305_USE_PROXY = 305;
+export const HTTP_306_RESERVED = 306;
+export const HTTP_307_TEMPORARY_REDIRECT = 307;
+export const HTTP_308_PERMANENT_REDIRECT = 308;
+export const HTTP_400_BAD_REQUEST = 400;
+export const HTTP_401_UNAUTHORIZED = 401;
+export const HTTP_402_PAYMENT_REQUIRED = 402;
+export const HTTP_403_FORBIDDEN = 403;
+export const HTTP_404_NOT_FOUND = 404;
+export const HTTP_405_METHOD_NOT_ALLOWED = 405;
+export const HTTP_406_NOT_ACCEPTABLE = 406;
+export const HTTP_407_PROXY_AUTHENTICATION_REQUIRED = 407;
+export const HTTP_408_REQUEST_TIMEOUT = 408;
+export const HTTP_409_CONFLICT = 409;
+export const HTTP_410_GONE = 410;
+export const HTTP_411_LENGTH_REQUIRED = 411;
+export const HTTP_412_PRECONDITION_FAILED = 412;
+export const HTTP_413_REQUEST_ENTITY_TOO_LARGE = 413;
+export const HTTP_414_REQUEST_URI_TOO_LONG = 414;
+export const HTTP_415_UNSUPPORTED_MEDIA_TYPE = 415;
+export const HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
+export const HTTP_417_EXPECTATION_FAILED = 417;
+export const HTTP_418_IM_A_TEAPOT = 418;
+export const HTTP_421_MISDIRECTED_REQUEST = 421;
+export const HTTP_422_UNPROCESSABLE_ENTITY = 422;
+export const HTTP_423_LOCKED = 423;
+export const HTTP_424_FAILED_DEPENDENCY = 424;
+export const HTTP_425_TOO_EARLY = 425;
+export const HTTP_426_UPGRADE_REQUIRED = 426;
+export const HTTP_428_PRECONDITION_REQUIRED = 428;
+export const HTTP_429_TOO_MANY_REQUESTS = 429;
+export const HTTP_499_CLIENT_CLOSED_CONNECTION = 499;
+export const HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
+export const HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
+export const HTTP_500_INTERNAL_SERVER_ERROR = 500;
+export const HTTP_501_NOT_IMPLEMENTED = 501;
+export const HTTP_502_BAD_GATEWAY = 502;
+export const HTTP_503_SERVICE_UNAVAILABLE = 503;
+export const HTTP_504_GATEWAY_TIMEOUT = 504;
+export const HTTP_505_HTTP_VERSION_NOT_SUPPORTED = 505;
+export const HTTP_506_VARIANT_ALSO_NEGOTIATES = 506;
+export const HTTP_507_INSUFFICIENT_STORAGE = 507;
+export const HTTP_508_LOOP_DETECTED = 508;
+export const HTTP_510_NOT_EXTENDED = 510;
+export const HTTP_511_NETWORK_AUTHENTICATION_REQUIRED = 511;

package/src/index.js

@@ -1,9 +1,10 @@
 // core
+export * from './const/http_status.js';
 export { Logger } from './logging/Logger.js';
 export { addLeadingZero } from './util/addLeadingZero.js';
 export { capitalize } from './util/capitalize.js';
 export { delayPromise } from './util/delayPromise.js';
-export { fetchRetry } from './util/fetchRetry.js';
+export { FetchError, fetchRetry } from './util/fetchRetry.js';
 export { getObjValueByPath } from './util/getObjValueByPath.js';
 export { getRandomInt } from './util/getRandomInt.js';
 export { getURLParam } from './util/getURLParam.js';

package/src/util/fetchRetry.js

@@ -1,33 +1,56 @@
+import { HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN, HTTP_405_METHOD_NOT_ALLOWED } from '../const/http_status.js';
 import { Logger } from '../logging/Logger.js';
 import { delayPromise } from './delayPromise.js';
 
 const logger = new Logger('fetch');
 
+export class FetchError extends Error {
+  /**
+   * Creates a new FetchError instance.
+   * @param {string} message - Error message.
+   * @param {Response} response - Fetch response object.
+   */
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+    // Error.captureStackTrace(this, FetchError);
+  }
+}
+
 /**
  * Fetch with retry.
  * @param {string | URL | Request} resource - Fetch URL.
  * @param {RequestInit} [fetchOptions] - Fetch options.
- * @param {{delay?: number, numTries?: number}} [retryOptions] - Retry options.
+ * @param {{delay?: number, numTries?: number, statusExcludes?: number[]}} [retryOptions] - Retry options.
  * @returns {Promise<Response>} Fetch result.
  */
 export const fetchRetry = async (resource, fetchOptions, retryOptions) => {
   retryOptions = retryOptions ?? {};
   retryOptions.delay = Math.max(retryOptions.delay ?? 500, 1);
   retryOptions.numTries = Math.max(retryOptions.numTries ?? 3, 1);
+  retryOptions.statusExcludes = retryOptions.statusExcludes ?? [
+    HTTP_401_UNAUTHORIZED,
+    HTTP_403_FORBIDDEN,
+    HTTP_405_METHOD_NOT_ALLOWED,
+  ];
   while (retryOptions.numTries > 0) {
     logger.info('request', { resource, fetchOptions, retryOptions });
     try {
       const response = await fetch(resource, fetchOptions);
       if (!response.ok) {
         logger.warn('failure', response);
-        throw new Error(`fetch ${response.url} returned status ${response.status}`, { cause: response.status });
+        throw new FetchError(`fetch ${response.url} returned status ${response.status}`, response);
       }
       logger.info('success', response);
       return response;
     } catch (error) {
-      logger.error('error', error instanceof Error ? error : new Error(String(error)));
+      const typedError = error instanceof Error ? error : new Error(String(error));
+      logger.error('error', typedError);
       retryOptions.numTries -= 1;
-      if (retryOptions.numTries === 0) {
+      if (
+        retryOptions.numTries === 0 ||
+        (typedError instanceof FetchError && retryOptions.statusExcludes.includes(typedError.response.status))
+      ) {
         throw error;
       }
       await delayPromise(retryOptions.delay);

package/types/const/http_status.d.ts

@@ -0,0 +1,65 @@
+export const HTTP_100_CONTINUE: 100;
+export const HTTP_101_SWITCHING_PROTOCOLS: 101;
+export const HTTP_102_PROCESSING: 102;
+export const HTTP_103_EARLY_HINTS: 103;
+export const HTTP_200_OK: 200;
+export const HTTP_201_CREATED: 201;
+export const HTTP_202_ACCEPTED: 202;
+export const HTTP_203_NON_AUTHORITATIVE_INFORMATION: 203;
+export const HTTP_204_NO_CONTENT: 204;
+export const HTTP_205_RESET_CONTENT: 205;
+export const HTTP_206_PARTIAL_CONTENT: 206;
+export const HTTP_207_MULTI_STATUS: 207;
+export const HTTP_208_ALREADY_REPORTED: 208;
+export const HTTP_226_IM_USED: 226;
+export const HTTP_300_MULTIPLE_CHOICES: 300;
+export const HTTP_301_MOVED_PERMANENTLY: 301;
+export const HTTP_302_FOUND: 302;
+export const HTTP_303_SEE_OTHER: 303;
+export const HTTP_304_NOT_MODIFIED: 304;
+export const HTTP_305_USE_PROXY: 305;
+export const HTTP_306_RESERVED: 306;
+export const HTTP_307_TEMPORARY_REDIRECT: 307;
+export const HTTP_308_PERMANENT_REDIRECT: 308;
+export const HTTP_400_BAD_REQUEST: 400;
+export const HTTP_401_UNAUTHORIZED: 401;
+export const HTTP_402_PAYMENT_REQUIRED: 402;
+export const HTTP_403_FORBIDDEN: 403;
+export const HTTP_404_NOT_FOUND: 404;
+export const HTTP_405_METHOD_NOT_ALLOWED: 405;
+export const HTTP_406_NOT_ACCEPTABLE: 406;
+export const HTTP_407_PROXY_AUTHENTICATION_REQUIRED: 407;
+export const HTTP_408_REQUEST_TIMEOUT: 408;
+export const HTTP_409_CONFLICT: 409;
+export const HTTP_410_GONE: 410;
+export const HTTP_411_LENGTH_REQUIRED: 411;
+export const HTTP_412_PRECONDITION_FAILED: 412;
+export const HTTP_413_REQUEST_ENTITY_TOO_LARGE: 413;
+export const HTTP_414_REQUEST_URI_TOO_LONG: 414;
+export const HTTP_415_UNSUPPORTED_MEDIA_TYPE: 415;
+export const HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE: 416;
+export const HTTP_417_EXPECTATION_FAILED: 417;
+export const HTTP_418_IM_A_TEAPOT: 418;
+export const HTTP_421_MISDIRECTED_REQUEST: 421;
+export const HTTP_422_UNPROCESSABLE_ENTITY: 422;
+export const HTTP_423_LOCKED: 423;
+export const HTTP_424_FAILED_DEPENDENCY: 424;
+export const HTTP_425_TOO_EARLY: 425;
+export const HTTP_426_UPGRADE_REQUIRED: 426;
+export const HTTP_428_PRECONDITION_REQUIRED: 428;
+export const HTTP_429_TOO_MANY_REQUESTS: 429;
+export const HTTP_499_CLIENT_CLOSED_CONNECTION: 499;
+export const HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE: 431;
+export const HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS: 451;
+export const HTTP_500_INTERNAL_SERVER_ERROR: 500;
+export const HTTP_501_NOT_IMPLEMENTED: 501;
+export const HTTP_502_BAD_GATEWAY: 502;
+export const HTTP_503_SERVICE_UNAVAILABLE: 503;
+export const HTTP_504_GATEWAY_TIMEOUT: 504;
+export const HTTP_505_HTTP_VERSION_NOT_SUPPORTED: 505;
+export const HTTP_506_VARIANT_ALSO_NEGOTIATES: 506;
+export const HTTP_507_INSUFFICIENT_STORAGE: 507;
+export const HTTP_508_LOOP_DETECTED: 508;
+export const HTTP_510_NOT_EXTENDED: 510;
+export const HTTP_511_NETWORK_AUTHENTICATION_REQUIRED: 511;
+//# sourceMappingURL=http_status.d.ts.map

package/types/const/http_status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http_status.d.ts","sourceRoot":"","sources":["../../src/const/http_status.js"],"names":[],"mappings":"AAAA,oCAAqC;AACrC,+CAAgD;AAChD,sCAAuC;AACvC,uCAAwC;AACxC,8BAA+B;AAC/B,mCAAoC;AACpC,oCAAqC;AACrC,yDAA0D;AAC1D,sCAAuC;AACvC,yCAA0C;AAC1C,2CAA4C;AAC5C,wCAAyC;AACzC,4CAA6C;AAC7C,mCAAoC;AACpC,4CAA6C;AAC7C,6CAA8C;AAC9C,iCAAkC;AAClC,qCAAsC;AACtC,wCAAyC;AACzC,qCAAsC;AACtC,oCAAqC;AACrC,8CAA+C;AAC/C,8CAA+C;AAC/C,uCAAwC;AACxC,wCAAyC;AACzC,4CAA6C;AAC7C,qCAAsC;AACtC,qCAAsC;AACtC,8CAA+C;AAC/C,0CAA2C;AAC3C,yDAA0D;AAC1D,2CAA4C;AAC5C,oCAAqC;AACrC,gCAAiC;AACjC,2CAA4C;AAC5C,+CAAgD;AAChD,oDAAqD;AACrD,gDAAiD;AACjD,kDAAmD;AACnD,2DAA4D;AAC5D,8CAA+C;AAC/C,uCAAwC;AACxC,+CAAgD;AAChD,gDAAiD;AACjD,kCAAmC;AACnC,6CAA8C;AAC9C,qCAAsC;AACtC,4CAA6C;AAC7C,iDAAkD;AAClD,6CAA8C;AAC9C,oDAAqD;AACrD,2DAA4D;AAC5D,yDAA0D;AAC1D,iDAAkD;AAClD,2CAA4C;AAC5C,uCAAwC;AACxC,+CAAgD;AAChD,2CAA4C;AAC5C,sDAAuD;AACvD,mDAAoD;AACpD,gDAAiD;AACjD,yCAA0C;AAC1C,wCAAyC;AACzC,2DAA4D"}

package/types/index.d.ts

@@ -1,12 +1,13 @@
+export * from "./const/http_status.js";
 export { Logger } from "./logging/Logger.js";
 export { addLeadingZero } from "./util/addLeadingZero.js";
 export { capitalize } from "./util/capitalize.js";
 export { delayPromise } from "./util/delayPromise.js";
-export { fetchRetry } from "./util/fetchRetry.js";
 export { getObjValueByPath } from "./util/getObjValueByPath.js";
 export { getRandomInt } from "./util/getRandomInt.js";
 export { getURLParam } from "./util/getURLParam.js";
 export { sanitizeURLParam } from "./util/sanitizeURLParam.js";
 export { setObjValueByPath } from "./util/setObjValueByPath.js";
 export { underscoreToCamelCase } from "./util/underscoreToCamelCase.js";
+export { FetchError, fetchRetry } from "./util/fetchRetry.js";
 //# sourceMappingURL=index.d.ts.map

package/types/util/fetchRetry.d.ts

@@ -1,5 +1,15 @@
+export class FetchError extends Error {
+    /**
+     * Creates a new FetchError instance.
+     * @param {string} message - Error message.
+     * @param {Response} response - Fetch response object.
+     */
+    constructor(message: string, response: Response);
+    response: Response;
+}
 export function fetchRetry(resource: string | URL | Request, fetchOptions?: RequestInit, retryOptions?: {
     delay?: number;
     numTries?: number;
+    statusExludes?: number[];
 }): Promise<Response>;
 //# sourceMappingURL=fetchRetry.d.ts.map

package/types/util/fetchRetry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchRetry.d.ts","sourceRoot":"","sources":["../../src/util/fetchRetry.js"],"names":[],"mappings":"AAYO,qCALI,MAAM,GAAG,GAAG,GAAG,OAAO,iBACtB,WAAW,iBACX;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAC,GACjC,OAAO,CAAC,QAAQ,CAAC,CA0B7B"}
+{"version":3,"file":"fetchRetry.d.ts","sourceRoot":"","sources":["../../src/util/fetchRetry.js"],"names":[],"mappings":"AAMA;IACE;;;;OAIG;IACH,qBAHW,MAAM,YACN,QAAQ,EAMlB;IAFC,mBAAwB;CAG3B;AASM,qCALI,MAAM,GAAG,GAAG,GAAG,OAAO,iBACtB,WAAW,iBACX;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,GAC3D,OAAO,CAAC,QAAQ,CAAC,CA+B7B"}