@twin.org/telemetry-service 0.0.2-next.1 → 0.0.2-next.3

package/dist/cjs/index.cjs

@@ -437,7 +437,7 @@ async function telemetryMetricList(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request", request);
     core.Guards.object(ROUTES_SOURCE, "request.query", request.query);
     const component = core.ComponentFactory.get(componentName);
-    const itemsAndCursor = await component.query(core.Coerce.number(request?.query?.type), request?.query?.cursor, core.Coerce.number(request?.query?.pageSize));
+    const itemsAndCursor = await component.query(core.Coerce.number(request?.query?.type), request?.query?.cursor, core.Coerce.number(request?.query?.limit));
     return {
         body: itemsAndCursor
     };
@@ -454,7 +454,7 @@ async function telemetryMetricValueList(httpRequestContext, componentName, reque
     core.Guards.object(ROUTES_SOURCE, "request.query", request.query);
     core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = core.ComponentFactory.get(componentName);
-    const itemsAndCursor = await component.queryValues(request?.pathParams.id, core.Coerce.number(request?.query?.timeStart), core.Coerce.number(request?.query?.timeEnd), request?.query?.cursor, core.Coerce.number(request?.query?.pageSize));
+    const itemsAndCursor = await component.queryValues(request?.pathParams.id, core.Coerce.number(request?.query?.timeStart), core.Coerce.number(request?.query?.timeEnd), request?.query?.cursor, core.Coerce.number(request?.query?.limit));
     return {
         body: itemsAndCursor
     };
@@ -469,7 +469,7 @@ class TelemetryService {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "TelemetryService";
+    static CLASS_NAME = "TelemetryService";
     /**
      * Telemetry connector used by the service.
      * @internal
@@ -488,7 +488,7 @@ class TelemetryService {
      * @returns Nothing.
      */
     async createMetric(metric) {
-        core.Guards.object(this.CLASS_NAME, "metric", metric);
+        core.Guards.object(TelemetryService.CLASS_NAME, "metric", metric);
         await this._telemetryConnector.createMetric(metric);
     }
     /**
@@ -497,7 +497,7 @@ class TelemetryService {
      * @returns The metric details and it's most recent value.
      */
     async getMetric(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
         return this._telemetryConnector.getMetric(id);
     }
     /**
@@ -506,8 +506,8 @@ class TelemetryService {
      * @returns Nothing.
      */
     async updateMetric(metric) {
-        core.Guards.object(this.CLASS_NAME, "metric", metric);
-        core.Guards.stringValue(this.CLASS_NAME, "metric.id", metric.id);
+        core.Guards.object(TelemetryService.CLASS_NAME, "metric", metric);
+        core.Guards.stringValue(TelemetryService.CLASS_NAME, "metric.id", metric.id);
         return this._telemetryConnector.updateMetric(metric);
     }
     /**
@@ -518,8 +518,8 @@ class TelemetryService {
      * @returns The created metric value id.
      */
     async addMetricValue(id, value, customData) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.defined(this.CLASS_NAME, "value", value);
+        core.Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
+        core.Guards.defined(TelemetryService.CLASS_NAME, "value", value);
         return this._telemetryConnector.addMetricValue(id, value, customData);
     }
     /**
@@ -528,35 +528,35 @@ class TelemetryService {
      * @returns Nothing.
      */
     async removeMetric(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
         return this._telemetryConnector.removeMetric(id);
     }
     /**
      * Query the metrics.
      * @param type The type of the metric.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    async query(type, cursor, pageSize) {
-        return this._telemetryConnector.query(type, cursor, pageSize);
+    async query(type, cursor, limit) {
+        return this._telemetryConnector.query(type, cursor, limit);
     }
     /**
      * Query the metric values.
      * @param id The id of the metric.
      * @param timeStart The inclusive time as the start of the metric entries.
      * @param timeEnd The inclusive time as the end of the metric entries.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    async queryValues(id, timeStart, timeEnd, cursor, pageSize) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        return this._telemetryConnector.queryValues(id, timeStart, timeEnd, cursor, pageSize);
+    async queryValues(id, timeStart, timeEnd, cursor, limit) {
+        core.Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
+        return this._telemetryConnector.queryValues(id, timeStart, timeEnd, cursor, limit);
     }
 }
 

package/dist/esm/index.mjs

@@ -435,7 +435,7 @@ async function telemetryMetricList(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     Guards.object(ROUTES_SOURCE, "request.query", request.query);
     const component = ComponentFactory.get(componentName);
-    const itemsAndCursor = await component.query(Coerce.number(request?.query?.type), request?.query?.cursor, Coerce.number(request?.query?.pageSize));
+    const itemsAndCursor = await component.query(Coerce.number(request?.query?.type), request?.query?.cursor, Coerce.number(request?.query?.limit));
     return {
         body: itemsAndCursor
     };
@@ -452,7 +452,7 @@ async function telemetryMetricValueList(httpRequestContext, componentName, reque
     Guards.object(ROUTES_SOURCE, "request.query", request.query);
     Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
     const component = ComponentFactory.get(componentName);
-    const itemsAndCursor = await component.queryValues(request?.pathParams.id, Coerce.number(request?.query?.timeStart), Coerce.number(request?.query?.timeEnd), request?.query?.cursor, Coerce.number(request?.query?.pageSize));
+    const itemsAndCursor = await component.queryValues(request?.pathParams.id, Coerce.number(request?.query?.timeStart), Coerce.number(request?.query?.timeEnd), request?.query?.cursor, Coerce.number(request?.query?.limit));
     return {
         body: itemsAndCursor
     };
@@ -467,7 +467,7 @@ class TelemetryService {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "TelemetryService";
+    static CLASS_NAME = "TelemetryService";
     /**
      * Telemetry connector used by the service.
      * @internal
@@ -486,7 +486,7 @@ class TelemetryService {
      * @returns Nothing.
      */
     async createMetric(metric) {
-        Guards.object(this.CLASS_NAME, "metric", metric);
+        Guards.object(TelemetryService.CLASS_NAME, "metric", metric);
         await this._telemetryConnector.createMetric(metric);
     }
     /**
@@ -495,7 +495,7 @@ class TelemetryService {
      * @returns The metric details and it's most recent value.
      */
     async getMetric(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
         return this._telemetryConnector.getMetric(id);
     }
     /**
@@ -504,8 +504,8 @@ class TelemetryService {
      * @returns Nothing.
      */
     async updateMetric(metric) {
-        Guards.object(this.CLASS_NAME, "metric", metric);
-        Guards.stringValue(this.CLASS_NAME, "metric.id", metric.id);
+        Guards.object(TelemetryService.CLASS_NAME, "metric", metric);
+        Guards.stringValue(TelemetryService.CLASS_NAME, "metric.id", metric.id);
         return this._telemetryConnector.updateMetric(metric);
     }
     /**
@@ -516,8 +516,8 @@ class TelemetryService {
      * @returns The created metric value id.
      */
     async addMetricValue(id, value, customData) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.defined(this.CLASS_NAME, "value", value);
+        Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
+        Guards.defined(TelemetryService.CLASS_NAME, "value", value);
         return this._telemetryConnector.addMetricValue(id, value, customData);
     }
     /**
@@ -526,35 +526,35 @@ class TelemetryService {
      * @returns Nothing.
      */
     async removeMetric(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
         return this._telemetryConnector.removeMetric(id);
     }
     /**
      * Query the metrics.
      * @param type The type of the metric.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    async query(type, cursor, pageSize) {
-        return this._telemetryConnector.query(type, cursor, pageSize);
+    async query(type, cursor, limit) {
+        return this._telemetryConnector.query(type, cursor, limit);
     }
     /**
      * Query the metric values.
      * @param id The id of the metric.
      * @param timeStart The inclusive time as the start of the metric entries.
      * @param timeEnd The inclusive time as the end of the metric entries.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    async queryValues(id, timeStart, timeEnd, cursor, pageSize) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
-        return this._telemetryConnector.queryValues(id, timeStart, timeEnd, cursor, pageSize);
+    async queryValues(id, timeStart, timeEnd, cursor, limit) {
+        Guards.stringValue(TelemetryService.CLASS_NAME, "id", id);
+        return this._telemetryConnector.queryValues(id, timeStart, timeEnd, cursor, limit);
     }
 }
 

package/dist/types/telemetryService.d.ts

@@ -7,7 +7,7 @@ export declare class TelemetryService implements ITelemetryComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of TelemetryService.
      * @param options The options for the connector.
@@ -53,13 +53,13 @@ export declare class TelemetryService implements ITelemetryComponent {
     /**
      * Query the metrics.
      * @param type The type of the metric.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    query(type?: MetricType, cursor?: string, pageSize?: number): Promise<{
+    query(type?: MetricType, cursor?: string, limit?: number): Promise<{
         /**
          * The metrics.
          */
@@ -74,13 +74,13 @@ export declare class TelemetryService implements ITelemetryComponent {
      * @param id The id of the metric.
      * @param timeStart The inclusive time as the start of the metric entries.
      * @param timeEnd The inclusive time as the end of the metric entries.
-     * @param cursor The cursor to request the next page of entities.
-     * @param pageSize The maximum number of entities in a page.
+     * @param cursor The cursor to request the next chunk of entities.
+     * @param limit Limit the number of entities to return.
      * @returns All the entities for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      * @throws NotImplementedError if the implementation does not support retrieval.
      */
-    queryValues(id: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{
+    queryValues(id: string, timeStart?: number, timeEnd?: number, cursor?: string, limit?: number): Promise<{
         /**
          * The metric details.
          */

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/telemetry-service - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.2-next.2...telemetry-service-v0.0.2-next.3) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([24ed804](https://github.com/twinfoundation/telemetry/commit/24ed804f7ebc47036f323722bc18452729860c92))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.2-next.1...telemetry-service-v0.0.2-next.2) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([69ac91a](https://github.com/twinfoundation/telemetry/commit/69ac91a89d0b5bc63374a0bd314f770b557dabb4))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/telemetry-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/telemetry/compare/telemetry-service-v0.0.2-next.0...telemetry-service-v0.0.2-next.1) (2025-08-20)
 
 

package/docs/open-api/spec.json

@@ -78,7 +78,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -99,7 +99,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -117,7 +117,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -152,15 +152,12 @@
 						}
 					},
 					{
-						"name": "pageSize",
-						"description": "The maximum number of entities in a page.",
+						"name": "limit",
+						"description": "Limit the number of entities to return.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					}
 				],
@@ -212,7 +209,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -233,7 +230,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -251,7 +248,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -326,7 +323,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -347,7 +344,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -365,7 +362,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -431,7 +428,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -452,7 +449,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -470,7 +467,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -518,7 +515,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -539,7 +536,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -557,7 +554,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -638,7 +635,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -659,7 +656,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -677,7 +674,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -738,15 +735,12 @@
 						}
 					},
 					{
-						"name": "pageSize",
-						"description": "The maximum number of entities in a page.",
+						"name": "limit",
+						"description": "Limit the number of entities to return.",
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					}
 				],
@@ -802,7 +796,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -823,7 +817,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -841,7 +835,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}

package/docs/reference/classes/TelemetryService.md

@@ -30,14 +30,10 @@ The options for the connector.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`ITelemetryComponent.CLASS_NAME`
-
 ## Methods
 
 ### createMetric()
@@ -182,7 +178,7 @@ Nothing.
 
 ### query()
 
-> **query**(`type?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
+> **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
 
 Query the metrics.
 
@@ -198,13 +194,13 @@ The type of the metric.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 
@@ -225,7 +221,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?`, `limit?`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
 
 Query the metric values.
 
@@ -253,13 +249,13 @@ The inclusive time as the end of the metric entries.
 
 `string`
 
-The cursor to request the next page of entities.
+The cursor to request the next chunk of entities.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/telemetry-service",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Telemetry contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/telemetry-models": "0.0.2-next.1",
+		"@twin.org/telemetry-models": "0.0.2-next.3",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -38,5 +38,20 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"telemetry",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/telemetry/issues"
+	},
+	"homepage": "https://twindev.org"
 }