@twin.org/logging-service 0.0.3-next.1 → 0.0.3-next.3

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Logging Service
 
-Logging contract implementation and REST endpoint definitions.
+Exposes logging operations through service routes and API contracts for server-side integration.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,23 +1,51 @@
-# @twin.org/logging-service - Changelog
+# Changelog
 
-## [0.0.3-next.1](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.3-next.0...logging-service-v0.0.3-next.1) (2025-11-10)
+## [0.0.3-next.3](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.3-next.2...logging-service-v0.0.3-next.3) (2026-05-11)
 
 
 ### Features
 
-* add context id features ([#33](https://github.com/twinfoundation/logging/issues/33)) ([38e982c](https://github.com/twinfoundation/logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
-* add production release automation ([5dbcad8](https://github.com/twinfoundation/logging/commit/5dbcad8b105d749947c4fda19c814373cee2a172))
-* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
-* eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
-* remove unused namespace ([7eb6575](https://github.com/twinfoundation/logging/commit/7eb65758fbdc9a42f68d149702ba03c000556325))
-* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
-* update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
-* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+* typescript 6 update ([cb28b05](https://github.com/iotaledger/twin-logging/commit/cb28b0557595d5ba9b25fab2d9f1222590787f5a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.3-next.1...logging-service-v0.0.3-next.2) (2026-03-02)
+
+
+### Bug Fixes
+
+* api data types ([8d37cab](https://github.com/iotaledger/twin-logging/commit/8d37cab7ec759f079b6480bcc27d739357dbc392))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/logging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.3-next.0...logging-service-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#33](https://github.com/iotaledger/twin-logging/issues/33)) ([38e982c](https://github.com/iotaledger/twin-logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
+* add production release automation ([5dbcad8](https://github.com/iotaledger/twin-logging/commit/5dbcad8b105d749947c4fda19c814373cee2a172))
+* add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+* eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
+* remove unused namespace ([7eb6575](https://github.com/iotaledger/twin-logging/commit/7eb65758fbdc9a42f68d149702ba03c000556325))
+* update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+* update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
+* use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
 
 
 ### Bug Fixes
 
-* query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
+* query params force coercion ([71c5329](https://github.com/iotaledger/twin-logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
 
 
 ### Dependencies
@@ -26,12 +54,12 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
 
-## [0.0.2-next.3](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.2-next.2...logging-service-v0.0.2-next.3) (2025-10-09)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.2-next.2...logging-service-v0.0.2-next.3) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
+* add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
 
 
 ### Dependencies
@@ -40,12 +68,12 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
 
-## [0.0.2-next.2](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.2-next.1...logging-service-v0.0.2-next.2) (2025-08-29)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.2-next.1...logging-service-v0.0.2-next.2) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
+* eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
 
 
 ### Dependencies
@@ -54,21 +82,21 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.2-next.1 to 0.0.2-next.2
 
-## [0.0.2-next.1](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.2-next.0...logging-service-v0.0.2-next.1) (2025-08-19)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.2-next.0...logging-service-v0.0.2-next.1) (2025-08-19)
 
 
 ### Features
 
-* add production release automation ([5dbcad8](https://github.com/twinfoundation/logging/commit/5dbcad8b105d749947c4fda19c814373cee2a172))
-* remove unused namespace ([7eb6575](https://github.com/twinfoundation/logging/commit/7eb65758fbdc9a42f68d149702ba03c000556325))
-* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
-* update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
-* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+* add production release automation ([5dbcad8](https://github.com/iotaledger/twin-logging/commit/5dbcad8b105d749947c4fda19c814373cee2a172))
+* remove unused namespace ([7eb6575](https://github.com/iotaledger/twin-logging/commit/7eb65758fbdc9a42f68d149702ba03c000556325))
+* update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+* update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
+* use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
 
 
 ### Bug Fixes
 
-* query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
+* query params force coercion ([71c5329](https://github.com/iotaledger/twin-logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
 
 
 ### Dependencies
@@ -82,7 +110,7 @@
 
 ### Features
 
-* release to production ([3458161](https://github.com/twinfoundation/logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
+* release to production ([3458161](https://github.com/iotaledger/twin-logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
 
 
 ### Dependencies
@@ -91,12 +119,12 @@
   * dependencies
     * @twin.org/logging-models bumped from ^0.0.0 to ^0.0.1
 
-## [0.0.1-next.16](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.1-next.15...logging-service-v0.0.1-next.16) (2025-06-20)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.1-next.15...logging-service-v0.0.1-next.16) (2025-06-20)
 
 
 ### Bug Fixes
 
-* query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
+* query params force coercion ([71c5329](https://github.com/iotaledger/twin-logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
 
 
 ### Dependencies
@@ -105,12 +133,12 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.1-next.15 to 0.0.1-next.16
 
-## [0.0.1-next.15](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.1-next.14...logging-service-v0.0.1-next.15) (2025-06-12)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.1-next.14...logging-service-v0.0.1-next.15) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
+* update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
 
 
 ### Dependencies
@@ -119,12 +147,12 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.1-next.14 to 0.0.1-next.15
 
-## [0.0.1-next.14](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.1-next.13...logging-service-v0.0.1-next.14) (2025-04-17)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.1-next.13...logging-service-v0.0.1-next.14) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
+* use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
 
 
 ### Dependencies
@@ -133,7 +161,7 @@
   * dependencies
     * @twin.org/logging-models bumped from 0.0.1-next.13 to 0.0.1-next.14
 
-## [0.0.1-next.13](https://github.com/twinfoundation/logging/compare/logging-service-v0.0.1-next.12...logging-service-v0.0.1-next.13) (2025-03-28)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-logging/compare/logging-service-v0.0.1-next.12...logging-service-v0.0.1-next.13) (2025-03-28)
 
 
 ### Miscellaneous Chores

package/docs/examples.md

@@ -1 +1,101 @@
-# @twin.org/logging-service - Examples
+# Logging Service Examples
+
+Use these examples to route application logs through a configurable connector and query recent entries for troubleshooting.
+
+## LoggingService
+
+```typescript
+import {
+  LoggingConnectorFactory,
+  type ILogEntry,
+  type ILoggingConnector
+} from '@twin.org/logging-models';
+import { LoggingService } from '@twin.org/logging-service';
+
+class MemoryLoggingConnector implements ILoggingConnector {
+  private readonly entries: ILogEntry[] = [];
+
+  public className(): string {
+    return 'MemoryLoggingConnector';
+  }
+
+  public async log(logEntry: ILogEntry): Promise<void> {
+    this.entries.push(logEntry);
+  }
+
+  public async query(): Promise<{ entities: Partial<ILogEntry>[]; cursor?: string }> {
+    return {
+      entities: this.entries
+    };
+  }
+}
+
+LoggingConnectorFactory.register('logging', () => new MemoryLoggingConnector());
+
+const service = new LoggingService();
+
+const className = service.className();
+
+await service.log({
+  level: 'warn',
+  source: 'worker-pool',
+  message: 'queueDepthHigh',
+  data: {
+    depth: 125,
+    threshold: 100
+  }
+});
+```
+
+```typescript
+import {
+  LoggingConnectorFactory,
+  type ILogEntry,
+  type ILoggingConnector
+} from '@twin.org/logging-models';
+import { LoggingService } from '@twin.org/logging-service';
+
+class QueryableMemoryConnector implements ILoggingConnector {
+  private readonly entries: ILogEntry[] = [
+    {
+      level: 'error',
+      source: 'worker-pool',
+      ts: Date.now() - 2_000,
+      message: 'jobTimedOut'
+    },
+    {
+      level: 'info',
+      source: 'worker-pool',
+      ts: Date.now() - 1_000,
+      message: 'jobCompleted'
+    }
+  ];
+
+  public className(): string {
+    return 'QueryableMemoryConnector';
+  }
+
+  public async log(logEntry: ILogEntry): Promise<void> {
+    this.entries.push(logEntry);
+  }
+
+  public async query(): Promise<{ entities: Partial<ILogEntry>[]; cursor?: string }> {
+    return {
+      entities: this.entries
+    };
+  }
+}
+
+LoggingConnectorFactory.register('logging', () => new QueryableMemoryConnector());
+
+const service = new LoggingService();
+
+const queryResult = await service.query(
+  'error',
+  'worker-pool',
+  Date.now() - 60_000,
+  Date.now(),
+  'cursor-21',
+  20
+);
+```

package/docs/open-api/spec.json

@@ -70,12 +70,62 @@
 					}
 				},
 				"responses": {
-					"200": {
-						"description": "The rest request ended in success with no data.",
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
 						"content": {
-							"text/plain": {
+							"application/json": {
 								"schema": {
-									"$ref": "#/components/schemas/NoContentResponse"
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
 								}
 							}
 						}
@@ -114,10 +164,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -126,10 +173,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -181,6 +225,63 @@
 								}
 							}
 						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
 					}
 				}
 			}
@@ -189,6 +290,7 @@
 	"components": {
 		"schemas": {
 			"Error": {
+				"description": "Model to describe serialized error.",
 				"type": "object",
 				"properties": {
 					"name": {
@@ -197,7 +299,7 @@
 					},
 					"message": {
 						"type": "string",
-						"description": "The message for the error."
+						"description": "The message for the error as an i18n key."
 					},
 					"source": {
 						"type": "string",
@@ -219,11 +321,10 @@
 				"required": [
 					"name",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
+				]
 			},
 			"LogEntry": {
+				"description": "Interface describing a log entry.",
 				"type": "object",
 				"properties": {
 					"level": {
@@ -254,39 +355,32 @@
 					"level",
 					"source",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a log entry."
+				]
 			},
 			"LogLevel": {
+				"description": "The log levels.",
 				"anyOf": [
 					{
-						"type": "string",
 						"const": "info",
 						"description": "Info."
 					},
 					{
-						"type": "string",
 						"const": "error",
 						"description": "Error."
 					},
 					{
-						"type": "string",
 						"const": "warn",
 						"description": "Warn."
 					},
 					{
-						"type": "string",
 						"const": "trace",
 						"description": "Trace."
 					},
 					{
-						"type": "string",
 						"const": "debug",
 						"description": "Debug."
 					}
-				],
-				"description": "The log levels."
+				]
 			},
 			"LoggingListResponse": {
 				"type": "object",
@@ -306,7 +400,6 @@
 				"required": [
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The response payload."
 			}
 		},

package/docs/reference/classes/LoggingService.md

@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -54,7 +54,7 @@ The class name of the component.
 
 ***
 
-### log()
+### log() {#log}
 
 > **log**(`logEntry`): `Promise`\<`void`\>
 
@@ -80,7 +80,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/ILoggingServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the logging service constructor.
 
 ## Properties
 
-### loggingConnectorType?
+### loggingConnectorType? {#loggingconnectortype}
 
-> `optional` **loggingConnectorType**: `string`
+> `optional` **loggingConnectorType?**: `string`
 
 The type of the logging connector to use.
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/logging-service",
-	"version": "0.0.3-next.1",
-	"description": "Logging contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.3",
+	"description": "Exposes logging operations through service routes and API contracts for server-side integration.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/logging.git",
+		"url": "git+https://github.com/iotaledger/logging.git",
 		"directory": "packages/logging-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -17,7 +17,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/logging-models": "0.0.3-next.1",
+		"@twin.org/logging-models": "0.0.3-next.3",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -49,7 +49,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/logging/issues"
+		"url": "git+https://github.com/iotaledger/logging/issues"
 	},
 	"homepage": "https://twindev.org"
 }