@twin.org/logging-rest-client 0.0.1-next.7 → 0.0.1-next.9

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/logging-rest-client - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/classes/LoggingClient.md

@@ -20,7 +20,9 @@ Create a new instance of LoggingClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
@@ -54,7 +56,9 @@ Log an entry to the connector.
 
 #### Parameters
 
-• **logEntry**: `ILogEntry`
+##### logEntry
+
+`ILogEntry`
 
 The entry to log.
 
@@ -72,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/logging-rest-client",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.9",
 	"description": "Logging contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/logging-models": "0.0.1-next.7",
+		"@twin.org/logging-models": "0.0.1-next.9",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -26,9 +26,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},