@vpmedia/simplify 1.3.0 → 1.4.0

package/CHANGES.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.4.0
+
+- Added fetch retry helper
+
 ## 1.3.0
 
 - Changed logger level initialization strategy

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/simplify
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.3.0)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.4.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/eslint.config.js

@@ -1,10 +1,10 @@
 import js from '@eslint/js';
-import importPlugin from 'eslint-plugin-import';
+// import importPlugin from 'eslint-plugin-import';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 import unicornPlugin from 'eslint-plugin-unicorn';
 import globals from 'globals';
 
-/** @type { import('eslint').Linter.FlatConfig[] } */
+/** @type { import('eslint').Linter.Config[] } */
 export default [
   {
     ignores: [
@@ -37,7 +37,7 @@ export default [
     },
     files: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'],
     plugins: {
-      import: importPlugin,
+      // import: importPlugin,
       jsdoc: jsdocPlugin,
       unicorn: unicornPlugin,
     },
@@ -52,15 +52,15 @@ export default [
     rules: {
       ...js.configs.recommended.rules,
       ...jsdocPlugin.configs['flat/recommended'].rules,
-      ...importPlugin.configs.recommended.rules,
+      // ...importPlugin.configs.recommended.rules,
       ...unicornPlugin.configs['flat/recommended'].rules,
       'unicorn/filename-case': 'off',
       'unicorn/no-null': 'off',
       'unicorn/prevent-abbreviations': 'off',
-      'no-unused-vars': 'warn',
+      'no-unused-vars': 'off',
       'prefer-arrow-callback': 'error',
       'prefer-template': 'error',
-      'import/extensions': ['warn', 'always'],
+      // 'import/extensions': ['warn', 'always'],
       'jsdoc/require-jsdoc': [
         'error',
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -19,21 +19,19 @@
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {
-    "@babel/preset-env": "^7.24.4",
-    "@eslint/js": "^8.57.0",
+    "@babel/preset-env": "^7.25.7",
+    "@eslint/js": "^9.10.0",
     "@jest/globals": "^29.7.0",
-    "@types/jest": "^29.5.12",
-    "eslint": "^8.57.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jest": "^27.9.0",
-    "eslint-plugin-jsdoc": "^48.2.3",
-    "eslint-plugin-unicorn": "^52.0.0",
-    "globals": "^15.0.0",
+    "@types/jest": "^29.5.13",
+    "eslint": "^9.11.1",
+    "eslint-plugin-jsdoc": "^50.3.1",
+    "eslint-plugin-unicorn": "^55.0.0",
+    "globals": "^15.10.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lefthook": "^1.6.10",
-    "prettier": "^3.2.5",
-    "typescript": "^5.4.5"
+    "lefthook": "^1.7.18",
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.2"
   },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
@@ -44,12 +42,8 @@
     "lefthook:uninstall": "lefthook uninstall"
   },
   "browserslist": [
-    "> 1%",
+    "> 0.5%",
     "not dead",
     "not op_mini all"
-  ],
-  "engines": {
-    "npm": ">=8.0.0",
-    "node": ">=18.0.0"
-  }
+  ]
 }

package/src/index.js

@@ -2,6 +2,8 @@
 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';

package/src/util/delayPromise.js

@@ -0,0 +1,6 @@
+/**
+ * Returns a promise with delayed resolve.
+ * @param {number} delayMS - Promise resolve delay in milliseconds.
+ * @returns {Promise<void>} Delayed resolve promise.
+ */
+export const delayPromise = (delayMS) => new Promise((resolve) => setTimeout(resolve, delayMS));

package/src/util/fetchRetry.js

@@ -0,0 +1,42 @@
+import { Logger } from '../logging/Logger.js';
+import { delayPromise } from './delayPromise.js';
+
+const logger = new Logger('fetchRetry');
+
+/**
+ * Fetch with retry.
+ * @param {string | URL | Request} resource - Fetch URL.
+ * @param {RequestInit} [fetchOptions] - Fetch options.
+ * @param {{ delay?: number, numRetries?: number, isLog?: boolean}} [retryOptions] - Retry options.
+ * @returns {Promise<Response>} Fetch result.
+ */
+export const fetchRetry = (resource, fetchOptions, retryOptions) => {
+  retryOptions = retryOptions ?? {};
+  retryOptions.delay = retryOptions.delay ?? 1000;
+  retryOptions.numRetries = retryOptions.numRetries ?? 3;
+  retryOptions.isLog = retryOptions.isLog ?? false;
+  return fetch(resource, fetchOptions)
+    .then((response) => {
+      if (retryOptions.isLog && !response.ok) {
+        logger.warn('Fetch failed', { fetchOptions, responseStatus: response.status });
+      }
+      return response.ok ? response.json() : Promise.reject(response);
+    })
+    .catch((error) => {
+      if (retryOptions.isLog) {
+        logger.exception('Fetch error', error);
+      }
+      retryOptions.numRetries -= 1;
+      retryOptions.delay *= 2;
+      if (retryOptions.numRetries > 0) {
+        if (retryOptions.isLog) {
+          logger.warn('Fetch retry', { resource, fetchOptions, retryOptions });
+        }
+        delayPromise(retryOptions.delay).then(() => {
+          return fetchRetry(resource, fetchOptions, retryOptions);
+        });
+      } else {
+        throw error;
+      }
+    });
+};

package/src/util/setObjValueByPath.js

@@ -3,6 +3,7 @@
  * @param {object} obj - TBD.
  * @param {string} path - TBD.
  * @param {*} value - TBD.
+ * @throws {SyntaxError} Error when illegal path value has been provided.
  */
 export function setObjValueByPath(obj, path, value) {
   if (!obj || !path) {
@@ -10,6 +11,9 @@ export function setObjValueByPath(obj, path, value) {
   }
   const keyParts = path.split('.');
   const nextKey = keyParts[0];
+  if (nextKey === '__proto__') {
+    throw new SyntaxError('Security violation error. Cannot use "__proto__" as parameter.');
+  }
   if (keyParts.length === 1) {
     obj[nextKey] = value;
   }

package/types/index.d.ts

@@ -1,6 +1,8 @@
 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";

package/types/logging/Logger.d.ts

@@ -7,7 +7,7 @@ export class Logger {
     /**
      * @type {(error) => {}}
      */
-    static exceptionHandler: (error) => {};
+    static exceptionHandler: (error: any) => {};
     /**
      * Creates a new Logger instance.
      * @param {string} name - The logger name.

package/types/logging/Logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/logging/Logger.js"],"names":[],"mappings":"AAGA,4BAA6B;AAC7B,2BAA4B;AAC5B,2BAA4B;AAC5B,4BAA6B;AAC7B,6BAA8B;AAE9B;IACE;;OAEG;IACH,yBAFU,CAAC,KAAK,KAAK,EAAE,CAEQ;IAE/B;;;OAGG;IACH,kBAFW,MAAM,EAShB;IANC,aAAgB;IAKhB,cAAkG;IAGpG;;;;OAIG;IACH,eAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,cAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,cAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,eAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,mBAHW,MAAM,aACN,KAAK,QAWf;CACF"}
+{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/logging/Logger.js"],"names":[],"mappings":"AAGA,4BAA6B;AAC7B,2BAA4B;AAC5B,2BAA4B;AAC5B,4BAA6B;AAC7B,6BAA8B;AAE9B;IACE;;OAEG;IACH,yBAFU,CAAC,KAAK,KAAA,KAAK,EAAE,CAEQ;IAE/B;;;OAGG;IACH,kBAFW,MAAM,EAShB;IANC,aAAgB;IAKhB,cAAkG;IAGpG;;;;OAIG;IACH,eAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,cAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,cAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,eAHW,MAAM,cACN,MAAM,QAYhB;IAED;;;;OAIG;IACH,mBAHW,MAAM,aACN,KAAK,QAWf;CACF"}

package/types/util/delayPromise.d.ts

@@ -0,0 +1,2 @@
+export function delayPromise(delayMS: number): Promise<void>;
+//# sourceMappingURL=delayPromise.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"delayPromise.d.ts","sourceRoot":"","sources":["../../src/util/delayPromise.js"],"names":[],"mappings":"AAKO,sCAHI,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAEqE"}

package/types/util/fetchRetry.d.ts

@@ -0,0 +1,6 @@
+export function fetchRetry(resource: string | URL | Request, fetchOptions?: RequestInit, retryOptions?: {
+    delay?: number;
+    numRetries?: number;
+    isLog?: boolean;
+}): Promise<Response>;
+//# sourceMappingURL=fetchRetry.d.ts.map

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

@@ -0,0 +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;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAC,GACrD,OAAO,CAAC,QAAQ,CAAC,CA+B7B"}

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

@@ -1 +1 @@
-{"version":3,"file":"getObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/getObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,uCAJW,MAAM,QACN,MAAM,OAahB"}
+{"version":3,"file":"getObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/getObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,uCAJW,MAAM,QACN,MAAM,GACJ,GAAC,CAYb"}

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

@@ -1 +1 @@
-{"version":3,"file":"getURLParam.d.ts","sourceRoot":"","sources":["../../src/util/getURLParam.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,iCALW,MAAM,mCAEN,OAAO,GACL,MAAM,CAWlB"}
+{"version":3,"file":"getURLParam.d.ts","sourceRoot":"","sources":["../../src/util/getURLParam.js"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,iCALW,MAAM,iBACN,GAAC,eACD,OAAO,GACL,MAAM,CAWlB"}

package/types/util/setObjValueByPath.d.ts

@@ -3,6 +3,7 @@
  * @param {object} obj - TBD.
  * @param {string} path - TBD.
  * @param {*} value - TBD.
+ * @throws {SyntaxError} Error when illegal path value has been provided.
  */
 export function setObjValueByPath(obj: object, path: string, value: any): void;
 //# sourceMappingURL=setObjValueByPath.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"setObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/setObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,uCAJW,MAAM,QACN,MAAM,oBAahB"}
+{"version":3,"file":"setObjValueByPath.d.ts","sourceRoot":"","sources":["../../src/util/setObjValueByPath.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,uCALW,MAAM,QACN,MAAM,SACN,GAAC,QAgBX"}