@decaf-ts/logging 0.3.7 → 0.3.9
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/dist/logging.cjs +651 -104
- package/dist/logging.esm.cjs +630 -101
- package/lib/constants.cjs +24 -6
- package/lib/constants.d.ts +7 -0
- package/lib/decorators.cjs +47 -24
- package/lib/decorators.d.ts +24 -6
- package/lib/environment.cjs +204 -0
- package/lib/environment.d.ts +86 -0
- package/lib/esm/constants.d.ts +7 -0
- package/lib/esm/constants.js +23 -5
- package/lib/esm/decorators.d.ts +24 -6
- package/lib/esm/decorators.js +46 -24
- package/lib/esm/environment.d.ts +86 -0
- package/lib/esm/environment.js +200 -0
- package/lib/esm/filters/LogFilter.d.ts +6 -0
- package/lib/esm/filters/LogFilter.js +7 -0
- package/lib/esm/filters/PatternFilter.d.ts +10 -0
- package/lib/esm/filters/PatternFilter.js +43 -0
- package/lib/esm/filters/index.d.ts +2 -0
- package/lib/esm/filters/index.js +3 -0
- package/lib/esm/index.d.ts +5 -1
- package/lib/esm/index.js +6 -2
- package/lib/esm/logging.d.ts +11 -11
- package/lib/esm/logging.js +62 -32
- package/lib/esm/text.d.ts +156 -0
- package/lib/esm/text.js +214 -0
- package/lib/esm/types.d.ts +32 -4
- package/lib/esm/types.js +1 -1
- package/lib/esm/web.d.ts +8 -0
- package/lib/esm/web.js +12 -0
- package/lib/esm/winston/winston.d.ts +2 -2
- package/lib/esm/winston/winston.js +4 -4
- package/lib/filters/LogFilter.cjs +11 -0
- package/lib/filters/LogFilter.d.ts +6 -0
- package/lib/filters/PatternFilter.cjs +47 -0
- package/lib/filters/PatternFilter.d.ts +10 -0
- package/lib/filters/index.cjs +19 -0
- package/lib/filters/index.d.ts +2 -0
- package/lib/index.cjs +6 -2
- package/lib/index.d.ts +5 -1
- package/lib/logging.cjs +61 -31
- package/lib/logging.d.ts +11 -11
- package/lib/text.cjs +227 -0
- package/lib/text.d.ts +156 -0
- package/lib/types.cjs +1 -1
- package/lib/types.d.ts +32 -4
- package/lib/web.cjs +15 -0
- package/lib/web.d.ts +8 -0
- package/lib/winston/winston.cjs +4 -4
- package/lib/winston/winston.d.ts +2 -2
- package/package.json +12 -3
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { ObjectAccumulator } from "typed-object-accumulator";
|
|
2
|
+
/**
|
|
3
|
+
* @description Factory type for creating Environment instances.
|
|
4
|
+
* @summary Defines a function type that creates and returns Environment instances.
|
|
5
|
+
*
|
|
6
|
+
* @template T - The type of object the Environment will accumulate.
|
|
7
|
+
* @template E - The specific Environment type to be created, extending Environment<T>.
|
|
8
|
+
* @typedef {function(...unknown[]): E} EnvironmentFactory
|
|
9
|
+
* @memberOf module:Logging
|
|
10
|
+
*/
|
|
11
|
+
export type EnvironmentFactory<T extends object, E extends Environment<T>> = (...args: unknown[]) => E;
|
|
12
|
+
/**
|
|
13
|
+
* @class Environment
|
|
14
|
+
* @extends {ObjectAccumulator<T>}
|
|
15
|
+
* @template T
|
|
16
|
+
* @description A class representing an environment with accumulation capabilities.
|
|
17
|
+
* @summary Manages environment-related data and provides methods for accumulation and key retrieval.
|
|
18
|
+
* @param {T} [initialData] - The initial data to populate the environment with.
|
|
19
|
+
*/
|
|
20
|
+
export declare class Environment<T extends object> extends ObjectAccumulator<T> {
|
|
21
|
+
/**
|
|
22
|
+
* @static
|
|
23
|
+
* @protected
|
|
24
|
+
* @description A factory function for creating Environment instances.
|
|
25
|
+
* @summary Defines how new instances of the Environment class should be created.
|
|
26
|
+
* @return {Environment<any>} A new instance of the Environment class.
|
|
27
|
+
*/
|
|
28
|
+
protected static factory: EnvironmentFactory<any, any>;
|
|
29
|
+
/**
|
|
30
|
+
* @static
|
|
31
|
+
* @private
|
|
32
|
+
* @description The singleton instance of the Environment class.
|
|
33
|
+
* @type {Environment<any>}
|
|
34
|
+
*/
|
|
35
|
+
private static _instance;
|
|
36
|
+
protected constructor();
|
|
37
|
+
/**
|
|
38
|
+
* @description Retrieves a value from the environment
|
|
39
|
+
* @summary Gets a value from the environment variables, handling browser and Node.js environments differently
|
|
40
|
+
* @param {string} k - The key to retrieve from the environment
|
|
41
|
+
* @return {unknown} The value from the environment, or undefined if not found
|
|
42
|
+
*/
|
|
43
|
+
protected fromEnv(k: string): unknown;
|
|
44
|
+
/**
|
|
45
|
+
* @description Expands an object into the environment
|
|
46
|
+
* @summary Defines properties on the environment object that can be accessed as getters and setters
|
|
47
|
+
* @template V - Type of the object being expanded
|
|
48
|
+
* @param {V} value - The object to expand into the environment
|
|
49
|
+
* @return {void}
|
|
50
|
+
*/
|
|
51
|
+
protected expand<V extends object>(value: V): void;
|
|
52
|
+
/**
|
|
53
|
+
* @protected
|
|
54
|
+
* @static
|
|
55
|
+
* @description Retrieves or creates the singleton instance of the Environment class.
|
|
56
|
+
* @summary Ensures only one instance of the Environment class exists.
|
|
57
|
+
* @template E
|
|
58
|
+
* @param {...unknown[]} args - Arguments to pass to the factory function if a new instance is created.
|
|
59
|
+
* @return {E} The singleton instance of the Environment class.
|
|
60
|
+
*/
|
|
61
|
+
protected static instance<E extends Environment<any>>(...args: unknown[]): E;
|
|
62
|
+
/**
|
|
63
|
+
* @static
|
|
64
|
+
* @description Accumulates the given value into the environment.
|
|
65
|
+
* @summary Adds new properties to the environment from the provided object.
|
|
66
|
+
* @template V
|
|
67
|
+
* @param {V} value - The object to accumulate into the environment.
|
|
68
|
+
* @return {V} The updated environment instance.
|
|
69
|
+
*/
|
|
70
|
+
static accumulate<V extends object>(value: V): typeof Environment._instance & V & ObjectAccumulator<typeof Environment._instance & V>;
|
|
71
|
+
static get(key: string): any;
|
|
72
|
+
private static buildEnvProxy;
|
|
73
|
+
/**
|
|
74
|
+
* @static
|
|
75
|
+
* @description Retrieves the keys of the environment, optionally converting them to ENV format.
|
|
76
|
+
* @summary Gets all keys in the environment, with an option to format them for environment variables.
|
|
77
|
+
* @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.
|
|
78
|
+
* @return {string[]} An array of keys from the environment.
|
|
79
|
+
*/
|
|
80
|
+
static keys(toEnv?: boolean): string[];
|
|
81
|
+
}
|
|
82
|
+
export declare const LoggedEnvironment: Environment<any> & import("./types").LoggingConfig & {
|
|
83
|
+
env: any;
|
|
84
|
+
} & ObjectAccumulator<Environment<any> & import("./types").LoggingConfig & {
|
|
85
|
+
env: any;
|
|
86
|
+
}>;
|
package/lib/esm/constants.d.ts
CHANGED
|
@@ -1,4 +1,11 @@
|
|
|
1
1
|
import { LoggingConfig, Theme } from "./types";
|
|
2
|
+
export declare const BrowserEnvKey = "ENV";
|
|
3
|
+
/**
|
|
4
|
+
* @description Delimiter used for composing nested environment variable names.
|
|
5
|
+
* @summary Joins parent and child keys when mapping object paths to ENV strings.
|
|
6
|
+
*/
|
|
7
|
+
export declare const ENV_PATH_DELIMITER = "__";
|
|
8
|
+
export declare const DefaultPlaceholderWrappers: string[];
|
|
2
9
|
/**
|
|
3
10
|
* @description Enum for log levels.
|
|
4
11
|
* @summary Defines different levels of logging for the application.
|
package/lib/esm/constants.js
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
export const BrowserEnvKey = "ENV";
|
|
2
|
+
/**
|
|
3
|
+
* @description Delimiter used for composing nested environment variable names.
|
|
4
|
+
* @summary Joins parent and child keys when mapping object paths to ENV strings.
|
|
5
|
+
*/
|
|
6
|
+
export const ENV_PATH_DELIMITER = "__";
|
|
7
|
+
export const DefaultPlaceholderWrappers = ["${", "}"];
|
|
1
8
|
/**
|
|
2
9
|
* @description Enum for log levels.
|
|
3
10
|
* @summary Defines different levels of logging for the application.
|
|
@@ -75,6 +82,8 @@ export var LoggingMode;
|
|
|
75
82
|
* @memberOf module:Logging
|
|
76
83
|
*/
|
|
77
84
|
export const DefaultTheme = {
|
|
85
|
+
app: {},
|
|
86
|
+
separator: {},
|
|
78
87
|
class: {
|
|
79
88
|
fg: 34,
|
|
80
89
|
},
|
|
@@ -94,10 +103,17 @@ export const DefaultTheme = {
|
|
|
94
103
|
fg: 31,
|
|
95
104
|
style: ["bold"],
|
|
96
105
|
},
|
|
97
|
-
info: {
|
|
98
|
-
|
|
106
|
+
info: {
|
|
107
|
+
fg: 34,
|
|
108
|
+
style: ["bold"],
|
|
109
|
+
},
|
|
110
|
+
verbose: {
|
|
111
|
+
fg: 34,
|
|
112
|
+
style: ["bold"],
|
|
113
|
+
},
|
|
99
114
|
debug: {
|
|
100
115
|
fg: 33,
|
|
116
|
+
style: ["bold"],
|
|
101
117
|
},
|
|
102
118
|
},
|
|
103
119
|
};
|
|
@@ -119,16 +135,18 @@ export const DefaultTheme = {
|
|
|
119
135
|
* @memberOf module:Logging
|
|
120
136
|
*/
|
|
121
137
|
export const DefaultLoggingConfig = {
|
|
138
|
+
env: "development",
|
|
122
139
|
verbose: 0,
|
|
123
140
|
level: LogLevel.info,
|
|
124
141
|
logLevel: true,
|
|
125
|
-
mode: LoggingMode.RAW,
|
|
126
142
|
style: false,
|
|
127
143
|
contextSeparator: ".",
|
|
128
|
-
separator: "
|
|
144
|
+
separator: "-",
|
|
129
145
|
timestamp: true,
|
|
130
146
|
timestampFormat: "HH:mm:ss.SSS",
|
|
131
147
|
context: true,
|
|
148
|
+
format: LoggingMode.RAW,
|
|
149
|
+
pattern: "{level} [{timestamp}] {app} {context} {separator} {message} {stack}",
|
|
132
150
|
theme: DefaultTheme,
|
|
133
151
|
};
|
|
134
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
152
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AAEvC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,CAAN,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,KAAR,QAAQ,QAWnB;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,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,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,4CAA4C;IAC5C,0BAAW,CAAA;IACX,sCAAsC;IACtC,4BAAa,CAAA;AACf,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAU;IACjC,GAAG,EAAE,EAAE;IACP,SAAS,EAAE,EAAE;IACb,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;YACJ,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,OAAO,EAAE;YACP,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;QACD,KAAK,EAAE;YACL,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,CAAC,MAAM,CAAC;SAChB;KACF;CACF,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAkB;IACjD,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE,CAAC;IACV,KAAK,EAAE,QAAQ,CAAC,IAAI;IACpB,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE,KAAK;IACZ,gBAAgB,EAAE,GAAG;IACrB,SAAS,EAAE,GAAG;IACd,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,cAAc;IAC/B,OAAO,EAAE,IAAI;IACb,MAAM,EAAE,WAAW,CAAC,GAAG;IACvB,OAAO,EACL,qEAAqE;IACvE,KAAK,EAAE,YAAY;CACpB,CAAC","sourcesContent":["import { LoggingConfig, Theme } from \"./types\";\n\nexport const BrowserEnvKey = \"ENV\";\n\n/**\n * @description Delimiter used for composing nested environment variable names.\n * @summary Joins parent and child keys when mapping object paths to ENV strings.\n */\nexport const ENV_PATH_DELIMITER = \"__\";\n\nexport const DefaultPlaceholderWrappers = [\"${\", \"}\"];\n\n/**\n * @description Enum for log levels.\n * @summary Defines different levels of logging for the application.\n * @enum {string}\n * @readonly\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  app: {},\n  separator: {},\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      fg: 34,\n      style: [\"bold\"],\n    },\n    verbose: {\n      fg: 34,\n      style: [\"bold\"],\n    },\n    debug: {\n      fg: 33,\n      style: [\"bold\"],\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  env: \"development\",\n  verbose: 0,\n  level: LogLevel.info,\n  logLevel: true,\n  style: false,\n  contextSeparator: \".\",\n  separator: \"-\",\n  timestamp: true,\n  timestampFormat: \"HH:mm:ss.SSS\",\n  context: true,\n  format: LoggingMode.RAW,\n  pattern:\n    \"{level} [{timestamp}] {app} {context} {separator} {message} {stack}\",\n  theme: DefaultTheme,\n};\n"]}
|
package/lib/esm/decorators.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ import { LogLevel } from "./constants";
|
|
|
30
30
|
* end
|
|
31
31
|
* @category Method Decorators
|
|
32
32
|
*/
|
|
33
|
-
export declare function log(level?: LogLevel, benchmark?: boolean, verbosity?: number): (target: any, propertyKey
|
|
33
|
+
export declare function log(level?: LogLevel, benchmark?: boolean, verbosity?: number): (target: any, propertyKey?: any, descriptor?: PropertyDescriptor) => void;
|
|
34
34
|
/**
|
|
35
35
|
* @description Method decorator for logging function calls with debug level
|
|
36
36
|
* @summary Convenience wrapper around the log decorator that uses LogLevel.debug
|
|
@@ -39,7 +39,7 @@ export declare function log(level?: LogLevel, benchmark?: boolean, verbosity?: n
|
|
|
39
39
|
* @function debug
|
|
40
40
|
* @category Method Decorators
|
|
41
41
|
*/
|
|
42
|
-
export declare function debug(benchmark?: boolean): (target: any, propertyKey
|
|
42
|
+
export declare function debug(benchmark?: boolean): (target: any, propertyKey?: any, descriptor?: PropertyDescriptor) => void;
|
|
43
43
|
/**
|
|
44
44
|
* @description Method decorator for logging function calls with info level
|
|
45
45
|
* @summary Convenience wrapper around the log decorator that uses LogLevel.info
|
|
@@ -48,7 +48,7 @@ export declare function debug(benchmark?: boolean): (target: any, propertyKey: s
|
|
|
48
48
|
* @function info
|
|
49
49
|
* @category Method Decorators
|
|
50
50
|
*/
|
|
51
|
-
export declare function info(benchmark?: boolean): (target: any, propertyKey
|
|
51
|
+
export declare function info(benchmark?: boolean): (target: any, propertyKey?: any, descriptor?: PropertyDescriptor) => void;
|
|
52
52
|
/**
|
|
53
53
|
* @description Method decorator for logging function calls with silly level
|
|
54
54
|
* @summary Convenience wrapper around the log decorator that uses LogLevel.silly
|
|
@@ -57,14 +57,14 @@ export declare function info(benchmark?: boolean): (target: any, propertyKey: st
|
|
|
57
57
|
* @function silly
|
|
58
58
|
* @category Method Decorators
|
|
59
59
|
*/
|
|
60
|
-
export declare function silly(benchmark?: boolean): (target: any, propertyKey
|
|
60
|
+
export declare function silly(benchmark?: boolean): (target: any, propertyKey?: any, descriptor?: PropertyDescriptor) => void;
|
|
61
61
|
/**
|
|
62
62
|
* @description Method decorator for logging function calls with verbose level
|
|
63
63
|
* @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity
|
|
64
64
|
* @return {Function} A method decorator that wraps the original method with verbose logging
|
|
65
65
|
* @function verbose
|
|
66
66
|
*/
|
|
67
|
-
export declare function verbose(): void;
|
|
67
|
+
export declare function verbose(): (target: any, propertyKey?: any, descriptor?: any) => void;
|
|
68
68
|
/**
|
|
69
69
|
* @description Method decorator for logging function calls with verbose level
|
|
70
70
|
* @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity
|
|
@@ -72,4 +72,22 @@ export declare function verbose(): void;
|
|
|
72
72
|
* @return {Function} A method decorator that wraps the original method with verbose logging
|
|
73
73
|
* @function verbose
|
|
74
74
|
*/
|
|
75
|
-
export declare function verbose(benchmark: boolean): void;
|
|
75
|
+
export declare function verbose(benchmark: boolean): (target: any, propertyKey?: any, descriptor?: any) => void;
|
|
76
|
+
/**
|
|
77
|
+
* @description Method decorator for logging function calls with verbose level
|
|
78
|
+
* @summary Convenience wrapper around the log decorator that uses LogLevel.verbose with configurable verbosity
|
|
79
|
+
* @param {number} verbosity - The verbosity level for the log messages (default: 0)
|
|
80
|
+
* @return {Function} A method decorator that wraps the original method with verbose logging
|
|
81
|
+
* @function verbose
|
|
82
|
+
* @category Method Decorators
|
|
83
|
+
*/
|
|
84
|
+
export declare function verbose(verbosity: number | boolean): (target: any, propertyKey?: any, descriptor?: any) => void;
|
|
85
|
+
/**
|
|
86
|
+
* @description Creates a decorator that makes a method non-configurable
|
|
87
|
+
* @summary This decorator prevents a method from being overridden by making it non-configurable.
|
|
88
|
+
* It throws an error if used on anything other than a method.
|
|
89
|
+
* @return {Function} A decorator function that can be applied to methods
|
|
90
|
+
* @function final
|
|
91
|
+
* @category Method Decorators
|
|
92
|
+
*/
|
|
93
|
+
export declare function final(): (target: object, propertyKey?: any, descriptor?: PropertyDescriptor) => PropertyDescriptor;
|
package/lib/esm/decorators.js
CHANGED
|
@@ -33,31 +33,35 @@ import { Logging } from "./logging.js";
|
|
|
33
33
|
*/
|
|
34
34
|
export function log(level = LogLevel.info, benchmark = false, verbosity = 0) {
|
|
35
35
|
return function (target, propertyKey, descriptor) {
|
|
36
|
-
|
|
37
|
-
|
|
36
|
+
if (!descriptor)
|
|
37
|
+
throw new Error(`Logging decoration only applies to methods`);
|
|
38
|
+
const logger = Logging.for(target).for(target[propertyKey]);
|
|
39
|
+
const method = logger[level].bind(logger);
|
|
38
40
|
const originalMethod = descriptor.value;
|
|
39
|
-
descriptor.value =
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
41
|
+
descriptor.value = new Proxy(originalMethod, {
|
|
42
|
+
apply(fn, thisArg, args) {
|
|
43
|
+
method(`called with ${args}`, verbosity);
|
|
44
|
+
const start = Date.now();
|
|
45
|
+
try {
|
|
46
|
+
const result = Reflect.apply(fn, thisArg, args);
|
|
47
|
+
if (result instanceof Promise) {
|
|
48
|
+
return result.then((r) => {
|
|
49
|
+
if (benchmark)
|
|
50
|
+
method(`completed in ${Date.now() - start}ms`, verbosity);
|
|
51
|
+
return r;
|
|
52
|
+
});
|
|
50
53
|
}
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
54
|
+
if (benchmark)
|
|
55
|
+
method(`completed in ${Date.now() - start}ms`, verbosity);
|
|
56
|
+
return result;
|
|
57
|
+
}
|
|
58
|
+
catch (err) {
|
|
59
|
+
if (benchmark)
|
|
60
|
+
method(`failed in ${Date.now() - start}ms`, verbosity);
|
|
61
|
+
throw err;
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
});
|
|
61
65
|
};
|
|
62
66
|
}
|
|
63
67
|
/**
|
|
@@ -109,4 +113,22 @@ export function verbose(verbosity = 0, benchmark) {
|
|
|
109
113
|
}
|
|
110
114
|
return log(LogLevel.verbose, benchmark, verbosity);
|
|
111
115
|
}
|
|
112
|
-
|
|
116
|
+
/**
|
|
117
|
+
* @description Creates a decorator that makes a method non-configurable
|
|
118
|
+
* @summary This decorator prevents a method from being overridden by making it non-configurable.
|
|
119
|
+
* It throws an error if used on anything other than a method.
|
|
120
|
+
* @return {Function} A decorator function that can be applied to methods
|
|
121
|
+
* @function final
|
|
122
|
+
* @category Method Decorators
|
|
123
|
+
*/
|
|
124
|
+
export function final() {
|
|
125
|
+
return (target, propertyKey, descriptor) => {
|
|
126
|
+
if (!descriptor)
|
|
127
|
+
throw new Error("final decorator can only be used on methods");
|
|
128
|
+
if (descriptor?.configurable) {
|
|
129
|
+
descriptor.configurable = false;
|
|
130
|
+
}
|
|
131
|
+
return descriptor;
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/decorators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,uBAAoB;AACvC,OAAO,EAAE,OAAO,EAAE,qBAAkB;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,GAAG,CACjB,QAAkB,QAAQ,CAAC,IAAI,EAC/B,YAAqB,KAAK,EAC1B,SAAS,GAAG,CAAC;IAEb,OAAO,UACL,MAAW,EACX,WAAiB,EACjB,UAA+B;QAE/B,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAQ,CAAC;QACjD,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,cAAc,EAAE;YAC3C,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAW;gBAC5B,MAAM,CAAC,eAAe,IAAI,EAAE,EAAE,SAAS,CAAC,CAAC;gBACzC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACzB,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;oBAChD,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;wBAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE;4BAC5B,IAAI,SAAS;gCACX,MAAM,CAAC,gBAAgB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,SAAS,CAAC,CAAC;4BAC5D,OAAO,CAAC,CAAC;wBACX,CAAC,CAAC,CAAC;oBACL,CAAC;oBACD,IAAI,SAAS;wBACX,MAAM,CAAC,gBAAgB,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,SAAS,CAAC,CAAC;oBAC5D,OAAO,MAAM,CAAC;gBAChB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,SAAS;wBAAE,MAAM,CAAC,aAAa,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,EAAE,SAAS,CAAC,CAAC;oBACtE,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,YAAqB,KAAK;IAC9C,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,IAAI,CAAC,YAAqB,KAAK;IAC7C,OAAO,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;AACvC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK,CAAC,YAAqB,KAAK;IAC9C,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACxC,CAAC;AAoCD;;;;;;;;GAQG;AACH,MAAM,UAAU,OAAO,CAAC,YAA8B,CAAC,EAAE,SAAmB;IAC1E,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE,CAAC;QACnC,SAAS,GAAG,SAAS,CAAC;QACtB,SAAS,GAAG,CAAC,CAAC;IAChB,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,KAAK;IACnB,OAAO,CACL,MAAc,EACd,WAAiB,EACjB,UAA+B,EAC/B,EAAE;QACF,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,IAAI,UAAU,EAAE,YAAY,EAAE,CAAC;YAC7B,UAAU,CAAC,YAAY,GAAG,KAAK,CAAC;QAClC,CAAC;QACD,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,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 * @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 * @category Method Decorators\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?: any,\n    descriptor?: PropertyDescriptor\n  ) {\n    if (!descriptor)\n      throw new Error(`Logging decoration only applies to methods`);\n    const logger = Logging.for(target).for(target[propertyKey]);\n    const method = logger[level].bind(logger) as any;\n    const originalMethod = descriptor.value;\n\n    descriptor.value = new Proxy(originalMethod, {\n      apply(fn, thisArg, args: any[]) {\n        method(`called with ${args}`, verbosity);\n        const start = Date.now();\n        try {\n          const result = Reflect.apply(fn, thisArg, args);\n          if (result instanceof Promise) {\n            return result.then((r: any) => {\n              if (benchmark)\n                method(`completed in ${Date.now() - start}ms`, verbosity);\n              return r;\n            });\n          }\n          if (benchmark)\n            method(`completed in ${Date.now() - start}ms`, verbosity);\n          return result;\n        } catch (err) {\n          if (benchmark) method(`failed in ${Date.now() - start}ms`, verbosity);\n          throw err;\n        }\n      },\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 Method 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 Method 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 Method 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 * @return {Function} A method decorator that wraps the original method with verbose logging\n * @function verbose\n */\nexport function verbose(): (\n  target: any,\n  propertyKey?: any,\n  descriptor?: any\n) => void;\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 {boolean} benchmark - Whether to log execution time\n * @return {Function} A method decorator that wraps the original method with verbose logging\n * @function verbose\n */\nexport function verbose(\n  benchmark: boolean\n): (target: any, propertyKey?: any, descriptor?: any) => void;\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 * @return {Function} A method decorator that wraps the original method with verbose logging\n * @function verbose\n * @category Method Decorators\n */\nexport function verbose(\n  verbosity: number | boolean\n): (target: any, propertyKey?: any, descriptor?: any) => void;\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 Method Decorators\n */\nexport function verbose(verbosity: number | boolean = 0, benchmark?: boolean) {\n  if (typeof verbosity === \"boolean\") {\n    benchmark = verbosity;\n    verbosity = 0;\n  }\n  return log(LogLevel.verbose, benchmark, verbosity);\n}\n\n/**\n * @description Creates a decorator that makes a method non-configurable\n * @summary This decorator prevents a method from being overridden by making it non-configurable.\n * It throws an error if used on anything other than a method.\n * @return {Function} A decorator function that can be applied to methods\n * @function final\n * @category Method Decorators\n */\nexport function final() {\n  return (\n    target: object,\n    propertyKey?: any,\n    descriptor?: PropertyDescriptor\n  ) => {\n    if (!descriptor)\n      throw new Error(\"final decorator can only be used on methods\");\n    if (descriptor?.configurable) {\n      descriptor.configurable = false;\n    }\n    return descriptor;\n  };\n}\n"]}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { ObjectAccumulator } from "typed-object-accumulator";
|
|
2
|
+
/**
|
|
3
|
+
* @description Factory type for creating Environment instances.
|
|
4
|
+
* @summary Defines a function type that creates and returns Environment instances.
|
|
5
|
+
*
|
|
6
|
+
* @template T - The type of object the Environment will accumulate.
|
|
7
|
+
* @template E - The specific Environment type to be created, extending Environment<T>.
|
|
8
|
+
* @typedef {function(...unknown[]): E} EnvironmentFactory
|
|
9
|
+
* @memberOf module:Logging
|
|
10
|
+
*/
|
|
11
|
+
export type EnvironmentFactory<T extends object, E extends Environment<T>> = (...args: unknown[]) => E;
|
|
12
|
+
/**
|
|
13
|
+
* @class Environment
|
|
14
|
+
* @extends {ObjectAccumulator<T>}
|
|
15
|
+
* @template T
|
|
16
|
+
* @description A class representing an environment with accumulation capabilities.
|
|
17
|
+
* @summary Manages environment-related data and provides methods for accumulation and key retrieval.
|
|
18
|
+
* @param {T} [initialData] - The initial data to populate the environment with.
|
|
19
|
+
*/
|
|
20
|
+
export declare class Environment<T extends object> extends ObjectAccumulator<T> {
|
|
21
|
+
/**
|
|
22
|
+
* @static
|
|
23
|
+
* @protected
|
|
24
|
+
* @description A factory function for creating Environment instances.
|
|
25
|
+
* @summary Defines how new instances of the Environment class should be created.
|
|
26
|
+
* @return {Environment<any>} A new instance of the Environment class.
|
|
27
|
+
*/
|
|
28
|
+
protected static factory: EnvironmentFactory<any, any>;
|
|
29
|
+
/**
|
|
30
|
+
* @static
|
|
31
|
+
* @private
|
|
32
|
+
* @description The singleton instance of the Environment class.
|
|
33
|
+
* @type {Environment<any>}
|
|
34
|
+
*/
|
|
35
|
+
private static _instance;
|
|
36
|
+
protected constructor();
|
|
37
|
+
/**
|
|
38
|
+
* @description Retrieves a value from the environment
|
|
39
|
+
* @summary Gets a value from the environment variables, handling browser and Node.js environments differently
|
|
40
|
+
* @param {string} k - The key to retrieve from the environment
|
|
41
|
+
* @return {unknown} The value from the environment, or undefined if not found
|
|
42
|
+
*/
|
|
43
|
+
protected fromEnv(k: string): unknown;
|
|
44
|
+
/**
|
|
45
|
+
* @description Expands an object into the environment
|
|
46
|
+
* @summary Defines properties on the environment object that can be accessed as getters and setters
|
|
47
|
+
* @template V - Type of the object being expanded
|
|
48
|
+
* @param {V} value - The object to expand into the environment
|
|
49
|
+
* @return {void}
|
|
50
|
+
*/
|
|
51
|
+
protected expand<V extends object>(value: V): void;
|
|
52
|
+
/**
|
|
53
|
+
* @protected
|
|
54
|
+
* @static
|
|
55
|
+
* @description Retrieves or creates the singleton instance of the Environment class.
|
|
56
|
+
* @summary Ensures only one instance of the Environment class exists.
|
|
57
|
+
* @template E
|
|
58
|
+
* @param {...unknown[]} args - Arguments to pass to the factory function if a new instance is created.
|
|
59
|
+
* @return {E} The singleton instance of the Environment class.
|
|
60
|
+
*/
|
|
61
|
+
protected static instance<E extends Environment<any>>(...args: unknown[]): E;
|
|
62
|
+
/**
|
|
63
|
+
* @static
|
|
64
|
+
* @description Accumulates the given value into the environment.
|
|
65
|
+
* @summary Adds new properties to the environment from the provided object.
|
|
66
|
+
* @template V
|
|
67
|
+
* @param {V} value - The object to accumulate into the environment.
|
|
68
|
+
* @return {V} The updated environment instance.
|
|
69
|
+
*/
|
|
70
|
+
static accumulate<V extends object>(value: V): typeof Environment._instance & V & ObjectAccumulator<typeof Environment._instance & V>;
|
|
71
|
+
static get(key: string): any;
|
|
72
|
+
private static buildEnvProxy;
|
|
73
|
+
/**
|
|
74
|
+
* @static
|
|
75
|
+
* @description Retrieves the keys of the environment, optionally converting them to ENV format.
|
|
76
|
+
* @summary Gets all keys in the environment, with an option to format them for environment variables.
|
|
77
|
+
* @param {boolean} [toEnv=true] - Whether to convert the keys to ENV format.
|
|
78
|
+
* @return {string[]} An array of keys from the environment.
|
|
79
|
+
*/
|
|
80
|
+
static keys(toEnv?: boolean): string[];
|
|
81
|
+
}
|
|
82
|
+
export declare const LoggedEnvironment: Environment<any> & import("./types").LoggingConfig & {
|
|
83
|
+
env: any;
|
|
84
|
+
} & ObjectAccumulator<Environment<any> & import("./types").LoggingConfig & {
|
|
85
|
+
env: any;
|
|
86
|
+
}>;
|