@twin.org/telemetry-service 0.0.1-next.3

package/dist/types/telemetryService.d.ts

@@ -0,0 +1,99 @@
+import { type ITelemetryComponent, type ITelemetryMetric, type ITelemetryMetricValue, type MetricType } from "@twin.org/telemetry-models";
+/**
+ * Service for performing telemetry operations to a connector.
+ */
+export declare class TelemetryService implements ITelemetryComponent {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TelemetryService.
+     * @param options The options for the connector.
+     * @param options.telemetryConnectorType The type of the telemetry connector to use, defaults to "telemetry".
+     */
+    constructor(options?: {
+        telemetryConnectorType?: string;
+    });
+    /**
+     * Create a new metric.
+     * @param metric The metric details.
+     * @returns Nothing.
+     */
+    createMetric(metric: ITelemetryMetric): Promise<void>;
+    /**
+     * 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.
+     */
+    getMetric(id: string): Promise<{
+        metric: ITelemetryMetric;
+        value: ITelemetryMetricValue;
+    }>;
+    /**
+     * Update metric.
+     * @param metric The metric details.
+     * @returns Nothing.
+     */
+    updateMetric(metric: Omit<ITelemetryMetric, "type">): Promise<void>;
+    /**
+     * 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.
+     */
+    addMetricValue(id: string, value: "inc" | "dec" | number, customData?: {
+        [key: string]: unknown;
+    }): Promise<string>;
+    /**
+     * Remove metric.
+     * @param id The id of the metric.
+     * @returns Nothing.
+     */
+    removeMetric(id: string): Promise<void>;
+    /**
+     * 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.
+     */
+    query(type?: MetricType, cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The metrics.
+         */
+        entities: ITelemetryMetric[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more values.
+         */
+        cursor?: string;
+    }>;
+    /**
+     * 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.
+     */
+    queryValues(id: string, timeStart?: number, timeEnd?: number, cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The metric details.
+         */
+        metric: ITelemetryMetric;
+        /**
+         * The values for the metric.
+         */
+        entities: ITelemetryMetricValue[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more values.
+         */
+        cursor?: string;
+    }>;
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/telemetry-service - Changelog
+
+## v0.0.1-next.3
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/telemetry-service - Examples