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

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 (6) hide show
  1. package/dist/cjs/index.cjs +0 -1
  2. package/dist/esm/index.mjs +0 -1
  3. package/dist/types/loggingClient.d.ts +0 -1
  4. package/docs/changelog.md +71 -1
  5. package/docs/reference/classes/LoggingClient.md +5 -9
  6. package/package.json +9 -9
package/dist/cjs/index.cjs CHANGED
@@ -46,7 +46,6 @@ class LoggingClient extends apiCore.BaseRestClient {
46
46
  * @param pageSize The maximum number of entities in a page.
47
47
  * @returns All the entities for the storage matching the conditions,
48
48
  * and a cursor which can be used to request more entities.
49
- * @throws NotImplementedError if the implementation does not support retrieval.
50
49
  */
51
50
  async query(level, source, timeStart, timeEnd, cursor, pageSize) {
52
51
  const response = await this.fetch("/", "GET", {
package/dist/esm/index.mjs CHANGED
@@ -44,7 +44,6 @@ class LoggingClient extends BaseRestClient {
44
44
  * @param pageSize The maximum number of entities in a page.
45
45
  * @returns All the entities for the storage matching the conditions,
46
46
  * and a cursor which can be used to request more entities.
47
- * @throws NotImplementedError if the implementation does not support retrieval.
48
47
  */
49
48
  async query(level, source, timeStart, timeEnd, cursor, pageSize) {
50
49
  const response = await this.fetch("/", "GET", {
package/dist/types/loggingClient.d.ts CHANGED
@@ -30,7 +30,6 @@ export declare class LoggingClient extends BaseRestClient implements ILoggingCom
30
30
  * @param pageSize The maximum number of entities in a page.
31
31
  * @returns All the entities for the storage matching the conditions,
32
32
  * and a cursor which can be used to request more entities.
33
- * @throws NotImplementedError if the implementation does not support retrieval.
34
33
  */
35
34
  query(level?: LogLevel, source?: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{
36
35
  /**
package/docs/changelog.md CHANGED
@@ -1,5 +1,75 @@
1
1
  # @twin.org/logging-rest-client - Changelog
2
2
 
3
- ## v0.0.1-next.8
3
+ ## 0.0.1 (2025-07-03)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([3458161](https://github.com/twinfoundation/logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/logging-models bumped from ^0.0.0 to ^0.0.1
16
+
17
+ ## [0.0.1-next.16](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.1-next.15...logging-rest-client-v0.0.1-next.16) (2025-06-20)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **logging-rest-client:** Synchronize repo versions
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/logging-models bumped from 0.0.1-next.15 to 0.0.1-next.16
30
+
31
+ ## [0.0.1-next.15](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.1-next.14...logging-rest-client-v0.0.1-next.15) (2025-06-12)
32
+
33
+
34
+ ### Features
35
+
36
+ * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
37
+
38
+
39
+ ### Dependencies
40
+
41
+ * The following workspace dependencies were updated
42
+ * dependencies
43
+ * @twin.org/logging-models bumped from 0.0.1-next.14 to 0.0.1-next.15
44
+
45
+ ## [0.0.1-next.14](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.1-next.13...logging-rest-client-v0.0.1-next.14) (2025-04-17)
46
+
47
+
48
+ ### Features
49
+
50
+ * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
51
+
52
+
53
+ ### Dependencies
54
+
55
+ * The following workspace dependencies were updated
56
+ * dependencies
57
+ * @twin.org/logging-models bumped from 0.0.1-next.13 to 0.0.1-next.14
58
+
59
+ ## [0.0.1-next.13](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.1-next.12...logging-rest-client-v0.0.1-next.13) (2025-03-28)
60
+
61
+
62
+ ### Miscellaneous Chores
63
+
64
+ * **logging-rest-client:** Synchronize repo versions
65
+
66
+
67
+ ### Dependencies
68
+
69
+ * The following workspace dependencies were updated
70
+ * dependencies
71
+ * @twin.org/logging-models bumped from 0.0.1-next.12 to 0.0.1-next.13
72
+
73
+ ## v0.0.1-next.12
4
74
 
5
75
  - Initial Release
package/docs/reference/classes/LoggingClient.md CHANGED
@@ -12,9 +12,9 @@ Client for performing logging through to REST endpoints.
12
12
 
13
13
  ## Constructors
14
14
 
15
- ### new LoggingClient()
15
+ ### Constructor
16
16
 
17
- > **new LoggingClient**(`config`): [`LoggingClient`](LoggingClient.md)
17
+ > **new LoggingClient**(`config`): `LoggingClient`
18
18
 
19
19
  Create a new instance of LoggingClient.
20
20
 
@@ -28,7 +28,7 @@ The configuration for the client.
28
28
 
29
29
  #### Returns
30
30
 
31
- [`LoggingClient`](LoggingClient.md)
31
+ `LoggingClient`
32
32
 
33
33
  #### Overrides
34
34
 
@@ -76,7 +76,7 @@ Nothing.
76
76
 
77
77
  ### query()
78
78
 
79
- > **query**(`level`?, `source`?, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
79
+ > **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
80
80
 
81
81
  Query the log entries.
82
82
 
@@ -120,15 +120,11 @@ The maximum number of entities in a page.
120
120
 
121
121
  #### Returns
122
122
 
123
- `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor`: `string`; \}\>
123
+ `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
124
124
 
125
125
  All the entities for the storage matching the conditions,
126
126
  and a cursor which can be used to request more entities.
127
127
 
128
- #### Throws
129
-
130
- NotImplementedError if the implementation does not support retrieval.
131
-
132
128
  #### Implementation of
133
129
 
134
130
  `ILoggingComponent.query`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/logging-rest-client",
3
- "version": "0.0.1-next.8",
3
+ "version": "0.0.1",
4
4
  "description": "Logging contract implementation which can connect to REST endpoints",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,21 +14,21 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-core": "next",
18
- "@twin.org/api-models": "next",
19
- "@twin.org/core": "next",
20
- "@twin.org/entity": "next",
21
- "@twin.org/logging-models": "0.0.1-next.8",
22
- "@twin.org/nameof": "next"
17
+ "@twin.org/api-core": "^0.0.1",
18
+ "@twin.org/api-models": "^0.0.1",
19
+ "@twin.org/core": "^0.0.1",
20
+ "@twin.org/entity": "^0.0.1",
21
+ "@twin.org/logging-models": "^0.0.1",
22
+ "@twin.org/nameof": "^0.0.1"
23
23
  },
24
24
  "main": "./dist/cjs/index.cjs",
25
25
  "module": "./dist/esm/index.mjs",
26
26
  "types": "./dist/types/index.d.ts",
27
27
  "exports": {
28
28
  ".": {
29
+ "types": "./dist/types/index.d.ts",
29
30
  "require": "./dist/cjs/index.cjs",
30
- "import": "./dist/esm/index.mjs",
31
- "types": "./dist/types/index.d.ts"
31
+ "import": "./dist/esm/index.mjs"
32
32
  },
33
33
  "./locales/*.json": "./locales/*.json"
34
34
  },