@twin.org/logging-models 0.0.1-next.14 → 0.0.1-next.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/dist/types/models/api/ILoggingListRequest.d.ts +4 -4
  2. package/docs/changelog.md +14 -0
  3. package/docs/reference/classes/MultiLoggingConnector.md +2 -2
  4. package/docs/reference/classes/SilentLoggingConnector.md +2 -2
  5. package/docs/reference/interfaces/ILoggingComponent.md +2 -2
  6. package/docs/reference/interfaces/ILoggingConnector.md +2 -2
  7. package/docs/reference/interfaces/ILoggingListRequest.md +5 -5
  8. package/package.json +1 -1
package/dist/types/models/api/ILoggingListRequest.d.ts CHANGED
@@ -6,7 +6,7 @@ export interface ILoggingListRequest {
6
6
  /**
7
7
  * The query parameters.
8
8
  */
9
- query: {
9
+ query?: {
10
10
  /**
11
11
  * The level of the log entries to retrieve.
12
12
  */
@@ -18,11 +18,11 @@ export interface ILoggingListRequest {
18
18
  /**
19
19
  * The start time of the metrics to retrieve as a timestamp in ms.
20
20
  */
21
- timeStart?: number;
21
+ timeStart?: number | string;
22
22
  /**
23
23
  * The end time of the metrics to retrieve as a timestamp in ms.
24
24
  */
25
- timeEnd?: number;
25
+ timeEnd?: number | string;
26
26
  /**
27
27
  * The optional cursor to get next chunk.
28
28
  */
@@ -30,6 +30,6 @@ export interface ILoggingListRequest {
30
30
  /**
31
31
  * The maximum number of entities in a page.
32
32
  */
33
- pageSize?: number;
33
+ pageSize?: number | string;
34
34
  };
35
35
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/logging-models - Changelog
2
2
 
3
+ ## [0.0.1-next.16](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.15...logging-models-v0.0.1-next.16) (2025-06-20)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * query params force coercion ([71c5329](https://github.com/twinfoundation/logging/commit/71c53292d300acae0369bd7937c5ca3ab5430689))
9
+
10
+ ## [0.0.1-next.15](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.14...logging-models-v0.0.1-next.15) (2025-06-12)
11
+
12
+
13
+ ### Features
14
+
15
+ * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
16
+
3
17
  ## [0.0.1-next.14](https://github.com/twinfoundation/logging/compare/logging-models-v0.0.1-next.13...logging-models-v0.0.1-next.14) (2025-04-17)
4
18
 
5
19
 
package/docs/reference/classes/MultiLoggingConnector.md CHANGED
@@ -76,7 +76,7 @@ Nothing.
76
76
 
77
77
  ### query()
78
78
 
79
- > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
79
+ > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
80
80
 
81
81
  Query the log entries.
82
82
 
@@ -114,7 +114,7 @@ The maximum number of entities in a page.
114
114
 
115
115
  #### Returns
116
116
 
117
- `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
117
+ `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
118
118
 
119
119
  All the entities for the storage matching the conditions,
120
120
  and a cursor which can be used to request more entities.
package/docs/reference/classes/SilentLoggingConnector.md CHANGED
@@ -66,7 +66,7 @@ Nothing.
66
66
 
67
67
  ### query()
68
68
 
69
- > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
69
+ > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
70
70
 
71
71
  Query the log entries.
72
72
 
@@ -104,7 +104,7 @@ The maximum number of entities in a page.
104
104
 
105
105
  #### Returns
106
106
 
107
- `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor`: `string`; \}\>
107
+ `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](../interfaces/ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
108
108
 
109
109
  All the entities for the storage matching the conditions,
110
110
  and a cursor which can be used to request more entities.
package/docs/reference/interfaces/ILoggingComponent.md CHANGED
@@ -32,7 +32,7 @@ Nothing.
32
32
 
33
33
  ### query()
34
34
 
35
- > **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor`: `string`; \}\>
35
+ > **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor?`: `string`; \}\>
36
36
 
37
37
  Query the log entries.
38
38
 
@@ -76,7 +76,7 @@ The maximum number of entities in a page.
76
76
 
77
77
  #### Returns
78
78
 
79
- `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor`: `string`; \}\>
79
+ `Promise`\<\{ `entities`: [`ILogEntry`](ILogEntry.md)[]; `cursor?`: `string`; \}\>
80
80
 
81
81
  All the entities for the storage matching the conditions,
82
82
  and a cursor which can be used to request more entities.
package/docs/reference/interfaces/ILoggingConnector.md CHANGED
@@ -32,7 +32,7 @@ Nothing.
32
32
 
33
33
  ### query()?
34
34
 
35
- > `optional` **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
35
+ > `optional` **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
36
36
 
37
37
  Query the log entries.
38
38
 
@@ -70,7 +70,7 @@ The maximum number of entities in a page.
70
70
 
71
71
  #### Returns
72
72
 
73
- `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor`: `string`; \}\>
73
+ `Promise`\<\{ `entities`: `Partial`\<[`ILogEntry`](ILogEntry.md)\>[]; `cursor?`: `string`; \}\>
74
74
 
75
75
  All the entities for the storage matching the conditions,
76
76
  and a cursor which can be used to request more entities.
package/docs/reference/interfaces/ILoggingListRequest.md CHANGED
@@ -4,9 +4,9 @@ Get the a list of the log entries.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### query
7
+ ### query?
8
8
 
9
- > **query**: `object`
9
+ > `optional` **query**: `object`
10
10
 
11
11
  The query parameters.
12
12
 
@@ -24,13 +24,13 @@ The source of the log entries to retrieve.
24
24
 
25
25
  #### timeStart?
26
26
 
27
- > `optional` **timeStart**: `number`
27
+ > `optional` **timeStart**: `string` \| `number`
28
28
 
29
29
  The start time of the metrics to retrieve as a timestamp in ms.
30
30
 
31
31
  #### timeEnd?
32
32
 
33
- > `optional` **timeEnd**: `number`
33
+ > `optional` **timeEnd**: `string` \| `number`
34
34
 
35
35
  The end time of the metrics to retrieve as a timestamp in ms.
36
36
 
@@ -42,6 +42,6 @@ The optional cursor to get next chunk.
42
42
 
43
43
  #### pageSize?
44
44
 
45
- > `optional` **pageSize**: `number`
45
+ > `optional` **pageSize**: `string` \| `number`
46
46
 
47
47
  The maximum number of entities in a page.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/logging-models",
3
- "version": "0.0.1-next.14",
3
+ "version": "0.0.1-next.16",
4
4
  "description": "Models which define the structure of the logging connectors and services",
5
5
  "repository": {
6
6
  "type": "git",