loglevel-mixin 7.1.0 → 7.2.1

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2023 by Markus Felten
+Copyright (c) 2015-2024 by Markus Felten
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/loglevel-mixin.svg)](https://www.npmjs.com/package/loglevel-mixin)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![bundlejs](https://deno.bundlejs.com/?q=loglevel-mixin\&badge=detailed)](https://bundlejs.com/?q=loglevel-mixin)
 [![downloads](http://img.shields.io/npm/dm/loglevel-mixin.svg?style=flat-square)](https://npmjs.org/package/loglevel-mixin)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/loglevel-mixin.svg?style=flat-square)](https://github.com/arlac77/loglevel-mixin/issues)

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "loglevel-mixin",
-  "version": "7.1.0",
+  "version": "7.2.1",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
+  "types": "./types/loglevel-mixin.d.mts",
   "exports": {
-    ".": "./src/loglevel-mixin.mjs"
+    ".": {
+      "types": "./types/loglevel-mixin.d.mts",
+      "default": "./src/loglevel-mixin.mjs"
+    }
   },
   "description": "mixin to declare logging methods named after a set of log levels",
   "keywords": [
@@ -20,27 +25,30 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
     "test": "npm run test:browser-ava && npm run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
-    "ava": "^6.0.1",
-    "browser-ava": "^2.1.4",
-    "c8": "^8.0.1",
-    "documentation": "^14.0.2",
-    "semantic-release": "^22.0.10"
+    "ava": "^6.1.1",
+    "browser-ava": "^2.2.0",
+    "c8": "^9.1.0",
+    "documentation": "^14.0.3",
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=16.20.2"
+    "node": ">=20.11.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arlac77/loglevel-mixin"
+    "url": "git+https://github.com/arlac77/loglevel-mixin.git"
   },
   "bugs": {
     "url": "https://github.com/arlac77/loglevel-mixin/issues"
@@ -50,7 +58,9 @@
     "inheritFrom": [
       "arlac77/template-arlac77-github",
       "arlac77/template-browser-ava",
-      "arlac77/template-esm-only"
+      "arlac77/template-javascript-component",
+      "arlac77/template-node-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/types/loglevel-mixin.d.mts

@@ -0,0 +1,122 @@
+/**
+ * Generate the loglevel objects out of a list of log level names.
+ * @param {string[]} list A list of log level names. The last name in the list will become the one with the highest priority.
+ * @return {Object} levels object a hash with all the loglevels. Stored by there name.
+ */
+export function declareLevels(list: string[]): any;
+/**
+ * <!-- skip-example -->
+ * Adds logging methods to an existing object.
+ * For each loglevel a method with the name of the log level will be created.
+ * @param {Object} object target where to assign properties to
+ * @param {Object} logLevels Hash with all the available loglevels. Stored by there name
+ * @param {Logger} [theFunction] to be added under the loglevel name.
+ *        This function will only be called if the current loglevel is greater equal
+ *        the log level of the called logging function.
+ *        By default a method log(level,message) will be used
+ * @return {undefined}
+ * @example
+ * defineLoggerMethods( obj)
+ * obj.info('info entry'); // will redirect to theFunction if obj.loglevel is at least info
+ * obj.error('error entry'); // will redirect to theFunction if obj.loglevel is at least error
+ */
+export function defineLoggerMethods(object: any, logLevels?: any, theFunction?: Logger): undefined;
+/**
+ * <!-- skip-example -->
+ * @class
+ * @classdesc This function is a mixin for ES2015 classes.
+ * @param {Object} superclass class to be extendet
+ * @param {Object} logLevels Object with all the available loglevels. Stored by their name
+ * @param {Loglevel} initialLogLevel the default value for the logLevel property
+ * @return {Object} newly created class ready to be further extendet/used
+ * @example
+ * import { LogLevelMixin } = from 'loglevel-mixin';
+ * class BaseClass {
+ *   log(level, message) { console.log(`${level} ${message}`); }
+ * }
+ * class LoggingEnabledClass extends LogLevelMixin(BaseClass) {
+ * }
+ * @mixin
+ */
+export function LogLevelMixin(superclass: any, logLevels?: any, initialLogLevel?: Loglevel): any;
+export class LogLevelMixin {
+    /**
+     * <!-- skip-example -->
+     * @class
+     * @classdesc This function is a mixin for ES2015 classes.
+     * @param {Object} superclass class to be extendet
+     * @param {Object} logLevels Object with all the available loglevels. Stored by their name
+     * @param {Loglevel} initialLogLevel the default value for the logLevel property
+     * @return {Object} newly created class ready to be further extendet/used
+     * @example
+     * import { LogLevelMixin } = from 'loglevel-mixin';
+     * class BaseClass {
+     *   log(level, message) { console.log(`${level} ${message}`); }
+     * }
+     * class LoggingEnabledClass extends LogLevelMixin(BaseClass) {
+     * }
+     * @mixin
+     */
+    constructor(superclass: any, logLevels?: any, initialLogLevel?: Loglevel);
+}
+/**
+ * Helper function to aggregate values into a log event.
+ * @param {string} severity log severity
+ * @param {string|Object} arg original log message - level may be overwritten
+ * @param {Object} [args] additional values to be merged into the final log event - values have precedence
+ * @return {Object} suitable for log event processing
+ */
+export function makeLogEvent(severity: string, arg: string | any, args?: any): any;
+export namespace defaultLogLevels {
+    namespace trace {
+        let name: string;
+        let priority: number;
+    }
+    namespace debug {
+        let name_1: string;
+        export { name_1 as name };
+        let priority_1: number;
+        export { priority_1 as priority };
+    }
+    namespace info {
+        let name_2: string;
+        export { name_2 as name };
+        let priority_2: number;
+        export { priority_2 as priority };
+    }
+    namespace notice {
+        let name_3: string;
+        export { name_3 as name };
+        let priority_3: number;
+        export { priority_3 as priority };
+    }
+    namespace warn {
+        let name_4: string;
+        export { name_4 as name };
+        let priority_4: number;
+        export { priority_4 as priority };
+    }
+    namespace error {
+        let name_5: string;
+        export { name_5 as name };
+        let priority_5: number;
+        export { priority_5 as priority };
+    }
+    namespace crit {
+        let name_6: string;
+        export { name_6 as name };
+        let priority_6: number;
+        export { priority_6 as priority };
+    }
+    namespace alert {
+        let name_7: string;
+        export { name_7 as name };
+        let priority_7: number;
+        export { priority_7 as priority };
+    }
+}
+export type Logger = () => any;
+export type Loglevel = {
+    name: string;
+    priority: number;
+};