nelog 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Mem U Sins
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,29 @@
1
+ # NoLog
2
+
3
+ nelog — adapter based logger util
4
+
5
+ ## Installation
6
+
7
+ ```shell
8
+ $ npm install nelog
9
+ ```
10
+
11
+ ## Adapters
12
+
13
+ | Adapter | destination |
14
+ |---------------------------------------------------------|---------------------|
15
+ | [Console](https://github.com/memUsins/nelogconsole) | Console adapter |
16
+ | [File](https://github.com/memUsins/nelogfile) | File (json) adapter |
17
+ | [Loki](https://github.com/memUsins/nelogloki) | Loki adapter |
18
+ | [Context Manager](https://github.com/memUsins/nelogctx) | Context manager |
19
+
20
+ ## Usage
21
+
22
+ ### Additional Methods for Logging
23
+ - **withFields**, **withField**, **withError**, **withName** for detailed context:
24
+ ```ts
25
+ logger.withFields({ "foo": "bar" }).info("Some log info")
26
+ logger.withField("foo", "bar").info("Some log info")
27
+ logger.withError(new Error("my error")).info("Some log info")
28
+ logger.withName("TestLogger").info("Some log info")
29
+ ```
package/lib/entry.d.ts ADDED
@@ -0,0 +1,18 @@
1
+ import { IEntry, F, Log, ILogger } from './thridparty';
2
+ export declare class Entry implements IEntry {
3
+ private logger;
4
+ private readonly data;
5
+ constructor(logger: ILogger);
6
+ log(log: Log): void;
7
+ withField(key: string, value: any): IEntry;
8
+ withFields(fields: F): IEntry;
9
+ withError(err: Error): IEntry;
10
+ withName(name: string): IEntry;
11
+ print(...args: any[]): void;
12
+ info(...args: any[]): void;
13
+ debug(...args: any[]): void;
14
+ debugJson(data: any): void;
15
+ warn(...args: any[]): void;
16
+ error(...args: any[]): void;
17
+ fatal(...args: any[]): void;
18
+ }
package/lib/entry.js ADDED
@@ -0,0 +1,80 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Entry = void 0;
4
+ const thridparty_1 = require("./thridparty");
5
+ // entry implements Entry
6
+ class Entry {
7
+ logger;
8
+ data;
9
+ constructor(logger) {
10
+ this.logger = logger;
11
+ this.data = {
12
+ fields: {},
13
+ error: null,
14
+ name: '',
15
+ withName: false,
16
+ };
17
+ }
18
+ // Log core method to logging
19
+ log(log) {
20
+ log.data = { ...this.data };
21
+ this.logger.log(log);
22
+ this.data.error = null;
23
+ this.data.fields = {};
24
+ }
25
+ // WithField add field to entry data
26
+ withField(key, value) {
27
+ this.data.fields = { [key]: value };
28
+ return this;
29
+ }
30
+ // WithFields add fields to entry data
31
+ withFields(fields) {
32
+ this.data.fields = { ...fields };
33
+ return this;
34
+ }
35
+ // WithError add error to entry data
36
+ withError(err) {
37
+ this.data.error = err;
38
+ return this;
39
+ }
40
+ // WithName add name to entry data
41
+ withName(name) {
42
+ this.data.name = name;
43
+ return this;
44
+ }
45
+ // Print default log
46
+ print(...args) {
47
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.UnselectedLevel, ...args));
48
+ }
49
+ // Info default log
50
+ info(...args) {
51
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.InfoLevel, ...args));
52
+ }
53
+ // Debug default log
54
+ debug(...args) {
55
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.DebugLevel, ...args));
56
+ }
57
+ // DebugJson log formating json struct
58
+ debugJson(data) {
59
+ try {
60
+ const jsonData = JSON.stringify(data, null, 2);
61
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.DebugLevel, jsonData));
62
+ }
63
+ catch (err) {
64
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.DebugLevel, 'failed to unmarshal json'));
65
+ }
66
+ }
67
+ // Warn default log
68
+ warn(...args) {
69
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.WarnLevel, ...args));
70
+ }
71
+ // Error default log
72
+ error(...args) {
73
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.ErrorLevel, ...args));
74
+ }
75
+ // Fatal default log
76
+ fatal(...args) {
77
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.FatalLevel, ...args));
78
+ }
79
+ }
80
+ exports.Entry = Entry;
package/lib/index.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export * from './thridparty';
2
+ export * from './logger';
3
+ export * from './entry';
package/lib/index.js ADDED
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./thridparty"), exports);
18
+ __exportStar(require("./logger"), exports);
19
+ __exportStar(require("./entry"), exports);
@@ -0,0 +1,21 @@
1
+ import { IAdapter, IEntry, F, Log, ILogger } from './thridparty';
2
+ export declare class Logger implements ILogger {
3
+ private readonly adapters;
4
+ constructor(adapters?: IAdapter[]);
5
+ log(log: Log): void;
6
+ withField(key: string, value: any): IEntry;
7
+ withFields(fields: F): IEntry;
8
+ withName(name: string): IEntry;
9
+ withError(err: Error): IEntry;
10
+ print(...args: any[]): void;
11
+ info(...args: any[]): void;
12
+ infon(name: string, ...args: any[]): void;
13
+ debug(...args: any[]): void;
14
+ debugn(name: string, ...args: any[]): void;
15
+ warn(...args: any[]): void;
16
+ warnn(name: string, ...args: any[]): void;
17
+ error(...args: any[]): void;
18
+ errorn(name: string, ...args: any[]): void;
19
+ fatal(...args: any[]): void;
20
+ fataln(name: string, ...args: any[]): void;
21
+ }
package/lib/logger.js ADDED
@@ -0,0 +1,88 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Logger = void 0;
4
+ const thridparty_1 = require("./thridparty");
5
+ const entry_1 = require("./entry");
6
+ // Logger implements ILogger
7
+ class Logger {
8
+ adapters;
9
+ constructor(adapters = []) {
10
+ this.adapters = adapters;
11
+ }
12
+ // Log core method to logging
13
+ log(log) {
14
+ for (const adapter of this.adapters) {
15
+ const copy = (0, thridparty_1.newLogCopy)(log);
16
+ adapter.log(copy);
17
+ }
18
+ }
19
+ // WithField returns Entry with field
20
+ withField(key, value) {
21
+ const e = new entry_1.Entry(this);
22
+ e.withField(key, value);
23
+ return e;
24
+ }
25
+ // WithFields returns Entry with fields
26
+ withFields(fields) {
27
+ const e = new entry_1.Entry(this);
28
+ e.withFields(fields);
29
+ return e;
30
+ }
31
+ // WithName returns Entry with name
32
+ withName(name) {
33
+ const e = new entry_1.Entry(this);
34
+ e.withName(name);
35
+ return e;
36
+ }
37
+ // WithError returns Entry with error
38
+ withError(err) {
39
+ const e = new entry_1.Entry(this);
40
+ e.withError(err);
41
+ return e;
42
+ }
43
+ // Print default log
44
+ print(...args) {
45
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.UnselectedLevel, ...args));
46
+ }
47
+ // Info default log
48
+ info(...args) {
49
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.InfoLevel, ...args));
50
+ }
51
+ // Infon log with name
52
+ infon(name, ...args) {
53
+ this.log((0, thridparty_1.newDefaultLogn)(thridparty_1.Level.InfoLevel, name, ...args));
54
+ }
55
+ // Debug default log
56
+ debug(...args) {
57
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.DebugLevel, ...args));
58
+ }
59
+ // Debugn log with name
60
+ debugn(name, ...args) {
61
+ this.log((0, thridparty_1.newDefaultLogn)(thridparty_1.Level.DebugLevel, name, ...args));
62
+ }
63
+ // Warn default log
64
+ warn(...args) {
65
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.WarnLevel, ...args));
66
+ }
67
+ // Warnn log with name
68
+ warnn(name, ...args) {
69
+ this.log((0, thridparty_1.newDefaultLogn)(thridparty_1.Level.WarnLevel, name, ...args));
70
+ }
71
+ // Error default log
72
+ error(...args) {
73
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.ErrorLevel, ...args));
74
+ }
75
+ // Errorn log with name
76
+ errorn(name, ...args) {
77
+ this.log((0, thridparty_1.newDefaultLogn)(thridparty_1.Level.ErrorLevel, name, ...args));
78
+ }
79
+ // Fatal default log
80
+ fatal(...args) {
81
+ this.log((0, thridparty_1.newDefaultLog)(thridparty_1.Level.FatalLevel, ...args));
82
+ }
83
+ // Fataln log with name
84
+ fataln(name, ...args) {
85
+ this.log((0, thridparty_1.newDefaultLogn)(thridparty_1.Level.FatalLevel, name, ...args));
86
+ }
87
+ }
88
+ exports.Logger = Logger;
@@ -0,0 +1,3 @@
1
+ export { ILogger, IEntry, IAdapter } from './types';
2
+ export { Level, isLevelEnabled, levelToString } from './level';
3
+ export { F, Log, LogData, newLogCopy, newDefaultLog, newDefaultLogn } from './log';
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.newDefaultLogn = exports.newDefaultLog = exports.newLogCopy = exports.levelToString = exports.isLevelEnabled = exports.Level = void 0;
4
+ var level_1 = require("./level");
5
+ Object.defineProperty(exports, "Level", { enumerable: true, get: function () { return level_1.Level; } });
6
+ Object.defineProperty(exports, "isLevelEnabled", { enumerable: true, get: function () { return level_1.isLevelEnabled; } });
7
+ Object.defineProperty(exports, "levelToString", { enumerable: true, get: function () { return level_1.levelToString; } });
8
+ var log_1 = require("./log");
9
+ Object.defineProperty(exports, "newLogCopy", { enumerable: true, get: function () { return log_1.newLogCopy; } });
10
+ Object.defineProperty(exports, "newDefaultLog", { enumerable: true, get: function () { return log_1.newDefaultLog; } });
11
+ Object.defineProperty(exports, "newDefaultLogn", { enumerable: true, get: function () { return log_1.newDefaultLogn; } });
@@ -0,0 +1,10 @@
1
+ export declare enum Level {
2
+ DebugLevel = -2,
3
+ InfoLevel = -1,
4
+ WarnLevel = 0,
5
+ ErrorLevel = 1,
6
+ FatalLevel = 2,
7
+ UnselectedLevel = 3
8
+ }
9
+ export declare const isLevelEnabled: (current: Level, level: Level) => boolean;
10
+ export declare const levelToString: (level: Level) => string;
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.levelToString = exports.isLevelEnabled = exports.Level = void 0;
4
+ // Level core level declaration
5
+ var Level;
6
+ (function (Level) {
7
+ Level[Level["DebugLevel"] = -2] = "DebugLevel";
8
+ Level[Level["InfoLevel"] = -1] = "InfoLevel";
9
+ Level[Level["WarnLevel"] = 0] = "WarnLevel";
10
+ Level[Level["ErrorLevel"] = 1] = "ErrorLevel";
11
+ Level[Level["FatalLevel"] = 2] = "FatalLevel";
12
+ Level[Level["UnselectedLevel"] = 3] = "UnselectedLevel";
13
+ })(Level || (exports.Level = Level = {}));
14
+ // IsEnabled check is level enabled
15
+ const isLevelEnabled = (current, level) => {
16
+ return level >= current;
17
+ };
18
+ exports.isLevelEnabled = isLevelEnabled;
19
+ // String returns the string representation of the level
20
+ const levelToString = (level) => {
21
+ switch (level) {
22
+ case Level.DebugLevel:
23
+ return 'debug';
24
+ case Level.InfoLevel:
25
+ return 'info';
26
+ case Level.WarnLevel:
27
+ return 'warn';
28
+ case Level.ErrorLevel:
29
+ return 'error';
30
+ case Level.FatalLevel:
31
+ return 'fatal';
32
+ case Level.UnselectedLevel:
33
+ return 'unselected';
34
+ default:
35
+ return '';
36
+ }
37
+ };
38
+ exports.levelToString = levelToString;
@@ -0,0 +1,17 @@
1
+ import { Level } from './level';
2
+ export type F = Record<string, any>;
3
+ export interface LogData {
4
+ fields: F;
5
+ error: Error | null;
6
+ name: string;
7
+ withName: boolean;
8
+ }
9
+ export interface Log {
10
+ level: Level;
11
+ data: LogData;
12
+ message: string;
13
+ timestamp: Date;
14
+ }
15
+ export declare const newLogCopy: (log: Log) => Log;
16
+ export declare const newDefaultLog: (level: Level, ...args: any[]) => Log;
17
+ export declare const newDefaultLogn: (level: Level, name: string, ...args: any[]) => Log;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.newDefaultLogn = exports.newDefaultLog = exports.newLogCopy = void 0;
4
+ // NewLogCopy returns copied Log
5
+ const newLogCopy = (log) => {
6
+ const fields = {};
7
+ for (const [k, v] of Object.entries(log.data.fields)) {
8
+ fields[k] = v;
9
+ }
10
+ return {
11
+ level: log.level,
12
+ message: log.message,
13
+ data: {
14
+ fields,
15
+ error: log.data.error,
16
+ name: log.data.name,
17
+ withName: log.data.withName,
18
+ },
19
+ timestamp: log.timestamp,
20
+ };
21
+ };
22
+ exports.newLogCopy = newLogCopy;
23
+ // NewDefaultLog returns new Log
24
+ const newDefaultLog = (level, ...args) => {
25
+ return {
26
+ level,
27
+ message: args.map(String).join(' '),
28
+ data: {
29
+ fields: {},
30
+ error: null,
31
+ name: '',
32
+ withName: false,
33
+ },
34
+ timestamp: new Date(),
35
+ };
36
+ };
37
+ exports.newDefaultLog = newDefaultLog;
38
+ // NewDefaultLogn returns new Log with name args
39
+ const newDefaultLogn = (level, name, ...args) => {
40
+ return {
41
+ level,
42
+ message: args.map(String).join(' '),
43
+ data: {
44
+ fields: {},
45
+ error: null,
46
+ name,
47
+ withName: false,
48
+ },
49
+ timestamp: new Date(),
50
+ };
51
+ };
52
+ exports.newDefaultLogn = newDefaultLogn;
@@ -0,0 +1,36 @@
1
+ import { F, Log } from './log';
2
+ export interface ILogger {
3
+ log(log: Log): void;
4
+ withField(key: string, value: any): IEntry;
5
+ withFields(fields: F): IEntry;
6
+ withError(err: Error): IEntry;
7
+ withName(name: string): IEntry;
8
+ print(...args: any[]): void;
9
+ info(...args: any[]): void;
10
+ infon(name: string, ...args: any[]): void;
11
+ debug(...args: any[]): void;
12
+ debugn(name: string, ...args: any[]): void;
13
+ warn(...args: any[]): void;
14
+ warnn(name: string, ...args: any[]): void;
15
+ error(...args: any[]): void;
16
+ errorn(name: string, ...args: any[]): void;
17
+ fatal(...args: any[]): void;
18
+ fataln(name: string, ...args: any[]): void;
19
+ }
20
+ export interface IEntry {
21
+ log(log: Log): void;
22
+ withField(key: string, value: any): IEntry;
23
+ withFields(fields: F): IEntry;
24
+ withError(err: Error): IEntry;
25
+ withName(name: string): IEntry;
26
+ print(...args: any[]): void;
27
+ info(...args: any[]): void;
28
+ debug(...args: any[]): void;
29
+ warn(...args: any[]): void;
30
+ error(...args: any[]): void;
31
+ fatal(...args: any[]): void;
32
+ }
33
+ export interface IAdapter {
34
+ log(log: Log): void;
35
+ format(log: Log): unknown;
36
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "name": "nelog",
3
+ "version": "0.0.1",
4
+ "description": "Logger",
5
+ "main": "lib/index.js",
6
+ "types": "lib/index.d.ts",
7
+ "files": [
8
+ "lib/**/*"
9
+ ],
10
+ "scripts": {
11
+ "build": "tsc && tsc-alias",
12
+ "format": "prettier -w ./src",
13
+ "lint": "eslint . --ext .ts"
14
+ },
15
+ "keywords": [
16
+ "Logger"
17
+ ],
18
+ "type": "commonjs",
19
+ "author": "memUsins",
20
+ "devDependencies": {
21
+ "eslint": "^9.39.1",
22
+ "prettier": "^3.7.3"
23
+ }
24
+ }