@adapt-arch/utiliti-es 0.3.0 → 0.3.3

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.
@@ -239,6 +239,7 @@ class M {
239
239
  case o.Critical:
240
240
  e = this._console.error || this._console.log;
241
241
  break;
242
+ // case LogLevel.None: // Do not log.
242
243
  default:
243
244
  e = null;
244
245
  break;
@@ -403,83 +404,62 @@ class C {
403
404
  await ((s = this._options.reporter) == null ? void 0 : s[Symbol.asyncDispose]());
404
405
  }
405
406
  /**
406
- * Indicates if the specified level will be logged.
407
- *
408
- * @param {LogLevel} level The log level.
407
+ * @inheritdoc
409
408
  */
410
409
  isEnabled(s) {
411
410
  return s !== o.None && s >= this._options.minimumLevel;
412
411
  }
413
412
  /**
414
- * Log trace.
415
- *
416
- * @param msg The message to log.
413
+ * @inheritdoc
417
414
  */
418
415
  trace(s) {
419
416
  const e = new c();
420
417
  e.level = o.Trace, e.message = s, this.logMessage(e);
421
418
  }
422
419
  /**
423
- * Log debug.
424
- *
425
- * @param msg The message to log.
420
+ * @inheritdoc
426
421
  */
427
422
  debug(s) {
428
423
  const e = new c();
429
424
  e.level = o.Debug, e.message = s, this.logMessage(e);
430
425
  }
431
426
  /**
432
- * Log information.
433
- *
434
- * @param msg The message to log.
427
+ * @inheritdoc
435
428
  */
436
429
  info(s) {
437
430
  const e = new c();
438
431
  e.level = o.Information, e.message = s, this.logMessage(e);
439
432
  }
440
433
  /**
441
- * Log warning.
442
- *
443
- * @param msg The message to log.
434
+ * @inheritdoc
444
435
  */
445
436
  warn(s) {
446
437
  const e = new c();
447
438
  e.level = o.Warning, e.message = s, this.logMessage(e);
448
439
  }
449
440
  /**
450
- * Log error.
451
- *
452
- * @param msg The message to log.
441
+ * @inheritdoc
453
442
  */
454
443
  error(s) {
455
444
  const e = new c();
456
445
  e.level = o.Error, e.message = s, this.logMessage(e);
457
446
  }
458
447
  /**
459
- * Log error.
460
- *
461
- * @param msg The message to log.
448
+ * @inheritdoc
462
449
  */
463
450
  crit(s) {
464
451
  const e = new c();
465
452
  e.level = o.Critical, e.message = s, this.logMessage(e);
466
453
  }
467
454
  /**
468
- * Log an event.
469
- *
470
- * @param {LogLevel} level The level to log the event.
471
- * @param {String} message Custom message.
472
- * @param {Error} e The error associated with the event.
473
- * @param {ExtraParams} params Extra parameters.
455
+ * @inheritdoc
474
456
  */
475
457
  log(s, e, t, n) {
476
458
  const a = new c();
477
459
  a.level = s, a.message = e, a.errorMessage = t == null ? void 0 : t.message, a.stackTrace = t == null ? void 0 : t.stack, a.extraParams = n, this.logMessage(a);
478
460
  }
479
461
  /**
480
- * Log a message.
481
- *
482
- * @param {LogMessage} message The message to log.
462
+ * @inheritdoc
483
463
  */
484
464
  logMessage(s) {
485
465
  this.isEnabled(s.level) && setTimeout(() => {
@@ -1 +1 @@
1
- export { type SerializableValues } from "./contracts";
1
+ export type { SerializableValues } from "./contracts";
package/dist/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export * from "./pubsub/index";
2
- export * from "./utils/index";
1
+ export * from "./pubsub";
2
+ export * from "./utils";
3
3
  export * from "./common";
4
4
  export * from "./logger";
package/dist/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export * from "./pubsub/index";
2
- export * from "./utils/index";
1
+ export * from "./pubsub";
2
+ export * from "./utils";
3
3
  export * from "./common";
4
4
  export * from "./logger";
@@ -93,3 +93,47 @@ export interface ILogMessageEnricher {
93
93
  */
94
94
  enrich(message: LogMessage): void;
95
95
  }
96
+ /**
97
+ * Logging service.
98
+ */
99
+ /**
100
+ * Interface for logging operations.
101
+ */
102
+ export interface ILogger extends AsyncDisposable {
103
+ /**
104
+ * Indicates if the specified level will be logged.
105
+ */
106
+ isEnabled(level: LogLevel): boolean;
107
+ /**
108
+ * Log trace.
109
+ */
110
+ trace(msg: string): void;
111
+ /**
112
+ * Log debug.
113
+ */
114
+ debug(msg: string): void;
115
+ /**
116
+ * Log information.
117
+ */
118
+ info(msg: string): void;
119
+ /**
120
+ * Log warning.
121
+ */
122
+ warn(msg: string): void;
123
+ /**
124
+ * Log error.
125
+ */
126
+ error(msg: string): void;
127
+ /**
128
+ * Log critical.
129
+ */
130
+ crit(msg: string): void;
131
+ /**
132
+ * Log an event.
133
+ */
134
+ log(level: LogLevel, message: string, e?: Error, params?: ExtraParams): void;
135
+ /**
136
+ * Log a message.
137
+ */
138
+ logMessage(message: LogMessage): void;
139
+ }
@@ -1,5 +1,5 @@
1
- export * from "./enrichers/index";
2
- export * from "./reporters/index";
1
+ export * from "./enrichers";
2
+ export * from "./reporters/";
3
3
  export * from "./contracts";
4
4
  export * from "./logger";
5
5
  export * from "./loggerOptions";
@@ -1,5 +1,5 @@
1
- export * from "./enrichers/index";
2
- export * from "./reporters/index";
1
+ export * from "./enrichers";
2
+ export * from "./reporters/";
3
3
  export * from "./contracts";
4
4
  export * from "./logger";
5
5
  export * from "./loggerOptions";
@@ -1,9 +1,9 @@
1
- import { type ExtraParams, LogLevel, LogMessage } from "./contracts";
1
+ import { type ExtraParams, type ILogger, LogLevel, LogMessage } from "./contracts";
2
2
  import type { LoggerOptions } from "./loggerOptions";
3
3
  /**
4
4
  * Logging service.
5
5
  */
6
- export declare class Logger implements AsyncDisposable {
6
+ export declare class Logger implements ILogger {
7
7
  private readonly _options;
8
8
  /**
9
9
  * Constructor.
@@ -22,60 +22,39 @@ export declare class Logger implements AsyncDisposable {
22
22
  */
23
23
  [Symbol.asyncDispose](): Promise<void>;
24
24
  /**
25
- * Indicates if the specified level will be logged.
26
- *
27
- * @param {LogLevel} level The log level.
25
+ * @inheritdoc
28
26
  */
29
27
  isEnabled(level: LogLevel): boolean;
30
28
  /**
31
- * Log trace.
32
- *
33
- * @param msg The message to log.
29
+ * @inheritdoc
34
30
  */
35
31
  trace(msg: string): void;
36
32
  /**
37
- * Log debug.
38
- *
39
- * @param msg The message to log.
33
+ * @inheritdoc
40
34
  */
41
35
  debug(msg: string): void;
42
36
  /**
43
- * Log information.
44
- *
45
- * @param msg The message to log.
37
+ * @inheritdoc
46
38
  */
47
39
  info(msg: string): void;
48
40
  /**
49
- * Log warning.
50
- *
51
- * @param msg The message to log.
41
+ * @inheritdoc
52
42
  */
53
43
  warn(msg: string): void;
54
44
  /**
55
- * Log error.
56
- *
57
- * @param msg The message to log.
45
+ * @inheritdoc
58
46
  */
59
47
  error(msg: string): void;
60
48
  /**
61
- * Log error.
62
- *
63
- * @param msg The message to log.
49
+ * @inheritdoc
64
50
  */
65
51
  crit(msg: string): void;
66
52
  /**
67
- * Log an event.
68
- *
69
- * @param {LogLevel} level The level to log the event.
70
- * @param {String} message Custom message.
71
- * @param {Error} e The error associated with the event.
72
- * @param {ExtraParams} params Extra parameters.
53
+ * @inheritdoc
73
54
  */
74
55
  log(level: LogLevel, message: string, e?: Error, params?: ExtraParams): void;
75
56
  /**
76
- * Log a message.
77
- *
78
- * @param {LogMessage} message The message to log.
57
+ * @inheritdoc
79
58
  */
80
59
  logMessage(message: LogMessage): void;
81
60
  }
@@ -31,17 +31,13 @@ export class Logger {
31
31
  await this._options.reporter?.[Symbol.asyncDispose]();
32
32
  }
33
33
  /**
34
- * Indicates if the specified level will be logged.
35
- *
36
- * @param {LogLevel} level The log level.
34
+ * @inheritdoc
37
35
  */
38
36
  isEnabled(level) {
39
37
  return level !== LogLevel.None && level >= this._options.minimumLevel;
40
38
  }
41
39
  /**
42
- * Log trace.
43
- *
44
- * @param msg The message to log.
40
+ * @inheritdoc
45
41
  */
46
42
  trace(msg) {
47
43
  const message = new LogMessage();
@@ -50,9 +46,7 @@ export class Logger {
50
46
  this.logMessage(message);
51
47
  }
52
48
  /**
53
- * Log debug.
54
- *
55
- * @param msg The message to log.
49
+ * @inheritdoc
56
50
  */
57
51
  debug(msg) {
58
52
  const message = new LogMessage();
@@ -61,9 +55,7 @@ export class Logger {
61
55
  this.logMessage(message);
62
56
  }
63
57
  /**
64
- * Log information.
65
- *
66
- * @param msg The message to log.
58
+ * @inheritdoc
67
59
  */
68
60
  info(msg) {
69
61
  const message = new LogMessage();
@@ -72,9 +64,7 @@ export class Logger {
72
64
  this.logMessage(message);
73
65
  }
74
66
  /**
75
- * Log warning.
76
- *
77
- * @param msg The message to log.
67
+ * @inheritdoc
78
68
  */
79
69
  warn(msg) {
80
70
  const message = new LogMessage();
@@ -83,9 +73,7 @@ export class Logger {
83
73
  this.logMessage(message);
84
74
  }
85
75
  /**
86
- * Log error.
87
- *
88
- * @param msg The message to log.
76
+ * @inheritdoc
89
77
  */
90
78
  error(msg) {
91
79
  const message = new LogMessage();
@@ -94,9 +82,7 @@ export class Logger {
94
82
  this.logMessage(message);
95
83
  }
96
84
  /**
97
- * Log error.
98
- *
99
- * @param msg The message to log.
85
+ * @inheritdoc
100
86
  */
101
87
  crit(msg) {
102
88
  const message = new LogMessage();
@@ -105,12 +91,7 @@ export class Logger {
105
91
  this.logMessage(message);
106
92
  }
107
93
  /**
108
- * Log an event.
109
- *
110
- * @param {LogLevel} level The level to log the event.
111
- * @param {String} message Custom message.
112
- * @param {Error} e The error associated with the event.
113
- * @param {ExtraParams} params Extra parameters.
94
+ * @inheritdoc
114
95
  */
115
96
  log(level, message, e, params) {
116
97
  const msg = new LogMessage();
@@ -122,9 +103,7 @@ export class Logger {
122
103
  this.logMessage(msg);
123
104
  }
124
105
  /**
125
- * Log a message.
126
- *
127
- * @param {LogMessage} message The message to log.
106
+ * @inheritdoc
128
107
  */
129
108
  logMessage(message) {
130
109
  if (!this.isEnabled(message.level))
@@ -1,3 +1,3 @@
1
1
  export type { IPubSubHub, MessageHandler, MessageData, MessageValue } from "./contracts";
2
2
  export * from "./pubsub";
3
- export * from "./plugins/index";
3
+ export * from "./plugins";
@@ -1,2 +1,2 @@
1
1
  export * from "./pubsub";
2
- export * from "./plugins/index";
2
+ export * from "./plugins";
@@ -1,4 +1,4 @@
1
- import { LogLevel, type Logger } from "../../logger";
1
+ import { type ILogger, LogLevel } from "../../logger";
2
2
  import type { PubSubPlugin, PubSubPluginContext } from "../pubsub";
3
3
  /**
4
4
  * A plugin to log messages.
@@ -12,7 +12,7 @@ export declare class LoggerPlugin implements PubSubPlugin {
12
12
  * @param {Logger} logger The logger.
13
13
  * @param {LogLevel} logLevel The log level.
14
14
  */
15
- constructor(logger: Logger, logLevel?: LogLevel);
15
+ constructor(logger: ILogger, logLevel?: LogLevel);
16
16
  /** @inheritdoc */
17
17
  onPublish(context: PubSubPluginContext): void;
18
18
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adapt-arch/utiliti-es",
3
- "version": "0.3.0",
3
+ "version": "0.3.3",
4
4
  "license": "MIT",
5
5
  "description": "ECMAScript common utilities library",
6
6
  "keywords": [
@@ -23,15 +23,15 @@
23
23
  "exports": {
24
24
  ".": {
25
25
  "types": "./dist/index.d.ts",
26
- "import": "./dist/bundle/utiliti-es.js",
27
- "require": "./dist/bundle/utiliti-es.cjs",
28
26
  "node": {
29
27
  "import": {
30
28
  "production": "./dist/bundle/utiliti-es.js",
31
29
  "development": "./dist/index.js",
32
30
  "default": "./dist/index.js"
33
31
  }
34
- }
32
+ },
33
+ "require": "./dist/bundle/utiliti-es.cjs",
34
+ "import": "./dist/bundle/utiliti-es.js"
35
35
  }
36
36
  },
37
37
  "repository": {
@@ -45,12 +45,13 @@
45
45
  "name": "Adaptive Architecture"
46
46
  },
47
47
  "scripts": {
48
+ "clean": "rm -rf ./node_modules/ && rm -rf ./package-lock.json",
48
49
  "dev": "vite",
49
50
  "empty-output": "node ./ci-cd/empty-output.js",
50
51
  "build": "tsc && vite build",
51
52
  "preview": "vite preview",
52
53
  "prelint": "node ./ci-cd/empty-output.js",
53
- "lint": "npx @biomejs/biome check --apply ./",
54
+ "lint": "npx @biomejs/biome check --write ./",
54
55
  "test": "vitest run --coverage",
55
56
  "docs:dev": "typedoc && vitepress dev docs",
56
57
  "docs:build": "typedoc && vitepress build docs",
@@ -58,15 +59,15 @@
58
59
  },
59
60
  "devDependencies": {
60
61
  "@biomejs/biome": "1.9.4",
61
- "@types/node": "22.7.7",
62
- "@vitest/coverage-v8": "2.1.3",
63
- "jsdom": "25.0.1",
64
- "msw": "2.4.12",
65
- "typedoc": "0.26.10",
66
- "typescript": "5.6.3",
67
- "vite": "5.4.9",
68
- "vitepress": "1.4.1",
69
- "vitest": "2.1.3"
62
+ "@types/node": "22.13.10",
63
+ "@vitest/coverage-v8": "3.0.9",
64
+ "jsdom": "26.0.0",
65
+ "msw": "2.7.3",
66
+ "typedoc": "0.28.0",
67
+ "typescript": "5.8.2",
68
+ "vite": "6.2.2",
69
+ "vitepress": "1.6.3",
70
+ "vitest": "3.0.9"
70
71
  },
71
72
  "msw": {
72
73
  "workerDirectory": [