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

package/dist/cjs/index.cjs

@@ -37,8 +37,6 @@ class MultiLoggingConnector {
     /**
      * Create a new instance of MultiLoggingConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorTypes The logging connectors to multiplex.
-     * @param options.config The configuration for the logging connector.
      */
     constructor(options) {
         core.Guards.object(this.CLASS_NAME, "options", options);

package/dist/esm/index.mjs

@@ -35,8 +35,6 @@ class MultiLoggingConnector {
     /**
      * Create a new instance of MultiLoggingConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorTypes The logging connectors to multiplex.
-     * @param options.config The configuration for the logging connector.
      */
     constructor(options) {
         Guards.object(this.CLASS_NAME, "options", options);

package/dist/types/connectors/multiLoggingConnector.d.ts

@@ -1,7 +1,7 @@
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
 import type { ILogEntry } from "../models/ILogEntry";
 import type { ILoggingConnector } from "../models/ILoggingConnector";
-import type { ILoggingLevelsConfig } from "../models/ILoggingLevelsConfig";
+import type { IMultiLoggingConnectorConstructorOptions } from "../models/IMultiLoggingConnectorConstructorOptions";
 /**
  * Class for performing logging operations on multiple connectors.
  */
@@ -17,13 +17,8 @@ export declare class MultiLoggingConnector implements ILoggingConnector {
     /**
      * Create a new instance of MultiLoggingConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorTypes The logging connectors to multiplex.
-     * @param options.config The configuration for the logging connector.
      */
-    constructor(options: {
-        loggingConnectorTypes: string[];
-        config?: ILoggingLevelsConfig;
-    });
+    constructor(options: IMultiLoggingConnectorConstructorOptions);
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.

package/dist/types/index.d.ts

@@ -9,4 +9,5 @@ export * from "./models/ILogEntry";
 export * from "./models/ILoggingComponent";
 export * from "./models/ILoggingConnector";
 export * from "./models/ILoggingLevelsConfig";
+export * from "./models/IMultiLoggingConnectorConstructorOptions";
 export * from "./models/logLevel";

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

@@ -0,0 +1,14 @@
+import type { ILoggingLevelsConfig } from "../models/ILoggingLevelsConfig";
+/**
+ * Options for the multi logging connector.
+ */
+export interface IMultiLoggingConnectorConstructorOptions {
+    /**
+     * The logging connectors to multiplex.
+     */
+    loggingConnectorTypes: string[];
+    /**
+     * The configuration for the logging connector.
+     */
+    config?: ILoggingLevelsConfig;
+}

package/docs/changelog.md

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

package/docs/reference/classes/LogEntryHelper.md

@@ -22,7 +22,9 @@ Translate the log entry.
 
 #### Parameters
 
-• **logEntry**: [`ILogEntry`](../interfaces/ILogEntry.md)
+##### logEntry
+
+[`ILogEntry`](../interfaces/ILogEntry.md)
 
 The log entry.
 

package/docs/reference/classes/MultiLoggingConnector.md

@@ -16,17 +16,11 @@ Create a new instance of MultiLoggingConnector.
 
 #### Parameters
 
-• **options**
+##### options
 
-The options for the connector.
-
-• **options.loggingConnectorTypes**: `string`[]
-
-The logging connectors to multiplex.
+[`IMultiLoggingConnectorConstructorOptions`](../interfaces/IMultiLoggingConnectorConstructorOptions.md)
 
-• **options.config?**: [`ILoggingLevelsConfig`](../interfaces/ILoggingLevelsConfig.md)
-
-The configuration for the logging connector.
+The options for the connector.
 
 #### Returns
 
@@ -62,7 +56,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: [`ILogEntry`](../interfaces/ILogEntry.md)
+##### logEntry
+
+[`ILogEntry`](../interfaces/ILogEntry.md)
 
 The entry to log.
 
@@ -80,51 +76,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>
+##### conditions?
+
+`EntityCondition`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof [`ILogEntry`](../interfaces/ILogEntry.md)[]
+##### properties?
+
+keyof [`ILogEntry`](../interfaces/ILogEntry.md)[]
 
 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`](../interfaces/ILogEntry.md)\>[]; `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`](../interfaces/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.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

package/docs/reference/classes/SilentLoggingConnector.md

@@ -46,7 +46,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: [`ILogEntry`](../interfaces/ILogEntry.md)
+##### logEntry
+
+[`ILogEntry`](../interfaces/ILogEntry.md)
 
 The entry to log.
 
@@ -64,51 +66,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>
+##### conditions?
+
+`EntityCondition`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof [`ILogEntry`](../interfaces/ILogEntry.md)[]
+##### properties?
+
+keyof [`ILogEntry`](../interfaces/ILogEntry.md)[]
 
 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`](../interfaces/ILogEntry.md)\>[]; `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`](../interfaces/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.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

package/docs/reference/index.md

@@ -12,6 +12,7 @@
 - [ILoggingComponent](interfaces/ILoggingComponent.md)
 - [ILoggingConnector](interfaces/ILoggingConnector.md)
 - [ILoggingLevelsConfig](interfaces/ILoggingLevelsConfig.md)
+- [IMultiLoggingConnectorConstructorOptions](interfaces/IMultiLoggingConnectorConstructorOptions.md)
 - [ILoggingCreateRequest](interfaces/ILoggingCreateRequest.md)
 - [ILoggingListRequest](interfaces/ILoggingListRequest.md)
 - [ILoggingListResponse](interfaces/ILoggingListResponse.md)

package/docs/reference/interfaces/ILogEntry.md

@@ -52,4 +52,4 @@ Optional data for the message.
 
 #### Index Signature
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`

package/docs/reference/interfaces/ILoggingComponent.md

@@ -16,7 +16,9 @@ Log an entry to the component.
 
 #### Parameters
 
-• **logEntry**: [`ILogEntry`](ILogEntry.md)
+##### logEntry
+
+[`ILogEntry`](ILogEntry.md)
 
 The entry to log.
 
@@ -30,55 +32,55 @@ Nothing.
 
 ### query()
 
-> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **level?**: [`LogLevel`](../type-aliases/LogLevel.md)
+##### level?
+
+[`LogLevel`](../type-aliases/LogLevel.md)
 
 The level of the log entries.
 
-• **source?**: `string`
+##### source?
+
+`string`
 
 The source of the log entries.
 
-• **timeStart?**: `number`
+##### timeStart?
+
+`number`
 
 The inclusive time as the start of the log entries.
 
-• **timeEnd?**: `number`
+##### timeEnd?
+
+`number`
 
 The inclusive time as the end of the log entries.
 
-• **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`: [`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.
 
-##### 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.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

package/docs/reference/interfaces/ILoggingConnector.md

@@ -16,7 +16,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: [`ILogEntry`](ILogEntry.md)
+##### logEntry
+
+[`ILogEntry`](ILogEntry.md)
 
 The entry to log.
 
@@ -30,51 +32,49 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<[`ILogEntry`](ILogEntry.md)\>
+##### conditions?
+
+`EntityCondition`\<[`ILogEntry`](ILogEntry.md)\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof [`ILogEntry`](ILogEntry.md)[]
+##### properties?
+
+keyof [`ILogEntry`](ILogEntry.md)[]
 
 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`](ILogEntry.md)\>[]; `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`](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.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-models",
-	"version": "0.0.1-next.6",
+	"version": "0.0.1-next.8",
 	"description": "Models which define the structure of the logging connectors and services",
 	"repository": {
 		"type": "git",