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

package/dist/cjs/index.cjs

@@ -171,7 +171,6 @@ class LoggingService {
     /**
      * Create a new instance of LoggingService.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of the logging connector to use, defaults to "logging".
      */
     constructor(options) {
         this._loggingConnector = loggingModels.LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");

package/dist/esm/index.mjs

@@ -169,7 +169,6 @@ class LoggingService {
     /**
      * Create a new instance of LoggingService.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of the logging connector to use, defaults to "logging".
      */
     constructor(options) {
         this._loggingConnector = LoggingConnectorFactory.get(options?.loggingConnectorType ?? "logging");

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./loggingRoutes";
 export * from "./loggingService";
+export * from "./models/ILoggingServiceConstructorOptions";
 export * from "./restEntryPoints";

package/dist/types/loggingService.d.ts

@@ -1,4 +1,5 @@
 import { type ILogEntry, type ILoggingComponent, type LogLevel } from "@twin.org/logging-models";
+import type { ILoggingServiceConstructorOptions } from "./models/ILoggingServiceConstructorOptions";
 /**
  * Service for performing logging operations to a connector.
  */
@@ -14,11 +15,8 @@ export declare class LoggingService implements ILoggingComponent {
     /**
      * Create a new instance of LoggingService.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of the logging connector to use, defaults to "logging".
      */
-    constructor(options?: {
-        loggingConnectorType?: string;
-    });
+    constructor(options?: ILoggingServiceConstructorOptions);
     /**
      * Log an entry to the connector.
      * @param logEntry The entry to log.

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the logging service constructor.
+ */
+export interface ILoggingServiceConstructorOptions {
+    /**
+     * The type of the logging connector to use.
+     * @default logging
+     */
+    loggingConnectorType?: string;
+}

package/docs/changelog.md

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

package/docs/reference/classes/LoggingService.md

@@ -16,13 +16,11 @@ Create a new instance of LoggingService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
+[`ILoggingServiceConstructorOptions`](../interfaces/ILoggingServiceConstructorOptions.md)
 
-The type of the logging connector to use, defaults to "logging".
+The options for the connector.
 
 #### Returns
 
@@ -58,7 +56,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: `ILogEntry`
+##### logEntry
+
+`ILogEntry`
 
 The entry to log.
 
@@ -76,55 +76,55 @@ Nothing.
 
 ### query()
 
-> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
 
 Query the log entries.
 
 #### Parameters
 
-• **level?**: `LogLevel`
+##### level?
+
+`LogLevel`
 
 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`[]; `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`[]
-
-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/functions/generateRestRoutesLogging.md

@@ -6,11 +6,15 @@ The REST routes for logging.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 

package/docs/reference/functions/loggingCreate.md

@@ -6,15 +6,21 @@ Create a new log entry.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ILoggingCreateRequest`
+### request
+
+`ILoggingCreateRequest`
 
 The request.
 

package/docs/reference/functions/loggingList.md

@@ -6,15 +6,21 @@ Get a list of the logging entries.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ILoggingListRequest`
+### request
+
+`ILoggingListRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -4,6 +4,10 @@
 
 - [LoggingService](classes/LoggingService.md)
 
+## Interfaces
+
+- [ILoggingServiceConstructorOptions](interfaces/ILoggingServiceConstructorOptions.md)
+
 ## Variables
 
 - [tagsLogging](variables/tagsLogging.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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-service",
-	"version": "0.0.1-next.6",
+	"version": "0.0.1-next.8",
 	"description": "Logging contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/logging-models": "0.0.1-next.6",
+		"@twin.org/logging-models": "0.0.1-next.8",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},