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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/telemetry-service",
-	"version": "0.0.2-next.2",
+	"version": "0.0.3-next.1",
 	"description": "Telemetry contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,25 +18,38 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/telemetry-models": "0.0.2-next.2",
+		"@twin.org/telemetry-models": "0.0.3-next.1",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"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"
 }

package/dist/cjs/index.cjs

@@ -1,582 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var telemetryModels = require('@twin.org/telemetry-models');
-var web = require('@twin.org/web');
-
-/**
- * The source used when communicating about these routes.
- */
-const ROUTES_SOURCE = "telemetryRoutes";
-/**
- * The tag to associate with the routes.
- */
-const tagsTelemetry = [
-    {
-        name: "Telemetry",
-        description: "Endpoints which are modelled to access a telemetry contract."
-    }
-];
-/**
- * The REST routes for telemetry.
- * @param baseRouteName Prefix to prepend to the paths.
- * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
- * @returns The generated routes.
- */
-function generateRestRoutesTelemetry(baseRouteName, componentName) {
-    const createMetricRoute = {
-        operationId: "telemetryCreateMetric",
-        summary: "Create a telemetry metric",
-        tag: tagsTelemetry[0].name,
-        method: "POST",
-        path: `${baseRouteName}/metric`,
-        handler: async (httpRequestContext, request) => telemetryCreateMetric(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryCreateMetricRequest",
-            examples: [
-                {
-                    id: "telemetryCreateMetricRequestExample",
-                    request: {
-                        body: {
-                            id: "my-counter",
-                            label: "My Counter",
-                            description: "This is my counter",
-                            type: telemetryModels.MetricType.Counter,
-                            unit: "KG"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "ICreatedResponse",
-                examples: [
-                    {
-                        id: "telemetryCreateMetricResponseExample",
-                        response: {
-                            statusCode: web.HttpStatusCode.created,
-                            headers: {
-                                [web.HeaderTypes.Location]: "my-counter"
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    };
-    const getMetricRoute = {
-        operationId: "telemetryGetMetric",
-        summary: "Get a telemetry metric and it's most recent value",
-        tag: tagsTelemetry[0].name,
-        method: "GET",
-        path: `${baseRouteName}/metric/:id`,
-        handler: async (httpRequestContext, request) => telemetryGetMetric(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryGetMetricRequest",
-            examples: [
-                {
-                    id: "telemetryGetMetricRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "ITelemetryGetMetricResponse",
-                examples: [
-                    {
-                        id: "telemetryGetMetricResponseExample",
-                        response: {
-                            body: {
-                                metric: {
-                                    id: "my-counter",
-                                    label: "My Counter",
-                                    description: "This is my counter",
-                                    type: telemetryModels.MetricType.Counter,
-                                    unit: "KG"
-                                },
-                                value: {
-                                    id: "aabbccdd11223445566",
-                                    ts: 1715252922273,
-                                    value: 10
-                                }
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    };
-    const updateMetricRoute = {
-        operationId: "telemetryUpdateMetric",
-        summary: "Update a telemetry metric",
-        tag: tagsTelemetry[0].name,
-        method: "PUT",
-        path: `${baseRouteName}/metric/:id`,
-        handler: async (httpRequestContext, request) => telemetryUpdateMetric(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryUpdateMetricRequest",
-            examples: [
-                {
-                    id: "telemetryUpdateMetricRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        },
-                        body: {
-                            label: "My New Label"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "INoContentResponse"
-            }
-        ]
-    };
-    const addMetricValueRoute = {
-        operationId: "telemetryAddMetricValue",
-        summary: "Add a telemetry metric value",
-        tag: tagsTelemetry[0].name,
-        method: "POST",
-        path: `${baseRouteName}/metric/:id/value`,
-        handler: async (httpRequestContext, request) => telemetryAddMetricValue(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryAddMetricValueRequest",
-            examples: [
-                {
-                    id: "telemetryAddMetricValueRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        },
-                        body: {
-                            value: 10
-                        }
-                    }
-                },
-                {
-                    id: "telemetryAddMetricValueIncRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        },
-                        body: {
-                            value: "inc"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "ICreatedResponse",
-                examples: [
-                    {
-                        id: "telemetryAddMetricValueResponseExample",
-                        response: {
-                            statusCode: web.HttpStatusCode.created,
-                            headers: {
-                                [web.HeaderTypes.Location]: "aabbccdd11223445566"
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    };
-    const removeMetricRoute = {
-        operationId: "telemetryRemoveMetric",
-        summary: "Remove a telemetry metric and it's values.",
-        tag: tagsTelemetry[0].name,
-        method: "DELETE",
-        path: `${baseRouteName}/metric/:id`,
-        handler: async (httpRequestContext, request) => telemetryRemoveMetric(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryRemoveMetricRequest",
-            examples: [
-                {
-                    id: "telemetryRemoveMetricRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "INoContentResponse"
-            }
-        ]
-    };
-    const listMetricsRoute = {
-        operationId: "telemetryListEntries",
-        summary: "Get a list of the telemetry metrics",
-        tag: tagsTelemetry[0].name,
-        method: "GET",
-        path: `${baseRouteName}/metric`,
-        handler: async (httpRequestContext, request) => telemetryMetricList(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryListRequest",
-            examples: [
-                {
-                    id: "telemetryListRequestExample",
-                    request: {
-                        query: {
-                            type: telemetryModels.MetricType.Counter
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "ITelemetryListResponse",
-                examples: [
-                    {
-                        id: "telemetryListResponseExample",
-                        response: {
-                            body: {
-                                entities: [
-                                    {
-                                        id: "my-counter",
-                                        label: "My Counter",
-                                        type: telemetryModels.MetricType.Counter,
-                                        unit: "KG"
-                                    },
-                                    {
-                                        id: "my-counter-2",
-                                        label: "My Counter 2",
-                                        type: telemetryModels.MetricType.IncDecCounter,
-                                        unit: "M"
-                                    }
-                                ],
-                                cursor: "1"
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    };
-    const listMetricsValuesRoute = {
-        operationId: "telemetryValuesListEntries",
-        summary: "Get a list of the values for a telemetry metric",
-        tag: tagsTelemetry[0].name,
-        method: "GET",
-        path: `${baseRouteName}/metric/:id/value`,
-        handler: async (httpRequestContext, request) => telemetryMetricValueList(httpRequestContext, componentName, request),
-        requestType: {
-            type: "ITelemetryValuesListRequest",
-            examples: [
-                {
-                    id: "telemetryValuesListRequestExample",
-                    request: {
-                        pathParams: {
-                            id: "my-counter"
-                        }
-                    }
-                }
-            ]
-        },
-        responseType: [
-            {
-                type: "ITelemetryValuesListResponse",
-                examples: [
-                    {
-                        id: "telemetryValuesListResponseExample",
-                        response: {
-                            body: {
-                                metric: {
-                                    id: "my-counter",
-                                    label: "My Counter",
-                                    type: telemetryModels.MetricType.Counter,
-                                    unit: "KG"
-                                },
-                                entities: [
-                                    {
-                                        id: "aabbccdd11223445566",
-                                        ts: 1715252922273,
-                                        value: 10
-                                    },
-                                    {
-                                        id: "aabbccdd11223445566",
-                                        ts: 1715252922274,
-                                        value: 11
-                                    }
-                                ],
-                                cursor: "1"
-                            }
-                        }
-                    }
-                ]
-            }
-        ]
-    };
-    return [
-        createMetricRoute,
-        getMetricRoute,
-        updateMetricRoute,
-        addMetricValueRoute,
-        removeMetricRoute,
-        listMetricsRoute,
-        listMetricsValuesRoute
-    ];
-}
-/**
- * Create a new telemetry metric.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryCreateMetric(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    const component = core.ComponentFactory.get(componentName);
-    await component.createMetric({
-        id: request.body.id,
-        label: request.body.label,
-        description: request.body.description,
-        type: request.body.type,
-        unit: request.body.unit
-    });
-    return {
-        statusCode: web.HttpStatusCode.created,
-        headers: {
-            [web.HeaderTypes.Location]: request.body.id
-        }
-    };
-}
-/**
- * Gets a telemetry metric.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryGetMetric(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    const component = core.ComponentFactory.get(componentName);
-    const result = await component.getMetric(request.pathParams.id);
-    return { body: result };
-}
-/**
- * Updates a telemetry metric.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryUpdateMetric(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    const component = core.ComponentFactory.get(componentName);
-    await component.updateMetric({
-        id: request.pathParams.id,
-        label: request.body.label,
-        description: request.body.description,
-        unit: request.body.unit
-    });
-    return { statusCode: web.HttpStatusCode.noContent };
-}
-/**
- * Add a telemetry metric value.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryAddMetricValue(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
-    const component = core.ComponentFactory.get(componentName);
-    const id = await component.addMetricValue(request.pathParams.id, request.body.value, request.body.customData);
-    return { statusCode: web.HttpStatusCode.created, headers: { [web.HeaderTypes.Location]: id } };
-}
-/**
- * Removes a telemetry metric.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryRemoveMetric(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    core.Guards.object(ROUTES_SOURCE, "request.pathParams", request.pathParams);
-    core.Guards.stringValue(ROUTES_SOURCE, "request.pathParams.id", request.pathParams.id);
-    const component = core.ComponentFactory.get(componentName);
-    await component.removeMetric(request.pathParams.id);
-    return {
-        statusCode: web.HttpStatusCode.noContent
-    };
-}
-/**
- * Get a list of the telemetry metrics.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-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));
-    return {
-        body: itemsAndCursor
-    };
-}
-/**
- * Get a list of the telemetry metric values.
- * @param httpRequestContext The request context for the API.
- * @param componentName The name of the component to use in the routes.
- * @param request The request.
- * @returns The response object with additional http response properties.
- */
-async function telemetryMetricValueList(httpRequestContext, componentName, request) {
-    core.Guards.object(ROUTES_SOURCE, "request", request);
-    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));
-    return {
-        body: itemsAndCursor
-    };
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing telemetry operations to a connector.
- */
-class TelemetryService {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "TelemetryService";
-    /**
-     * Telemetry connector used by the service.
-     * @internal
-     */
-    _telemetryConnector;
-    /**
-     * Create a new instance of TelemetryService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._telemetryConnector = telemetryModels.TelemetryConnectorFactory.get(options?.telemetryConnectorType ?? "telemetry");
-    }
-    /**
-     * Create a new metric.
-     * @param metric The metric details.
-     * @returns Nothing.
-     */
-    async createMetric(metric) {
-        core.Guards.object(this.CLASS_NAME, "metric", metric);
-        await this._telemetryConnector.createMetric(metric);
-    }
-    /**
-     * Get the metric details and it's most recent value.
-     * @param id The metric id.
-     * @returns The metric details and it's most recent value.
-     */
-    async getMetric(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        return this._telemetryConnector.getMetric(id);
-    }
-    /**
-     * Update metric.
-     * @param metric The metric details.
-     * @returns Nothing.
-     */
-    async updateMetric(metric) {
-        core.Guards.object(this.CLASS_NAME, "metric", metric);
-        core.Guards.stringValue(this.CLASS_NAME, "metric.id", metric.id);
-        return this._telemetryConnector.updateMetric(metric);
-    }
-    /**
-     * Add a metric value.
-     * @param id The id of the metric.
-     * @param value The value for the add operation.
-     * @param customData The custom data for the add operation.
-     * @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);
-        return this._telemetryConnector.addMetricValue(id, value, customData);
-    }
-    /**
-     * Remove metric.
-     * @param id The id of the metric.
-     * @returns Nothing.
-     */
-    async removeMetric(id) {
-        core.Guards.stringValue(this.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.
-     * @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);
-    }
-    /**
-     * 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.
-     * @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);
-    }
-}
-
-const restEntryPoints = [
-    {
-        name: "telemetry",
-        defaultBaseRoute: "telemetry",
-        tags: tagsTelemetry,
-        generateRoutes: generateRestRoutesTelemetry
-    }
-];
-
-exports.TelemetryService = TelemetryService;
-exports.generateRestRoutesTelemetry = generateRestRoutesTelemetry;
-exports.restEntryPoints = restEntryPoints;
-exports.tagsTelemetry = tagsTelemetry;
-exports.telemetryAddMetricValue = telemetryAddMetricValue;
-exports.telemetryCreateMetric = telemetryCreateMetric;
-exports.telemetryGetMetric = telemetryGetMetric;
-exports.telemetryMetricList = telemetryMetricList;
-exports.telemetryMetricValueList = telemetryMetricValueList;
-exports.telemetryRemoveMetric = telemetryRemoveMetric;
-exports.telemetryUpdateMetric = telemetryUpdateMetric;