@vpmedia/simplify 1.1.0 → 1.2.1

package/CHANGES.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.2.1
+
+- Fixed logger issue with vite compiled apps
+
+## 1.2.0
+
+- Added Logger class
+- Fixed lint and typecheck issues
+
 ## 1.1.0
 
 - Updated dependencies

package/README.md

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

@@ -0,0 +1,88 @@
+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';
+
+/** @type { import('eslint').Linter.FlatConfig[] } */
+export default [
+  {
+    ignores: [
+      '.github/**/*.*',
+      '.idea/**/*.*',
+      '.vscode/**/*.*',
+      'build/**/*.*',
+      'coverage/**/*.*',
+      'dist/**/*.*',
+      'public/**/*.*',
+      'types/**/*.*',
+      'node_modules/**/*.*',
+    ],
+  },
+  {
+    languageOptions: {
+      globals: {
+        ...globals.jest,
+        ...globals.browser,
+        ...globals.node,
+        ...globals.es2021,
+      },
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    files: ['**/*.{js,jsx,mjs,cjs,ts,tsx}'],
+    plugins: {
+      import: importPlugin,
+      jsdoc: jsdocPlugin,
+      unicorn: unicornPlugin,
+    },
+    settings: {
+      'import/parsers': {
+        espree: ['.js', '.cjs', '.mjs', '.jsx'],
+      },
+      'import/resolver': {
+        node: true,
+      },
+    },
+    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',
+      'unicorn/prevent-abbreviations': 'off',
+      'no-unused-vars': 'warn',
+      'prefer-arrow-callback': 'error',
+      'prefer-template': 'error',
+      'import/extensions': ['warn', 'always'],
+      'jsdoc/require-jsdoc': [
+        'error',
+        {
+          require: {
+            FunctionDeclaration: true,
+            MethodDefinition: true,
+            ClassDeclaration: false,
+            ArrowFunctionExpression: false,
+            FunctionExpression: false,
+          },
+        },
+      ],
+      'jsdoc/check-indentation': 1,
+      'jsdoc/check-line-alignment': 1,
+      'jsdoc/check-syntax': 1,
+      'jsdoc/require-asterisk-prefix': 1,
+      'jsdoc/require-description': 1,
+      'jsdoc/require-description-complete-sentence': 1,
+      'jsdoc/require-hyphen-before-param-description': 1,
+      'jsdoc/require-throws': 1,
+      'jsdoc/sort-tags': 1,
+      'jsdoc/no-undefined-types': 0,
+    },
+  },
+];

package/lefthook.yml

@@ -10,13 +10,8 @@ pre-commit:
       run: |
         set -e
         yq 'true' {staged_files} > /dev/null
-    lint_json:
-      glob: "*.{json}"
-      run: |
-        set -e
-        jq empty {staged_files}
     lint_js:
-      glob: "*.{js,ts,jsx,tsx}"
+      glob: "*.{js,jsx}"
       run: |
         set -e
         ./node_modules/.bin/eslint {staged_files}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/simplify",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "@vpmedia/simplify",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -19,24 +19,27 @@
   "types": "./types/index.d.ts",
   "type": "module",
   "devDependencies": {
-    "@babel/preset-env": "^7.23.9",
+    "@babel/preset-env": "^7.24.4",
+    "@eslint/js": "^8.57.0",
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.12",
-    "eslint": "^8.56.0",
+    "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jest": "^27.6.3",
-    "eslint-plugin-jsdoc": "^48.0.4",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-jsdoc": "^48.2.3",
+    "eslint-plugin-unicorn": "^52.0.0",
+    "globals": "^15.0.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
-    "lefthook": "^1.6.1",
-    "prettier": "^3.2.4",
-    "typescript": "^5.3.3"
+    "lefthook": "^1.6.10",
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.5"
   },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
     "lint": "eslint \"**/*.{js,jsx}\"",
     "typecheck": "tsc",
-    "format": "prettier --write \"**/*.{css,js,jsx}\"",
+    "format": "prettier --write \"./**/*.{js,jsx,mjs,cjs,ts,tsx,json,md,css}\"",
     "lefthook:install": "lefthook install",
     "lefthook:uninstall": "lefthook uninstall"
   },

package/src/index.js

@@ -1,20 +1,10 @@
 // core
-import { addLeadingZero } from './util/addLeadingZero.js';
-import { capitalize } from './util/capitalize.js';
-import { getObjValueByPath } from './util/getObjValueByPath.js';
-import { getRandomInt } from './util/getRandomInt.js';
-import { getURLParam } from './util/getURLParam.js';
-import { sanitizeURLParam } from './util/sanitizeURLParam.js';
-import { setObjValueByPath } from './util/setObjValueByPath.js';
-import { underscoreToCamelCase } from './util/underscoreToCamelCase.js';
-// exports
-export {
-  addLeadingZero,
-  capitalize,
-  getObjValueByPath,
-  getRandomInt,
-  getURLParam,
-  sanitizeURLParam,
-  setObjValueByPath,
-  underscoreToCamelCase,
-};
+export { Logger } from './logging/Logger.js';
+export { addLeadingZero } from './util/addLeadingZero.js';
+export { capitalize } from './util/capitalize.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';

package/src/logging/Logger.js

@@ -0,0 +1,113 @@
+import { getURLParam } from '../util/getURLParam.js';
+
+export const LEVEL_DEBUG = 4;
+export const LEVEL_INFO = 3;
+export const LEVEL_WARN = 2;
+export const LEVEL_ERROR = 1;
+export const LEVEL_SILENT = 0;
+
+export class Logger {
+  /**
+   * @type {(error) => {}}
+   */
+  static exceptionHandler = null;
+
+  /**
+   * Creates a new Logger instance.
+   * @param {string} name - The logger name.
+   */
+  constructor(name) {
+    this.name = name;
+    const appEnvironment = process?.env.APP_ENVIRONMENT || 'local';
+    const isProduction = appEnvironment === 'production' || appEnvironment === 'release';
+    const defaultLevel = isProduction ? LEVEL_SILENT : LEVEL_DEBUG;
+    const parameterName = `log_${this.name.toLowerCase()}`;
+    this.level = Number.parseInt(getURLParam(parameterName, defaultLevel), 10);
+    const allLevel = Number.parseInt(getURLParam('log_all', LEVEL_SILENT), 10);
+    this.level = allLevel || this.level;
+  }
+
+  /**
+   * TBD.
+   * @param {string} message - TBD.
+   * @param {object} extraData - TBD.
+   */
+  debug(message, extraData = null) {
+    if (this.level < LEVEL_DEBUG) {
+      return;
+    }
+    const logMessage = `${Date.now()} [${this.name}] ${message}`;
+    if (extraData !== null) {
+      console.debug(logMessage, extraData);
+      return;
+    }
+    console.debug(logMessage);
+  }
+
+  /**
+   * TBD.
+   * @param {string} message - TBD.
+   * @param {object} extraData - TBD.
+   */
+  info(message, extraData = null) {
+    if (this.level < LEVEL_INFO) {
+      return;
+    }
+    const logMessage = `${Date.now()} [${this.name}] ${message}`;
+    if (extraData !== null) {
+      console.info(logMessage, extraData);
+      return;
+    }
+    console.info(logMessage);
+  }
+
+  /**
+   * TBD.
+   * @param {string} message - TBD.
+   * @param {object} extraData - TBD.
+   */
+  warn(message, extraData = null) {
+    if (this.level < LEVEL_WARN) {
+      return;
+    }
+    const logMessage = `${Date.now()} [${this.name}] ${message}`;
+    if (extraData !== null) {
+      console.warn(logMessage, extraData);
+      return;
+    }
+    console.warn(logMessage);
+  }
+
+  /**
+   * TBD.
+   * @param {string} message - TBD.
+   * @param {object} extraData - TBD.
+   */
+  error(message, extraData = null) {
+    if (this.level < LEVEL_ERROR) {
+      return;
+    }
+    const logMessage = `${Date.now()} [${this.name}] ${message}`;
+    if (extraData !== null) {
+      console.error(logMessage, extraData);
+      return;
+    }
+    console.error(logMessage);
+  }
+
+  /**
+   * TBD.
+   * @param {string} message - TBD.
+   * @param {Error} exception - TBD.
+   */
+  exception(message, exception) {
+    if (Logger.exceptionHandler) {
+      Logger.exceptionHandler(exception);
+    }
+    if (this.level < LEVEL_ERROR) {
+      return;
+    }
+    const logMessage = `${Date.now()} [${this.name}] ${message}`;
+    console.error(logMessage, exception);
+  }
+}

package/src/logging/Logger.test.js

@@ -0,0 +1,14 @@
+import { LEVEL_DEBUG, Logger } from './Logger.js';
+
+test('Tests Logger', () => {
+  const logger = new Logger('test');
+  expect(Logger.exceptionHandler).toBe(null);
+  expect(logger.level).toBe(LEVEL_DEBUG);
+  let handledError = null;
+  const exceptionHandler = (error) => {
+    handledError = error;
+  };
+  Logger.exceptionHandler = exceptionHandler;
+  logger.exception('test', 'error');
+  expect(handledError).toBe('error');
+});

package/src/util/addLeadingZero.js

@@ -6,11 +6,12 @@
  */
 export function addLeadingZero(value, size = 2) {
   if (value === null || value === undefined) {
+    // @ts-ignore: Type 'string | number' is not assignable to type 'string'.
     return value;
   }
   value = value.toString();
   while (value.length < size) {
-    value = '0' + value;
+    value = `0${value}`;
   }
   return value;
 }

package/src/util/addLeadingZero.test.js

@@ -7,5 +7,5 @@ test('Tests add leading zero', () => {
   expect(addLeadingZero('21')).toBe('21');
   expect(addLeadingZero(21)).toBe('21');
   expect(addLeadingZero(null)).toBe(null);
-  expect(addLeadingZero(undefined)).toBe(undefined);
+  expect(addLeadingZero()).toBe(undefined);
 });

package/src/util/sanitizeURLParam.js

@@ -7,5 +7,5 @@ export function sanitizeURLParam(input) {
   if (!input) {
     return input;
   }
-  return input.replace(/[^a-zA-Z0-9-_]/gi, '');
+  return input.replaceAll(/[^\w-]/gi, '');
 }

package/src/util/underscoreToCamelCase.js

@@ -4,7 +4,7 @@
  * @returns {string} The output string in camel case.
  */
 export function underscoreToCamelCase(value) {
-  return value.replace(/(_\w)/g, function (m) {
+  return value.replaceAll(/(_\w)/g, (m) => {
     return m[1].toUpperCase();
   });
 }

package/types/index.d.ts

@@ -1,9 +1,10 @@
-import { capitalize } from './util/capitalize.js';
-import { getObjValueByPath } from './util/getObjValueByPath.js';
-import { getRandomInt } from './util/getRandomInt.js';
-import { getURLParam } from './util/getURLParam.js';
-import { sanitizeURLParam } from './util/sanitizeURLParam.js';
-import { setObjValueByPath } from './util/setObjValueByPath.js';
-import { underscoreToCamelCase } from './util/underscoreToCamelCase.js';
-export { capitalize, getObjValueByPath, getRandomInt, getURLParam, sanitizeURLParam, setObjValueByPath, underscoreToCamelCase };
+export { Logger } from "./logging/Logger.js";
+export { addLeadingZero } from "./util/addLeadingZero.js";
+export { capitalize } from "./util/capitalize.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";
 //# sourceMappingURL=index.d.ts.map

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"2BAC2B,sBAAsB;kCACf,6BAA6B;6BAClC,wBAAwB;4BACzB,uBAAuB;iCAClB,4BAA4B;kCAC3B,6BAA6B;sCACzB,iCAAiC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":""}

package/types/logging/Logger.d.ts

@@ -0,0 +1,49 @@
+export const LEVEL_DEBUG: 4;
+export const LEVEL_INFO: 3;
+export const LEVEL_WARN: 2;
+export const LEVEL_ERROR: 1;
+export const LEVEL_SILENT: 0;
+export class Logger {
+    /**
+     * @type {(error) => {}}
+     */
+    static exceptionHandler: (error) => {};
+    /**
+     * Creates a new Logger instance.
+     * @param {string} name - The logger name.
+     */
+    constructor(name: string);
+    name: string;
+    level: number;
+    /**
+     * TBD.
+     * @param {string} message - TBD.
+     * @param {object} extraData - TBD.
+     */
+    debug(message: string, extraData?: object): void;
+    /**
+     * TBD.
+     * @param {string} message - TBD.
+     * @param {object} extraData - TBD.
+     */
+    info(message: string, extraData?: object): void;
+    /**
+     * TBD.
+     * @param {string} message - TBD.
+     * @param {object} extraData - TBD.
+     */
+    warn(message: string, extraData?: object): void;
+    /**
+     * TBD.
+     * @param {string} message - TBD.
+     * @param {object} extraData - TBD.
+     */
+    error(message: string, extraData?: object): void;
+    /**
+     * TBD.
+     * @param {string} message - TBD.
+     * @param {Error} exception - TBD.
+     */
+    exception(message: string, exception: Error): void;
+}
+//# sourceMappingURL=Logger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Logger.d.ts","sourceRoot":"","sources":["../../src/logging/Logger.js"],"names":[],"mappings":"AAEA,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,EAWhB;IARC,aAAgB;IAKhB,cAA0E;IAK5E;;;;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/addLeadingZero.d.ts

@@ -0,0 +1,8 @@
+/**
+ * TBD.
+ * @param {number|string} value - TBD.
+ * @param {number} size - TBD.
+ * @returns {string} TBD.
+ */
+export function addLeadingZero(value: number | string, size?: number): string;
+//# sourceMappingURL=addLeadingZero.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"addLeadingZero.d.ts","sourceRoot":"","sources":["../../src/util/addLeadingZero.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,sCAJW,MAAM,GAAC,MAAM,SACb,MAAM,GACJ,MAAM,CAYlB"}