@vpmedia/simplify 1.7.1 → 1.9.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/simplify
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.7.1)](https://badge.fury.io/js/@vpmedia%2Fsimplify)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fsimplify.svg?v=1.9.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,5 +1,4 @@
 import js from '@eslint/js';
-// import importPlugin from 'eslint-plugin-import';
 import jsdocPlugin from 'eslint-plugin-jsdoc';
 import unicornPlugin from 'eslint-plugin-unicorn';
 import globals from 'globals';
@@ -37,7 +36,6 @@ export default [
     },
     files: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'],
     plugins: {
-      // import: importPlugin,
       jsdoc: jsdocPlugin,
       unicorn: unicornPlugin,
     },
@@ -52,7 +50,6 @@ export default [
     rules: {
       ...js.configs.recommended.rules,
       ...jsdocPlugin.configs['flat/recommended'].rules,
-      // ...importPlugin.configs.recommended.rules,
       ...unicornPlugin.configs['flat/recommended'].rules,
       'unicorn/filename-case': 'off',
       'unicorn/no-null': 'off',
@@ -62,7 +59,6 @@ export default [
       'no-unused-vars': 'off',
       'prefer-arrow-callback': 'error',
       'prefer-template': 'error',
-      // 'import/extensions': ['warn', 'always'],
       'jsdoc/require-jsdoc': [
         'error',
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.7.1",
+  "version": "1.9.0",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -19,19 +19,19 @@
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {
-    "@babel/preset-env": "^7.25.7",
-    "@eslint/js": "^9.10.0",
+    "@babel/preset-env": "^7.25.8",
+    "@eslint/js": "^9.12.0",
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.13",
     "eslint": "^9.12.0",
-    "eslint-plugin-jsdoc": "^50.3.1",
+    "eslint-plugin-jsdoc": "^50.3.2",
     "eslint-plugin-unicorn": "^56.0.0",
-    "globals": "^15.10.0",
+    "globals": "^15.11.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "lefthook": "^1.7.18",
     "prettier": "^3.3.3",
-    "typescript": "^5.6.2"
+    "typescript": "^5.6.3"
   },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",

package/src/index.js

@@ -6,10 +6,12 @@ export { capitalize } from './util/capitalize.js';
 export { deg2rad } from './util/deg2rad.js';
 export { delayPromise } from './util/delayPromise.js';
 export { FetchError, HTTP_0_ANY, fetchRetry } from './util/fetchRetry.js';
+export { fixFloatPrecision } from './util/fixFloatPrecision.js';
 export { getObjValueByPath } from './util/getObjValueByPath.js';
 export { getRandomInt } from './util/getRandomInt.js';
 export { getURLParam } from './util/getURLParam.js';
 export { purgeObject } from './util/purgeObject.js';
+export { addFloat, fixFloat, subFloat } from './util/safeFloat.js';
 export { sanitizeURLParam } from './util/sanitizeURLParam.js';
 export { saveAsFile } from './util/saveAsFile.js';
 export { setObjValueByPath } from './util/setObjValueByPath.js';

package/src/logging/Logger.js

@@ -9,9 +9,13 @@ export const LEVEL_SILENT = 0;
 
 export class Logger {
   /**
-   * @type {(error) => {}}
+   * @type {(error: Error) => {}}
    */
   static exceptionHandler = null;
+  /**
+   * @type {(level: string, message: string, extraData: object) => {}}
+   */
+  static suppressedLogHandler = null;
 
   /**
    * Creates a new Logger instance.
@@ -33,6 +37,9 @@ export class Logger {
    */
   debug(message, extraData = null) {
     if (this.level < LEVEL_DEBUG) {
+      if (Logger.suppressedLogHandler) {
+        Logger.suppressedLogHandler('debug', message, extraData);
+      }
       return;
     }
     const logMessage = `${Date.now()} [${this.name}] ${message}`;
@@ -50,6 +57,9 @@ export class Logger {
    */
   info(message, extraData = null) {
     if (this.level < LEVEL_INFO) {
+      if (Logger.suppressedLogHandler) {
+        Logger.suppressedLogHandler('info', message, extraData);
+      }
       return;
     }
     const logMessage = `${Date.now()} [${this.name}] ${message}`;
@@ -67,6 +77,9 @@ export class Logger {
    */
   warn(message, extraData = null) {
     if (this.level < LEVEL_WARN) {
+      if (Logger.suppressedLogHandler) {
+        Logger.suppressedLogHandler('warning', message, extraData);
+      }
       return;
     }
     const logMessage = `${Date.now()} [${this.name}] ${message}`;
@@ -84,6 +97,9 @@ export class Logger {
    */
   error(message, extraData = null) {
     if (this.level < LEVEL_ERROR) {
+      if (Logger.suppressedLogHandler) {
+        Logger.suppressedLogHandler('error', message, extraData);
+      }
       return;
     }
     const logMessage = `${Date.now()} [${this.name}] ${message}`;

package/src/util/fixFloatPrecision.js

@@ -0,0 +1,8 @@
+/**
+ * Fixes floating point number (0.20000000000000004 -> 0.2).
+ * @param {number} value - Number to fix.
+ * @returns {number} The fixed number.
+ */
+export function fixFloatPrecision(value) {
+  return Number.parseFloat(value.toPrecision(12));
+}

package/src/util/fixFloatPrecision.test.js

@@ -0,0 +1,5 @@
+import { fixFloatPrecision } from './fixFloatPrecision.js';
+
+test('TBD', () => {
+  expect(fixFloatPrecision(0.20000000000000004)).toBe(0.2);
+});

package/src/util/purgeObject.test.js

@@ -0,0 +1,8 @@
+import { purgeObject } from './purgeObject.js';
+
+test('TBD', () => {
+  const a = { k: 'v' };
+  expect(a.k).toBe('v');
+  purgeObject(a);
+  expect(a.k).toBe(null);
+});

package/src/util/safeFloat.js

@@ -0,0 +1,31 @@
+/**
+ * Convenience method for floating point precision handling.
+ * @param {number} value - The number to process.
+ * @param {number} p - The precision. Defaults to 2.
+ * @returns {number} The processed value.
+ */
+export function fixFloat(value, p = 2) {
+  return Number.parseFloat(value.toFixed(p));
+}
+
+/**
+ * Adds two value with floating point precision.
+ * @param {number} a - The number a.
+ * @param {number} b - The number b.
+ * @returns {number} The processed value.
+ */
+export function addFloat(a, b) {
+  const p = 100;
+  return fixFloat((a * p + b * p) / p);
+}
+
+/**
+ * Substracts two value with floating point precision.
+ * @param {number} a - The number a.
+ * @param {number} b - The number b.
+ * @returns {number} The processed value.
+ */
+export function subFloat(a, b) {
+  const p = 100;
+  return fixFloat((a * p - b * p) / p);
+}

package/src/util/safeFloat.test.js

@@ -0,0 +1,13 @@
+import { addFloat, fixFloat, subFloat } from './safeFloat.js';
+
+test('fixFloat()', () => {
+  expect(fixFloat(0.20000000000000004)).toBe(0.2);
+});
+
+test('addFloat()', () => {
+  expect(addFloat(0.20000000000000004, 0.1000001)).toBe(0.3);
+});
+
+test('subFloat()', () => {
+  expect(subFloat(0.20000000000000004, 0.1000001)).toBe(0.1);
+});

package/types/index.d.ts

@@ -4,6 +4,7 @@ export { addLeadingZero } from "./util/addLeadingZero.js";
 export { capitalize } from "./util/capitalize.js";
 export { deg2rad } from "./util/deg2rad.js";
 export { delayPromise } from "./util/delayPromise.js";
+export { fixFloatPrecision } from "./util/fixFloatPrecision.js";
 export { getObjValueByPath } from "./util/getObjValueByPath.js";
 export { getRandomInt } from "./util/getRandomInt.js";
 export { getURLParam } from "./util/getURLParam.js";
@@ -13,4 +14,5 @@ export { saveAsFile } from "./util/saveAsFile.js";
 export { setObjValueByPath } from "./util/setObjValueByPath.js";
 export { underscoreToCamelCase } from "./util/underscoreToCamelCase.js";
 export { FetchError, HTTP_0_ANY, fetchRetry } from "./util/fetchRetry.js";
+export { addFloat, fixFloat, subFloat } from "./util/safeFloat.js";
 //# sourceMappingURL=index.d.ts.map

package/types/util/cloneObject.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Clones an object.
+ * @param {object} source - A reference to the source object.
+ * @returns {object} The cloned object.
+ */
+export function cloneObject(source: object): object;
+//# sourceMappingURL=cloneObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"cloneObject.d.ts","sourceRoot":"","sources":["../../src/util/cloneObject.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oCAHW,MAAM,GACJ,MAAM,CAKlB"}

package/types/util/fixFloatPrecision.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Fixes floating point number (0.20000000000000004 -> 0.2).
+ * @param {number} value - Number to fix.
+ * @returns {number} The fixed number.
+ */
+export function fixFloatPrecision(value: number): number;
+//# sourceMappingURL=fixFloatPrecision.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fixFloatPrecision.d.ts","sourceRoot":"","sources":["../../src/util/fixFloatPrecision.js"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,yCAHW,MAAM,GACJ,MAAM,CAIlB"}

package/types/util/safeFloat.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Convenience method for floating point precision handling.
+ * @param {number} value - The number to process.
+ * @param {number} p - The precision. Defaults to 2.
+ * @returns {number} The processed value.
+ */
+export function fixFloat(value: number, p?: number): number;
+/**
+ * Adds two value with floating point precision.
+ * @param {number} a - The number a.
+ * @param {number} b - The number b.
+ * @returns {number} The processed value.
+ */
+export function addFloat(a: number, b: number): number;
+/**
+ * Substracts two value with floating point precision.
+ * @param {number} a - The number a.
+ * @param {number} b - The number b.
+ * @returns {number} The processed value.
+ */
+export function subFloat(a: number, b: number): number;
+//# sourceMappingURL=safeFloat.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"safeFloat.d.ts","sourceRoot":"","sources":["../../src/util/safeFloat.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,gCAJW,MAAM,MACN,MAAM,GACJ,MAAM,CAIlB;AAED;;;;;GAKG;AACH,4BAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAKlB;AAED;;;;;GAKG;AACH,4BAJW,MAAM,KACN,MAAM,GACJ,MAAM,CAKlB"}