@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/esm/types.d.ts
CHANGED
|
@@ -1,16 +1,29 @@
|
|
|
1
1
|
import { styles } from "styled-string-builder";
|
|
2
2
|
import { LoggingMode, LogLevel } from "./constants";
|
|
3
|
+
/**
|
|
4
|
+
* @description A type representing string-like values
|
|
5
|
+
* @summary Represents either a string or an object with a toString method that returns a string
|
|
6
|
+
* @typedef {(string|Object)} StringLike
|
|
7
|
+
* @memberOf module:Logging
|
|
8
|
+
*/
|
|
3
9
|
export type StringLike = string | {
|
|
4
10
|
toString: () => string;
|
|
5
11
|
};
|
|
12
|
+
export type AnyFunction = (...args: any[]) => any;
|
|
13
|
+
/**
|
|
14
|
+
* @description A type representing logging context
|
|
15
|
+
* @summary Represents a context for logging, which can be a string, a class constructor, or a function
|
|
16
|
+
* @typedef {(string|Function|Object)} LoggingContext
|
|
17
|
+
* @memberOf module:Logging
|
|
18
|
+
*/
|
|
6
19
|
export type LoggingContext = string | {
|
|
7
20
|
new (...args: any[]): any;
|
|
8
|
-
} |
|
|
21
|
+
} | AnyFunction;
|
|
9
22
|
/**
|
|
10
23
|
* @description Interface for a logger with verbosity levels.
|
|
11
24
|
* @summary Defines methods for logging at different verbosity levels.
|
|
12
25
|
* @interface Logger
|
|
13
|
-
* @memberOf
|
|
26
|
+
* @memberOf module:Logging
|
|
14
27
|
*/
|
|
15
28
|
export interface Logger {
|
|
16
29
|
/**
|
|
@@ -39,7 +52,19 @@ export interface Logger {
|
|
|
39
52
|
* @param {string} msg - The message to log.
|
|
40
53
|
*/
|
|
41
54
|
debug(msg: StringLike): void;
|
|
55
|
+
/**
|
|
56
|
+
* @description Creates a new logger for a specific method or context
|
|
57
|
+
* @summary Returns a new logger instance that includes the specified method or context in its logs
|
|
58
|
+
* @param {string|Function} [method] - The method name or function to create a logger for
|
|
59
|
+
* @param {Partial<LoggingConfig>} [config] - Optional configuration for the new logger
|
|
60
|
+
* @return {Logger} A new logger instance
|
|
61
|
+
*/
|
|
42
62
|
for(method?: string | ((...args: any[]) => any), config?: Partial<LoggingConfig>): Logger;
|
|
63
|
+
/**
|
|
64
|
+
* @description Updates the logger configuration
|
|
65
|
+
* @summary Sets or updates the configuration options for this logger instance
|
|
66
|
+
* @param {Partial<LoggingConfig>} config - The configuration options to apply
|
|
67
|
+
*/
|
|
43
68
|
setConfig(config: Partial<LoggingConfig>): void;
|
|
44
69
|
}
|
|
45
70
|
/**
|
|
@@ -47,14 +72,25 @@ export interface Logger {
|
|
|
47
72
|
* @summary Defines the log level and verbosity for logging.
|
|
48
73
|
* @typedef {Object} LoggingConfig
|
|
49
74
|
* @property {LogLevel} level - The logging level.
|
|
75
|
+
* @property {boolean} [logLevel] - Whether to display log level in output.
|
|
50
76
|
* @property {number} verbose - The verbosity level.
|
|
51
|
-
* @
|
|
77
|
+
* @property {LoggingMode} [mode] - Output format mode.
|
|
78
|
+
* @property {string} contextSeparator - Separator between context entries.
|
|
79
|
+
* @property {string} separator - Separator between log components.
|
|
80
|
+
* @property {boolean} [style] - Whether to apply styling to log output.
|
|
81
|
+
* @property {boolean} [timestamp] - Whether to include timestamps in log messages.
|
|
82
|
+
* @property {string} [timestampFormat] - Format for timestamps.
|
|
83
|
+
* @property {boolean} [context] - Whether to include context information in log messages.
|
|
84
|
+
* @property {Theme} [theme] - The theme to use for styling log messages.
|
|
85
|
+
* @property {string|number} [correlationId] - Correlation ID for tracking related log messages.
|
|
86
|
+
* @memberOf module:Logging
|
|
52
87
|
*/
|
|
53
88
|
export type LoggingConfig = {
|
|
54
89
|
level: LogLevel;
|
|
55
90
|
logLevel?: boolean;
|
|
56
91
|
verbose: number;
|
|
57
92
|
mode?: LoggingMode;
|
|
93
|
+
contextSeparator: string;
|
|
58
94
|
separator: string;
|
|
59
95
|
style?: boolean;
|
|
60
96
|
timestamp?: boolean;
|
|
@@ -63,33 +99,45 @@ export type LoggingConfig = {
|
|
|
63
99
|
theme?: Theme;
|
|
64
100
|
correlationId?: string | number;
|
|
65
101
|
};
|
|
102
|
+
/**
|
|
103
|
+
* @description A factory function type for creating loggers
|
|
104
|
+
* @summary Defines a function type that creates and returns a logger instance for a given object
|
|
105
|
+
* @template L - The logger type, extending the base Logger interface
|
|
106
|
+
* @typedef {Function} LoggerFactory
|
|
107
|
+
* @param {string} object - The object or context name for the logger
|
|
108
|
+
* @param {Partial<LoggingConfig>} [config] - Optional configuration for the logger
|
|
109
|
+
* @return {L} A logger instance
|
|
110
|
+
* @memberOf module:Logging
|
|
111
|
+
*/
|
|
66
112
|
export type LoggerFactory<L extends Logger = Logger> = (object: string, config?: Partial<LoggingConfig>, ...args: any[]) => L;
|
|
67
113
|
/**
|
|
68
|
-
/**
|
|
69
114
|
* @description Represents a theme option for console output styling.
|
|
70
115
|
* @summary Defines the structure for styling a specific element in the console output.
|
|
71
116
|
* It allows for customization of foreground color, background color, and additional styles.
|
|
72
117
|
* Colors can be specified as a single number, an RGB array, or left undefined for default.
|
|
73
|
-
*
|
|
74
118
|
* @interface ThemeOption
|
|
75
|
-
* @memberOf
|
|
119
|
+
* @memberOf module:Logging
|
|
76
120
|
*/
|
|
77
121
|
export interface ThemeOption {
|
|
78
122
|
fg?: number | [number] | [number, number, number];
|
|
79
123
|
bg?: number | [number] | [number, number, number];
|
|
80
124
|
style?: number[] | [keyof typeof styles];
|
|
81
125
|
}
|
|
126
|
+
/**
|
|
127
|
+
* @description A type for theme options organized by log level
|
|
128
|
+
* @summary Defines a partial record mapping log levels to theme options, allowing different styling for different log levels
|
|
129
|
+
* @typedef {Object} ThemeOptionByLogLevel
|
|
130
|
+
* @memberOf module:Logging
|
|
131
|
+
*/
|
|
82
132
|
export type ThemeOptionByLogLevel = Partial<Record<LogLevel, ThemeOption>>;
|
|
83
133
|
/**
|
|
84
|
-
/**
|
|
85
134
|
* @description Defines the color theme for console output.
|
|
86
135
|
* @summary This interface specifies the color scheme for various elements of console output,
|
|
87
136
|
* including styling for different log levels and components. It uses ThemeOption to
|
|
88
137
|
* define the styling for each element, allowing for customization of colors and styles
|
|
89
138
|
* for different parts of the log output.
|
|
90
|
-
*
|
|
91
139
|
* @interface Theme
|
|
92
|
-
* @memberOf
|
|
140
|
+
* @memberOf module:Logging
|
|
93
141
|
*/
|
|
94
142
|
export interface Theme {
|
|
95
143
|
/**
|
package/lib/esm/types.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import { styles } from \"styled-string-builder\";\nimport { LoggingMode, LogLevel } from \"./constants\";\n\n/**\n * @description A type representing string-like values\n * @summary Represents either a string or an object with a toString method that returns a string\n * @typedef {(string|Object)} StringLike\n * @memberOf module:Logging\n */\nexport type StringLike = string | { toString: () => string };\n\nexport type AnyFunction = (...args: any[]) => any;\n\n/**\n * @description A type representing logging context\n * @summary Represents a context for logging, which can be a string, a class constructor, or a function\n * @typedef {(string|Function|Object)} LoggingContext\n * @memberOf module:Logging\n */\nexport type LoggingContext =\n  | string\n  | { new (...args: any[]): any }\n  | AnyFunction;\n\n/**\n * @description Interface for a logger with verbosity levels.\n * @summary Defines methods for logging at different verbosity levels.\n * @interface Logger\n * @memberOf module:Logging\n */\nexport interface Logger {\n  /**\n   * @description Logs a `way too verbose` or a silly message.\n   * @param {StringLike} msg - The message to log.\n   */\n  silly(msg: StringLike): void;\n  /**\n   * @description Logs a verbose message.\n   * @param {StringLike} msg - The message to log.\n   * @param {number} verbosity - The verbosity level of the message.\n   */\n  verbose(msg: StringLike, verbosity?: number): void;\n\n  /**\n   * @description Logs an info message.\n   * @param {StringLike} msg - The message to log.\n   */\n  info(msg: StringLike): void;\n\n  /**\n   * @description Logs an error message.\n   * @param {StringLike | Error} msg - The message to log.\n   */\n  error(msg: StringLike | Error): void;\n\n  /**\n   * @description Logs a debug message.\n   * @param {string} msg - The message to log.\n   */\n  debug(msg: StringLike): void;\n\n  /**\n   * @description Creates a new logger for a specific method or context\n   * @summary Returns a new logger instance that includes the specified method or context in its logs\n   * @param {string|Function} [method] - The method name or function to create a logger for\n   * @param {Partial<LoggingConfig>} [config] - Optional configuration for the new logger\n   * @return {Logger} A new logger instance\n   */\n  for(\n    method?: string | ((...args: any[]) => any),\n    config?: Partial<LoggingConfig>\n  ): Logger;\n\n  /**\n   * @description Updates the logger configuration\n   * @summary Sets or updates the configuration options for this logger instance\n   * @param {Partial<LoggingConfig>} config - The configuration options to apply\n   */\n  setConfig(config: Partial<LoggingConfig>): void;\n}\n\n/**\n * @description Configuration for logging.\n * @summary Defines the log level and verbosity for logging.\n * @typedef {Object} LoggingConfig\n * @property {LogLevel} level - The logging level.\n * @property {boolean} [logLevel] - Whether to display log level in output.\n * @property {number} verbose - The verbosity level.\n * @property {LoggingMode} [mode] - Output format mode.\n * @property {string} contextSeparator - Separator between context entries.\n * @property {string} separator - Separator between log components.\n * @property {boolean} [style] - Whether to apply styling to log output.\n * @property {boolean} [timestamp] - Whether to include timestamps in log messages.\n * @property {string} [timestampFormat] - Format for timestamps.\n * @property {boolean} [context] - Whether to include context information in log messages.\n * @property {Theme} [theme] - The theme to use for styling log messages.\n * @property {string|number} [correlationId] - Correlation ID for tracking related log messages.\n * @memberOf module:Logging\n */\nexport type LoggingConfig = {\n  level: LogLevel;\n  logLevel?: boolean;\n  verbose: number;\n  mode?: LoggingMode;\n  contextSeparator: string;\n  separator: string;\n  style?: boolean;\n  timestamp?: boolean;\n  timestampFormat?: string;\n  context?: boolean;\n  theme?: Theme;\n  correlationId?: string | number;\n};\n\n/**\n * @description A factory function type for creating loggers\n * @summary Defines a function type that creates and returns a logger instance for a given object\n * @template L - The logger type, extending the base Logger interface\n * @typedef {Function} LoggerFactory\n * @param {string} object - The object or context name for the logger\n * @param {Partial<LoggingConfig>} [config] - Optional configuration for the logger\n * @return {L} A logger instance\n * @memberOf module:Logging\n */\nexport type LoggerFactory<L extends Logger = Logger> = (\n  object: string,\n  config?: Partial<LoggingConfig>,\n  ...args: any[]\n) => L;\n\n/**\n * @description Represents a theme option for console output styling.\n * @summary Defines the structure for styling a specific element in the console output.\n * It allows for customization of foreground color, background color, and additional styles.\n * Colors can be specified as a single number, an RGB array, or left undefined for default.\n * @interface ThemeOption\n * @memberOf module:Logging\n */\nexport interface ThemeOption {\n  fg?: number | [number] | [number, number, number];\n\n  bg?: number | [number] | [number, number, number];\n\n  style?: number[] | [keyof typeof styles];\n}\n\n/**\n * @description A type for theme options organized by log level\n * @summary Defines a partial record mapping log levels to theme options, allowing different styling for different log levels\n * @typedef {Object} ThemeOptionByLogLevel\n * @memberOf module:Logging\n */\nexport type ThemeOptionByLogLevel = Partial<Record<LogLevel, ThemeOption>>;\n\n/**\n * @description Defines the color theme for console output.\n * @summary This interface specifies the color scheme for various elements of console output,\n * including styling for different log levels and components. It uses ThemeOption to\n * define the styling for each element, allowing for customization of colors and styles\n * for different parts of the log output.\n * @interface Theme\n * @memberOf module:Logging\n */\nexport interface Theme {\n  /**\n   * @description Styling for class names in the output.\n   */\n  class: ThemeOption | ThemeOptionByLogLevel;\n\n  /**\n   * @description Styling for timestamps in the output.\n   */\n  timestamp: ThemeOption | ThemeOptionByLogLevel;\n\n  /**\n   * @description Styling for the main message text in the output.\n   */\n  message: ThemeOption | ThemeOptionByLogLevel;\n\n  /**\n   * @description Styling for method names in the output.\n   */\n  method: ThemeOption | ThemeOptionByLogLevel;\n\n  /**\n   * @description Styling for identifier elements in the output.\n   */\n  id: ThemeOption | ThemeOptionByLogLevel;\n\n  /**\n   * @description Styling for identifier elements in the output.\n   */\n  stack: ThemeOption;\n\n  /**\n   * @description Styling for different log levels in the output.\n   */\n  logLevel: ThemeOptionByLogLevel;\n}\n"]}
|
|
File without changes
|
package/lib/esm/winston/index.js
CHANGED
|
File without changes
|
|
@@ -3,10 +3,49 @@ import Transport from "winston-transport";
|
|
|
3
3
|
import { Logger, LoggerFactory, LoggingConfig, StringLike } from "../types";
|
|
4
4
|
import { MiniLogger } from "../logging";
|
|
5
5
|
import { LogLevel } from "../constants";
|
|
6
|
+
/**
|
|
7
|
+
* @description A logger implementation using Winston
|
|
8
|
+
* @summary WinstonLogger extends MiniLogger to provide logging functionality using the Winston library.
|
|
9
|
+
* It configures Winston with appropriate transports and formats based on the logging configuration.
|
|
10
|
+
* @param {string} cont - The context (typically class name) this logger is associated with
|
|
11
|
+
* @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
|
|
12
|
+
* @param {Transport[]|Transport} [transports] - Winston transports to use for logging
|
|
13
|
+
* @class WinstonLogger
|
|
14
|
+
* @example
|
|
15
|
+
* // Create a Winston logger for a class
|
|
16
|
+
* const logger = new WinstonLogger('MyClass');
|
|
17
|
+
*
|
|
18
|
+
* // Log messages at different levels
|
|
19
|
+
* logger.info('Application started');
|
|
20
|
+
* logger.error(new Error('Something went wrong'));
|
|
21
|
+
*
|
|
22
|
+
* // Create a child logger for a specific method
|
|
23
|
+
* const methodLogger = logger.for('myMethod');
|
|
24
|
+
* methodLogger.debug('Processing data...');
|
|
25
|
+
*/
|
|
6
26
|
export declare class WinstonLogger extends MiniLogger implements Logger {
|
|
7
27
|
protected transports?: (Transport[] | Transport) | undefined;
|
|
8
28
|
protected winston: winston.Logger;
|
|
9
29
|
constructor(cont: string, conf?: Partial<LoggingConfig>, transports?: (Transport[] | Transport) | undefined);
|
|
30
|
+
/**
|
|
31
|
+
* @description Logs a message with the specified log level using Winston
|
|
32
|
+
* @summary Overrides the base log method to use Winston for logging
|
|
33
|
+
* @param {LogLevel} level - The log level of the message
|
|
34
|
+
* @param {StringLike | Error} msg - The message to be logged or an Error object
|
|
35
|
+
* @param {string} [stack] - Optional stack trace to include in the log
|
|
36
|
+
* @return {void}
|
|
37
|
+
*/
|
|
10
38
|
protected log(level: LogLevel, msg: StringLike | Error, stack?: string): void;
|
|
11
39
|
}
|
|
40
|
+
/**
|
|
41
|
+
* @description Factory function for creating Winston loggers
|
|
42
|
+
* @summary A LoggerFactory implementation that creates WinstonLogger instances
|
|
43
|
+
* @const WinstonFactory
|
|
44
|
+
* @type {LoggerFactory}
|
|
45
|
+
* @param {string} context - The context (typically class name) for the logger
|
|
46
|
+
* @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
|
|
47
|
+
* @param {...any} args - Additional arguments to pass to the WinstonLogger constructor
|
|
48
|
+
* @return {WinstonLogger} A new WinstonLogger instance
|
|
49
|
+
* @memberOf module:Logging
|
|
50
|
+
*/
|
|
12
51
|
export declare const WinstonFactory: LoggerFactory;
|
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
import winston from "winston";
|
|
2
2
|
import { Logging, MiniLogger } from "../logging";
|
|
3
|
+
/**
|
|
4
|
+
* @description A logger implementation using Winston
|
|
5
|
+
* @summary WinstonLogger extends MiniLogger to provide logging functionality using the Winston library.
|
|
6
|
+
* It configures Winston with appropriate transports and formats based on the logging configuration.
|
|
7
|
+
* @param {string} cont - The context (typically class name) this logger is associated with
|
|
8
|
+
* @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
|
|
9
|
+
* @param {Transport[]|Transport} [transports] - Winston transports to use for logging
|
|
10
|
+
* @class WinstonLogger
|
|
11
|
+
* @example
|
|
12
|
+
* // Create a Winston logger for a class
|
|
13
|
+
* const logger = new WinstonLogger('MyClass');
|
|
14
|
+
*
|
|
15
|
+
* // Log messages at different levels
|
|
16
|
+
* logger.info('Application started');
|
|
17
|
+
* logger.error(new Error('Something went wrong'));
|
|
18
|
+
*
|
|
19
|
+
* // Create a child logger for a specific method
|
|
20
|
+
* const methodLogger = logger.for('myMethod');
|
|
21
|
+
* methodLogger.debug('Processing data...');
|
|
22
|
+
*/
|
|
3
23
|
export class WinstonLogger extends MiniLogger {
|
|
4
24
|
constructor(cont, conf, transports) {
|
|
5
25
|
super(cont, conf);
|
|
@@ -30,6 +50,14 @@ export class WinstonLogger extends MiniLogger {
|
|
|
30
50
|
};
|
|
31
51
|
this.winston = winston.createLogger(winstonConfig);
|
|
32
52
|
}
|
|
53
|
+
/**
|
|
54
|
+
* @description Logs a message with the specified log level using Winston
|
|
55
|
+
* @summary Overrides the base log method to use Winston for logging
|
|
56
|
+
* @param {LogLevel} level - The log level of the message
|
|
57
|
+
* @param {StringLike | Error} msg - The message to be logged or an Error object
|
|
58
|
+
* @param {string} [stack] - Optional stack trace to include in the log
|
|
59
|
+
* @return {void}
|
|
60
|
+
*/
|
|
33
61
|
log(level, msg, stack) {
|
|
34
62
|
const logData = {
|
|
35
63
|
level: level,
|
|
@@ -40,5 +68,16 @@ export class WinstonLogger extends MiniLogger {
|
|
|
40
68
|
this.winston.log(logData);
|
|
41
69
|
}
|
|
42
70
|
}
|
|
71
|
+
/**
|
|
72
|
+
* @description Factory function for creating Winston loggers
|
|
73
|
+
* @summary A LoggerFactory implementation that creates WinstonLogger instances
|
|
74
|
+
* @const WinstonFactory
|
|
75
|
+
* @type {LoggerFactory}
|
|
76
|
+
* @param {string} context - The context (typically class name) for the logger
|
|
77
|
+
* @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
|
|
78
|
+
* @param {...any} args - Additional arguments to pass to the WinstonLogger constructor
|
|
79
|
+
* @return {WinstonLogger} A new WinstonLogger instance
|
|
80
|
+
* @memberOf module:Logging
|
|
81
|
+
*/
|
|
43
82
|
export const WinstonFactory = (context, conf, ...args) => new WinstonLogger(context, conf, ...args);
|
|
44
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
83
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid2luc3Rvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy93aW5zdG9uL3dpbnN0b24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxPQUFvQyxNQUFNLFNBQVMsQ0FBQztBQUczRCxPQUFPLEVBQUUsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLFlBQVksQ0FBQztBQUdqRDs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW1CRztBQUNILE1BQU0sT0FBTyxhQUFjLFNBQVEsVUFBVTtJQUczQyxZQUNFLElBQVksRUFDWixJQUE2QixFQUNuQixVQUFvQztRQUU5QyxLQUFLLENBQUMsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO1FBRlIsZUFBVSxHQUFWLFVBQVUsQ0FBMEI7UUFHOUMsTUFBTSxNQUFNLEdBQWtCLE1BQU0sQ0FBQyxNQUFNLENBQ3pDLEVBQUUsRUFDRixJQUFJLENBQUMsSUFBSSxJQUFJLEVBQUUsRUFDZixPQUFPLENBQUMsU0FBUyxFQUFFLENBQ3BCLENBQUM7UUFDRixJQUFJLENBQUMsSUFBSSxHQUFHLE1BQU0sQ0FBQyxNQUFNLENBQUMsRUFBRSxFQUFFLElBQUksQ0FBQyxJQUFJLElBQUksRUFBRSxFQUFFO1lBQzdDLEtBQUssRUFBRSxLQUFLO1lBQ1osUUFBUSxFQUFFLEtBQUs7WUFDZixTQUFTLEVBQUUsS0FBSztZQUNoQixPQUFPLEVBQUUsS0FBSztTQUNmLENBQUMsQ0FBQztRQUNILE1BQU0sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUUsZUFBZSxFQUFFLEdBQUcsTUFBTSxDQUFDO1FBRXJFLE1BQU0sT0FBTyxHQUFHLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxLQUFLLEVBQUUsRUFBRSxPQUFPLENBQUMsTUFBTSxDQUFDLE1BQU0sRUFBRSxDQUFDLENBQUM7UUFDbEUsSUFBSSxTQUFTO1lBQ1gsT0FBTyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxFQUFFLE1BQU0sRUFBRSxlQUFlLEVBQUUsQ0FBQyxDQUFDLENBQUM7UUFDekUsSUFBSSxLQUFLO1lBQUUsT0FBTyxDQUFDLE9BQU8sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUM7UUFFdEQsSUFBSSxDQUFDLFVBQVUsR0FBRyxJQUFJLENBQUMsVUFBVSxJQUFJO1lBQ25DLElBQUksT0FBTyxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUM7Z0JBQzdCLE1BQU0sRUFBRSxPQUFPLENBQUMsTUFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLE9BQU8sQ0FBQzthQUMzQyxDQUFDO1NBQ0gsQ0FBQztRQUVGLE1BQU0sYUFBYSxHQUFrQjtZQUNuQyxLQUFLLEVBQUUsS0FBSztZQUNaLFdBQVcsRUFBRSxPQUFPO1lBQ3BCLE1BQU0sRUFBRSxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRTtZQUM3QixVQUFVLEVBQUUsVUFBVTtTQUN2QixDQUFDO1FBQ0YsSUFBSSxDQUFDLE9BQU8sR0FBRyxPQUFPLENBQUMsWUFBWSxDQUFDLGFBQWEsQ0FBQyxDQUFDO0lBQ3JELENBQUM7SUFFRDs7Ozs7OztPQU9HO0lBQ2dCLEdBQUcsQ0FDcEIsS0FBZSxFQUNmLEdBQXVCLEVBQ3ZCLEtBQWM7UUFFZCxNQUFNLE9BQU8sR0FBYTtZQUN4QixLQUFLLEVBQUUsS0FBSztZQUNaLE9BQU8sRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssRUFBRSxHQUFHLEVBQUUsS0FBSyxDQUFDO1NBQzNDLENBQUM7UUFDRixJQUFJLElBQUksQ0FBQyxNQUFNLENBQUMsZUFBZSxDQUFDO1lBQzlCLE9BQU8sQ0FBQyxlQUFlLENBQUMsR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1FBQzFELElBQUksQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzVCLENBQUM7Q0FDRjtBQUVEOzs7Ozs7Ozs7O0dBVUc7QUFDSCxNQUFNLENBQUMsTUFBTSxjQUFjLEdBQWtCLENBQzNDLE9BQWUsRUFDZixJQUE2QixFQUM3QixHQUFHLElBQVcsRUFDZCxFQUFFLENBQUMsSUFBSSxhQUFhLENBQUMsT0FBTyxFQUFFLElBQUksRUFBRSxHQUFHLElBQUksQ0FBQyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHdpbnN0b24sIHsgTG9nRW50cnksIExvZ2dlck9wdGlvbnMgfSBmcm9tIFwid2luc3RvblwiO1xuaW1wb3J0IFRyYW5zcG9ydCBmcm9tIFwid2luc3Rvbi10cmFuc3BvcnRcIjtcbmltcG9ydCB7IExvZ2dlciwgTG9nZ2VyRmFjdG9yeSwgTG9nZ2luZ0NvbmZpZywgU3RyaW5nTGlrZSB9IGZyb20gXCIuLi90eXBlc1wiO1xuaW1wb3J0IHsgTG9nZ2luZywgTWluaUxvZ2dlciB9IGZyb20gXCIuLi9sb2dnaW5nXCI7XG5pbXBvcnQgeyBMb2dMZXZlbCB9IGZyb20gXCIuLi9jb25zdGFudHNcIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQSBsb2dnZXIgaW1wbGVtZW50YXRpb24gdXNpbmcgV2luc3RvblxuICogQHN1bW1hcnkgV2luc3RvbkxvZ2dlciBleHRlbmRzIE1pbmlMb2dnZXIgdG8gcHJvdmlkZSBsb2dnaW5nIGZ1bmN0aW9uYWxpdHkgdXNpbmcgdGhlIFdpbnN0b24gbGlicmFyeS5cbiAqIEl0IGNvbmZpZ3VyZXMgV2luc3RvbiB3aXRoIGFwcHJvcHJpYXRlIHRyYW5zcG9ydHMgYW5kIGZvcm1hdHMgYmFzZWQgb24gdGhlIGxvZ2dpbmcgY29uZmlndXJhdGlvbi5cbiAqIEBwYXJhbSB7c3RyaW5nfSBjb250IC0gVGhlIGNvbnRleHQgKHR5cGljYWxseSBjbGFzcyBuYW1lKSB0aGlzIGxvZ2dlciBpcyBhc3NvY2lhdGVkIHdpdGhcbiAqIEBwYXJhbSB7UGFydGlhbDxMb2dnaW5nQ29uZmlnPn0gW2NvbmZdIC0gT3B0aW9uYWwgY29uZmlndXJhdGlvbiB0byBvdmVycmlkZSBnbG9iYWwgc2V0dGluZ3NcbiAqIEBwYXJhbSB7VHJhbnNwb3J0W118VHJhbnNwb3J0fSBbdHJhbnNwb3J0c10gLSBXaW5zdG9uIHRyYW5zcG9ydHMgdG8gdXNlIGZvciBsb2dnaW5nXG4gKiBAY2xhc3MgV2luc3RvbkxvZ2dlclxuICogQGV4YW1wbGVcbiAqIC8vIENyZWF0ZSBhIFdpbnN0b24gbG9nZ2VyIGZvciBhIGNsYXNzXG4gKiBjb25zdCBsb2dnZXIgPSBuZXcgV2luc3RvbkxvZ2dlcignTXlDbGFzcycpO1xuICpcbiAqIC8vIExvZyBtZXNzYWdlcyBhdCBkaWZmZXJlbnQgbGV2ZWxzXG4gKiBsb2dnZXIuaW5mbygnQXBwbGljYXRpb24gc3RhcnRlZCcpO1xuICogbG9nZ2VyLmVycm9yKG5ldyBFcnJvcignU29tZXRoaW5nIHdlbnQgd3JvbmcnKSk7XG4gKlxuICogLy8gQ3JlYXRlIGEgY2hpbGQgbG9nZ2VyIGZvciBhIHNwZWNpZmljIG1ldGhvZFxuICogY29uc3QgbWV0aG9kTG9nZ2VyID0gbG9nZ2VyLmZvcignbXlNZXRob2QnKTtcbiAqIG1ldGhvZExvZ2dlci5kZWJ1ZygnUHJvY2Vzc2luZyBkYXRhLi4uJyk7XG4gKi9cbmV4cG9ydCBjbGFzcyBXaW5zdG9uTG9nZ2VyIGV4dGVuZHMgTWluaUxvZ2dlciBpbXBsZW1lbnRzIExvZ2dlciB7XG4gIHByb3RlY3RlZCB3aW5zdG9uOiB3aW5zdG9uLkxvZ2dlcjtcblxuICBjb25zdHJ1Y3RvcihcbiAgICBjb250OiBzdHJpbmcsXG4gICAgY29uZj86IFBhcnRpYWw8TG9nZ2luZ0NvbmZpZz4sXG4gICAgcHJvdGVjdGVkIHRyYW5zcG9ydHM/OiBUcmFuc3BvcnRbXSB8IFRyYW5zcG9ydFxuICApIHtcbiAgICBzdXBlcihjb250LCBjb25mKTtcbiAgICBjb25zdCBjb25maWc6IExvZ2dpbmdDb25maWcgPSBPYmplY3QuYXNzaWduKFxuICAgICAge30sXG4gICAgICB0aGlzLmNvbmYgfHwge30sXG4gICAgICBMb2dnaW5nLmdldENvbmZpZygpXG4gICAgKTtcbiAgICB0aGlzLmNvbmYgPSBPYmplY3QuYXNzaWduKHt9LCB0aGlzLmNvbmYgfHwge30sIHtcbiAgICAgIHN0eWxlOiBmYWxzZSxcbiAgICAgIGxvZ0xldmVsOiBmYWxzZSxcbiAgICAgIHRpbWVzdGFtcDogZmFsc2UsXG4gICAgICBjb250ZXh0OiBmYWxzZSxcbiAgICB9KTtcbiAgICBjb25zdCB7IGxldmVsLCBjb250ZXh0LCBzdHlsZSwgdGltZXN0YW1wLCB0aW1lc3RhbXBGb3JtYXQgfSA9IGNvbmZpZztcblxuICAgIGNvbnN0IGZvcm1hdHMgPSBbd2luc3Rvbi5mb3JtYXQuc3BsYXQoKSwgd2luc3Rvbi5mb3JtYXQuc2ltcGxlKCldO1xuICAgIGlmICh0aW1lc3RhbXApXG4gICAgICBmb3JtYXRzLnVuc2hpZnQod2luc3Rvbi5mb3JtYXQudGltZXN0YW1wKHsgZm9ybWF0OiB0aW1lc3RhbXBGb3JtYXQgfSkpO1xuICAgIGlmIChzdHlsZSkgZm9ybWF0cy51bnNoaWZ0KHdpbnN0b24uZm9ybWF0LmNvbG9yaXplKCkpO1xuXG4gICAgdGhpcy50cmFuc3BvcnRzID0gdGhpcy50cmFuc3BvcnRzIHx8IFtcbiAgICAgIG5ldyB3aW5zdG9uLnRyYW5zcG9ydHMuQ29uc29sZSh7XG4gICAgICAgIGZvcm1hdDogd2luc3Rvbi5mb3JtYXQuY29tYmluZSguLi5mb3JtYXRzKSxcbiAgICAgIH0pLFxuICAgIF07XG5cbiAgICBjb25zdCB3aW5zdG9uQ29uZmlnOiBMb2dnZXJPcHRpb25zID0ge1xuICAgICAgbGV2ZWw6IGxldmVsLFxuICAgICAgZGVmYXVsdE1ldGE6IGNvbnRleHQsXG4gICAgICBmb3JtYXQ6IHdpbnN0b24uZm9ybWF0Lmpzb24oKSxcbiAgICAgIHRyYW5zcG9ydHM6IHRyYW5zcG9ydHMsXG4gICAgfTtcbiAgICB0aGlzLndpbnN0b24gPSB3aW5zdG9uLmNyZWF0ZUxvZ2dlcih3aW5zdG9uQ29uZmlnKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gTG9ncyBhIG1lc3NhZ2Ugd2l0aCB0aGUgc3BlY2lmaWVkIGxvZyBsZXZlbCB1c2luZyBXaW5zdG9uXG4gICAqIEBzdW1tYXJ5IE92ZXJyaWRlcyB0aGUgYmFzZSBsb2cgbWV0aG9kIHRvIHVzZSBXaW5zdG9uIGZvciBsb2dnaW5nXG4gICAqIEBwYXJhbSB7TG9nTGV2ZWx9IGxldmVsIC0gVGhlIGxvZyBsZXZlbCBvZiB0aGUgbWVzc2FnZVxuICAgKiBAcGFyYW0ge1N0cmluZ0xpa2UgfCBFcnJvcn0gbXNnIC0gVGhlIG1lc3NhZ2UgdG8gYmUgbG9nZ2VkIG9yIGFuIEVycm9yIG9iamVjdFxuICAgKiBAcGFyYW0ge3N0cmluZ30gW3N0YWNrXSAtIE9wdGlvbmFsIHN0YWNrIHRyYWNlIHRvIGluY2x1ZGUgaW4gdGhlIGxvZ1xuICAgKiBAcmV0dXJuIHt2b2lkfVxuICAgKi9cbiAgcHJvdGVjdGVkIG92ZXJyaWRlIGxvZyhcbiAgICBsZXZlbDogTG9nTGV2ZWwsXG4gICAgbXNnOiBTdHJpbmdMaWtlIHwgRXJyb3IsXG4gICAgc3RhY2s/OiBzdHJpbmdcbiAgKSB7XG4gICAgY29uc3QgbG9nRGF0YTogTG9nRW50cnkgPSB7XG4gICAgICBsZXZlbDogbGV2ZWwsXG4gICAgICBtZXNzYWdlOiB0aGlzLmNyZWF0ZUxvZyhsZXZlbCwgbXNnLCBzdGFjayksXG4gICAgfTtcbiAgICBpZiAodGhpcy5jb25maWcoXCJjb3JyZWxhdGlvbklkXCIpKVxuICAgICAgbG9nRGF0YVtcImNvcnJlbGF0aW9uSWRcIl0gPSB0aGlzLmNvbmZpZyhcImNvcnJlbGF0aW9uSWRcIik7XG4gICAgdGhpcy53aW5zdG9uLmxvZyhsb2dEYXRhKTtcbiAgfVxufVxuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBGYWN0b3J5IGZ1bmN0aW9uIGZvciBjcmVhdGluZyBXaW5zdG9uIGxvZ2dlcnNcbiAqIEBzdW1tYXJ5IEEgTG9nZ2VyRmFjdG9yeSBpbXBsZW1lbnRhdGlvbiB0aGF0IGNyZWF0ZXMgV2luc3RvbkxvZ2dlciBpbnN0YW5jZXNcbiAqIEBjb25zdCBXaW5zdG9uRmFjdG9yeVxuICogQHR5cGUge0xvZ2dlckZhY3Rvcnl9XG4gKiBAcGFyYW0ge3N0cmluZ30gY29udGV4dCAtIFRoZSBjb250ZXh0ICh0eXBpY2FsbHkgY2xhc3MgbmFtZSkgZm9yIHRoZSBsb2dnZXJcbiAqIEBwYXJhbSB7UGFydGlhbDxMb2dnaW5nQ29uZmlnPn0gW2NvbmZdIC0gT3B0aW9uYWwgY29uZmlndXJhdGlvbiB0byBvdmVycmlkZSBnbG9iYWwgc2V0dGluZ3NcbiAqIEBwYXJhbSB7Li4uYW55fSBhcmdzIC0gQWRkaXRpb25hbCBhcmd1bWVudHMgdG8gcGFzcyB0byB0aGUgV2luc3RvbkxvZ2dlciBjb25zdHJ1Y3RvclxuICogQHJldHVybiB7V2luc3RvbkxvZ2dlcn0gQSBuZXcgV2luc3RvbkxvZ2dlciBpbnN0YW5jZVxuICogQG1lbWJlck9mIG1vZHVsZTpMb2dnaW5nXG4gKi9cbmV4cG9ydCBjb25zdCBXaW5zdG9uRmFjdG9yeTogTG9nZ2VyRmFjdG9yeSA9IChcbiAgY29udGV4dDogc3RyaW5nLFxuICBjb25mPzogUGFydGlhbDxMb2dnaW5nQ29uZmlnPixcbiAgLi4uYXJnczogYW55W11cbikgPT4gbmV3IFdpbnN0b25Mb2dnZXIoY29udGV4dCwgY29uZiwgLi4uYXJncyk7XG4iXX0=
|
package/lib/index.cjs
CHANGED
|
@@ -20,21 +20,15 @@ __exportStar(require("./decorators.cjs"), exports);
|
|
|
20
20
|
__exportStar(require("./logging.cjs"), exports);
|
|
21
21
|
__exportStar(require("./types.cjs"), exports);
|
|
22
22
|
/**
|
|
23
|
-
* @
|
|
24
|
-
* @
|
|
23
|
+
* @description A logging module for TypeScript applications
|
|
24
|
+
* @summary This module provides a comprehensive logging solution for TypeScript applications. It exports constants, decorators, logging utilities, and type definitions to facilitate structured logging.
|
|
25
25
|
* @module Logging
|
|
26
26
|
*/
|
|
27
27
|
/**
|
|
28
|
-
* @
|
|
29
|
-
* @
|
|
30
|
-
* @namespace Logging
|
|
31
|
-
* @memberOf module:Logging
|
|
32
|
-
*/
|
|
33
|
-
/**
|
|
34
|
-
* @summary stores the current package version
|
|
35
|
-
* @description this is how you should document a constant
|
|
28
|
+
* @description Current package version string
|
|
29
|
+
* @summary Stores the current package version, used for version tracking and compatibility checks
|
|
36
30
|
* @const VERSION
|
|
37
|
-
* @memberOf module:
|
|
31
|
+
* @memberOf module:Logging
|
|
38
32
|
*/
|
|
39
|
-
exports.VERSION = "0.
|
|
40
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
33
|
+
exports.VERSION = "0.3.0";
|
|
34
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxrREFBNEI7QUFDNUIsbURBQTZCO0FBQzdCLGdEQUEwQjtBQUMxQiw4Q0FBd0I7QUFFeEI7Ozs7R0FJRztBQUVIOzs7OztHQUtHO0FBQ1UsUUFBQSxPQUFPLEdBQUcsYUFBYSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiZXhwb3J0ICogZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9kZWNvcmF0b3JzXCI7XG5leHBvcnQgKiBmcm9tIFwiLi9sb2dnaW5nXCI7XG5leHBvcnQgKiBmcm9tIFwiLi90eXBlc1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBBIGxvZ2dpbmcgbW9kdWxlIGZvciBUeXBlU2NyaXB0IGFwcGxpY2F0aW9uc1xuICogQHN1bW1hcnkgVGhpcyBtb2R1bGUgcHJvdmlkZXMgYSBjb21wcmVoZW5zaXZlIGxvZ2dpbmcgc29sdXRpb24gZm9yIFR5cGVTY3JpcHQgYXBwbGljYXRpb25zLiBJdCBleHBvcnRzIGNvbnN0YW50cywgZGVjb3JhdG9ycywgbG9nZ2luZyB1dGlsaXRpZXMsIGFuZCB0eXBlIGRlZmluaXRpb25zIHRvIGZhY2lsaXRhdGUgc3RydWN0dXJlZCBsb2dnaW5nLlxuICogQG1vZHVsZSBMb2dnaW5nXG4gKi9cblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQ3VycmVudCBwYWNrYWdlIHZlcnNpb24gc3RyaW5nXG4gKiBAc3VtbWFyeSBTdG9yZXMgdGhlIGN1cnJlbnQgcGFja2FnZSB2ZXJzaW9uLCB1c2VkIGZvciB2ZXJzaW9uIHRyYWNraW5nIGFuZCBjb21wYXRpYmlsaXR5IGNoZWNrc1xuICogQGNvbnN0IFZFUlNJT05cbiAqIEBtZW1iZXJPZiBtb2R1bGU6TG9nZ2luZ1xuICovXG5leHBvcnQgY29uc3QgVkVSU0lPTiA9IFwiIyNWRVJTSU9OIyNcIjtcbiJdfQ==
|
package/lib/index.d.ts
CHANGED
|
@@ -3,20 +3,14 @@ export * from "./decorators";
|
|
|
3
3
|
export * from "./logging";
|
|
4
4
|
export * from "./types";
|
|
5
5
|
/**
|
|
6
|
-
* @
|
|
7
|
-
* @
|
|
6
|
+
* @description A logging module for TypeScript applications
|
|
7
|
+
* @summary This module provides a comprehensive logging solution for TypeScript applications. It exports constants, decorators, logging utilities, and type definitions to facilitate structured logging.
|
|
8
8
|
* @module Logging
|
|
9
9
|
*/
|
|
10
10
|
/**
|
|
11
|
-
* @
|
|
12
|
-
* @
|
|
13
|
-
* @namespace Logging
|
|
14
|
-
* @memberOf module:Logging
|
|
15
|
-
*/
|
|
16
|
-
/**
|
|
17
|
-
* @summary stores the current package version
|
|
18
|
-
* @description this is how you should document a constant
|
|
11
|
+
* @description Current package version string
|
|
12
|
+
* @summary Stores the current package version, used for version tracking and compatibility checks
|
|
19
13
|
* @const VERSION
|
|
20
|
-
* @memberOf module:
|
|
14
|
+
* @memberOf module:Logging
|
|
21
15
|
*/
|
|
22
|
-
export declare const VERSION = "0.
|
|
16
|
+
export declare const VERSION = "0.3.0";
|