@twin.org/logging-connector-console 0.0.3-next.1 → 0.0.3-next.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.
Files changed (7) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +51 -23
  3. package/docs/examples.md +51 -1
  4. package/docs/reference/classes/ConsoleLoggingConnector.md +4 -4
  5. package/docs/reference/interfaces/IConsoleLoggingConnectorConfig.md +16 -4
  6. package/docs/reference/interfaces/IConsoleLoggingConnectorConstructorOptions.md +2 -2
  7. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Logging Connector Console
2
2
 
3
- Logging connector implementation using the console.
3
+ Sends log events to the console for local development, debugging, and lightweight runtime diagnostics.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,16 +1,44 @@
1
- # @twin.org/logging-connector-console - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.1](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.3-next.0...logging-connector-console-v0.0.3-next.1) (2025-11-10)
3
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.3-next.2...logging-connector-console-v0.0.3-next.3) (2026-05-11)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * add context id features ([#33](https://github.com/twinfoundation/logging/issues/33)) ([38e982c](https://github.com/twinfoundation/logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
9
- * add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
10
- * eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
11
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
12
- * update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
13
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
8
+ * typescript 6 update ([cb28b05](https://github.com/iotaledger/twin-logging/commit/cb28b0557595d5ba9b25fab2d9f1222590787f5a))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/logging-models bumped from 0.0.3-next.2 to 0.0.3-next.3
16
+
17
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.3-next.1...logging-connector-console-v0.0.3-next.2) (2026-03-02)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **logging-connector-console:** Synchronize repo versions
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/logging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
30
+
31
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.3-next.0...logging-connector-console-v0.0.3-next.1) (2025-11-10)
32
+
33
+
34
+ ### Features
35
+
36
+ * add context id features ([#33](https://github.com/iotaledger/twin-logging/issues/33)) ([38e982c](https://github.com/iotaledger/twin-logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
37
+ * add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
38
+ * eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
39
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
40
+ * update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
41
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
14
42
 
15
43
 
16
44
  ### Dependencies
@@ -19,12 +47,12 @@
19
47
  * dependencies
20
48
  * @twin.org/logging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
21
49
 
22
- ## [0.0.2-next.3](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.2-next.2...logging-connector-console-v0.0.2-next.3) (2025-10-09)
50
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.2-next.2...logging-connector-console-v0.0.2-next.3) (2025-10-09)
23
51
 
24
52
 
25
53
  ### Features
26
54
 
27
- * add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
55
+ * add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
28
56
 
29
57
 
30
58
  ### Dependencies
@@ -33,12 +61,12 @@
33
61
  * dependencies
34
62
  * @twin.org/logging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
35
63
 
36
- ## [0.0.2-next.2](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.2-next.1...logging-connector-console-v0.0.2-next.2) (2025-08-29)
64
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.2-next.1...logging-connector-console-v0.0.2-next.2) (2025-08-29)
37
65
 
38
66
 
39
67
  ### Features
40
68
 
41
- * eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
69
+ * eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
42
70
 
43
71
 
44
72
  ### Dependencies
@@ -47,14 +75,14 @@
47
75
  * dependencies
48
76
  * @twin.org/logging-models bumped from 0.0.2-next.1 to 0.0.2-next.2
49
77
 
50
- ## [0.0.2-next.1](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.2-next.0...logging-connector-console-v0.0.2-next.1) (2025-08-19)
78
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.2-next.0...logging-connector-console-v0.0.2-next.1) (2025-08-19)
51
79
 
52
80
 
53
81
  ### Features
54
82
 
55
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
56
- * update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
57
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
83
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
84
+ * update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
85
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
58
86
 
59
87
 
60
88
  ### Dependencies
@@ -68,7 +96,7 @@
68
96
 
69
97
  ### Features
70
98
 
71
- * release to production ([3458161](https://github.com/twinfoundation/logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
99
+ * release to production ([3458161](https://github.com/iotaledger/twin-logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
72
100
 
73
101
 
74
102
  ### Dependencies
@@ -77,7 +105,7 @@
77
105
  * dependencies
78
106
  * @twin.org/logging-models bumped from ^0.0.0 to ^0.0.1
79
107
 
80
- ## [0.0.1-next.16](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.1-next.15...logging-connector-console-v0.0.1-next.16) (2025-06-20)
108
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.1-next.15...logging-connector-console-v0.0.1-next.16) (2025-06-20)
81
109
 
82
110
 
83
111
  ### Miscellaneous Chores
@@ -91,12 +119,12 @@
91
119
  * dependencies
92
120
  * @twin.org/logging-models bumped from 0.0.1-next.15 to 0.0.1-next.16
93
121
 
94
- ## [0.0.1-next.15](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.1-next.14...logging-connector-console-v0.0.1-next.15) (2025-06-12)
122
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.1-next.14...logging-connector-console-v0.0.1-next.15) (2025-06-12)
95
123
 
96
124
 
97
125
  ### Features
98
126
 
99
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
127
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
100
128
 
101
129
 
102
130
  ### Dependencies
@@ -105,12 +133,12 @@
105
133
  * dependencies
106
134
  * @twin.org/logging-models bumped from 0.0.1-next.14 to 0.0.1-next.15
107
135
 
108
- ## [0.0.1-next.14](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.1-next.13...logging-connector-console-v0.0.1-next.14) (2025-04-17)
136
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.1-next.13...logging-connector-console-v0.0.1-next.14) (2025-04-17)
109
137
 
110
138
 
111
139
  ### Features
112
140
 
113
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
141
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
114
142
 
115
143
 
116
144
  ### Dependencies
@@ -119,7 +147,7 @@
119
147
  * dependencies
120
148
  * @twin.org/logging-models bumped from 0.0.1-next.13 to 0.0.1-next.14
121
149
 
122
- ## [0.0.1-next.13](https://github.com/twinfoundation/logging/compare/logging-connector-console-v0.0.1-next.12...logging-connector-console-v0.0.1-next.13) (2025-03-28)
150
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-logging/compare/logging-connector-console-v0.0.1-next.12...logging-connector-console-v0.0.1-next.13) (2025-03-28)
123
151
 
124
152
 
125
153
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,51 @@
1
- # @twin.org/logging-connector-console - Examples
1
+ # Logging Connector Console Examples
2
+
3
+ Use these snippets to wire console logging quickly with practical level filtering and message formatting settings.
4
+
5
+ ## ConsoleLoggingConnector
6
+
7
+ ```typescript
8
+ import { ConsoleLoggingConnector } from '@twin.org/logging-connector-console';
9
+
10
+ const connector = new ConsoleLoggingConnector({
11
+ config: {
12
+ levels: ['info', 'warn', 'error'],
13
+ hideGroups: false,
14
+ translateMessages: false
15
+ }
16
+ });
17
+
18
+ const className = connector.className();
19
+
20
+ await connector.log({
21
+ level: 'info',
22
+ source: 'api-server',
23
+ message: 'startupComplete',
24
+ data: {
25
+ port: 8080,
26
+ environment: 'production'
27
+ }
28
+ });
29
+ ```
30
+
31
+ ```typescript
32
+ import { ConsoleLoggingConnector } from '@twin.org/logging-connector-console';
33
+
34
+ const connector = new ConsoleLoggingConnector({
35
+ config: {
36
+ levels: ['error'],
37
+ hideGroups: true
38
+ }
39
+ });
40
+
41
+ await connector.log({
42
+ level: 'error',
43
+ source: 'worker',
44
+ message: 'jobFailed',
45
+ error: new Error('Unable to process queue item'),
46
+ data: {
47
+ jobId: 'job-42',
48
+ retries: 3
49
+ }
50
+ });
51
+ ```
package/docs/reference/classes/ConsoleLoggingConnector.md CHANGED
@@ -28,7 +28,7 @@ The options for the logging connector.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ***
38
38
 
39
- ### NAMESPACE
39
+ ### NAMESPACE {#namespace}
40
40
 
41
41
  > `readonly` `static` **NAMESPACE**: `string` = `"console"`
42
42
 
@@ -44,7 +44,7 @@ The namespace for the logging connector.
44
44
 
45
45
  ## Methods
46
46
 
47
- ### className()
47
+ ### className() {#classname}
48
48
 
49
49
  > **className**(): `string`
50
50
 
@@ -62,7 +62,7 @@ The class name of the component.
62
62
 
63
63
  ***
64
64
 
65
- ### log()
65
+ ### log() {#log}
66
66
 
67
67
  > **log**(`logEntry`): `Promise`\<`void`\>
68
68
 
package/docs/reference/interfaces/IConsoleLoggingConnectorConfig.md CHANGED
@@ -8,16 +8,28 @@ Configuration for the Console Logging Connector.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### translateMessages?
11
+ ### translateMessages? {#translatemessages}
12
12
 
13
- > `optional` **translateMessages**: `boolean`
13
+ > `optional` **translateMessages?**: `boolean`
14
14
 
15
15
  Translate message using the current locale.
16
16
 
17
17
  ***
18
18
 
19
- ### hideGroups?
19
+ ### hideGroups? {#hidegroups}
20
20
 
21
- > `optional` **hideGroups**: `boolean`
21
+ > `optional` **hideGroups?**: `boolean`
22
22
 
23
23
  Hide the group display.
24
+
25
+ ***
26
+
27
+ ### levels? {#levels}
28
+
29
+ > `optional` **levels?**: `LogLevel`[]
30
+
31
+ The log levels to display, will default to all.
32
+
33
+ #### Inherited from
34
+
35
+ `ILoggingLevelsConfig.levels`
package/docs/reference/interfaces/IConsoleLoggingConnectorConstructorOptions.md CHANGED
@@ -4,8 +4,8 @@ Options for the console logging connector constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### config?
7
+ ### config? {#config}
8
8
 
9
- > `optional` **config**: [`IConsoleLoggingConnectorConfig`](IConsoleLoggingConnectorConfig.md)
9
+ > `optional` **config?**: [`IConsoleLoggingConnectorConfig`](IConsoleLoggingConnectorConfig.md)
10
10
 
11
11
  The configuration for the console logging connector.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/logging-connector-console",
3
- "version": "0.0.3-next.1",
4
- "description": "Logging connector implementation using the console",
3
+ "version": "0.0.3-next.3",
4
+ "description": "Sends log events to the console for local development, debugging, and lightweight runtime diagnostics.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/logging.git",
7
+ "url": "git+https://github.com/iotaledger/logging.git",
8
8
  "directory": "packages/logging-connector-console"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/core": "next",
18
- "@twin.org/logging-models": "0.0.3-next.1",
18
+ "@twin.org/logging-models": "0.0.3-next.3",
19
19
  "@twin.org/nameof": "next"
20
20
  },
21
21
  "main": "./dist/es/index.js",
@@ -46,7 +46,7 @@
46
46
  "integration"
47
47
  ],
48
48
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/logging/issues"
49
+ "url": "git+https://github.com/iotaledger/logging/issues"
50
50
  },
51
51
  "homepage": "https://twindev.org"
52
52
  }