@twin.org/telemetry-service 0.0.1-next.9 → 0.0.1

package/docs/changelog.md

@@ -1,5 +1,75 @@
 # @twin.org/telemetry-service - Changelog
 
-## v0.0.1-next.9
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* release to production ([df2151d](https://github.com/twinfoundation/telemetry/commit/df2151d24844fd2c3e6092ce3a6f888ac16219a0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.18](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.1-next.17...telemetry-service-v0.0.1-next.18) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([ec7999e](https://github.com/twinfoundation/telemetry/commit/ec7999eadb66c65585efa19f3ce4cabb50eed761))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.1-next.17 to 0.0.1-next.18
+
+## [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)
+
+
+### Features
+
+* update dependencies ([0e55c48](https://github.com/twinfoundation/telemetry/commit/0e55c48de4139c6fe66b823101ca17973e60847c))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.1-next.16 to 0.0.1-next.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)
+
+
+### Features
+
+* use shared store mechanism ([#7](https://github.com/twinfoundation/telemetry/issues/7)) ([806fe2c](https://github.com/twinfoundation/telemetry/commit/806fe2c2b7653d6b949c27ebf57bd13c3e040242))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.1-next.15 to 0.0.1-next.16
+
+## [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)
+
+
+### Bug Fixes
+
+* Update metric endpoint paths by removing trailing slashes and query type as string ([#3](https://github.com/twinfoundation/telemetry/issues/3)) ([b386ca5](https://github.com/twinfoundation/telemetry/commit/b386ca55404aa933ad8917f82a7f0e588593fcc8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.1-next.14 to 0.0.1-next.15
+
+## v0.0.1-next.14
 
 - Initial Release

package/docs/open-api/spec.json

@@ -157,7 +157,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "number"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					}
 				],
@@ -707,7 +710,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "number"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					},
 					{
@@ -716,7 +722,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "number"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					},
 					{
@@ -734,7 +743,10 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": "number"
+							"type": [
+								"number",
+								"string"
+							]
 						}
 					}
 				],
@@ -950,10 +962,12 @@
 				"properties": {
 					"entities": {
 						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/TelemetryMetric"
-						},
-						"description": "The metrics."
+						"description": "The metrics.",
+						"prefixItems": [
+							{
+								"$ref": "#/components/schemas/TelemetryMetric"
+							}
+						]
 					},
 					"cursor": {
 						"type": "string",
@@ -1056,10 +1070,12 @@
 					},
 					"entities": {
 						"type": "array",
-						"items": {
-							"$ref": "#/components/schemas/TelemetryMetricValue"
-						},
-						"description": "The metric values."
+						"description": "The metric values.",
+						"prefixItems": [
+							{
+								"$ref": "#/components/schemas/TelemetryMetricValue"
+							}
+						]
 					},
 					"cursor": {
 						"type": "string",

package/docs/reference/classes/TelemetryService.md

@@ -8,9 +8,9 @@ Service for performing telemetry operations to a connector.
 
 ## Constructors
 
-### new TelemetryService()
+### Constructor
 
-> **new TelemetryService**(`options`?): [`TelemetryService`](TelemetryService.md)
+> **new TelemetryService**(`options?`): `TelemetryService`
 
 Create a new instance of TelemetryService.
 
@@ -24,7 +24,7 @@ The options for the connector.
 
 #### Returns
 
-[`TelemetryService`](TelemetryService.md)
+`TelemetryService`
 
 ## Properties
 
@@ -128,7 +128,7 @@ Nothing.
 
 ### addMetricValue()
 
-> **addMetricValue**(`id`, `value`, `customData`?): `Promise`\<`string`\>
+> **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
 
 Add a metric value.
 
@@ -190,7 +190,7 @@ Nothing.
 
 ### query()
 
-> **query**(`type`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
+> **query**(`type?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
 
 Query the metrics.
 
@@ -216,7 +216,7 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
@@ -233,7 +233,7 @@ NotImplementedError if the implementation does not support retrieval.
 
 ### queryValues()
 
-> **queryValues**(`id`, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
+> **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `pageSize?`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
 
 Query the metric values.
 
@@ -271,7 +271,7 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.

package/docs/reference/functions/generateRestRoutesTelemetry.md

@@ -1,6 +1,6 @@
 # Function: generateRestRoutesTelemetry()
 
-> **generateRestRoutesTelemetry**(`baseRouteName`, `componentName`): `IRestRoute`[]
+> **generateRestRoutesTelemetry**(`baseRouteName`, `componentName`): `IRestRoute`\<`any`, `any`\>[]
 
 The REST routes for telemetry.
 
@@ -20,6 +20,6 @@ The name of the component to use in the routes stored in the ComponentFactory.
 
 ## Returns
 
-`IRestRoute`[]
+`IRestRoute`\<`any`, `any`\>[]
 
 The generated routes.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/telemetry-service",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"description": "Telemetry contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -14,12 +14,12 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "next",
-		"@twin.org/core": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/telemetry-models": "0.0.1-next.9",
-		"@twin.org/web": "next"
+		"@twin.org/api-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/telemetry-models": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",