@twin.org/logging-connector-console 0.0.1-next.6 → 0.0.1-next.8

package/dist/cjs/index.cjs

@@ -51,7 +51,6 @@ class ConsoleLoggingConnector {
     /**
      * Create a new instance of ConsoleLoggingConnector.
      * @param options The options for the logging connector.
-     * @param options.config The configuration for the logging connector.
      */
     constructor(options) {
         this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
@@ -66,14 +65,17 @@ class ConsoleLoggingConnector {
     async log(logEntry) {
         core.Guards.object(this.CLASS_NAME, "logEntry", logEntry);
         if (this._levels.includes(logEntry.level)) {
-            if (!this._hideGroups) {
-                this.handleGroup(logEntry.source);
-            }
             logEntry.ts ??= Date.now();
             const params = [
                 this.colorize(logEntry.level.toUpperCase(), logEntry.level === "error" ? "red" : "green"),
                 this.colorize(`[${new Date(logEntry.ts).toISOString()}]`, "magenta")
             ];
+            if (!this._hideGroups) {
+                this.handleGroup(logEntry.source);
+            }
+            else {
+                params.push(this.colorize(logEntry.source, "blue"));
+            }
             let message = logEntry.message;
             let data = logEntry.data;
             if (this._translateMessages) {

package/dist/esm/index.mjs

@@ -49,7 +49,6 @@ class ConsoleLoggingConnector {
     /**
      * Create a new instance of ConsoleLoggingConnector.
      * @param options The options for the logging connector.
-     * @param options.config The configuration for the logging connector.
      */
     constructor(options) {
         this._levels = options?.config?.levels ?? ["debug", "info", "warn", "error", "trace"];
@@ -64,14 +63,17 @@ class ConsoleLoggingConnector {
     async log(logEntry) {
         Guards.object(this.CLASS_NAME, "logEntry", logEntry);
         if (this._levels.includes(logEntry.level)) {
-            if (!this._hideGroups) {
-                this.handleGroup(logEntry.source);
-            }
             logEntry.ts ??= Date.now();
             const params = [
                 this.colorize(logEntry.level.toUpperCase(), logEntry.level === "error" ? "red" : "green"),
                 this.colorize(`[${new Date(logEntry.ts).toISOString()}]`, "magenta")
             ];
+            if (!this._hideGroups) {
+                this.handleGroup(logEntry.source);
+            }
+            else {
+                params.push(this.colorize(logEntry.source, "blue"));
+            }
             let message = logEntry.message;
             let data = logEntry.data;
             if (this._translateMessages) {

package/dist/types/consoleLoggingConnector.d.ts

@@ -1,6 +1,6 @@
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
 import { type ILogEntry, type ILoggingConnector } from "@twin.org/logging-models";
-import type { IConsoleLoggingConnectorConfig } from "./models/IConsoleLoggingConnectorConfig";
+import type { IConsoleLoggingConnectorConstructorOptions } from "./models/IConsoleLoggingConnectorConstructorOptions";
 /**
  * Class for performing logging operations in the console.
  */
@@ -16,11 +16,8 @@ export declare class ConsoleLoggingConnector implements ILoggingConnector {
     /**
      * Create a new instance of ConsoleLoggingConnector.
      * @param options The options for the logging connector.
-     * @param options.config The configuration for the logging connector.
      */
-    constructor(options?: {
-        config?: IConsoleLoggingConnectorConfig;
-    });
+    constructor(options?: IConsoleLoggingConnectorConstructorOptions);
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./consoleLoggingConnector";
 export * from "./models/IConsoleLoggingConnectorConfig";
+export * from "./models/IConsoleLoggingConnectorConstructorOptions";

package/dist/types/models/IConsoleLoggingConnectorConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+import type { IConsoleLoggingConnectorConfig } from "./IConsoleLoggingConnectorConfig";
+/**
+ * Options for the console logging connector constructor.
+ */
+export interface IConsoleLoggingConnectorConstructorOptions {
+    /**
+     * The configuration for the console logging connector.
+     */
+    config?: IConsoleLoggingConnectorConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/logging-connector-console - Changelog
 
-## v0.0.1-next.6
+## v0.0.1-next.8
 
 - Initial Release

package/docs/reference/classes/ConsoleLoggingConnector.md

@@ -16,13 +16,11 @@ Create a new instance of ConsoleLoggingConnector.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the logging connector.
-
-• **options.config?**: [`IConsoleLoggingConnectorConfig`](../interfaces/IConsoleLoggingConnectorConfig.md)
+[`IConsoleLoggingConnectorConstructorOptions`](../interfaces/IConsoleLoggingConnectorConstructorOptions.md)
 
-The configuration for the logging connector.
+The options for the logging connector.
 
 #### Returns
 
@@ -58,7 +56,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: `ILogEntry`
+##### logEntry
+
+`ILogEntry`
 
 The entry to log.
 
@@ -76,51 +76,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`ILogEntry`\>[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`ILogEntry`\>
+##### conditions?
+
+`EntityCondition`\<`ILogEntry`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `ILogEntry`[]
+##### properties?
+
+keyof `ILogEntry`[]
 
 The optional keys to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`ILogEntry`\>[]; `cursor`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-##### entities
-
-> **entities**: `Partial`\<`ILogEntry`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

package/docs/reference/index.md

@@ -7,3 +7,4 @@
 ## Interfaces
 
 - [IConsoleLoggingConnectorConfig](interfaces/IConsoleLoggingConnectorConfig.md)
+- [IConsoleLoggingConnectorConstructorOptions](interfaces/IConsoleLoggingConnectorConstructorOptions.md)

package/docs/reference/interfaces/IConsoleLoggingConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IConsoleLoggingConnectorConstructorOptions
+
+Options for the console logging connector constructor.
+
+## Properties
+
+### config?
+
+> `optional` **config**: [`IConsoleLoggingConnectorConfig`](IConsoleLoggingConnectorConfig.md)
+
+The configuration for the console logging connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-connector-console",
-	"version": "0.0.1-next.6",
+	"version": "0.0.1-next.8",
 	"description": "Logging connector implementation using the console",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/logging-models": "0.0.1-next.6",
+		"@twin.org/logging-models": "0.0.1-next.8",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",