@twin.org/telemetry-service 0.0.1-next.15 → 0.0.1-next.17

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.
package/docs/changelog.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # @twin.org/telemetry-service - Changelog
2
2
 
3
+ ## [0.0.1-next.17](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.1-next.16...telemetry-service-v0.0.1-next.17) (2025-06-12)
4
+
5
+
6
+ ### Features
7
+
8
+ * update dependencies ([0e55c48](https://github.com/twinfoundation/telemetry/commit/0e55c48de4139c6fe66b823101ca17973e60847c))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/telemetry-models bumped from 0.0.1-next.16 to 0.0.1-next.17
16
+
17
+ ## [0.0.1-next.16](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.1-next.15...telemetry-service-v0.0.1-next.16) (2025-04-17)
18
+
19
+
20
+ ### Features
21
+
22
+ * use shared store mechanism ([#7](https://github.com/twinfoundation/telemetry/issues/7)) ([806fe2c](https://github.com/twinfoundation/telemetry/commit/806fe2c2b7653d6b949c27ebf57bd13c3e040242))
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/telemetry-models bumped from 0.0.1-next.15 to 0.0.1-next.16
30
+
3
31
  ## [0.0.1-next.15](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.1-next.14...telemetry-service-v0.0.1-next.15) (2025-03-28)
4
32
 
5
33
 
@@ -8,9 +8,9 @@ Service for performing telemetry operations to a connector.
8
8
 
9
9
  ## Constructors
10
10
 
11
- ### new TelemetryService()
11
+ ### Constructor
12
12
 
13
- > **new TelemetryService**(`options`?): [`TelemetryService`](TelemetryService.md)
13
+ > **new TelemetryService**(`options?`): `TelemetryService`
14
14
 
15
15
  Create a new instance of TelemetryService.
16
16
 
@@ -24,7 +24,7 @@ The options for the connector.
24
24
 
25
25
  #### Returns
26
26
 
27
- [`TelemetryService`](TelemetryService.md)
27
+ `TelemetryService`
28
28
 
29
29
  ## Properties
30
30
 
@@ -128,7 +128,7 @@ Nothing.
128
128
 
129
129
  ### addMetricValue()
130
130
 
131
- > **addMetricValue**(`id`, `value`, `customData`?): `Promise`\<`string`\>
131
+ > **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
132
132
 
133
133
  Add a metric value.
134
134
 
@@ -190,7 +190,7 @@ Nothing.
190
190
 
191
191
  ### query()
192
192
 
193
- > **query**(`type`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
193
+ > **query**(`type?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
194
194
 
195
195
  Query the metrics.
196
196
 
@@ -216,7 +216,7 @@ The maximum number of entities in a page.
216
216
 
217
217
  #### Returns
218
218
 
219
- `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
219
+ `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
220
220
 
221
221
  All the entities for the storage matching the conditions,
222
222
  and a cursor which can be used to request more entities.
@@ -233,7 +233,7 @@ NotImplementedError if the implementation does not support retrieval.
233
233
 
234
234
  ### queryValues()
235
235
 
236
- > **queryValues**(`id`, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
236
+ > **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
237
237
 
238
238
  Query the metric values.
239
239
 
@@ -271,7 +271,7 @@ The maximum number of entities in a page.
271
271
 
272
272
  #### Returns
273
273
 
274
- `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
274
+ `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
275
275
 
276
276
  All the entities for the storage matching the conditions,
277
277
  and a cursor which can be used to request more entities.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/telemetry-service",
3
- "version": "0.0.1-next.15",
3
+ "version": "0.0.1-next.17",
4
4
  "description": "Telemetry contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -18,7 +18,7 @@
18
18
  "@twin.org/core": "next",
19
19
  "@twin.org/entity": "next",
20
20
  "@twin.org/nameof": "next",
21
- "@twin.org/telemetry-models": "0.0.1-next.15",
21
+ "@twin.org/telemetry-models": "0.0.1-next.17",
22
22
  "@twin.org/web": "next"
23
23
  },
24
24
  "main": "./dist/cjs/index.cjs",