@imqueue/async-logger 2.0.2 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@imqueue/async-logger",
-  "version": "2.0.2",
+  "version": "3.0.0",
   "description": "Configurable async logger over winston for @imqueue services",
   "keywords": [
     "logger",
@@ -8,60 +8,25 @@
     "imqueue",
     "services"
   ],
-  "main": "index.js",
-  "dependencies": {
-    "@imqueue/core": "^2.0.11",
-    "winston": "^3.17.0",
-    "winston-transport": "^4.9.0"
-  },
-  "devDependencies": {
-    "@types/chai": "^5.2.2",
-    "@types/mocha": "^10.0.10",
-    "@types/mock-require": "^3.0.0",
-    "@types/node": "^24.3.1",
-    "@types/sinon": "^17.0.4",
-    "@typescript-eslint/eslint-plugin": "^8.42.0",
-    "@typescript-eslint/parser": "^8.42.0",
-    "@typescript-eslint/typescript-estree": "^8.42.0",
-    "chai": "^6.0.1",
-    "coveralls-next": "^5.0.0",
-    "eslint": "^9.34.0",
-    "glob": "^11.0.3",
-    "minimist": "^1.2.8",
-    "mocha": "^11.7.2",
-    "mocha-lcov-reporter": "^1.3.0",
-    "mock-require": "^3.0.3",
-    "npm-scripts-help": "^0.8.0",
-    "nyc": "^17.1.0",
-    "open": "^10.2.0",
-    "sinon": "^21.0.0",
-    "source-map-support": "^0.5.21",
-    "ts-node": "^10.9.2",
-    "typedoc": "^0.28.12",
-    "typedoc-plugin-as-member-of": "^1.0.2",
-    "typedoc-plugin-markdown": "^4.8.1",
-    "typescript": "^5.9.2"
-  },
   "scripts": {
-    "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 0",
-    "clean:ts": "find . -name '*.ts' -not -wholename '*node_modules*' -not -wholename '*.d.ts' -type f -delete",
-    "clean:dts": "find . -name '*.d.ts' -not -wholename '*node_modules*' -type f -delete",
-    "clean:map": "find . -name '*.js.map' -not -wholename '*node_modules*' -type f -delete",
-    "clean:js": "find . -name '*.js' -not -wholename '*node_modules*' -not -wholename '*bin*' -type f -delete",
-    "clean:build": "rm -rf ./node_modules/@types ; find . -name '*.js.map' -type f -delete ; find . -name '*.ts' -type f -delete",
-    "clean:test": "rm -rf .nyc_output coverage",
-    "clean:doc": "rm -rf docs",
-    "clean:wiki": "rm -rf wiki",
-    "clean": "npm run clean:test ; npm run clean:dts ; npm run clean:map ; npm run clean:js ; npm run clean:doc ; npm run clean:wiki",
-    "build": "tsc",
-    "mocha": "nyc mocha",
-    "show:doc": "/usr/bin/env node -e \"require('open')('file://`pwd`/docs/index.html',{wait:false});\"",
-    "doc": "npm run clean && typedoc --excludePrivate --excludeExternals --hideGenerator --exclude \"**/+(debug|test|node_modules|docs|coverage|.nyc_output|examples)/**/*\" --out ./docs --plugin typedoc-plugin-as-member-of . && npm run show:doc",
-    "help": "npm-scripts-help"
+    "clean-compiled": "npm run clean-js && npm run clean-typedefs && npm run clean-maps",
+    "build": "npm run clean-compiled && tsc",
+    "prepare": "npm run build",
+    "lint": "oxlint",
+    "format": "oxfmt \"index.ts\" \"src/**/*.ts\" \"test/**/*.ts\"",
+    "format:check": "oxfmt --check \"index.ts\" \"src/**/*.ts\" \"test/**/*.ts\"",
+    "test": "npm run build && node --test --test-timeout=15000 $(find test -name '*.spec.js')",
+    "test-coverage": "npm run build && node --enable-source-maps --test --experimental-test-coverage --test-timeout=15000 $(find test -name '*.spec.js')",
+    "test-lcov": "npm run build && mkdir -p coverage && node --enable-source-maps --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info --test-timeout=15000 $(find test -name '*.spec.js'); node scripts/strip-comment-coverage.mjs coverage/lcov.info",
+    "test-coverage-html": "npm run test-lcov; genhtml coverage/lcov.info --output-directory coverage/html --ignore-errors inconsistent,corrupt,format,mismatch && echo \"Coverage report: file://$(pwd)/coverage/html/index.html\"",
+    "test-dev": "npm run test && npm run clean-js && npm run clean-typedefs && npm run clean-maps",
+    "clean-typedefs": "find . -name '*.d.ts' -not -wholename '*node_modules*' -type f -delete",
+    "clean-maps": "find . -name '*.js.map' -not -wholename '*node_modules*' -type f -delete",
+    "clean-js": "find . -name '*.js' -not -wholename '*node_modules*' -type f -delete",
+    "clean-tests": "rm -rf .nyc_output coverage",
+    "clean-doc": "rm -rf docs",
+    "clean": "npm run clean-tests && npm run clean-typedefs && npm run clean-maps && npm run clean-js && npm run clean-doc"
   },
-  "author": "imqueue.com <support@imqueue.com>",
-  "license": "GPL-3.0-only",
   "repository": {
     "type": "git",
     "url": "git://github.com/imqueue/async-logger.git"
@@ -69,5 +34,20 @@
   "bugs": {
     "url": "https://github.com/imqueue/async-logger/issues"
   },
-  "homepage": "https://github.com/imqueue/async-logger"
+  "homepage": "https://github.com/imqueue/async-logger",
+  "author": "imqueue.com <support@imqueue.com> (https://imqueue.com)",
+  "license": "GPL-3.0-only",
+  "dependencies": {
+    "@imqueue/core": "^3.1.0",
+    "winston": "^3.19.0",
+    "winston-transport": "^4.9.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.9.1",
+    "oxfmt": "0.57.0",
+    "oxlint": "1.72.0",
+    "typescript": "^7.0.2"
+  },
+  "main": "index.js",
+  "types": "index.d.ts"
 }

package/src/Logger.d.ts

@@ -47,7 +47,7 @@ export declare class Logger implements ILogger {
      *
      * @type {WinstonLogger}
      */
-    private readonly logger;
+    private readonly logger?;
     /**
      * Logger Ctor
      *

package/src/Logger.js

@@ -7,6 +7,18 @@ const helpers_1 = require("./helpers");
  * Class Logger
  */
 class Logger {
+    /**
+     * Asynchronous console async-logger
+     *
+     * @type {ILogger}
+     */
+    static console = {
+        // oxlint-disable-next-line no-console -- forwarding is the API here
+        log: (...args) => setTimeout(() => console.log(...args)),
+        info: (...args) => setTimeout(() => console.info(...args)),
+        warn: (...args) => setTimeout(() => console.warn(...args)),
+        error: (...args) => setTimeout(() => console.error(...args)),
+    };
     /**
      * @description
      * Configuring options of async-logger
@@ -20,6 +32,12 @@ class Logger {
             defaultMeta: metadata || (0, helpers_1.defaultMetadata)(),
         };
     }
+    /**
+     * Winston based async-logger having different logging transports
+     *
+     * @type {WinstonLogger}
+     */
+    logger;
     /**
      * Logger Ctor
      *
@@ -97,20 +115,12 @@ class Logger {
                 continue;
             }
             const transport = (0, helpers_1.getTransport)(options.type, options.options);
-            this.logger.add(transport);
+            // the constructor always creates the winston logger before
+            // calling setupLogger(), the optional chaining only satisfies
+            // strict property-initialization analysis
+            this.logger?.add(transport);
         }
     }
 }
 exports.Logger = Logger;
-/**
- * Asynchronous console async-logger
- *
- * @type {ILogger}
- */
-Logger.console = {
-    log: (...args) => setTimeout(() => console.log(...args)),
-    info: (...args) => setTimeout(() => console.info(...args)),
-    warn: (...args) => setTimeout(() => console.warn(...args)),
-    error: (...args) => setTimeout(() => console.error(...args)),
-};
 //# sourceMappingURL=Logger.js.map

package/src/helpers/env.js

@@ -32,7 +32,7 @@ function transportsConfig() {
             .replace(RX_VERSION, version));
     }
     catch (err) {
-        throw new TypeError(`Logger: can not parse transports config: ${err.stack ? err.stack : err.message}`);
+        throw new TypeError(`Logger: can not parse transports config: ${err instanceof Error ? err.stack || err.message : String(err)}`);
     }
 }
 /**
@@ -48,7 +48,7 @@ function defaultMetadata() {
             .replace(RX_VERSION, version));
     }
     catch (err) {
-        throw new TypeError(`Logger: can not parse metadata: ${err.stack ? err.stack : err.message}`);
+        throw new TypeError(`Logger: can not parse metadata: ${err instanceof Error ? err.stack || err.message : String(err)}`);
     }
 }
 //# sourceMappingURL=env.js.map

package/eslint.config.mjs

@@ -1,58 +0,0 @@
-import typescriptEslint from "@typescript-eslint/eslint-plugin";
-import globals from "globals";
-import tsParser from "@typescript-eslint/parser";
-import path from "node:path";
-import { fileURLToPath } from "node:url";
-import js from "@eslint/js";
-import { FlatCompat } from "@eslint/eslintrc";
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-const compat = new FlatCompat({
-    baseDirectory: __dirname,
-    recommendedConfig: js.configs.recommended,
-    allConfig: js.configs.all
-});
-
-export default [
-    ...compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended"),
-    {
-        plugins: {
-            "@typescript-eslint": typescriptEslint,
-        },
-
-        languageOptions: {
-            globals: {
-                ...globals.node,
-            },
-
-            parser: tsParser,
-        },
-
-        rules: {
-            "max-len": ["error", {
-                code: 80,
-            }],
-
-            "new-parens": "error",
-            "no-caller": "error",
-            "no-cond-assign": ["error", "always"],
-            "no-multiple-empty-lines": "off",
-
-            quotes: ["error", "single", {
-                avoidEscape: true,
-            }],
-
-            "arrow-parens": "off",
-            "no-bitwise": "off",
-            "sort-keys": "off",
-            "no-console": "off",
-            "max-classes-per-file": "off",
-            "no-unused-expressions": "off",
-            "@typescript-eslint/interface-name-prefix": "off",
-            "comma-dangle": ["error", "always-multiline"],
-            "@typescript-eslint/no-namespace": "off",
-            "@typescript-eslint/no-extraneous-class": "off",
-        },
-    },
-];