@travetto/log 6.0.0-rc.1 → 6.0.0

package/README.md

@@ -13,7 +13,7 @@ npm install @travetto/log
 yarn add @travetto/log
 ```
 
-This module provides logging functionality, building upon [ConsoleManager](https://github.com/travetto/travetto/tree/main/module/runtime/src/console.ts) in the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime for travetto applications.") module.  This is all ultimately built upon [console](https://nodejs.org/api/console.html) operations. The logging infrastructure is built upon the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") system, and so new loggers can be created that rely upon dependency injected services and sources.
+This module provides logging functionality, building upon [ConsoleManager](https://github.com/travetto/travetto/tree/main/module/runtime/src/console.ts#L43) in the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime for travetto applications.") module.  This is all ultimately built upon [console](https://nodejs.org/api/console.html) operations. The logging infrastructure is built upon the [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support.") system, and so new loggers can be created that rely upon dependency injected services and sources.
 
 ## Extending the Common Logger
 By default, the system ships with the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12), and by default will leverage the [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L37) and the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7). The configuration [CommonLoggerConfig](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) provides two configuration variables that allows for switching out [LineLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/line.ts#L37) for the [JsonLogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/formatter/json.ts#L16), depending on the value of `CommonLoggerConfig.format`.  Additionally the [ConsoleLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/console.ts#L7) can be swapped out for the [FileLogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/appender/file.ts#L11) depending on the value of `CommonLoggerConfig.output`.
@@ -29,7 +29,7 @@ export class CommonLoggerConfig {
 }
 ```
 
-In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L34) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L26), with the declared symbol of `LogCommonSymbol`.
+In addition to these simple overrides, the [CommonLogger](https://github.com/travetto/travetto/tree/main/module/log/src/common.ts#L12) can be extended by providing an implementation of either a [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L36) or [LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L28), with the declared symbol of `LogCommonSymbol`.
 
 **Code: Sample Common Formatter**
 ```typescript
@@ -45,10 +45,10 @@ export class SampleFormatter implements LogFormatter {
 }
 ```
 
-As you can see, implementing [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L34)/[LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L26) with the appropriate symbol is all that is necessary to customize the general logging functionality.
+As you can see, implementing [LogFormatter](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L36)/[LogAppender](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L28) with the appropriate symbol is all that is necessary to customize the general logging functionality.
 
 ## Creating a Logger
-The default pattern for logging is to create a [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L41) which simply consumes a logging event. The method is not asynchronous as ensuring the ordering of append calls will be the responsibility of the logger.  The default logger uses `console.log` and that is synchronous by default.
+The default pattern for logging is to create a [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L44) which simply consumes a logging event. The method is not asynchronous as ensuring the ordering of append calls will be the responsibility of the logger.  The default logger uses `console.log` and that is synchronous by default.
 
 **Code: Logger Shape**
 ```typescript
@@ -69,7 +69,7 @@ export interface LogEvent extends ConsoleEvent {
 
 **Code: Console Event**
 ```typescript
-export type ConsoleEvent = {
+export interface ConsoleEvent {
   /** Time of event */
   timestamp: Date;
   /** The level of the console event */
@@ -87,7 +87,7 @@ export type ConsoleEvent = {
 };
 ```
 
-The [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) is an extension of the [ConsoleEvent](https://github.com/travetto/travetto/tree/main/module/runtime/src/console.ts#L6) with the addition of two fields:
+The [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L9) is an extension of the [ConsoleEvent](https://github.com/travetto/travetto/tree/main/module/runtime/src/console.ts#L9) with the addition of two fields:
    *  `message` - This is the primary argument passed to the console statement, if it happens to be a string, otherwise the field is left empty
    *  `context` - This is the final argument passed to the console statement, if it happens to be a simple object.  This is useful for external loggers that allow for searching/querying by complex data
 
@@ -108,7 +108,7 @@ export class CustomLogger implements Logger {
 ```
 
 ## Creating a Decorator
-In addition to being able to control the entire logging experience, there are also scenarios in which the caller may want to only add information to the log event, without affecting control of the formatting or appending. The [Logger](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L18) is an interface that provides a contract that allows transforming the [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L8) data. A common scenario for this would be to add additional metadata data (e.g. server name, ip, code revision, CPU usage, memory usage, etc) into the log messages.
+In addition to being able to control the entire logging experience, there are also scenarios in which the caller may want to only add information to the log event, without affecting control of the formatting or appending. The [LogDecorator](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L20) is an interface that provides a contract that allows transforming the [LogEvent](https://github.com/travetto/travetto/tree/main/module/log/src/types.ts#L9) data. A common scenario for this would be to add additional metadata data (e.g. server name, ip, code revision, CPU usage, memory usage, etc) into the log messages.
 
 **Code: Log Decorator Shape**
 ```typescript

package/__index__.ts

@@ -1,10 +1,10 @@
-import type { } from './src/trv';
-export * from './src/service';
-export * from './src/formatter/json';
-export * from './src/formatter/line';
-export * from './src/formatter/google';
-export * from './src/formatter/util';
-export * from './src/appender/console';
-export * from './src/appender/file';
-export * from './src/types';
-export * from './src/common';
+import type { } from './src/trv.d.ts';
+export * from './src/service.ts';
+export * from './src/formatter/json.ts';
+export * from './src/formatter/line.ts';
+export * from './src/formatter/google.ts';
+export * from './src/formatter/util.ts';
+export * from './src/appender/console.ts';
+export * from './src/appender/file.ts';
+export * from './src/types.ts';
+export * from './src/common.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/log",
-  "version": "6.0.0-rc.1",
+  "version": "6.0.0",
   "description": "Logging framework that integrates at the console.log level.",
   "keywords": [
     "typescript",
@@ -23,9 +23,9 @@
     "directory": "module/log"
   },
   "dependencies": {
-    "@travetto/config": "^6.0.0-rc.1",
-    "@travetto/di": "^6.0.0-rc.1",
-    "@travetto/terminal": "^6.0.0-rc.1"
+    "@travetto/config": "^6.0.0",
+    "@travetto/di": "^6.0.0",
+    "@travetto/terminal": "^6.0.0"
   },
   "travetto": {
     "displayName": "Logging"

package/src/appender/console.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@travetto/di';
 import { Config } from '@travetto/config';
 
-import { LogAppender, LogEvent } from '../types';
+import { LogAppender, LogEvent } from '../types.ts';
 
 @Config('log')
 export class ConsoleLogAppenderConfig {

package/src/appender/file.ts

@@ -5,7 +5,7 @@ import { Env, Runtime } from '@travetto/runtime';
 import { Injectable } from '@travetto/di';
 import { Config, EnvVar } from '@travetto/config';
 
-import { LogAppender, LogEvent } from '../types';
+import { LogAppender, LogEvent } from '../types.ts';
 
 @Config('log')
 export class FileLogAppenderConfig {

package/src/common.ts

@@ -2,11 +2,11 @@ import { Env } from '@travetto/runtime';
 import { Config, EnvVar } from '@travetto/config';
 import { DependencyRegistry, Inject, Injectable } from '@travetto/di';
 
-import { ConsoleLogAppender } from './appender/console';
-import { FileLogAppender } from './appender/file';
-import { JsonLogFormatter } from './formatter/json';
-import { LineLogFormatter } from './formatter/line';
-import { LogAppender, LogFormatter, LogEvent, LogCommonSymbol, Logger } from './types';
+import { ConsoleLogAppender } from './appender/console.ts';
+import { FileLogAppender } from './appender/file.ts';
+import { JsonLogFormatter } from './formatter/json.ts';
+import { LineLogFormatter } from './formatter/line.ts';
+import { LogAppender, LogFormatter, LogEvent, LogCommonSymbol, Logger } from './types.ts';
 
 @Config('log')
 export class CommonLoggerConfig {

package/src/formatter/google.ts

@@ -1,7 +1,7 @@
 import { Injectable } from '@travetto/di';
 
-import { LogFormatter, LogEvent } from '../types';
-import { LogFormatUtil } from './util';
+import { LogFormatter, LogEvent } from '../types.ts';
+import { LogFormatUtil } from './util.ts';
 
 /**
  * Google Logging Formatter

package/src/formatter/json.ts

@@ -1,8 +1,8 @@
 import { Injectable } from '@travetto/di';
 import { Config } from '@travetto/config';
 
-import { LogEvent, LogFormatter } from '../types';
-import { LogFormatUtil } from './util';
+import { LogEvent, LogFormatter } from '../types.ts';
+import { LogFormatUtil } from './util.ts';
 
 @Config('log')
 export class JSONLogFormatterConfig {

package/src/formatter/line.ts

@@ -6,8 +6,8 @@ import { Config, EnvVar } from '@travetto/config';
 import { Ignore } from '@travetto/schema';
 import { StyleUtil } from '@travetto/terminal';
 
-import { LogEvent, LogFormatter } from '../types';
-import { LogFormatUtil } from './util';
+import { LogEvent, LogFormatter } from '../types.ts';
+import { LogFormatUtil } from './util.ts';
 
 /**
  * Level coloring

package/src/formatter/util.ts

@@ -1,6 +1,6 @@
 import { inspect, type InspectOptions } from 'node:util';
 import { DataUtil } from '@travetto/schema';
-import { LogEvent } from '../types';
+import { LogEvent } from '../types.ts';
 
 export class LogFormatUtil {
   static #inspectOptions = { colors: false, showHidden: false, depth: 5, breakLength: 200 };

package/src/service.ts

@@ -1,15 +1,14 @@
-import { ConsoleListener, ConsoleManager, ConsoleEvent } from '@travetto/runtime';
-import { AutoCreate, DependencyRegistry, Injectable } from '@travetto/di';
+import { ConsoleListener, ConsoleManager, ConsoleEvent, toConcrete } from '@travetto/runtime';
+import { DependencyRegistry, Injectable } from '@travetto/di';
 
-import { LogDecorator, LogEvent, Logger } from './types';
-import { LogDecoratorTarget, LoggerTarget } from './internal/types';
-import { CommonLogger } from './common';
+import { LogDecorator, LogEvent, Logger } from './types.ts';
+import { CommonLogger } from './common.ts';
 
 /**
  * Logger service
  */
-@Injectable()
-export class LogService implements ConsoleListener, AutoCreate {
+@Injectable({ autoCreate: true })
+export class LogService implements ConsoleListener {
 
   /**
    * Log listeners
@@ -22,12 +21,12 @@ export class LogService implements ConsoleListener, AutoCreate {
   #decorators: LogDecorator[] = [];
 
   async postConstruct(): Promise<void> {
-    this.#listeners = await DependencyRegistry.getCandidateInstances<Logger>(LoggerTarget, c => c.class !== CommonLogger);
+    this.#listeners = await DependencyRegistry.getCandidateInstances(toConcrete<Logger>(), c => c.class !== CommonLogger);
     if (!this.#listeners.length) {
       this.#listeners = [await DependencyRegistry.getInstance(CommonLogger)];
     }
 
-    this.#decorators = await DependencyRegistry.getCandidateInstances<LogDecorator>(LogDecoratorTarget);
+    this.#decorators = await DependencyRegistry.getCandidateInstances(toConcrete<LogDecorator>());
 
     ConsoleManager.set(this);
   }

package/src/types.ts

@@ -4,6 +4,7 @@ export const LogCommonSymbol = Symbol.for('@travetto/log:common');
 
 /**
  * Logging event
+ * @concrete
  */
 export interface LogEvent extends ConsoleEvent {
   /**
@@ -13,7 +14,8 @@ export interface LogEvent extends ConsoleEvent {
 }
 
 /**
- * @concrete ./internal/types#LogDecoratorTarget
+ * Log event decorator
+ * @concrete
  */
 export interface LogDecorator {
   decorate(ev: LogEvent): LogEvent;
@@ -21,7 +23,7 @@ export interface LogDecorator {
 
 /**
  * Output appender for the logger
- * @concrete ./internal/types#LogAppenderTarget
+ * @concrete
  */
 export interface LogAppender {
   append(ev: LogEvent, formatted: string): void;
@@ -29,14 +31,15 @@ export interface LogAppender {
 
 /**
  * Output formatter
- * @concrete ./internal/types#LogFormatterTarget
+ * @concrete
  */
 export interface LogFormatter {
   format(e: LogEvent): string;
 }
 
 /**
- * @concrete ./internal/types#LoggerTarget
+ * Basic logging contract
+ * @concrete
  */
 export interface Logger {
   log(ev: LogEvent): unknown;

package/src/internal/types.ts

@@ -1,4 +0,0 @@
-export class LogAppenderTarget { }
-export class LogFormatterTarget { }
-export class LogDecoratorTarget { }
-export class LoggerTarget { }