@twin.org/logging-rest-client 0.0.3-next.2 → 0.0.3-next.4

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 (5) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +53 -25
  3. package/docs/examples.md +43 -1
  4. package/docs/reference/classes/LoggingRestClient.md +4 -4
  5. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Logging REST Client
2
2
 
3
- Logging contract implementation which can connect to REST endpoints.
3
+ Provides a client for interacting with logging service endpoints from applications and services.
4
4
 
5
5
  ## Installation
6
6
 
package/docs/changelog.md CHANGED
@@ -1,11 +1,39 @@
1
- # @twin.org/logging-rest-client - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.2](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.3-next.1...logging-rest-client-v0.0.3-next.2) (2026-03-02)
3
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.3-next.3...logging-rest-client-v0.0.3-next.4) (2026-05-20)
4
+
5
+
6
+ ### Features
7
+
8
+ * update dependencies ([ed1e652](https://github.com/iotaledger/twin-logging/commit/ed1e652c4ba32c854d06e9def2f7f6db0bf9a7bd))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/logging-models bumped from 0.0.3-next.3 to 0.0.3-next.4
16
+
17
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.3-next.2...logging-rest-client-v0.0.3-next.3) (2026-05-11)
18
+
19
+
20
+ ### Features
21
+
22
+ * typescript 6 update ([cb28b05](https://github.com/iotaledger/twin-logging/commit/cb28b0557595d5ba9b25fab2d9f1222590787f5a))
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/logging-models bumped from 0.0.3-next.2 to 0.0.3-next.3
30
+
31
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.3-next.1...logging-rest-client-v0.0.3-next.2) (2026-03-02)
4
32
 
5
33
 
6
34
  ### Bug Fixes
7
35
 
8
- * api data types ([8d37cab](https://github.com/twinfoundation/logging/commit/8d37cab7ec759f079b6480bcc27d739357dbc392))
36
+ * api data types ([8d37cab](https://github.com/iotaledger/twin-logging/commit/8d37cab7ec759f079b6480bcc27d739357dbc392))
9
37
 
10
38
 
11
39
  ### Dependencies
@@ -14,17 +42,17 @@
14
42
  * dependencies
15
43
  * @twin.org/logging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
16
44
 
17
- ## [0.0.3-next.1](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.3-next.0...logging-rest-client-v0.0.3-next.1) (2025-11-10)
45
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.3-next.0...logging-rest-client-v0.0.3-next.1) (2025-11-10)
18
46
 
19
47
 
20
48
  ### Features
21
49
 
22
- * add context id features ([#33](https://github.com/twinfoundation/logging/issues/33)) ([38e982c](https://github.com/twinfoundation/logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
23
- * add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
24
- * eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
25
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
26
- * update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
27
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
50
+ * add context id features ([#33](https://github.com/iotaledger/twin-logging/issues/33)) ([38e982c](https://github.com/iotaledger/twin-logging/commit/38e982c9f009019fc02b67d919444b52657c9021))
51
+ * add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
52
+ * eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
53
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
54
+ * update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
55
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
28
56
 
29
57
 
30
58
  ### Dependencies
@@ -33,12 +61,12 @@
33
61
  * dependencies
34
62
  * @twin.org/logging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
35
63
 
36
- ## [0.0.2-next.3](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.2-next.2...logging-rest-client-v0.0.2-next.3) (2025-10-09)
64
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.2-next.2...logging-rest-client-v0.0.2-next.3) (2025-10-09)
37
65
 
38
66
 
39
67
  ### Features
40
68
 
41
- * add validate-locales ([df53f13](https://github.com/twinfoundation/logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
69
+ * add validate-locales ([df53f13](https://github.com/iotaledger/twin-logging/commit/df53f1331394f2f9333e91e4995a88dded90e484))
42
70
 
43
71
 
44
72
  ### Dependencies
@@ -47,12 +75,12 @@
47
75
  * dependencies
48
76
  * @twin.org/logging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
49
77
 
50
- ## [0.0.2-next.2](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.2-next.1...logging-rest-client-v0.0.2-next.2) (2025-08-29)
78
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.2-next.1...logging-rest-client-v0.0.2-next.2) (2025-08-29)
51
79
 
52
80
 
53
81
  ### Features
54
82
 
55
- * eslint migration to flat config ([1f9fdde](https://github.com/twinfoundation/logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
83
+ * eslint migration to flat config ([1f9fdde](https://github.com/iotaledger/twin-logging/commit/1f9fddedfdcce9942afed431d9460a0f22092744))
56
84
 
57
85
 
58
86
  ### Dependencies
@@ -61,14 +89,14 @@
61
89
  * dependencies
62
90
  * @twin.org/logging-models bumped from 0.0.2-next.1 to 0.0.2-next.2
63
91
 
64
- ## [0.0.2-next.1](https://github.com/twinfoundation/logging/compare/logging-rest-client-v0.0.2-next.0...logging-rest-client-v0.0.2-next.1) (2025-08-19)
92
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.2-next.0...logging-rest-client-v0.0.2-next.1) (2025-08-19)
65
93
 
66
94
 
67
95
  ### Features
68
96
 
69
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
70
- * update framework core ([aac823c](https://github.com/twinfoundation/logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
71
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
97
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
98
+ * update framework core ([aac823c](https://github.com/iotaledger/twin-logging/commit/aac823c2ead88843618b8a82b308d5a793411764))
99
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
72
100
 
73
101
 
74
102
  ### Dependencies
@@ -82,7 +110,7 @@
82
110
 
83
111
  ### Features
84
112
 
85
- * release to production ([3458161](https://github.com/twinfoundation/logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
113
+ * release to production ([3458161](https://github.com/iotaledger/twin-logging/commit/3458161b4bb530f86e4d1fe06123d885cdcb114d))
86
114
 
87
115
 
88
116
  ### Dependencies
@@ -91,7 +119,7 @@
91
119
  * dependencies
92
120
  * @twin.org/logging-models bumped from ^0.0.0 to ^0.0.1
93
121
 
94
- ## [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)
122
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.1-next.15...logging-rest-client-v0.0.1-next.16) (2025-06-20)
95
123
 
96
124
 
97
125
  ### Miscellaneous Chores
@@ -105,12 +133,12 @@
105
133
  * dependencies
106
134
  * @twin.org/logging-models bumped from 0.0.1-next.15 to 0.0.1-next.16
107
135
 
108
- ## [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)
136
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.1-next.14...logging-rest-client-v0.0.1-next.15) (2025-06-12)
109
137
 
110
138
 
111
139
  ### Features
112
140
 
113
- * update dependencies ([976fc06](https://github.com/twinfoundation/logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
141
+ * update dependencies ([976fc06](https://github.com/iotaledger/twin-logging/commit/976fc06976c4899769486b7cb2e827c407d7fc89))
114
142
 
115
143
 
116
144
  ### Dependencies
@@ -119,12 +147,12 @@
119
147
  * dependencies
120
148
  * @twin.org/logging-models bumped from 0.0.1-next.14 to 0.0.1-next.15
121
149
 
122
- ## [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)
150
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.1-next.13...logging-rest-client-v0.0.1-next.14) (2025-04-17)
123
151
 
124
152
 
125
153
  ### Features
126
154
 
127
- * use shared store mechanism ([#20](https://github.com/twinfoundation/logging/issues/20)) ([bbacd31](https://github.com/twinfoundation/logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
155
+ * use shared store mechanism ([#20](https://github.com/iotaledger/twin-logging/issues/20)) ([bbacd31](https://github.com/iotaledger/twin-logging/commit/bbacd31af991d82d84294ad432a40830692880ca))
128
156
 
129
157
 
130
158
  ### Dependencies
@@ -133,7 +161,7 @@
133
161
  * dependencies
134
162
  * @twin.org/logging-models bumped from 0.0.1-next.13 to 0.0.1-next.14
135
163
 
136
- ## [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)
164
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-logging/compare/logging-rest-client-v0.0.1-next.12...logging-rest-client-v0.0.1-next.13) (2025-03-28)
137
165
 
138
166
 
139
167
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,43 @@
1
- # @twin.org/logging-rest-client - Examples
1
+ # Logging Rest Client Examples
2
+
3
+ These snippets show how to send entries to an HTTP endpoint and query filtered log data for operational dashboards.
4
+
5
+ ## LoggingRestClient
6
+
7
+ ```typescript
8
+ import { LoggingRestClient } from '@twin.org/logging-rest-client';
9
+
10
+ const client = new LoggingRestClient({
11
+ endpoint: 'https://api.example.com'
12
+ });
13
+
14
+ const className = client.className();
15
+
16
+ await client.log({
17
+ level: 'info',
18
+ source: 'payment-service',
19
+ message: 'authorisationAccepted',
20
+ data: {
21
+ paymentId: 'pay-1024',
22
+ amount: 1999,
23
+ currency: 'GBP'
24
+ }
25
+ });
26
+ ```
27
+
28
+ ```typescript
29
+ import { LoggingRestClient } from '@twin.org/logging-rest-client';
30
+
31
+ const client = new LoggingRestClient({
32
+ endpoint: 'https://api.example.com'
33
+ });
34
+
35
+ const queryResult = await client.query(
36
+ 'error',
37
+ 'payment-service',
38
+ Date.now() - 60 * 60 * 1000,
39
+ Date.now(),
40
+ 'cursor-13',
41
+ 50
42
+ );
43
+ ```
package/docs/reference/classes/LoggingRestClient.md CHANGED
@@ -36,7 +36,7 @@ The configuration for the client.
36
36
 
37
37
  ## Properties
38
38
 
39
- ### CLASS\_NAME
39
+ ### CLASS\_NAME {#class_name}
40
40
 
41
41
  > `readonly` `static` **CLASS\_NAME**: `string`
42
42
 
@@ -44,7 +44,7 @@ Runtime name for the class.
44
44
 
45
45
  ## Methods
46
46
 
47
- ### className()
47
+ ### className() {#classname}
48
48
 
49
49
  > **className**(): `string`
50
50
 
@@ -62,7 +62,7 @@ The class name of the component.
62
62
 
63
63
  ***
64
64
 
65
- ### log()
65
+ ### log() {#log}
66
66
 
67
67
  > **log**(`logEntry`): `Promise`\<`void`\>
68
68
 
@@ -88,7 +88,7 @@ Nothing.
88
88
 
89
89
  ***
90
90
 
91
- ### query()
91
+ ### query() {#query}
92
92
 
93
93
  > **query**(`level?`, `source?`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ILogEntry`[]; `cursor?`: `string`; \}\>
94
94
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/logging-rest-client",
3
- "version": "0.0.3-next.2",
4
- "description": "Logging contract implementation which can connect to REST endpoints",
3
+ "version": "0.0.3-next.4",
4
+ "description": "Provides a client for interacting with logging service endpoints from applications and services.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/logging.git",
7
+ "url": "git+https://github.com/iotaledger/logging.git",
8
8
  "directory": "packages/logging-rest-client"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -18,7 +18,7 @@
18
18
  "@twin.org/api-models": "next",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/entity": "next",
21
- "@twin.org/logging-models": "0.0.3-next.2",
21
+ "@twin.org/logging-models": "0.0.3-next.4",
22
22
  "@twin.org/nameof": "next"
23
23
  },
24
24
  "main": "./dist/es/index.js",
@@ -46,7 +46,7 @@
46
46
  "logging"
47
47
  ],
48
48
  "bugs": {
49
- "url": "git+https://github.com/twinfoundation/logging/issues"
49
+ "url": "git+https://github.com/iotaledger/logging/issues"
50
50
  },
51
51
  "homepage": "https://twindev.org"
52
52
  }