@rainbow-o23/n1 1.0.63 → 1.0.65

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.
Files changed (6) hide show
  1. package/index.cjs +25 -17
  2. package/index.js +25 -17
  3. package/lib/utils/logger.d.ts +15 -15
  4. package/package.json +1 -1
  5. package/src/lib/pipeline/pipeline-execution.ts +8 -2
  6. package/src/lib/utils/logger.ts +31 -31
package/index.cjs CHANGED
@@ -69,7 +69,7 @@ const buildOutput = (message, ...optionalParams) => {
69
69
  }
70
70
  };
71
71
  class EnhancedLogger {
72
- static ENABLED_LEVELS = ['warn', 'error'];
72
+ static ENABLED_LEVELS = ['log', 'warn', 'error'];
73
73
  static ENABLEMENTS = {};
74
74
  _logger;
75
75
  constructor(logger) {
@@ -146,46 +146,46 @@ class EnhancedLogger {
146
146
  debug(message, ...optionalParams) {
147
147
  const { key } = buildOutput(message, ...optionalParams);
148
148
  if (key != null && EnhancedLogger.isEnabled(`${key}.debug`)) {
149
- return this._logger.debug(message, ...optionalParams);
149
+ this._logger.debug(message, ...optionalParams);
150
150
  }
151
151
  else if (EnhancedLogger.isLevelEnabled('debug')) {
152
- return this._logger.debug(message, ...optionalParams);
152
+ this._logger.debug(message, ...optionalParams);
153
153
  }
154
154
  }
155
155
  verbose(message, ...optionalParams) {
156
156
  const { key } = buildOutput(message, ...optionalParams);
157
157
  if (key != null && EnhancedLogger.isEnabled(`${key}.verbose`)) {
158
- return this._logger.verbose(message, ...optionalParams);
158
+ this._logger.verbose(message, ...optionalParams);
159
159
  }
160
160
  else if (EnhancedLogger.isLevelEnabled('verbose')) {
161
- return this._logger.verbose(message, ...optionalParams);
161
+ this._logger.verbose(message, ...optionalParams);
162
162
  }
163
163
  }
164
164
  log(message, ...optionalParams) {
165
165
  const { key } = buildOutput(message, ...optionalParams);
166
166
  if (key != null && EnhancedLogger.isEnabled(`${key}.log`)) {
167
- return this._logger.log(message, ...optionalParams);
167
+ this._logger.log(message, ...optionalParams);
168
168
  }
169
169
  else if (EnhancedLogger.isLevelEnabled('log')) {
170
- return this._logger.log(message, ...optionalParams);
170
+ this._logger.log(message, ...optionalParams);
171
171
  }
172
172
  }
173
173
  warn(message, ...optionalParams) {
174
174
  const { key } = buildOutput(message, ...optionalParams);
175
175
  if (key != null && EnhancedLogger.isEnabled(`${key}.warn`)) {
176
- return this._logger.warn(message, ...optionalParams);
176
+ this._logger.warn(message, ...optionalParams);
177
177
  }
178
178
  else if (EnhancedLogger.isLevelEnabled('warn')) {
179
- return this._logger.warn(message, ...optionalParams);
179
+ this._logger.warn(message, ...optionalParams);
180
180
  }
181
181
  }
182
182
  error(message, ...optionalParams) {
183
183
  const { key } = buildOutput(message, ...optionalParams);
184
184
  if (key != null && EnhancedLogger.isEnabled(`${key}.error`)) {
185
- return this._logger.error(message, ...optionalParams);
185
+ this._logger.error(message, ...optionalParams);
186
186
  }
187
187
  else if (EnhancedLogger.isLevelEnabled('error')) {
188
- return this._logger.error(message, ...optionalParams);
188
+ this._logger.error(message, ...optionalParams);
189
189
  }
190
190
  }
191
191
  }
@@ -200,19 +200,19 @@ class ConsoleLogger {
200
200
  ];
201
201
  }
202
202
  debug(message, ...optionalParams) {
203
- return console.debug(...this.buildPrefix('debug', message, ...optionalParams));
203
+ console.debug(...this.buildPrefix('debug', message, ...optionalParams));
204
204
  }
205
205
  verbose(message, ...optionalParams) {
206
- return console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
206
+ console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
207
207
  }
208
208
  log(message, ...optionalParams) {
209
- return console.log(...this.buildPrefix('log', message, ...optionalParams));
209
+ console.log(...this.buildPrefix('log', message, ...optionalParams));
210
210
  }
211
211
  warn(message, ...optionalParams) {
212
- return console.warn(...this.buildPrefix('warn', message, ...optionalParams));
212
+ console.warn(...this.buildPrefix('warn', message, ...optionalParams));
213
213
  }
214
214
  error(message, ...optionalParams) {
215
- return console.error(...this.buildPrefix('error', message, ...optionalParams));
215
+ console.error(...this.buildPrefix('error', message, ...optionalParams));
216
216
  }
217
217
  }
218
218
  const createLogger = (logger) => {
@@ -537,7 +537,15 @@ class AbstractPipelineExecution {
537
537
  _debugLogEnabled;
538
538
  constructor(options) {
539
539
  const { config, logger } = options ?? {};
540
- this._logger = logger ?? createLogger();
540
+ if (logger == null) {
541
+ this._logger = createLogger();
542
+ }
543
+ else if (logger instanceof EnhancedLogger) {
544
+ this._logger = logger;
545
+ }
546
+ else {
547
+ this._logger = new EnhancedLogger(logger);
548
+ }
541
549
  this._config = config ?? createConfig(this._logger);
542
550
  this._debugLogEnabled = this._config.getBoolean('pipeline.debug.log.enabled', false);
543
551
  this._performanceLogEnabled = this._debugLogEnabled || this._config.getBoolean('pipeline.performance.log.enabled', false);
package/index.js CHANGED
@@ -67,7 +67,7 @@ const buildOutput = (message, ...optionalParams) => {
67
67
  }
68
68
  };
69
69
  class EnhancedLogger {
70
- static ENABLED_LEVELS = ['warn', 'error'];
70
+ static ENABLED_LEVELS = ['log', 'warn', 'error'];
71
71
  static ENABLEMENTS = {};
72
72
  _logger;
73
73
  constructor(logger) {
@@ -144,46 +144,46 @@ class EnhancedLogger {
144
144
  debug(message, ...optionalParams) {
145
145
  const { key } = buildOutput(message, ...optionalParams);
146
146
  if (key != null && EnhancedLogger.isEnabled(`${key}.debug`)) {
147
- return this._logger.debug(message, ...optionalParams);
147
+ this._logger.debug(message, ...optionalParams);
148
148
  }
149
149
  else if (EnhancedLogger.isLevelEnabled('debug')) {
150
- return this._logger.debug(message, ...optionalParams);
150
+ this._logger.debug(message, ...optionalParams);
151
151
  }
152
152
  }
153
153
  verbose(message, ...optionalParams) {
154
154
  const { key } = buildOutput(message, ...optionalParams);
155
155
  if (key != null && EnhancedLogger.isEnabled(`${key}.verbose`)) {
156
- return this._logger.verbose(message, ...optionalParams);
156
+ this._logger.verbose(message, ...optionalParams);
157
157
  }
158
158
  else if (EnhancedLogger.isLevelEnabled('verbose')) {
159
- return this._logger.verbose(message, ...optionalParams);
159
+ this._logger.verbose(message, ...optionalParams);
160
160
  }
161
161
  }
162
162
  log(message, ...optionalParams) {
163
163
  const { key } = buildOutput(message, ...optionalParams);
164
164
  if (key != null && EnhancedLogger.isEnabled(`${key}.log`)) {
165
- return this._logger.log(message, ...optionalParams);
165
+ this._logger.log(message, ...optionalParams);
166
166
  }
167
167
  else if (EnhancedLogger.isLevelEnabled('log')) {
168
- return this._logger.log(message, ...optionalParams);
168
+ this._logger.log(message, ...optionalParams);
169
169
  }
170
170
  }
171
171
  warn(message, ...optionalParams) {
172
172
  const { key } = buildOutput(message, ...optionalParams);
173
173
  if (key != null && EnhancedLogger.isEnabled(`${key}.warn`)) {
174
- return this._logger.warn(message, ...optionalParams);
174
+ this._logger.warn(message, ...optionalParams);
175
175
  }
176
176
  else if (EnhancedLogger.isLevelEnabled('warn')) {
177
- return this._logger.warn(message, ...optionalParams);
177
+ this._logger.warn(message, ...optionalParams);
178
178
  }
179
179
  }
180
180
  error(message, ...optionalParams) {
181
181
  const { key } = buildOutput(message, ...optionalParams);
182
182
  if (key != null && EnhancedLogger.isEnabled(`${key}.error`)) {
183
- return this._logger.error(message, ...optionalParams);
183
+ this._logger.error(message, ...optionalParams);
184
184
  }
185
185
  else if (EnhancedLogger.isLevelEnabled('error')) {
186
- return this._logger.error(message, ...optionalParams);
186
+ this._logger.error(message, ...optionalParams);
187
187
  }
188
188
  }
189
189
  }
@@ -198,19 +198,19 @@ class ConsoleLogger {
198
198
  ];
199
199
  }
200
200
  debug(message, ...optionalParams) {
201
- return console.debug(...this.buildPrefix('debug', message, ...optionalParams));
201
+ console.debug(...this.buildPrefix('debug', message, ...optionalParams));
202
202
  }
203
203
  verbose(message, ...optionalParams) {
204
- return console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
204
+ console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
205
205
  }
206
206
  log(message, ...optionalParams) {
207
- return console.log(...this.buildPrefix('log', message, ...optionalParams));
207
+ console.log(...this.buildPrefix('log', message, ...optionalParams));
208
208
  }
209
209
  warn(message, ...optionalParams) {
210
- return console.warn(...this.buildPrefix('warn', message, ...optionalParams));
210
+ console.warn(...this.buildPrefix('warn', message, ...optionalParams));
211
211
  }
212
212
  error(message, ...optionalParams) {
213
- return console.error(...this.buildPrefix('error', message, ...optionalParams));
213
+ console.error(...this.buildPrefix('error', message, ...optionalParams));
214
214
  }
215
215
  }
216
216
  const createLogger = (logger) => {
@@ -535,7 +535,15 @@ class AbstractPipelineExecution {
535
535
  _debugLogEnabled;
536
536
  constructor(options) {
537
537
  const { config, logger } = options ?? {};
538
- this._logger = logger ?? createLogger();
538
+ if (logger == null) {
539
+ this._logger = createLogger();
540
+ }
541
+ else if (logger instanceof EnhancedLogger) {
542
+ this._logger = logger;
543
+ }
544
+ else {
545
+ this._logger = new EnhancedLogger(logger);
546
+ }
539
547
  this._config = config ?? createConfig(this._logger);
540
548
  this._debugLogEnabled = this._config.getBoolean('pipeline.debug.log.enabled', false);
541
549
  this._performanceLogEnabled = this._debugLogEnabled || this._config.getBoolean('pipeline.performance.log.enabled', false);
package/lib/utils/logger.d.ts CHANGED
@@ -2,11 +2,11 @@ export type LoggerLevel = 'debug' | 'verbose' | 'log' | 'warn' | 'error';
2
2
  export type LoggerName = `${string}.${LoggerLevel}`;
3
3
  export type LoggerEnablement = Record<LoggerName, boolean>;
4
4
  export interface Logger {
5
- log(message: any, ...optionalParams: any[]): any;
6
- error(message: any, ...optionalParams: any[]): any;
7
- warn(message: any, ...optionalParams: any[]): any;
8
- debug?(message: any, ...optionalParams: any[]): any;
9
- verbose?(message: any, ...optionalParams: any[]): any;
5
+ log(message: any, ...optionalParams: any[]): void;
6
+ error(message: any, ...optionalParams: any[]): void;
7
+ warn(message: any, ...optionalParams: any[]): void;
8
+ debug?(message: any, ...optionalParams: any[]): void;
9
+ verbose?(message: any, ...optionalParams: any[]): void;
10
10
  }
11
11
  export declare class EnhancedLogger implements Logger {
12
12
  private static ENABLED_LEVELS;
@@ -22,19 +22,19 @@ export declare class EnhancedLogger implements Logger {
22
22
  static isEnabled(name: LoggerName): boolean;
23
23
  takeover(to: Logger): void;
24
24
  restore(): void;
25
- debug(message: any, ...optionalParams: any[]): any;
26
- verbose(message: any, ...optionalParams: any[]): any;
27
- log(message: any, ...optionalParams: any[]): any;
28
- warn(message: any, ...optionalParams: any[]): any;
29
- error(message: any, ...optionalParams: any[]): any;
25
+ debug(message: any, ...optionalParams: any[]): void;
26
+ verbose(message: any, ...optionalParams: any[]): void;
27
+ log(message: any, ...optionalParams: any[]): void;
28
+ warn(message: any, ...optionalParams: any[]): void;
29
+ error(message: any, ...optionalParams: any[]): void;
30
30
  }
31
31
  export declare class ConsoleLogger implements Logger {
32
32
  private buildPrefix;
33
- debug(message: any, ...optionalParams: any[]): any;
34
- verbose(message: any, ...optionalParams: any[]): any;
35
- log(message: any, ...optionalParams: any[]): any;
36
- warn(message: any, ...optionalParams: any[]): any;
37
- error(message: any, ...optionalParams: any[]): any;
33
+ debug(message: any, ...optionalParams: any[]): void;
34
+ verbose(message: any, ...optionalParams: any[]): void;
35
+ log(message: any, ...optionalParams: any[]): void;
36
+ warn(message: any, ...optionalParams: any[]): void;
37
+ error(message: any, ...optionalParams: any[]): void;
38
38
  }
39
39
  export declare const createLogger: (logger?: Logger) => EnhancedLogger;
40
40
  export declare class LoggerPerformanceSaver {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rainbow-o23/n1",
3
- "version": "1.0.63",
3
+ "version": "1.0.65",
4
4
  "description": "o23 interfaces",
5
5
  "main": "index.cjs",
6
6
  "module": "index.js",
package/src/lib/pipeline/pipeline-execution.ts CHANGED
@@ -1,4 +1,4 @@
1
- import {Config, createConfig, createLogger, Logger, LoggerUtils} from '../utils';
1
+ import {Config, createConfig, createLogger, EnhancedLogger, Logger, LoggerUtils} from '../utils';
2
2
  import {PipelineOptions} from './pipeline';
3
3
  import {PipelineStep, PipelineStepData} from './pipeline-step';
4
4
  import {PIPELINE_STEP_RETURN_NULL} from './step-helpers-utils';
@@ -45,7 +45,13 @@ export class AbstractPipelineExecution {
45
45
  // noinspection TypeScriptAbstractClassConstructorCanBeMadeProtected
46
46
  public constructor(options?: PipelineOptions) {
47
47
  const {config, logger} = options ?? {};
48
- this._logger = logger ?? createLogger();
48
+ if (logger == null) {
49
+ this._logger = createLogger();
50
+ } else if (logger instanceof EnhancedLogger) {
51
+ this._logger = logger;
52
+ } else {
53
+ this._logger = new EnhancedLogger(logger);
54
+ }
49
55
  this._config = config ?? createConfig(this._logger);
50
56
  this._debugLogEnabled = this._config.getBoolean('pipeline.debug.log.enabled', false);
51
57
  this._performanceLogEnabled = this._debugLogEnabled || this._config.getBoolean('pipeline.performance.log.enabled', false);
package/src/lib/utils/logger.ts CHANGED
@@ -4,31 +4,31 @@ export type LoggerEnablement = Record<LoggerName, boolean>;
4
4
 
5
5
  export interface Logger {
6
6
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
7
- log(message: any, ...optionalParams: any[]): any;
7
+ log(message: any, ...optionalParams: any[]): void;
8
8
 
9
9
  /**
10
10
  * Write an 'error' level log.
11
11
  */
12
12
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
13
- error(message: any, ...optionalParams: any[]): any;
13
+ error(message: any, ...optionalParams: any[]): void;
14
14
 
15
15
  /**
16
16
  * Write a 'warn' level log.
17
17
  */
18
18
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
19
- warn(message: any, ...optionalParams: any[]): any;
19
+ warn(message: any, ...optionalParams: any[]): void;
20
20
 
21
21
  /**
22
22
  * Write a 'debug' level log.
23
23
  */
24
24
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
25
- debug?(message: any, ...optionalParams: any[]): any;
25
+ debug?(message: any, ...optionalParams: any[]): void;
26
26
 
27
27
  /**
28
28
  * Write a 'verbose' level log.
29
29
  */
30
30
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
31
- verbose?(message: any, ...optionalParams: any[]): any;
31
+ verbose?(message: any, ...optionalParams: any[]): void;
32
32
  }
33
33
 
34
34
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -48,7 +48,7 @@ const buildOutput = (message: any, ...optionalParams: any[]): RedressedOutputPar
48
48
  };
49
49
 
50
50
  export class EnhancedLogger implements Logger {
51
- private static ENABLED_LEVELS: Array<LoggerLevel> = ['warn', 'error'];
51
+ private static ENABLED_LEVELS: Array<LoggerLevel> = ['log', 'warn', 'error'];
52
52
  // noinspection SpellCheckingInspection
53
53
  private static ENABLEMENTS: LoggerEnablement = {};
54
54
  private _logger: Logger;
@@ -137,52 +137,52 @@ export class EnhancedLogger implements Logger {
137
137
  }
138
138
 
139
139
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
140
- public debug(message: any, ...optionalParams: any[]): any {
140
+ public debug(message: any, ...optionalParams: any[]): void {
141
141
  const {key} = buildOutput(message, ...optionalParams);
142
142
  if (key != null && EnhancedLogger.isEnabled(`${key}.debug`)) {
143
- return this._logger.debug(message, ...optionalParams);
143
+ this._logger.debug(message, ...optionalParams);
144
144
  } else if (EnhancedLogger.isLevelEnabled('debug')) {
145
- return this._logger.debug(message, ...optionalParams);
145
+ this._logger.debug(message, ...optionalParams);
146
146
  }
147
147
  }
148
148
 
149
149
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
150
- public verbose(message: any, ...optionalParams: any[]): any {
150
+ public verbose(message: any, ...optionalParams: any[]): void {
151
151
  const {key} = buildOutput(message, ...optionalParams);
152
152
  if (key != null && EnhancedLogger.isEnabled(`${key}.verbose`)) {
153
- return this._logger.verbose(message, ...optionalParams);
153
+ this._logger.verbose(message, ...optionalParams);
154
154
  } else if (EnhancedLogger.isLevelEnabled('verbose')) {
155
- return this._logger.verbose(message, ...optionalParams);
155
+ this._logger.verbose(message, ...optionalParams);
156
156
  }
157
157
  }
158
158
 
159
159
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
160
- public log(message: any, ...optionalParams: any[]): any {
160
+ public log(message: any, ...optionalParams: any[]): void {
161
161
  const {key} = buildOutput(message, ...optionalParams);
162
162
  if (key != null && EnhancedLogger.isEnabled(`${key}.log`)) {
163
- return this._logger.log(message, ...optionalParams);
163
+ this._logger.log(message, ...optionalParams);
164
164
  } else if (EnhancedLogger.isLevelEnabled('log')) {
165
- return this._logger.log(message, ...optionalParams);
165
+ this._logger.log(message, ...optionalParams);
166
166
  }
167
167
  }
168
168
 
169
169
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
170
- public warn(message: any, ...optionalParams: any[]): any {
170
+ public warn(message: any, ...optionalParams: any[]): void {
171
171
  const {key} = buildOutput(message, ...optionalParams);
172
172
  if (key != null && EnhancedLogger.isEnabled(`${key}.warn`)) {
173
- return this._logger.warn(message, ...optionalParams);
173
+ this._logger.warn(message, ...optionalParams);
174
174
  } else if (EnhancedLogger.isLevelEnabled('warn')) {
175
- return this._logger.warn(message, ...optionalParams);
175
+ this._logger.warn(message, ...optionalParams);
176
176
  }
177
177
  }
178
178
 
179
179
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
180
- public error(message: any, ...optionalParams: any[]): any {
180
+ public error(message: any, ...optionalParams: any[]): void {
181
181
  const {key} = buildOutput(message, ...optionalParams);
182
182
  if (key != null && EnhancedLogger.isEnabled(`${key}.error`)) {
183
- return this._logger.error(message, ...optionalParams);
183
+ this._logger.error(message, ...optionalParams);
184
184
  } else if (EnhancedLogger.isLevelEnabled('error')) {
185
- return this._logger.error(message, ...optionalParams);
185
+ this._logger.error(message, ...optionalParams);
186
186
  }
187
187
  }
188
188
  }
@@ -200,28 +200,28 @@ export class ConsoleLogger implements Logger {
200
200
  }
201
201
 
202
202
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
203
- debug(message: any, ...optionalParams: any[]): any {
204
- return console.debug(...this.buildPrefix('debug', message, ...optionalParams));
203
+ debug(message: any, ...optionalParams: any[]): void {
204
+ console.debug(...this.buildPrefix('debug', message, ...optionalParams));
205
205
  }
206
206
 
207
207
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
208
- verbose(message: any, ...optionalParams: any[]): any {
209
- return console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
208
+ verbose(message: any, ...optionalParams: any[]): void {
209
+ console.trace(...this.buildPrefix('verbose', message, ...optionalParams));
210
210
  }
211
211
 
212
212
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
213
- log(message: any, ...optionalParams: any[]): any {
214
- return console.log(...this.buildPrefix('log', message, ...optionalParams));
213
+ log(message: any, ...optionalParams: any[]): void {
214
+ console.log(...this.buildPrefix('log', message, ...optionalParams));
215
215
  }
216
216
 
217
217
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
218
- warn(message: any, ...optionalParams: any[]): any {
219
- return console.warn(...this.buildPrefix('warn', message, ...optionalParams));
218
+ warn(message: any, ...optionalParams: any[]): void {
219
+ console.warn(...this.buildPrefix('warn', message, ...optionalParams));
220
220
  }
221
221
 
222
222
  // eslint-disable-next-line @typescript-eslint/no-explicit-any
223
- error(message: any, ...optionalParams: any[]): any {
224
- return console.error(...this.buildPrefix('error', message, ...optionalParams));
223
+ error(message: any, ...optionalParams: any[]): void {
224
+ console.error(...this.buildPrefix('error', message, ...optionalParams));
225
225
  }
226
226
  }
227
227