@twin.org/logging-service 0.0.1-next.10

package/docs/open-api/spec.json

@@ -0,0 +1,403 @@
+{
+	"openapi": "3.1.0",
+	"info": {
+		"title": "TWIN - Test Endpoints",
+		"description": "REST API for TWIN - Test Endpoints.",
+		"version": "1.0.0",
+		"license": {
+			"name": "Apache 2.0 License",
+			"url": "https://opensource.org/licenses/Apache-2.0"
+		}
+	},
+	"servers": [
+		{
+			"url": "https://localhost"
+		}
+	],
+	"tags": [
+		{
+			"name": "Logging",
+			"description": "Endpoints which are modelled to access a logging contract."
+		}
+	],
+	"paths": {
+		"/logging": {
+			"post": {
+				"operationId": "loggingEntryCreate",
+				"summary": "Create a log entry",
+				"tags": [
+					"Logging"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Create a new log entry.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/LogEntry"
+							},
+							"examples": {
+								"loggingEntryCreateInfoExample": {
+									"value": {
+										"level": "info",
+										"message": "This is an information message",
+										"source": "source",
+										"ts": 1715252922273
+									}
+								},
+								"loggingEntryCreateErrorExample": {
+									"value": {
+										"level": "info",
+										"message": "This is an error message",
+										"source": "source",
+										"ts": 1715252922273,
+										"error": {
+											"name": "GeneralError",
+											"message": "component.error",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"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": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "component.error",
+											"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"get": {
+				"operationId": "loggingListEntries",
+				"summary": "Get a list of the log entries",
+				"tags": [
+					"Logging"
+				],
+				"parameters": [
+					{
+						"name": "level",
+						"description": "The level of the log entries to retrieve.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"$ref": "#/components/schemas/LogLevel"
+						},
+						"example": "info"
+					},
+					{
+						"name": "source",
+						"description": "The source of the log entries to retrieve.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "timeStart",
+						"description": "The start time of the metrics to retrieve as a timestamp in ms.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "number"
+						}
+					},
+					{
+						"name": "timeEnd",
+						"description": "The end time of the metrics to retrieve as a timestamp in ms.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "number"
+						}
+					},
+					{
+						"name": "cursor",
+						"description": "The optional cursor to get next chunk.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
+					},
+					{
+						"name": "pageSize",
+						"description": "The maximum number of entities in a page.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "number"
+						}
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response for log entry list request.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/LoggingListResponse"
+								},
+								"examples": {
+									"listResponseExample": {
+										"value": {
+											"entities": [
+												{
+													"level": "info",
+													"message": "This is an information message",
+													"source": "source",
+													"ts": 1715252922273
+												}
+											],
+											"cursor": "1"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "component.error",
+											"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					},
+					"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": "component.error"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"Error": {
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "The name for the error."
+					},
+					"message": {
+						"type": "string",
+						"description": "The message for the error."
+					},
+					"source": {
+						"type": "string",
+						"description": "The source of the error."
+					},
+					"properties": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Any additional information for the error."
+					},
+					"stack": {
+						"type": "string",
+						"description": "The stack trace for the error."
+					},
+					"inner": {
+						"$ref": "#/components/schemas/Error"
+					}
+				},
+				"required": [
+					"name",
+					"message"
+				],
+				"additionalProperties": false,
+				"description": "Model to describe serialized error."
+			},
+			"LogEntry": {
+				"type": "object",
+				"properties": {
+					"level": {
+						"$ref": "#/components/schemas/LogLevel"
+					},
+					"source": {
+						"type": "string",
+						"description": "The source of the log entry."
+					},
+					"ts": {
+						"type": "number",
+						"description": "The timestamp of the log entry, if left blank will be populated by the connector."
+					},
+					"message": {
+						"type": "string",
+						"description": "The message."
+					},
+					"error": {
+						"$ref": "#/components/schemas/Error"
+					},
+					"data": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Optional data for the message."
+					}
+				},
+				"required": [
+					"level",
+					"source",
+					"message"
+				],
+				"additionalProperties": false,
+				"description": "Interface describing a log entry."
+			},
+			"LogLevel": {
+				"type": "string",
+				"enum": [
+					"info",
+					"error",
+					"warn",
+					"trace",
+					"debug"
+				],
+				"description": "Log level."
+			},
+			"LoggingListResponse": {
+				"type": "object",
+				"properties": {
+					"entities": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/LogEntry"
+						},
+						"description": "The entities, which can be partial if a limited keys list was provided."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "An optional cursor, when defined can be used to call find to get more entities."
+					}
+				},
+				"required": [
+					"entities"
+				],
+				"additionalProperties": false,
+				"description": "The response payload."
+			}
+		},
+		"securitySchemes": {
+			"jwtBearerAuthScheme": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT"
+			}
+		}
+	}
+}

package/docs/reference/classes/LoggingService.md

@@ -0,0 +1,134 @@
+# Class: LoggingService
+
+Service for performing logging operations to a connector.
+
+## Implements
+
+- `ILoggingComponent`
+
+## Constructors
+
+### new LoggingService()
+
+> **new LoggingService**(`options`?): [`LoggingService`](LoggingService.md)
+
+Create a new instance of LoggingService.
+
+#### Parameters
+
+##### options?
+
+[`ILoggingServiceConstructorOptions`](../interfaces/ILoggingServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+[`LoggingService`](LoggingService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"logging"`
+
+The namespace for the logging component.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`ILoggingComponent.CLASS_NAME`
+
+## Methods
+
+### log()
+
+> **log**(`logEntry`): `Promise`\<`void`\>
+
+Log an entry to the connector.
+
+#### Parameters
+
+##### logEntry
+
+`ILogEntry`
+
+The entry to log.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ILoggingComponent.log`
+
+***
+
+### query()
+
+> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
+
+Query the log entries.
+
+#### Parameters
+
+##### level?
+
+`LogLevel`
+
+The level of the log entries.
+
+##### source?
+
+`string`
+
+The source of the log entries.
+
+##### timeStart?
+
+`number`
+
+The inclusive time as the start of the log entries.
+
+##### timeEnd?
+
+`number`
+
+The inclusive time as the end of the log entries.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+`ILoggingComponent.query`

package/docs/reference/functions/generateRestRoutesLogging.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesLogging()
+
+> **generateRestRoutesLogging**(`baseRouteName`, `componentName`): `IRestRoute`[]
+
+The REST routes for logging.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`[]
+
+The generated routes.

package/docs/reference/functions/loggingCreate.md

@@ -0,0 +1,31 @@
+# Function: loggingCreate()
+
+> **loggingCreate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Create a new log entry.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ILoggingCreateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/loggingList.md

@@ -0,0 +1,31 @@
+# Function: loggingList()
+
+> **loggingList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ILoggingListResponse`\>
+
+Get a list of the logging entries.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ILoggingListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ILoggingListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,20 @@
+# @twin.org/logging-service
+
+## Classes
+
+- [LoggingService](classes/LoggingService.md)
+
+## Interfaces
+
+- [ILoggingServiceConstructorOptions](interfaces/ILoggingServiceConstructorOptions.md)
+
+## Variables
+
+- [tagsLogging](variables/tagsLogging.md)
+- [restEntryPoints](variables/restEntryPoints.md)
+
+## Functions
+
+- [generateRestRoutesLogging](functions/generateRestRoutesLogging.md)
+- [loggingCreate](functions/loggingCreate.md)
+- [loggingList](functions/loggingList.md)

package/docs/reference/interfaces/ILoggingServiceConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: ILoggingServiceConstructorOptions
+
+Options for the logging service constructor.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of the logging connector to use.
+
+#### Default
+
+```ts
+logging
+```

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsLogging.md

@@ -0,0 +1,5 @@
+# Variable: tagsLogging
+
+> `const` **tagsLogging**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1 @@
+{}