@decaf-ts/logging 0.2.3 → 0.3.0
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.md +0 -0
- package/README.md +363 -2
- package/dist/logging.cjs +304 -89
- package/dist/logging.esm.cjs +304 -89
- package/lib/constants.cjs +28 -15
- package/lib/constants.d.ts +26 -14
- package/lib/decorators.cjs +65 -1
- package/lib/decorators.d.ts +64 -0
- package/lib/esm/constants.d.ts +26 -14
- package/lib/esm/constants.js +28 -15
- package/lib/esm/decorators.d.ts +64 -0
- package/lib/esm/decorators.js +65 -1
- package/lib/esm/index.d.ts +6 -12
- package/lib/esm/index.js +7 -13
- package/lib/esm/logging.d.ts +190 -63
- package/lib/esm/logging.js +207 -63
- package/lib/esm/types.d.ts +57 -9
- package/lib/esm/types.js +1 -1
- package/lib/esm/winston/index.d.ts +0 -0
- package/lib/esm/winston/index.js +0 -0
- package/lib/esm/winston/winston.d.ts +39 -0
- package/lib/esm/winston/winston.js +40 -1
- package/lib/index.cjs +7 -13
- package/lib/index.d.ts +6 -12
- package/lib/logging.cjs +207 -63
- package/lib/logging.d.ts +190 -63
- package/lib/types.cjs +1 -1
- package/lib/types.d.ts +57 -9
- package/lib/winston/index.cjs +0 -0
- package/lib/winston/index.d.ts +0 -0
- package/lib/winston/winston.cjs +40 -1
- package/lib/winston/winston.d.ts +39 -0
- package/package.json +1 -1
package/lib/constants.cjs
CHANGED
|
@@ -5,7 +5,7 @@ exports.DefaultLoggingConfig = exports.DefaultTheme = exports.LoggingMode = expo
|
|
|
5
5
|
* @description Enum for log levels.
|
|
6
6
|
* @summary Defines different levels of logging for the application.
|
|
7
7
|
* @enum {string}
|
|
8
|
-
* @memberOf
|
|
8
|
+
* @memberOf module:Logging
|
|
9
9
|
*/
|
|
10
10
|
var LogLevel;
|
|
11
11
|
(function (LogLevel) {
|
|
@@ -23,13 +23,13 @@ var LogLevel;
|
|
|
23
23
|
/**
|
|
24
24
|
* @description Numeric values associated with log levels.
|
|
25
25
|
* @summary Provides a numeric representation of log levels for comparison and filtering.
|
|
26
|
-
* @const
|
|
27
|
-
* @property {number} error - Numeric value for error level (
|
|
28
|
-
* @property {number} info - Numeric value for info level (
|
|
29
|
-
* @property {number} verbose - Numeric value for verbose level (
|
|
30
|
-
* @property {number} debug - Numeric value for debug level (
|
|
31
|
-
* @property {number} silly - Numeric value for silly level (
|
|
32
|
-
* @memberOf
|
|
26
|
+
* @const NumericLogLevels
|
|
27
|
+
* @property {number} error - Numeric value for error level (2).
|
|
28
|
+
* @property {number} info - Numeric value for info level (4).
|
|
29
|
+
* @property {number} verbose - Numeric value for verbose level (6).
|
|
30
|
+
* @property {number} debug - Numeric value for debug level (7).
|
|
31
|
+
* @property {number} silly - Numeric value for silly level (9).
|
|
32
|
+
* @memberOf module:Logging
|
|
33
33
|
*/
|
|
34
34
|
exports.NumericLogLevels = {
|
|
35
35
|
error: 2,
|
|
@@ -38,9 +38,17 @@ exports.NumericLogLevels = {
|
|
|
38
38
|
debug: 7,
|
|
39
39
|
silly: 9,
|
|
40
40
|
};
|
|
41
|
+
/**
|
|
42
|
+
* @description Enum for logging output modes.
|
|
43
|
+
* @summary Defines different output formats for log messages.
|
|
44
|
+
* @enum {string}
|
|
45
|
+
* @memberOf module:Logging
|
|
46
|
+
*/
|
|
41
47
|
var LoggingMode;
|
|
42
48
|
(function (LoggingMode) {
|
|
49
|
+
/** Raw text format for human readability */
|
|
43
50
|
LoggingMode["RAW"] = "raw";
|
|
51
|
+
/** JSON format for machine parsing */
|
|
44
52
|
LoggingMode["JSON"] = "json";
|
|
45
53
|
})(LoggingMode || (exports.LoggingMode = LoggingMode = {}));
|
|
46
54
|
/**
|
|
@@ -49,23 +57,24 @@ var LoggingMode;
|
|
|
49
57
|
* @const DefaultTheme
|
|
50
58
|
* @typedef {Theme} DefaultTheme
|
|
51
59
|
* @property {Object} class - Styling for class names.
|
|
52
|
-
* @property {number} class.fg - Foreground color code for class names (
|
|
60
|
+
* @property {number} class.fg - Foreground color code for class names (34).
|
|
53
61
|
* @property {Object} id - Styling for identifiers.
|
|
54
62
|
* @property {number} id.fg - Foreground color code for identifiers (36).
|
|
55
63
|
* @property {Object} stack - Styling for stack traces (empty object).
|
|
56
64
|
* @property {Object} timestamp - Styling for timestamps (empty object).
|
|
57
65
|
* @property {Object} message - Styling for different types of messages.
|
|
58
66
|
* @property {Object} message.error - Styling for error messages.
|
|
59
|
-
* @property {number} message.error.fg - Foreground color code for error messages (
|
|
67
|
+
* @property {number} message.error.fg - Foreground color code for error messages (31).
|
|
60
68
|
* @property {Object} method - Styling for method names (empty object).
|
|
61
69
|
* @property {Object} logLevel - Styling for different log levels.
|
|
62
70
|
* @property {Object} logLevel.error - Styling for error level logs.
|
|
63
|
-
* @property {number} logLevel.error.fg - Foreground color code for error level logs (
|
|
71
|
+
* @property {number} logLevel.error.fg - Foreground color code for error level logs (31).
|
|
72
|
+
* @property {string[]} logLevel.error.style - Style attributes for error level logs (["bold"]).
|
|
64
73
|
* @property {Object} logLevel.info - Styling for info level logs (empty object).
|
|
65
74
|
* @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).
|
|
66
75
|
* @property {Object} logLevel.debug - Styling for debug level logs.
|
|
67
|
-
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (
|
|
68
|
-
* @memberOf
|
|
76
|
+
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (33).
|
|
77
|
+
* @memberOf module:Logging
|
|
69
78
|
*/
|
|
70
79
|
exports.DefaultTheme = {
|
|
71
80
|
class: {
|
|
@@ -101,12 +110,15 @@ exports.DefaultTheme = {
|
|
|
101
110
|
* @typedef {LoggingConfig} DefaultLoggingConfig
|
|
102
111
|
* @property {number} verbose - Verbosity level (0).
|
|
103
112
|
* @property {LogLevel} level - Default log level (LogLevel.info).
|
|
113
|
+
* @property {boolean} logLevel - Whether to display log level in output (true).
|
|
114
|
+
* @property {LoggingMode} mode - Output format mode (LoggingMode.RAW).
|
|
104
115
|
* @property {boolean} style - Whether to apply styling to log output (false).
|
|
116
|
+
* @property {string} separator - Separator between log components (" - ").
|
|
105
117
|
* @property {boolean} timestamp - Whether to include timestamps in log messages (true).
|
|
106
118
|
* @property {string} timestampFormat - Format for timestamps ("HH:mm:ss.SSS").
|
|
107
119
|
* @property {boolean} context - Whether to include context information in log messages (true).
|
|
108
120
|
* @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).
|
|
109
|
-
* @memberOf
|
|
121
|
+
* @memberOf module:Logging
|
|
110
122
|
*/
|
|
111
123
|
exports.DefaultLoggingConfig = {
|
|
112
124
|
verbose: 0,
|
|
@@ -114,10 +126,11 @@ exports.DefaultLoggingConfig = {
|
|
|
114
126
|
logLevel: true,
|
|
115
127
|
mode: LoggingMode.RAW,
|
|
116
128
|
style: false,
|
|
129
|
+
contextSeparator: ".",
|
|
117
130
|
separator: " - ",
|
|
118
131
|
timestamp: true,
|
|
119
132
|
timestampFormat: "HH:mm:ss.SSS",
|
|
120
133
|
context: true,
|
|
121
134
|
theme: exports.DefaultTheme,
|
|
122
135
|
};
|
|
123
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
136
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";;;AAEA;;;;;GAKG;AACH,IAAY,QAWX;AAXD,WAAY,QAAQ;IAClB,sDAAsD;IACtD,2BAAe,CAAA;IACf,kEAAkE;IAClE,yBAAa,CAAA;IACb,uCAAuC;IACvC,+BAAmB,CAAA;IACnB,kCAAkC;IAClC,2BAAe,CAAA;IACf,4CAA4C;IAC5C,2BAAe,CAAA;AACjB,CAAC,EAXW,QAAQ,wBAAR,QAAQ,QAWnB;AAED;;;;;;;;;;GAUG;AACU,QAAA,gBAAgB,GAAG;IAC9B,KAAK,EAAE,CAAC;IACR,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,CAAC;IACR,KAAK,EAAE,CAAC;CACT,CAAC;AAEF;;;;;GAKG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA4C;IAC5C,0BAAW,CAAA;IACX,sCAAsC;IACtC,4BAAa,CAAA;AACf,CAAC,EALW,WAAW,2BAAX,WAAW,QAKtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACU,QAAA,YAAY,GAAU;IACjC,KAAK,EAAE;QACL,EAAE,EAAE,EAAE;KACP;IACD,EAAE,EAAE;QACF,EAAE,EAAE,EAAE;KACP;IACD,KAAK,EAAE,EAAE;IACT,SAAS,EAAE,EAAE;IACb,OAAO,EAAE;QACP,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;SACP;KACF;IACD,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE;QACR,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,IAAI,EAAE,EAAE;QACR,OAAO,EAAE,EAAE;QACX,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;SACP;KACF;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,oBAAoB,GAAkB;IACjD,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,QAAQ,CAAC,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,WAAW,CAAC,GAAG;IACrB,KAAK,EAAE,KAAK;IACZ,gBAAgB,EAAE,GAAG;IACrB,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,cAAc;IAC/B,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,oBAAY;CACpB,CAAC","sourcesContent":["import { LoggingConfig, Theme } from \"./types\";\n\n/**\n * @description Enum for log levels.\n * @summary Defines different levels of logging for the application.\n * @enum {string}\n * @memberOf module:Logging\n */\nexport enum LogLevel {\n  /** Error events that are likely to cause problems. */\n  error = \"error\",\n  /** Routine information, such as ongoing status or performance. */\n  info = \"info\",\n  /** Additional relevant information. */\n  verbose = \"verbose\",\n  /** Debug or trace information. */\n  debug = \"debug\",\n  /** way too verbose or silly information. */\n  silly = \"silly\",\n}\n\n/**\n * @description Numeric values associated with log levels.\n * @summary Provides a numeric representation of log levels for comparison and filtering.\n * @const NumericLogLevels\n * @property {number} error - Numeric value for error level (2).\n * @property {number} info - Numeric value for info level (4).\n * @property {number} verbose - Numeric value for verbose level (6).\n * @property {number} debug - Numeric value for debug level (7).\n * @property {number} silly - Numeric value for silly level (9).\n * @memberOf module:Logging\n */\nexport const NumericLogLevels = {\n  error: 2,\n  info: 4,\n  verbose: 6,\n  debug: 7,\n  silly: 9,\n};\n\n/**\n * @description Enum for logging output modes.\n * @summary Defines different output formats for log messages.\n * @enum {string}\n * @memberOf module:Logging\n */\nexport enum LoggingMode {\n  /** Raw text format for human readability */\n  RAW = \"raw\",\n  /** JSON format for machine parsing */\n  JSON = \"json\",\n}\n\n/**\n * @description Default theme for styling log output.\n * @summary Defines the default color and style settings for various components of log messages.\n * @const DefaultTheme\n * @typedef {Theme} DefaultTheme\n * @property {Object} class - Styling for class names.\n * @property {number} class.fg - Foreground color code for class names (34).\n * @property {Object} id - Styling for identifiers.\n * @property {number} id.fg - Foreground color code for identifiers (36).\n * @property {Object} stack - Styling for stack traces (empty object).\n * @property {Object} timestamp - Styling for timestamps (empty object).\n * @property {Object} message - Styling for different types of messages.\n * @property {Object} message.error - Styling for error messages.\n * @property {number} message.error.fg - Foreground color code for error messages (31).\n * @property {Object} method - Styling for method names (empty object).\n * @property {Object} logLevel - Styling for different log levels.\n * @property {Object} logLevel.error - Styling for error level logs.\n * @property {number} logLevel.error.fg - Foreground color code for error level logs (31).\n * @property {string[]} logLevel.error.style - Style attributes for error level logs ([\"bold\"]).\n * @property {Object} logLevel.info - Styling for info level logs (empty object).\n * @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).\n * @property {Object} logLevel.debug - Styling for debug level logs.\n * @property {number} logLevel.debug.fg - Foreground color code for debug level logs (33).\n * @memberOf module:Logging\n */\nexport const DefaultTheme: Theme = {\n  class: {\n    fg: 34,\n  },\n  id: {\n    fg: 36,\n  },\n  stack: {},\n  timestamp: {},\n  message: {\n    error: {\n      fg: 31,\n    },\n  },\n  method: {},\n  logLevel: {\n    error: {\n      fg: 31,\n      style: [\"bold\"],\n    },\n    info: {},\n    verbose: {},\n    debug: {\n      fg: 33,\n    },\n  },\n};\n\n/**\n * @description Default configuration for logging.\n * @summary Defines the default settings for the logging system, including verbosity, log level, styling, and timestamp format.\n * @const DefaultLoggingConfig\n * @typedef {LoggingConfig} DefaultLoggingConfig\n * @property {number} verbose - Verbosity level (0).\n * @property {LogLevel} level - Default log level (LogLevel.info).\n * @property {boolean} logLevel - Whether to display log level in output (true).\n * @property {LoggingMode} mode - Output format mode (LoggingMode.RAW).\n * @property {boolean} style - Whether to apply styling to log output (false).\n * @property {string} separator - Separator between log components (\" - \").\n * @property {boolean} timestamp - Whether to include timestamps in log messages (true).\n * @property {string} timestampFormat - Format for timestamps (\"HH:mm:ss.SSS\").\n * @property {boolean} context - Whether to include context information in log messages (true).\n * @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).\n * @memberOf module:Logging\n */\nexport const DefaultLoggingConfig: LoggingConfig = {\n  verbose: 0,\n  level: LogLevel.info,\n  logLevel: true,\n  mode: LoggingMode.RAW,\n  style: false,\n  contextSeparator: \".\",\n  separator: \" - \",\n  timestamp: true,\n  timestampFormat: \"HH:mm:ss.SSS\",\n  context: true,\n  theme: DefaultTheme,\n};\n"]}
|
package/lib/constants.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import { LoggingConfig, Theme } from "./types";
|
|
|
3
3
|
* @description Enum for log levels.
|
|
4
4
|
* @summary Defines different levels of logging for the application.
|
|
5
5
|
* @enum {string}
|
|
6
|
-
* @memberOf
|
|
6
|
+
* @memberOf module:Logging
|
|
7
7
|
*/
|
|
8
8
|
export declare enum LogLevel {
|
|
9
9
|
/** Error events that are likely to cause problems. */
|
|
@@ -20,13 +20,13 @@ export declare enum LogLevel {
|
|
|
20
20
|
/**
|
|
21
21
|
* @description Numeric values associated with log levels.
|
|
22
22
|
* @summary Provides a numeric representation of log levels for comparison and filtering.
|
|
23
|
-
* @const
|
|
24
|
-
* @property {number} error - Numeric value for error level (
|
|
25
|
-
* @property {number} info - Numeric value for info level (
|
|
26
|
-
* @property {number} verbose - Numeric value for verbose level (
|
|
27
|
-
* @property {number} debug - Numeric value for debug level (
|
|
28
|
-
* @property {number} silly - Numeric value for silly level (
|
|
29
|
-
* @memberOf
|
|
23
|
+
* @const NumericLogLevels
|
|
24
|
+
* @property {number} error - Numeric value for error level (2).
|
|
25
|
+
* @property {number} info - Numeric value for info level (4).
|
|
26
|
+
* @property {number} verbose - Numeric value for verbose level (6).
|
|
27
|
+
* @property {number} debug - Numeric value for debug level (7).
|
|
28
|
+
* @property {number} silly - Numeric value for silly level (9).
|
|
29
|
+
* @memberOf module:Logging
|
|
30
30
|
*/
|
|
31
31
|
export declare const NumericLogLevels: {
|
|
32
32
|
error: number;
|
|
@@ -35,8 +35,16 @@ export declare const NumericLogLevels: {
|
|
|
35
35
|
debug: number;
|
|
36
36
|
silly: number;
|
|
37
37
|
};
|
|
38
|
+
/**
|
|
39
|
+
* @description Enum for logging output modes.
|
|
40
|
+
* @summary Defines different output formats for log messages.
|
|
41
|
+
* @enum {string}
|
|
42
|
+
* @memberOf module:Logging
|
|
43
|
+
*/
|
|
38
44
|
export declare enum LoggingMode {
|
|
45
|
+
/** Raw text format for human readability */
|
|
39
46
|
RAW = "raw",
|
|
47
|
+
/** JSON format for machine parsing */
|
|
40
48
|
JSON = "json"
|
|
41
49
|
}
|
|
42
50
|
/**
|
|
@@ -45,23 +53,24 @@ export declare enum LoggingMode {
|
|
|
45
53
|
* @const DefaultTheme
|
|
46
54
|
* @typedef {Theme} DefaultTheme
|
|
47
55
|
* @property {Object} class - Styling for class names.
|
|
48
|
-
* @property {number} class.fg - Foreground color code for class names (
|
|
56
|
+
* @property {number} class.fg - Foreground color code for class names (34).
|
|
49
57
|
* @property {Object} id - Styling for identifiers.
|
|
50
58
|
* @property {number} id.fg - Foreground color code for identifiers (36).
|
|
51
59
|
* @property {Object} stack - Styling for stack traces (empty object).
|
|
52
60
|
* @property {Object} timestamp - Styling for timestamps (empty object).
|
|
53
61
|
* @property {Object} message - Styling for different types of messages.
|
|
54
62
|
* @property {Object} message.error - Styling for error messages.
|
|
55
|
-
* @property {number} message.error.fg - Foreground color code for error messages (
|
|
63
|
+
* @property {number} message.error.fg - Foreground color code for error messages (31).
|
|
56
64
|
* @property {Object} method - Styling for method names (empty object).
|
|
57
65
|
* @property {Object} logLevel - Styling for different log levels.
|
|
58
66
|
* @property {Object} logLevel.error - Styling for error level logs.
|
|
59
|
-
* @property {number} logLevel.error.fg - Foreground color code for error level logs (
|
|
67
|
+
* @property {number} logLevel.error.fg - Foreground color code for error level logs (31).
|
|
68
|
+
* @property {string[]} logLevel.error.style - Style attributes for error level logs (["bold"]).
|
|
60
69
|
* @property {Object} logLevel.info - Styling for info level logs (empty object).
|
|
61
70
|
* @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).
|
|
62
71
|
* @property {Object} logLevel.debug - Styling for debug level logs.
|
|
63
|
-
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (
|
|
64
|
-
* @memberOf
|
|
72
|
+
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (33).
|
|
73
|
+
* @memberOf module:Logging
|
|
65
74
|
*/
|
|
66
75
|
export declare const DefaultTheme: Theme;
|
|
67
76
|
/**
|
|
@@ -71,11 +80,14 @@ export declare const DefaultTheme: Theme;
|
|
|
71
80
|
* @typedef {LoggingConfig} DefaultLoggingConfig
|
|
72
81
|
* @property {number} verbose - Verbosity level (0).
|
|
73
82
|
* @property {LogLevel} level - Default log level (LogLevel.info).
|
|
83
|
+
* @property {boolean} logLevel - Whether to display log level in output (true).
|
|
84
|
+
* @property {LoggingMode} mode - Output format mode (LoggingMode.RAW).
|
|
74
85
|
* @property {boolean} style - Whether to apply styling to log output (false).
|
|
86
|
+
* @property {string} separator - Separator between log components (" - ").
|
|
75
87
|
* @property {boolean} timestamp - Whether to include timestamps in log messages (true).
|
|
76
88
|
* @property {string} timestampFormat - Format for timestamps ("HH:mm:ss.SSS").
|
|
77
89
|
* @property {boolean} context - Whether to include context information in log messages (true).
|
|
78
90
|
* @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).
|
|
79
|
-
* @memberOf
|
|
91
|
+
* @memberOf module:Logging
|
|
80
92
|
*/
|
|
81
93
|
export declare const DefaultLoggingConfig: LoggingConfig;
|
package/lib/decorators.cjs
CHANGED
|
@@ -7,6 +7,37 @@ exports.silly = silly;
|
|
|
7
7
|
exports.verbose = verbose;
|
|
8
8
|
const constants_1 = require("./constants.cjs");
|
|
9
9
|
const logging_1 = require("./logging.cjs");
|
|
10
|
+
/**
|
|
11
|
+
* @description Method decorator for logging function calls
|
|
12
|
+
* @summary Creates a decorator that logs method calls with specified level, benchmarking, and verbosity
|
|
13
|
+
* @param {LogLevel} level - The log level to use (default: LogLevel.info)
|
|
14
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
15
|
+
* @param {number} [verbosity=0] - The verbosity level for the log messages (default: 0)
|
|
16
|
+
* @return {Function} A method decorator that wraps the original method with logging
|
|
17
|
+
* @function log
|
|
18
|
+
* @category Decorators
|
|
19
|
+
* @mermaid
|
|
20
|
+
* sequenceDiagram
|
|
21
|
+
* participant Client
|
|
22
|
+
* participant Decorator as log decorator
|
|
23
|
+
* participant Method as Original Method
|
|
24
|
+
* participant Logger as Logging instance
|
|
25
|
+
*
|
|
26
|
+
* Client->>Decorator: call decorated method
|
|
27
|
+
* Decorator->>Logger: log method call
|
|
28
|
+
* Decorator->>Method: call original method
|
|
29
|
+
* alt result is Promise
|
|
30
|
+
* Method-->>Decorator: return Promise
|
|
31
|
+
* Decorator->>Decorator: attach then handler
|
|
32
|
+
* Note over Decorator: Promise resolves
|
|
33
|
+
* Decorator->>Logger: log benchmark (if enabled)
|
|
34
|
+
* Decorator-->>Client: return result
|
|
35
|
+
* else result is not Promise
|
|
36
|
+
* Method-->>Decorator: return result
|
|
37
|
+
* Decorator->>Logger: log benchmark (if enabled)
|
|
38
|
+
* Decorator-->>Client: return result
|
|
39
|
+
* end
|
|
40
|
+
*/
|
|
10
41
|
function log(level = constants_1.LogLevel.info, benchmark = false, verbosity = 0) {
|
|
11
42
|
return function (target, propertyKey, descriptor) {
|
|
12
43
|
const log = logging_1.Logging.for(target).for(target[propertyKey]);
|
|
@@ -36,16 +67,49 @@ function log(level = constants_1.LogLevel.info, benchmark = false, verbosity = 0
|
|
|
36
67
|
};
|
|
37
68
|
};
|
|
38
69
|
}
|
|
70
|
+
/**
|
|
71
|
+
* @description Method decorator for logging function calls with debug level
|
|
72
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.debug
|
|
73
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
74
|
+
* @return {Function} A method decorator that wraps the original method with debug logging
|
|
75
|
+
* @function debug
|
|
76
|
+
* @category Decorators
|
|
77
|
+
*/
|
|
39
78
|
function debug(benchmark = false) {
|
|
40
79
|
return log(constants_1.LogLevel.debug, benchmark);
|
|
41
80
|
}
|
|
81
|
+
/**
|
|
82
|
+
* @description Method decorator for logging function calls with info level
|
|
83
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.info
|
|
84
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
85
|
+
* @return {Function} A method decorator that wraps the original method with info logging
|
|
86
|
+
* @function info
|
|
87
|
+
* @category Decorators
|
|
88
|
+
*/
|
|
42
89
|
function info(benchmark = false) {
|
|
43
90
|
return log(constants_1.LogLevel.info, benchmark);
|
|
44
91
|
}
|
|
92
|
+
/**
|
|
93
|
+
* @description Method decorator for logging function calls with silly level
|
|
94
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.silly
|
|
95
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
96
|
+
* @return {Function} A method decorator that wraps the original method with silly logging
|
|
97
|
+
* @function silly
|
|
98
|
+
* @category Decorators
|
|
99
|
+
*/
|
|
45
100
|
function silly(benchmark = false) {
|
|
46
101
|
return log(constants_1.LogLevel.silly, benchmark);
|
|
47
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* @description Method decorator for logging function calls with verbose level
|
|
105
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity
|
|
106
|
+
* @param {number} verbosity - The verbosity level for the log messages (default: 0)
|
|
107
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
108
|
+
* @return {Function} A method decorator that wraps the original method with verbose logging
|
|
109
|
+
* @function verbose
|
|
110
|
+
* @category Decorators
|
|
111
|
+
*/
|
|
48
112
|
function verbose(verbosity = 0, benchmark = false) {
|
|
49
113
|
return log(constants_1.LogLevel.verbose, benchmark, verbosity);
|
|
50
114
|
}
|
|
51
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
115
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../src/decorators.ts"],"names":[],"mappings":";;AAkCA,kBAmCC;AAUD,sBAEC;AAUD,oBAEC;AAUD,sBAEC;AAWD,0BAEC;AAtHD,+CAAuC;AACvC,2CAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,GAAG,CACjB,QAAkB,oBAAQ,CAAC,IAAI,EAC/B,YAAqB,KAAK,EAC1B,SAAS,GAAG,CAAC;IAEb,OAAO,UACL,MAAW,EACX,WAAmB,EACnB,UAA8B;QAE9B,MAAM,GAAG,GAAG,iBAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QACxC,UAAU,CAAC,KAAK,GAAG,UAAU,GAAG,IAAW;YACzC,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;YACzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACzB,IAAI,GAAW,CAAC;YAChB,MAAM,MAAM,GAAQ,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACrD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;gBAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;oBACvB,IAAI,SAAS,EAAE,CAAC;wBACd,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;wBACjB,IAAI,SAAS;4BAAE,MAAM,CAAC,gBAAgB,GAAG,GAAG,KAAK,IAAI,EAAE,SAAS,CAAC,CAAC;oBACpE,CAAC;oBACD,OAAO,CAAC,CAAC;gBACX,CAAC,CAAC,CAAC;YACL,CAAC;YACD,IAAI,SAAS,EAAE,CAAC;gBACd,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACjB,IAAI,SAAS;oBAAE,MAAM,CAAC,gBAAgB,GAAG,GAAG,KAAK,IAAI,EAAE,SAAS,CAAC,CAAC;YACpE,CAAC;YAED,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CAAC,YAAqB,KAAK;IAC9C,OAAO,GAAG,CAAC,oBAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,IAAI,CAAC,YAAqB,KAAK;IAC7C,OAAO,GAAG,CAAC,oBAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,KAAK,CAAC,YAAqB,KAAK;IAC9C,OAAO,GAAG,CAAC,oBAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,OAAO,CAAC,SAAS,GAAG,CAAC,EAAE,YAAqB,KAAK;IAC/D,OAAO,GAAG,CAAC,oBAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { LogLevel } from \"./constants\";\nimport { Logging } from \"./logging\";\n\n/**\n * @description Method decorator for logging function calls\n * @summary Creates a decorator that logs method calls with specified level, benchmarking, and verbosity\n * @param {LogLevel} level - The log level to use (default: LogLevel.info)\n * @param {boolean} [benchmark=false] - Whether to log execution time (default: false)\n * @param {number} [verbosity=0] - The verbosity level for the log messages (default: 0)\n * @return {Function} A method decorator that wraps the original method with logging\n * @function log\n * @category Decorators\n * @mermaid\n * sequenceDiagram\n *   participant Client\n *   participant Decorator as log decorator\n *   participant Method as Original Method\n *   participant Logger as Logging instance\n *\n *   Client->>Decorator: call decorated method\n *   Decorator->>Logger: log method call\n *   Decorator->>Method: call original method\n *   alt result is Promise\n *     Method-->>Decorator: return Promise\n *     Decorator->>Decorator: attach then handler\n *     Note over Decorator: Promise resolves\n *     Decorator->>Logger: log benchmark (if enabled)\n *     Decorator-->>Client: return result\n *   else result is not Promise\n *     Method-->>Decorator: return result\n *     Decorator->>Logger: log benchmark (if enabled)\n *     Decorator-->>Client: return result\n *   end\n */\nexport function log(\n  level: LogLevel = LogLevel.info,\n  benchmark: boolean = false,\n  verbosity = 0\n) {\n  return function (\n    target: any,\n    propertyKey: string,\n    descriptor: PropertyDescriptor\n  ) {\n    const log = Logging.for(target).for(target[propertyKey]);\n    const method = log[level].bind(log);\n    const originalMethod = descriptor.value;\n    descriptor.value = function (...args: any[]) {\n      method(`called with ${args}`, verbosity);\n      const start = Date.now();\n      let end: number;\n      const result: any = originalMethod.apply(this, args);\n      if (result instanceof Promise) {\n        return result.then((r) => {\n          if (benchmark) {\n            end = Date.now();\n            if (benchmark) method(`completed in ${end - start}ms`, verbosity);\n          }\n          return r;\n        });\n      }\n      if (benchmark) {\n        end = Date.now();\n        if (benchmark) method(`completed in ${end - start}ms`, verbosity);\n      }\n\n      return result;\n    };\n  };\n}\n\n/**\n * @description Method decorator for logging function calls with debug level\n * @summary Convenience wrapper around the log decorator that uses LogLevel.debug\n * @param {boolean} [benchmark=false] - Whether to log execution time (default: false)\n * @return {Function} A method decorator that wraps the original method with debug logging\n * @function debug\n * @category Decorators\n */\nexport function debug(benchmark: boolean = false) {\n  return log(LogLevel.debug, benchmark);\n}\n\n/**\n * @description Method decorator for logging function calls with info level\n * @summary Convenience wrapper around the log decorator that uses LogLevel.info\n * @param {boolean} [benchmark=false] - Whether to log execution time (default: false)\n * @return {Function} A method decorator that wraps the original method with info logging\n * @function info\n * @category Decorators\n */\nexport function info(benchmark: boolean = false) {\n  return log(LogLevel.info, benchmark);\n}\n\n/**\n * @description Method decorator for logging function calls with silly level\n * @summary Convenience wrapper around the log decorator that uses LogLevel.silly\n * @param {boolean} [benchmark=false] - Whether to log execution time (default: false)\n * @return {Function} A method decorator that wraps the original method with silly logging\n * @function silly\n * @category Decorators\n */\nexport function silly(benchmark: boolean = false) {\n  return log(LogLevel.silly, benchmark);\n}\n\n/**\n * @description Method decorator for logging function calls with verbose level\n * @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity\n * @param {number} verbosity - The verbosity level for the log messages (default: 0)\n * @param {boolean} [benchmark=false] - Whether to log execution time (default: false)\n * @return {Function} A method decorator that wraps the original method with verbose logging\n * @function verbose\n * @category Decorators\n */\nexport function verbose(verbosity = 0, benchmark: boolean = false) {\n  return log(LogLevel.verbose, benchmark, verbosity);\n}\n"]}
|
package/lib/decorators.d.ts
CHANGED
|
@@ -1,6 +1,70 @@
|
|
|
1
1
|
import { LogLevel } from "./constants";
|
|
2
|
+
/**
|
|
3
|
+
* @description Method decorator for logging function calls
|
|
4
|
+
* @summary Creates a decorator that logs method calls with specified level, benchmarking, and verbosity
|
|
5
|
+
* @param {LogLevel} level - The log level to use (default: LogLevel.info)
|
|
6
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
7
|
+
* @param {number} [verbosity=0] - The verbosity level for the log messages (default: 0)
|
|
8
|
+
* @return {Function} A method decorator that wraps the original method with logging
|
|
9
|
+
* @function log
|
|
10
|
+
* @category Decorators
|
|
11
|
+
* @mermaid
|
|
12
|
+
* sequenceDiagram
|
|
13
|
+
* participant Client
|
|
14
|
+
* participant Decorator as log decorator
|
|
15
|
+
* participant Method as Original Method
|
|
16
|
+
* participant Logger as Logging instance
|
|
17
|
+
*
|
|
18
|
+
* Client->>Decorator: call decorated method
|
|
19
|
+
* Decorator->>Logger: log method call
|
|
20
|
+
* Decorator->>Method: call original method
|
|
21
|
+
* alt result is Promise
|
|
22
|
+
* Method-->>Decorator: return Promise
|
|
23
|
+
* Decorator->>Decorator: attach then handler
|
|
24
|
+
* Note over Decorator: Promise resolves
|
|
25
|
+
* Decorator->>Logger: log benchmark (if enabled)
|
|
26
|
+
* Decorator-->>Client: return result
|
|
27
|
+
* else result is not Promise
|
|
28
|
+
* Method-->>Decorator: return result
|
|
29
|
+
* Decorator->>Logger: log benchmark (if enabled)
|
|
30
|
+
* Decorator-->>Client: return result
|
|
31
|
+
* end
|
|
32
|
+
*/
|
|
2
33
|
export declare function log(level?: LogLevel, benchmark?: boolean, verbosity?: number): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
|
|
34
|
+
/**
|
|
35
|
+
* @description Method decorator for logging function calls with debug level
|
|
36
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.debug
|
|
37
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
38
|
+
* @return {Function} A method decorator that wraps the original method with debug logging
|
|
39
|
+
* @function debug
|
|
40
|
+
* @category Decorators
|
|
41
|
+
*/
|
|
3
42
|
export declare function debug(benchmark?: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
|
|
43
|
+
/**
|
|
44
|
+
* @description Method decorator for logging function calls with info level
|
|
45
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.info
|
|
46
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
47
|
+
* @return {Function} A method decorator that wraps the original method with info logging
|
|
48
|
+
* @function info
|
|
49
|
+
* @category Decorators
|
|
50
|
+
*/
|
|
4
51
|
export declare function info(benchmark?: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
|
|
52
|
+
/**
|
|
53
|
+
* @description Method decorator for logging function calls with silly level
|
|
54
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.silly
|
|
55
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
56
|
+
* @return {Function} A method decorator that wraps the original method with silly logging
|
|
57
|
+
* @function silly
|
|
58
|
+
* @category Decorators
|
|
59
|
+
*/
|
|
5
60
|
export declare function silly(benchmark?: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
|
|
61
|
+
/**
|
|
62
|
+
* @description Method decorator for logging function calls with verbose level
|
|
63
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity
|
|
64
|
+
* @param {number} verbosity - The verbosity level for the log messages (default: 0)
|
|
65
|
+
* @param {boolean} [benchmark=false] - Whether to log execution time (default: false)
|
|
66
|
+
* @return {Function} A method decorator that wraps the original method with verbose logging
|
|
67
|
+
* @function verbose
|
|
68
|
+
* @category Decorators
|
|
69
|
+
*/
|
|
6
70
|
export declare function verbose(verbosity?: number, benchmark?: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
|
package/lib/esm/constants.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import { LoggingConfig, Theme } from "./types";
|
|
|
3
3
|
* @description Enum for log levels.
|
|
4
4
|
* @summary Defines different levels of logging for the application.
|
|
5
5
|
* @enum {string}
|
|
6
|
-
* @memberOf
|
|
6
|
+
* @memberOf module:Logging
|
|
7
7
|
*/
|
|
8
8
|
export declare enum LogLevel {
|
|
9
9
|
/** Error events that are likely to cause problems. */
|
|
@@ -20,13 +20,13 @@ export declare enum LogLevel {
|
|
|
20
20
|
/**
|
|
21
21
|
* @description Numeric values associated with log levels.
|
|
22
22
|
* @summary Provides a numeric representation of log levels for comparison and filtering.
|
|
23
|
-
* @const
|
|
24
|
-
* @property {number} error - Numeric value for error level (
|
|
25
|
-
* @property {number} info - Numeric value for info level (
|
|
26
|
-
* @property {number} verbose - Numeric value for verbose level (
|
|
27
|
-
* @property {number} debug - Numeric value for debug level (
|
|
28
|
-
* @property {number} silly - Numeric value for silly level (
|
|
29
|
-
* @memberOf
|
|
23
|
+
* @const NumericLogLevels
|
|
24
|
+
* @property {number} error - Numeric value for error level (2).
|
|
25
|
+
* @property {number} info - Numeric value for info level (4).
|
|
26
|
+
* @property {number} verbose - Numeric value for verbose level (6).
|
|
27
|
+
* @property {number} debug - Numeric value for debug level (7).
|
|
28
|
+
* @property {number} silly - Numeric value for silly level (9).
|
|
29
|
+
* @memberOf module:Logging
|
|
30
30
|
*/
|
|
31
31
|
export declare const NumericLogLevels: {
|
|
32
32
|
error: number;
|
|
@@ -35,8 +35,16 @@ export declare const NumericLogLevels: {
|
|
|
35
35
|
debug: number;
|
|
36
36
|
silly: number;
|
|
37
37
|
};
|
|
38
|
+
/**
|
|
39
|
+
* @description Enum for logging output modes.
|
|
40
|
+
* @summary Defines different output formats for log messages.
|
|
41
|
+
* @enum {string}
|
|
42
|
+
* @memberOf module:Logging
|
|
43
|
+
*/
|
|
38
44
|
export declare enum LoggingMode {
|
|
45
|
+
/** Raw text format for human readability */
|
|
39
46
|
RAW = "raw",
|
|
47
|
+
/** JSON format for machine parsing */
|
|
40
48
|
JSON = "json"
|
|
41
49
|
}
|
|
42
50
|
/**
|
|
@@ -45,23 +53,24 @@ export declare enum LoggingMode {
|
|
|
45
53
|
* @const DefaultTheme
|
|
46
54
|
* @typedef {Theme} DefaultTheme
|
|
47
55
|
* @property {Object} class - Styling for class names.
|
|
48
|
-
* @property {number} class.fg - Foreground color code for class names (
|
|
56
|
+
* @property {number} class.fg - Foreground color code for class names (34).
|
|
49
57
|
* @property {Object} id - Styling for identifiers.
|
|
50
58
|
* @property {number} id.fg - Foreground color code for identifiers (36).
|
|
51
59
|
* @property {Object} stack - Styling for stack traces (empty object).
|
|
52
60
|
* @property {Object} timestamp - Styling for timestamps (empty object).
|
|
53
61
|
* @property {Object} message - Styling for different types of messages.
|
|
54
62
|
* @property {Object} message.error - Styling for error messages.
|
|
55
|
-
* @property {number} message.error.fg - Foreground color code for error messages (
|
|
63
|
+
* @property {number} message.error.fg - Foreground color code for error messages (31).
|
|
56
64
|
* @property {Object} method - Styling for method names (empty object).
|
|
57
65
|
* @property {Object} logLevel - Styling for different log levels.
|
|
58
66
|
* @property {Object} logLevel.error - Styling for error level logs.
|
|
59
|
-
* @property {number} logLevel.error.fg - Foreground color code for error level logs (
|
|
67
|
+
* @property {number} logLevel.error.fg - Foreground color code for error level logs (31).
|
|
68
|
+
* @property {string[]} logLevel.error.style - Style attributes for error level logs (["bold"]).
|
|
60
69
|
* @property {Object} logLevel.info - Styling for info level logs (empty object).
|
|
61
70
|
* @property {Object} logLevel.verbose - Styling for verbose level logs (empty object).
|
|
62
71
|
* @property {Object} logLevel.debug - Styling for debug level logs.
|
|
63
|
-
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (
|
|
64
|
-
* @memberOf
|
|
72
|
+
* @property {number} logLevel.debug.fg - Foreground color code for debug level logs (33).
|
|
73
|
+
* @memberOf module:Logging
|
|
65
74
|
*/
|
|
66
75
|
export declare const DefaultTheme: Theme;
|
|
67
76
|
/**
|
|
@@ -71,11 +80,14 @@ export declare const DefaultTheme: Theme;
|
|
|
71
80
|
* @typedef {LoggingConfig} DefaultLoggingConfig
|
|
72
81
|
* @property {number} verbose - Verbosity level (0).
|
|
73
82
|
* @property {LogLevel} level - Default log level (LogLevel.info).
|
|
83
|
+
* @property {boolean} logLevel - Whether to display log level in output (true).
|
|
84
|
+
* @property {LoggingMode} mode - Output format mode (LoggingMode.RAW).
|
|
74
85
|
* @property {boolean} style - Whether to apply styling to log output (false).
|
|
86
|
+
* @property {string} separator - Separator between log components (" - ").
|
|
75
87
|
* @property {boolean} timestamp - Whether to include timestamps in log messages (true).
|
|
76
88
|
* @property {string} timestampFormat - Format for timestamps ("HH:mm:ss.SSS").
|
|
77
89
|
* @property {boolean} context - Whether to include context information in log messages (true).
|
|
78
90
|
* @property {Theme} theme - The theme to use for styling log messages (DefaultTheme).
|
|
79
|
-
* @memberOf
|
|
91
|
+
* @memberOf module:Logging
|
|
80
92
|
*/
|
|
81
93
|
export declare const DefaultLoggingConfig: LoggingConfig;
|