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

package/docs/reference/interfaces/ILoggingConnector.md

@@ -0,0 +1,80 @@
+# Interface: ILoggingConnector
+
+Interface describing a logging connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### log()
+
+> **log**(`logEntry`): `Promise`\<`void`\>
+
+Log an entry to the connector.
+
+#### Parameters
+
+##### logEntry
+
+[`ILogEntry`](ILogEntry.md)
+
+The entry to log.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### query()
+
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
+
+Query the log entries.
+
+#### Parameters
+
+##### conditions?
+
+`EntityCondition`\<[`ILogEntry`](ILogEntry.md)\>
+
+The conditions to match for the entities.
+
+##### sortProperties?
+
+`object`[]
+
+The optional sort order.
+
+##### properties?
+
+keyof [`ILogEntry`](ILogEntry.md)[]
+
+The optional keys to return, defaults to all.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `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.

package/docs/reference/interfaces/ILoggingCreateRequest.md

@@ -0,0 +1,11 @@
+# Interface: ILoggingCreateRequest
+
+Create a new log entry.
+
+## Properties
+
+### body
+
+> **body**: [`ILogEntry`](ILogEntry.md)
+
+The data to be used in the create.

package/docs/reference/interfaces/ILoggingLevelsConfig.md

@@ -0,0 +1,11 @@
+# Interface: ILoggingLevelsConfig
+
+Configuration for the logging connectors to specify the levels to display.
+
+## Properties
+
+### levels?
+
+> `optional` **levels**: [`LogLevel`](../type-aliases/LogLevel.md)[]
+
+The log levels to display, will default to all.

package/docs/reference/interfaces/ILoggingListRequest.md

@@ -0,0 +1,47 @@
+# Interface: ILoggingListRequest
+
+Get the a list of the log entries.
+
+## Properties
+
+### query
+
+> **query**: `object`
+
+The query parameters.
+
+#### level?
+
+> `optional` **level**: [`LogLevel`](../type-aliases/LogLevel.md)
+
+The level of the log entries to retrieve.
+
+#### source?
+
+> `optional` **source**: `string`
+
+The source of the log entries to retrieve.
+
+#### timeStart?
+
+> `optional` **timeStart**: `number`
+
+The start time of the metrics to retrieve as a timestamp in ms.
+
+#### timeEnd?
+
+> `optional` **timeEnd**: `number`
+
+The end time of the metrics to retrieve as a timestamp in ms.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The optional cursor to get next chunk.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+The maximum number of entities in a page.

package/docs/reference/interfaces/ILoggingListResponse.md

@@ -0,0 +1,23 @@
+# Interface: ILoggingListResponse
+
+Response for log entry list request.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### entities
+
+> **entities**: [`ILogEntry`](ILogEntry.md)[]
+
+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.

package/docs/reference/interfaces/IMultiLoggingConnectorConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IMultiLoggingConnectorConstructorOptions
+
+Options for the multi logging connector.
+
+## Properties
+
+### loggingConnectorTypes
+
+> **loggingConnectorTypes**: `string`[]
+
+The logging connectors to multiplex.
+
+***
+
+### config?
+
+> `optional` **config**: [`ILoggingLevelsConfig`](ILoggingLevelsConfig.md)
+
+The configuration for the logging connector.

package/docs/reference/type-aliases/LogLevel.md

@@ -0,0 +1,5 @@
+# Type Alias: LogLevel
+
+> **LogLevel**: `"info"` \| `"error"` \| `"warn"` \| `"trace"` \| `"debug"`
+
+Log level.

package/docs/reference/variables/LoggingConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: LoggingConnectorFactory
+
+> `const` **LoggingConnectorFactory**: `Factory`\<[`ILoggingConnector`](../interfaces/ILoggingConnector.md)\>
+
+Factory for creating logging connectors.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+	"name": "@twin.org/logging-models",
+	"version": "0.0.1-next.10",
+	"description": "Models which define the structure of the logging connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/logging.git",
+		"directory": "packages/logging-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}