@3sixty/telemetry-models 0.0.0-stage → 0.20.0-next.0

package/dist/es/helpers/metricHelper.js

@@ -0,0 +1,139 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { AlreadyExistsError, BaseError, Is } from "@3sixty/core";
+import { MetricCounterOperation } from "../models/metricCounterOperation.js";
+/**
+ * Helper class for performing common metric operations, swallowing any errors from the telemetry component.
+ */
+export class MetricHelper {
+    /**
+     * Create multiple metrics if they don't already exist, swallowing any already exists errors.
+     * A convenience wrapper over createMetric for callers that always have a list.
+     * @param telemetryComponent The telemetry component to use for creating the metrics.
+     * @param metrics The telemetry metrics to create.
+     * @returns A promise that resolves when all metrics have been created or confirmed to exist.
+     */
+    static async createMetrics(telemetryComponent, metrics) {
+        if (Is.arrayValue(metrics)) {
+            await MetricHelper.createMetric(telemetryComponent, metrics);
+        }
+    }
+    /**
+     * Create one or more metrics if they don't already exist, swallowing any already exists errors.
+     * @param telemetryComponent The telemetry component to use for creating the metrics.
+     * @param metric The telemetry metric to create, or the metrics to create.
+     * @returns A promise that resolves when the metrics have been created or confirmed to exist.
+     */
+    static async createMetric(telemetryComponent, metric) {
+        if (!Is.undefined(telemetryComponent)) {
+            try {
+                await telemetryComponent.createMetric(metric);
+            }
+            catch (err) {
+                // If the metric already exists, we can ignore the error. Otherwise, rethrow it.
+                if (!BaseError.isErrorName(err, AlreadyExistsError.CLASS_NAME)) {
+                    throw err;
+                }
+            }
+        }
+    }
+    /**
+     * Increment a metric counter, swallowing any telemetry errors.
+     * @param telemetryComponent The telemetry component to use for incrementing the metric.
+     * @param id The metric ID.
+     * @param customData Optional custom data for the increment.
+     * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.
+     * @returns A promise that resolves when the increment has been recorded or the error swallowed.
+     */
+    static async metricIncrement(telemetryComponent, id, customData, onError) {
+        if (!Is.undefined(telemetryComponent)) {
+            try {
+                await telemetryComponent.addMetricValue(id, MetricCounterOperation.Increment, customData);
+            }
+            catch (err) {
+                // This method is designed to swallow any errors from the telemetry component
+                // So it can safely be called without interrupting any external flows.
+                await MetricHelper.notifyError(onError, err);
+            }
+        }
+    }
+    /**
+     * Decrement a metric counter, swallowing any telemetry errors.
+     * @param telemetryComponent The telemetry component to use for decrementing the metric.
+     * @param id The metric ID.
+     * @param customData Optional custom data for the decrement.
+     * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.
+     * @returns A promise that resolves when the decrement has been recorded or the error swallowed.
+     */
+    static async metricDecrement(telemetryComponent, id, customData, onError) {
+        if (!Is.undefined(telemetryComponent)) {
+            try {
+                await telemetryComponent.addMetricValue(id, MetricCounterOperation.Decrement, customData);
+            }
+            catch (err) {
+                // This method is designed to swallow any errors from the telemetry component
+                // So it can safely be called without interrupting any external flows.
+                await MetricHelper.notifyError(onError, err);
+            }
+        }
+    }
+    /**
+     * Set a metric value, swallowing any telemetry errors.
+     * @param telemetryComponent The telemetry component to use for setting the metric value.
+     * @param id The metric ID.
+     * @param value The metric value to set.
+     * @param customData Optional custom data for setting the value.
+     * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.
+     * @returns A promise that resolves when the value has been recorded or the error swallowed.
+     */
+    static async metricValue(telemetryComponent, id, value, customData, onError) {
+        if (!Is.undefined(telemetryComponent)) {
+            try {
+                await telemetryComponent.addMetricValue(id, value, customData);
+            }
+            catch (err) {
+                // This method is designed to swallow any errors from the telemetry component
+                // So it can safely be called without interrupting any external flows.
+                await MetricHelper.notifyError(onError, err);
+            }
+        }
+    }
+    /**
+     * Set several metric values at once, swallowing any telemetry errors.
+     * Components which support it record the whole set in one operation, which for a persisted
+     * connector is a single write rather than one per value.
+     * @param telemetryComponent The telemetry component to use for setting the metric values.
+     * @param values The metric values to set.
+     * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.
+     * @returns A promise that resolves when the values have been recorded or the error swallowed.
+     */
+    static async metricValues(telemetryComponent, values, onError) {
+        if (!Is.undefined(telemetryComponent) && Is.arrayValue(values)) {
+            try {
+                await telemetryComponent.addMetricValues(values);
+            }
+            catch (err) {
+                // This method is designed to swallow any errors from the telemetry component
+                // So it can safely be called without interrupting any external flows.
+                await MetricHelper.notifyError(onError, err);
+            }
+        }
+    }
+    /**
+     * Invoke the caller's error callback, swallowing anything it throws so a broken callback can
+     * never break the never-interrupt contract of the calling method.
+     * @param onError The optional callback to invoke.
+     * @param err The error to pass to the callback.
+     * @returns A promise that resolves once the callback has run or failed.
+     * @internal
+     */
+    static async notifyError(onError, err) {
+        try {
+            await onError?.(err);
+        }
+        catch {
+            // The onError callback must never be able to break the swallow contract above.
+        }
+    }
+}
+//# sourceMappingURL=metricHelper.js.map

package/dist/es/helpers/metricHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricHelper.js","sourceRoot":"","sources":["../../../src/helpers/metricHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,kBAAkB,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAIjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;GAEG;AACH,MAAM,OAAO,YAAY;IACxB;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAChC,kBAAmD,EACnD,OAA2B;QAE3B,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,MAAM,YAAY,CAAC,YAAY,CAAC,kBAAkB,EAAE,OAAO,CAAC,CAAC;QAC9D,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAC/B,kBAAmD,EACnD,MAA6C;QAE7C,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC;gBACJ,MAAM,kBAAkB,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YAC/C,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,gFAAgF;gBAChF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,kBAAkB,CAAC,UAAU,CAAC,EAAE,CAAC;oBAChE,MAAM,GAAG,CAAC;gBACX,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAClC,kBAAmD,EACnD,EAAU,EACV,UAAuC,EACvC,OAAgD;QAEhD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC;gBACJ,MAAM,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,sBAAsB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC3F,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,6EAA6E;gBAC7E,sEAAsE;gBACtE,MAAM,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC9C,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,eAAe,CAClC,kBAAmD,EACnD,EAAU,EACV,UAAuC,EACvC,OAAgD;QAEhD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC;gBACJ,MAAM,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,sBAAsB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC3F,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,6EAA6E;gBAC7E,sEAAsE;gBACtE,MAAM,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC9C,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,kBAAmD,EACnD,EAAU,EACV,KAAa,EACb,UAAuC,EACvC,OAAgD;QAEhD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACvC,IAAI,CAAC;gBACJ,MAAM,kBAAkB,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,6EAA6E;gBAC7E,sEAAsE;gBACtE,MAAM,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC9C,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAC/B,kBAAmD,EACnD,MAAoC,EACpC,OAAgD;QAEhD,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAChE,IAAI,CAAC;gBACJ,MAAM,kBAAkB,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YAClD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,6EAA6E;gBAC7E,sEAAsE;gBACtE,MAAM,YAAY,CAAC,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;YAC9C,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,KAAK,CAAC,WAAW,CAC/B,OAA6D,EAC7D,GAAY;QAEZ,IAAI,CAAC;YACJ,MAAM,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;QAAC,MAAM,CAAC;YACR,+EAA+E;QAChF,CAAC;IACF,CAAC;CACD","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { AlreadyExistsError, BaseError, Is } from \"@3sixty/core\";\nimport type { ITelemetryComponent } from \"../models/ITelemetryComponent.js\";\nimport type { ITelemetryMetric } from \"../models/ITelemetryMetric.js\";\nimport type { ITelemetryMetricValueEntry } from \"../models/ITelemetryMetricValueEntry.js\";\nimport { MetricCounterOperation } from \"../models/metricCounterOperation.js\";\n\n/**\n * Helper class for performing common metric operations, swallowing any errors from the telemetry component.\n */\nexport class MetricHelper {\n\t/**\n\t * Create multiple metrics if they don't already exist, swallowing any already exists errors.\n\t * A convenience wrapper over createMetric for callers that always have a list.\n\t * @param telemetryComponent The telemetry component to use for creating the metrics.\n\t * @param metrics The telemetry metrics to create.\n\t * @returns A promise that resolves when all metrics have been created or confirmed to exist.\n\t */\n\tpublic static async createMetrics(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tmetrics: ITelemetryMetric[]\n\t): Promise<void> {\n\t\tif (Is.arrayValue(metrics)) {\n\t\t\tawait MetricHelper.createMetric(telemetryComponent, metrics);\n\t\t}\n\t}\n\n\t/**\n\t * Create one or more metrics if they don't already exist, swallowing any already exists errors.\n\t * @param telemetryComponent The telemetry component to use for creating the metrics.\n\t * @param metric The telemetry metric to create, or the metrics to create.\n\t * @returns A promise that resolves when the metrics have been created or confirmed to exist.\n\t */\n\tpublic static async createMetric(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tmetric: ITelemetryMetric | ITelemetryMetric[]\n\t): Promise<void> {\n\t\tif (!Is.undefined(telemetryComponent)) {\n\t\t\ttry {\n\t\t\t\tawait telemetryComponent.createMetric(metric);\n\t\t\t} catch (err) {\n\t\t\t\t// If the metric already exists, we can ignore the error. Otherwise, rethrow it.\n\t\t\t\tif (!BaseError.isErrorName(err, AlreadyExistsError.CLASS_NAME)) {\n\t\t\t\t\tthrow err;\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Increment a metric counter, swallowing any telemetry errors.\n\t * @param telemetryComponent The telemetry component to use for incrementing the metric.\n\t * @param id The metric ID.\n\t * @param customData Optional custom data for the increment.\n\t * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.\n\t * @returns A promise that resolves when the increment has been recorded or the error swallowed.\n\t */\n\tpublic static async metricIncrement(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tid: string,\n\t\tcustomData?: { [key: string]: unknown },\n\t\tonError?: (err: unknown) => Promise<void> | void\n\t): Promise<void> {\n\t\tif (!Is.undefined(telemetryComponent)) {\n\t\t\ttry {\n\t\t\t\tawait telemetryComponent.addMetricValue(id, MetricCounterOperation.Increment, customData);\n\t\t\t} catch (err) {\n\t\t\t\t// This method is designed to swallow any errors from the telemetry component\n\t\t\t\t// So it can safely be called without interrupting any external flows.\n\t\t\t\tawait MetricHelper.notifyError(onError, err);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Decrement a metric counter, swallowing any telemetry errors.\n\t * @param telemetryComponent The telemetry component to use for decrementing the metric.\n\t * @param id The metric ID.\n\t * @param customData Optional custom data for the decrement.\n\t * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.\n\t * @returns A promise that resolves when the decrement has been recorded or the error swallowed.\n\t */\n\tpublic static async metricDecrement(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tid: string,\n\t\tcustomData?: { [key: string]: unknown },\n\t\tonError?: (err: unknown) => Promise<void> | void\n\t): Promise<void> {\n\t\tif (!Is.undefined(telemetryComponent)) {\n\t\t\ttry {\n\t\t\t\tawait telemetryComponent.addMetricValue(id, MetricCounterOperation.Decrement, customData);\n\t\t\t} catch (err) {\n\t\t\t\t// This method is designed to swallow any errors from the telemetry component\n\t\t\t\t// So it can safely be called without interrupting any external flows.\n\t\t\t\tawait MetricHelper.notifyError(onError, err);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Set a metric value, swallowing any telemetry errors.\n\t * @param telemetryComponent The telemetry component to use for setting the metric value.\n\t * @param id The metric ID.\n\t * @param value The metric value to set.\n\t * @param customData Optional custom data for setting the value.\n\t * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.\n\t * @returns A promise that resolves when the value has been recorded or the error swallowed.\n\t */\n\tpublic static async metricValue(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tid: string,\n\t\tvalue: number,\n\t\tcustomData?: { [key: string]: unknown },\n\t\tonError?: (err: unknown) => Promise<void> | void\n\t): Promise<void> {\n\t\tif (!Is.undefined(telemetryComponent)) {\n\t\t\ttry {\n\t\t\t\tawait telemetryComponent.addMetricValue(id, value, customData);\n\t\t\t} catch (err) {\n\t\t\t\t// This method is designed to swallow any errors from the telemetry component\n\t\t\t\t// So it can safely be called without interrupting any external flows.\n\t\t\t\tawait MetricHelper.notifyError(onError, err);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Set several metric values at once, swallowing any telemetry errors.\n\t * Components which support it record the whole set in one operation, which for a persisted\n\t * connector is a single write rather than one per value.\n\t * @param telemetryComponent The telemetry component to use for setting the metric values.\n\t * @param values The metric values to set.\n\t * @param onError Optional callback invoked with the swallowed error, for callers that want visibility.\n\t * @returns A promise that resolves when the values have been recorded or the error swallowed.\n\t */\n\tpublic static async metricValues(\n\t\ttelemetryComponent: ITelemetryComponent | undefined,\n\t\tvalues: ITelemetryMetricValueEntry[],\n\t\tonError?: (err: unknown) => Promise<void> | void\n\t): Promise<void> {\n\t\tif (!Is.undefined(telemetryComponent) && Is.arrayValue(values)) {\n\t\t\ttry {\n\t\t\t\tawait telemetryComponent.addMetricValues(values);\n\t\t\t} catch (err) {\n\t\t\t\t// This method is designed to swallow any errors from the telemetry component\n\t\t\t\t// So it can safely be called without interrupting any external flows.\n\t\t\t\tawait MetricHelper.notifyError(onError, err);\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Invoke the caller's error callback, swallowing anything it throws so a broken callback can\n\t * never break the never-interrupt contract of the calling method.\n\t * @param onError The optional callback to invoke.\n\t * @param err The error to pass to the callback.\n\t * @returns A promise that resolves once the callback has run or failed.\n\t * @internal\n\t */\n\tprivate static async notifyError(\n\t\tonError: ((err: unknown) => Promise<void> | void) | undefined,\n\t\terr: unknown\n\t): Promise<void> {\n\t\ttry {\n\t\t\tawait onError?.(err);\n\t\t} catch {\n\t\t\t// The onError callback must never be able to break the swallow contract above.\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,30 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./connectors/multiTelemetryConnector.js";
+export * from "./connectors/silentTelemetryConnector.js";
+export * from "./factories/metricsProducerFactory.js";
+export * from "./factories/telemetryConnectorFactory.js";
+export * from "./helpers/metricHelper.js";
+export * from "./models/api/ITelemetryAddMetricValueRequest.js";
+export * from "./models/api/ITelemetryCreateMetricRequest.js";
+export * from "./models/api/ITelemetryGetMetricRequest.js";
+export * from "./models/api/ITelemetryGetMetricResponse.js";
+export * from "./models/api/ITelemetryGetMetricValueRequest.js";
+export * from "./models/api/ITelemetryGetMetricValueResponse.js";
+export * from "./models/api/ITelemetryListRequest.js";
+export * from "./models/api/ITelemetryListResponse.js";
+export * from "./models/api/ITelemetryRemoveMetricRequest.js";
+export * from "./models/api/ITelemetryUpdateMetricRequest.js";
+export * from "./models/api/ITelemetryValuesListRequest.js";
+export * from "./models/api/ITelemetryValuesListResponse.js";
+export * from "./models/IMetricsCollectorComponent.js";
+export * from "./models/IMetricsProducer.js";
+export * from "./models/IMultiTelemetryConnectorConstructorOptions.js";
+export * from "./models/ITelemetryComponent.js";
+export * from "./models/ITelemetryConnector.js";
+export * from "./models/ITelemetryMetric.js";
+export * from "./models/ITelemetryMetricValue.js";
+export * from "./models/ITelemetryMetricValueEntry.js";
+export * from "./models/metricCounterOperation.js";
+export * from "./models/metricType.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,uCAAuC,CAAC;AACtD,cAAc,0CAA0C,CAAC;AACzD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,4CAA4C,CAAC;AAC3D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,uCAAuC,CAAC;AACtD,cAAc,wCAAwC,CAAC;AACvD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,wCAAwC,CAAC;AACvD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wDAAwD,CAAC;AACvE,cAAc,iCAAiC,CAAC;AAChD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./connectors/multiTelemetryConnector.js\";\nexport * from \"./connectors/silentTelemetryConnector.js\";\nexport * from \"./factories/metricsProducerFactory.js\";\nexport * from \"./factories/telemetryConnectorFactory.js\";\nexport * from \"./helpers/metricHelper.js\";\nexport * from \"./models/api/ITelemetryAddMetricValueRequest.js\";\nexport * from \"./models/api/ITelemetryCreateMetricRequest.js\";\nexport * from \"./models/api/ITelemetryGetMetricRequest.js\";\nexport * from \"./models/api/ITelemetryGetMetricResponse.js\";\nexport * from \"./models/api/ITelemetryGetMetricValueRequest.js\";\nexport * from \"./models/api/ITelemetryGetMetricValueResponse.js\";\nexport * from \"./models/api/ITelemetryListRequest.js\";\nexport * from \"./models/api/ITelemetryListResponse.js\";\nexport * from \"./models/api/ITelemetryRemoveMetricRequest.js\";\nexport * from \"./models/api/ITelemetryUpdateMetricRequest.js\";\nexport * from \"./models/api/ITelemetryValuesListRequest.js\";\nexport * from \"./models/api/ITelemetryValuesListResponse.js\";\nexport * from \"./models/IMetricsCollectorComponent.js\";\nexport * from \"./models/IMetricsProducer.js\";\nexport * from \"./models/IMultiTelemetryConnectorConstructorOptions.js\";\nexport * from \"./models/ITelemetryComponent.js\";\nexport * from \"./models/ITelemetryConnector.js\";\nexport * from \"./models/ITelemetryMetric.js\";\nexport * from \"./models/ITelemetryMetricValue.js\";\nexport * from \"./models/ITelemetryMetricValueEntry.js\";\nexport * from \"./models/metricCounterOperation.js\";\nexport * from \"./models/metricType.js\";\n"]}

package/dist/es/models/IMetricsCollectorComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMetricsCollectorComponent.js.map

package/dist/es/models/IMetricsCollectorComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMetricsCollectorComponent.js","sourceRoot":"","sources":["../../../src/models/IMetricsCollectorComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Contract for a metrics collector component.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IMetricsCollectorComponent extends IComponent {}\n"]}

package/dist/es/models/IMetricsProducer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMetricsProducer.js.map

package/dist/es/models/IMetricsProducer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMetricsProducer.js","sourceRoot":"","sources":["../../../src/models/IMetricsProducer.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { ITelemetryMetricValueEntry } from \"./ITelemetryMetricValueEntry.js\";\n\n/**\n * Contract for a metrics producer.\n *\n * A producer declares its metrics with `register()` once and pushes current\n * values with `collect()` on every poll cycle. Producers are discovered via\n * `MetricsProducerFactory` and orchestrated by a `MetricsCollectorService`.\n *\n * Producers are factory-only entries - they are not lifecycle components of\n * the engine. The orchestrating service owns the polling timer.\n */\nexport interface IMetricsProducer extends IComponent {\n\t/**\n\t * Register every metric this producer emits with the telemetry component.\n\t * Called once when the orchestrating service starts.\n\t * @returns A promise that resolves when all metrics have been registered.\n\t */\n\tregister(): Promise<void>;\n\n\t/**\n\t * Read the current values for every metric this producer emits.\n\t * Called on every poll cycle. The values are returned rather than recorded, so the\n\t * orchestrating service can record a whole cycle in one operation.\n\t * @returns The current values for this producer's metrics.\n\t */\n\tcollect(): Promise<ITelemetryMetricValueEntry[]>;\n}\n"]}

package/dist/es/models/IMultiTelemetryConnectorConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMultiTelemetryConnectorConstructorOptions.js.map

package/dist/es/models/IMultiTelemetryConnectorConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IMultiTelemetryConnectorConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IMultiTelemetryConnectorConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The options for the multi telemetry connector constructor.\n */\nexport interface IMultiTelemetryConnectorConstructorOptions {\n\t/**\n\t * The telemetry connector types to multiplex.\n\t */\n\ttelemetryConnectorTypes: string[];\n}\n"]}

package/dist/es/models/ITelemetryComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryComponent.js.map

package/dist/es/models/ITelemetryComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryComponent.js","sourceRoot":"","sources":["../../../src/models/ITelemetryComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { ITelemetryMetric } from \"./ITelemetryMetric.js\";\nimport type { ITelemetryMetricValue } from \"./ITelemetryMetricValue.js\";\nimport type { ITelemetryMetricValueEntry } from \"./ITelemetryMetricValueEntry.js\";\nimport type { MetricCounterOperation } from \"./metricCounterOperation.js\";\nimport type { MetricType } from \"./metricType.js\";\n\n/**\n * Interface describing a telemetry component contract.\n */\nexport interface ITelemetryComponent extends IComponent {\n\t/**\n\t * Create one or more metrics.\n\t * A single metric fails if it already exists; an array declares the set that should exist,\n\t * creating the ones that are missing and leaving the rest untouched, so implementations\n\t * which persist the definitions can resolve the whole set in one operation.\n\t * @param metric The metric details, or the details of several metrics.\n\t * @returns A promise that resolves when the metrics have been created.\n\t */\n\tcreateMetric(metric: ITelemetryMetric | ITelemetryMetric[]): Promise<void>;\n\n\t/**\n\t * Get the metric details and it's most recent value.\n\t * @param id The metric id.\n\t * @returns The metric details and it's most recent value.\n\t */\n\tgetMetric(id: string): Promise<{\n\t\tmetric: ITelemetryMetric;\n\t\tvalue?: ITelemetryMetricValue;\n\t}>;\n\n\t/**\n\t * Get a specific metric value by its id.\n\t * @param id The id of the metric.\n\t * @param valueId The id of the metric value.\n\t * @returns The metric value.\n\t */\n\tgetMetricValue(id: string, valueId: string): Promise<ITelemetryMetricValue>;\n\n\t/**\n\t * Update metric.\n\t * @param metric The metric details.\n\t * @returns A promise that resolves when the metric has been updated.\n\t */\n\tupdateMetric(metric: Omit<ITelemetryMetric, \"type\">): Promise<void>;\n\n\t/**\n\t * Add a metric value.\n\t * @param id The id of the metric.\n\t * @param value The value for the add operation.\n\t * @param customData The custom data for the add operation.\n\t * @returns The created metric value id.\n\t */\n\taddMetricValue(\n\t\tid: string,\n\t\tvalue: MetricCounterOperation | number,\n\t\tcustomData?: { [key: string]: unknown }\n\t): Promise<string>;\n\n\t/**\n\t * Add multiple metric values, so implementations which persist them can do so in one\n\t * operation instead of one per value.\n\t * @param values The metric values to add.\n\t * @returns The created metric value ids, in the order the values were supplied.\n\t */\n\taddMetricValues(values: ITelemetryMetricValueEntry[]): Promise<string[]>;\n\n\t/**\n\t * Remove metric.\n\t * @param id The id of the metric.\n\t * @returns A promise that resolves when the metric and all its values have been removed.\n\t */\n\tremoveMetric(id: string): Promise<void>;\n\n\t/**\n\t * Query the metrics.\n\t * @param type The type of the metric.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tquery(\n\t\ttype?: MetricType,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The metrics.\n\t\t */\n\t\tentities: ITelemetryMetric[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more values.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Query the metric values.\n\t * @param id The id of the metric.\n\t * @param timeStart The inclusive time as the start of the metric entries.\n\t * @param timeEnd The inclusive time as the end of the metric entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryValues(\n\t\tid: string,\n\t\ttimeStart?: number,\n\t\ttimeEnd?: number,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The metric details.\n\t\t */\n\t\tmetric: ITelemetryMetric;\n\n\t\t/**\n\t\t * The values for the metric.\n\t\t */\n\t\tentities: ITelemetryMetricValue[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more values.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/ITelemetryConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryConnector.js.map

package/dist/es/models/ITelemetryConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryConnector.js","sourceRoot":"","sources":["../../../src/models/ITelemetryConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\nimport type { ITelemetryMetric } from \"./ITelemetryMetric.js\";\nimport type { ITelemetryMetricValue } from \"./ITelemetryMetricValue.js\";\nimport type { ITelemetryMetricValueEntry } from \"./ITelemetryMetricValueEntry.js\";\nimport type { MetricCounterOperation } from \"./metricCounterOperation.js\";\nimport type { MetricType } from \"./metricType.js\";\n\n/**\n * Interface describing a telemetry connector.\n */\nexport interface ITelemetryConnector extends IComponent {\n\t/**\n\t * Create one or more metrics.\n\t * A single metric fails if it already exists; an array declares the set that should exist,\n\t * creating the ones that are missing and leaving the rest untouched, so implementations\n\t * which persist the definitions can resolve the whole set in one operation.\n\t * @param metric The metric details, or the details of several metrics.\n\t * @returns A promise that resolves when the metrics have been created.\n\t */\n\tcreateMetric(metric: ITelemetryMetric | ITelemetryMetric[]): Promise<void>;\n\n\t/**\n\t * Get the metric details and it's most recent value.\n\t * @param id The metric id.\n\t * @returns The metric details and it's most recent value.\n\t */\n\tgetMetric?(id: string): Promise<{\n\t\tmetric: ITelemetryMetric;\n\t\tvalue?: ITelemetryMetricValue;\n\t}>;\n\n\t/**\n\t * Get a specific metric value by its id.\n\t * @param id The id of the metric.\n\t * @param valueId The id of the metric value.\n\t * @returns The metric value.\n\t */\n\tgetMetricValue?(id: string, valueId: string): Promise<ITelemetryMetricValue>;\n\n\t/**\n\t * Update metric.\n\t * @param metric The metric details.\n\t * @returns A promise that resolves when the metric has been updated.\n\t */\n\tupdateMetric(metric: Omit<ITelemetryMetric, \"type\">): Promise<void>;\n\n\t/**\n\t * Update metric value.\n\t * @param id The id of the metric.\n\t * @param value The value for the update operation.\n\t * @param customData The custom data for the update operation.\n\t * @returns The created metric value id.\n\t */\n\taddMetricValue(\n\t\tid: string,\n\t\tvalue: MetricCounterOperation | number,\n\t\tcustomData?: { [key: string]: unknown }\n\t): Promise<string>;\n\n\t/**\n\t * Add multiple metric values, so implementations which persist them can do so in one\n\t * operation instead of one per value.\n\t * @param values The metric values to add.\n\t * @returns The created metric value ids, in the order the values were supplied.\n\t */\n\taddMetricValues(values: ITelemetryMetricValueEntry[]): Promise<string[]>;\n\n\t/**\n\t * Remove metric.\n\t * @param id The id of the metric.\n\t * @returns A promise that resolves when the metric and all its values have been removed.\n\t */\n\tremoveMetric(id: string): Promise<void>;\n\n\t/**\n\t * Query the metrics.\n\t * @param type The type of the metric.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tquery?(\n\t\ttype?: MetricType,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The metrics.\n\t\t */\n\t\tentities: ITelemetryMetric[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more values.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Query the metric values.\n\t * @param id The id of the metric.\n\t * @param timeStart The inclusive time as the start of the metric entries.\n\t * @param timeEnd The inclusive time as the end of the metric entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t * @throws NotImplementedError if the implementation does not support retrieval.\n\t */\n\tqueryValues?(\n\t\tid: string,\n\t\ttimeStart?: number,\n\t\ttimeEnd?: number,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The metric details.\n\t\t */\n\t\tmetric: ITelemetryMetric;\n\n\t\t/**\n\t\t * The values for the metric.\n\t\t */\n\t\tentities: ITelemetryMetricValue[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more values.\n\t\t */\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/ITelemetryMetric.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryMetric.js.map

package/dist/es/models/ITelemetryMetric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryMetric.js","sourceRoot":"","sources":["../../../src/models/ITelemetryMetric.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { MetricType } from \"./metricType.js\";\n\n/**\n * Interface describing a telemetry metric.\n */\nexport interface ITelemetryMetric {\n\t/**\n\t * The id of the metric.\n\t */\n\tid: string;\n\n\t/**\n\t * The label of the metric.\n\t */\n\tlabel: string;\n\n\t/**\n\t * The type of the metric.\n\t */\n\ttype: MetricType;\n\n\t/**\n\t * Description.\n\t */\n\tdescription?: string;\n\n\t/**\n\t * The unit the metric describes.\n\t */\n\tunit?: string;\n\n\t/**\n\t * The maximum number of values to retain; oldest are trimmed on each addMetricValue call.\n\t * Unlimited when absent.\n\t */\n\tmaxHistory?: number;\n}\n"]}

package/dist/es/models/ITelemetryMetricValue.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryMetricValue.js.map

package/dist/es/models/ITelemetryMetricValue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryMetricValue.js","sourceRoot":"","sources":["../../../src/models/ITelemetryMetricValue.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing a telemetry metric value.\n */\nexport interface ITelemetryMetricValue {\n\t/**\n\t * The id of the metric value.\n\t */\n\tid: string;\n\n\t/**\n\t * The timestamp of the metric.\n\t */\n\tts: number;\n\n\t/**\n\t * The value of the metric.\n\t */\n\tvalue: number;\n\n\t/**\n\t * The custom data for the metric value.\n\t */\n\tcustomData?: { [key: string]: unknown };\n}\n"]}

package/dist/es/models/ITelemetryMetricValueEntry.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryMetricValueEntry.js.map

package/dist/es/models/ITelemetryMetricValueEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryMetricValueEntry.js","sourceRoot":"","sources":["../../../src/models/ITelemetryMetricValueEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { MetricCounterOperation } from \"./metricCounterOperation.js\";\n\n/**\n * A single metric value in a batch add operation.\n */\nexport interface ITelemetryMetricValueEntry {\n\t/**\n\t * The id of the metric.\n\t */\n\tid: string;\n\n\t/**\n\t * The value for the add operation.\n\t */\n\tvalue: MetricCounterOperation | number;\n\n\t/**\n\t * The custom data for the metric value.\n\t */\n\tcustomData?: { [key: string]: unknown };\n}\n"]}

package/dist/es/models/api/ITelemetryAddMetricValueRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryAddMetricValueRequest.js.map

package/dist/es/models/api/ITelemetryAddMetricValueRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryAddMetricValueRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryAddMetricValueRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { MetricCounterOperation } from \"../metricCounterOperation.js\";\n\n/**\n * Add a telemetry metric value.\n */\nexport interface ITelemetryAddMetricValueRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The data to be used in the update.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The value for the update operation.\n\t\t */\n\t\tvalue: MetricCounterOperation | number;\n\n\t\t/**\n\t\t * The custom data for the update operation.\n\t\t */\n\t\tcustomData?: { [key: string]: unknown };\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryCreateMetricRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryCreateMetricRequest.js.map

package/dist/es/models/api/ITelemetryCreateMetricRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryCreateMetricRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryCreateMetricRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITelemetryMetric } from \"../ITelemetryMetric.js\";\n\n/**\n * Create one or more telemetry metrics.\n */\nexport interface ITelemetryCreateMetricRequest {\n\t/**\n\t * The data to be used in the create. A single metric fails if it already exists; an array\n\t * declares the set that should exist, creating the ones that are missing.\n\t */\n\tbody: ITelemetryMetric | ITelemetryMetric[];\n}\n"]}

package/dist/es/models/api/ITelemetryGetMetricRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryGetMetricRequest.js.map

package/dist/es/models/api/ITelemetryGetMetricRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryGetMetricRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryGetMetricRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get a telemetry metric.\n */\nexport interface ITelemetryGetMetricRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryGetMetricResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryGetMetricResponse.js.map

package/dist/es/models/api/ITelemetryGetMetricResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryGetMetricResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryGetMetricResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITelemetryMetric } from \"../ITelemetryMetric.js\";\nimport type { ITelemetryMetricValue } from \"../ITelemetryMetricValue.js\";\n\n/**\n * Get a telemetry metric response.\n */\nexport interface ITelemetryGetMetricResponse {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The metric.\n\t\t */\n\t\tmetric: ITelemetryMetric;\n\n\t\t/**\n\t\t * The latest metric value.\n\t\t */\n\t\tvalue?: ITelemetryMetricValue;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryGetMetricValueRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryGetMetricValueRequest.js.map

package/dist/es/models/api/ITelemetryGetMetricValueRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryGetMetricValueRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryGetMetricValueRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get a telemetry metric value.\n */\nexport interface ITelemetryGetMetricValueRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\n\t\t/**\n\t\t * The id of the metric value.\n\t\t */\n\t\tvalueId: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryGetMetricValueResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryGetMetricValueResponse.js.map

package/dist/es/models/api/ITelemetryGetMetricValueResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryGetMetricValueResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryGetMetricValueResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITelemetryMetricValue } from \"../ITelemetryMetricValue.js\";\n\n/**\n * Get a telemetry metric value response.\n */\nexport interface ITelemetryGetMetricValueResponse {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: ITelemetryMetricValue;\n}\n"]}

package/dist/es/models/api/ITelemetryListRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryListRequest.js.map

package/dist/es/models/api/ITelemetryListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryListRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get the a list of the telemetry metrics.\n */\nexport interface ITelemetryListRequest {\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The type of the metric.\n\t\t */\n\t\ttype?: string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryListResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryListResponse.js.map

package/dist/es/models/api/ITelemetryListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITelemetryMetric } from \"../ITelemetryMetric.js\";\n\n/**\n * Response for telemetry list request.\n */\nexport interface ITelemetryListResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The metrics.\n\t\t */\n\t\tentities: ITelemetryMetric[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryRemoveMetricRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryRemoveMetricRequest.js.map

package/dist/es/models/api/ITelemetryRemoveMetricRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryRemoveMetricRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryRemoveMetricRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove a telemetry metric and it's values.\n */\nexport interface ITelemetryRemoveMetricRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryUpdateMetricRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryUpdateMetricRequest.js.map

package/dist/es/models/api/ITelemetryUpdateMetricRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryUpdateMetricRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryUpdateMetricRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Update a telemetry metric.\n */\nexport interface ITelemetryUpdateMetricRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The data to be used in the update.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The label of the metric.\n\t\t */\n\t\tlabel: string;\n\n\t\t/**\n\t\t * The description of the metric.\n\t\t */\n\t\tdescription?: string;\n\n\t\t/**\n\t\t * The unit of the metric.\n\t\t */\n\t\tunit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryValuesListRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ITelemetryValuesListRequest.js.map

package/dist/es/models/api/ITelemetryValuesListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryValuesListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryValuesListRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Get the a list of the telemetry values.\n */\nexport interface ITelemetryValuesListRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the metric.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The start time of the metrics to retrieve as a timestamp in ms.\n\t\t */\n\t\ttimeStart?: string;\n\n\t\t/**\n\t\t * The end time of the metrics to retrieve as a timestamp in ms.\n\t\t */\n\t\ttimeEnd?: string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}

package/dist/es/models/api/ITelemetryValuesListResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITelemetryValuesListResponse.js.map

package/dist/es/models/api/ITelemetryValuesListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITelemetryValuesListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/ITelemetryValuesListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITelemetryMetric } from \"../ITelemetryMetric.js\";\nimport type { ITelemetryMetricValue } from \"../ITelemetryMetricValue.js\";\n\n/**\n * Response for telemetry list request.\n */\nexport interface ITelemetryValuesListResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The main metric details.\n\t\t */\n\t\tmetric: ITelemetryMetric;\n\n\t\t/**\n\t\t * The metric values.\n\t\t */\n\t\tentities: ITelemetryMetricValue[];\n\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/metricCounterOperation.js

@@ -0,0 +1,17 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of metric value operations for increment decrement counter metrics.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MetricCounterOperation = {
+    /**
+     * Increment Counter.
+     */
+    Increment: "inc",
+    /**
+     * Decrement Counter.
+     */
+    Decrement: "dec"
+};
+//# sourceMappingURL=metricCounterOperation.js.map

package/dist/es/models/metricCounterOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricCounterOperation.js","sourceRoot":"","sources":["../../../src/models/metricCounterOperation.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,KAAK;IAEhB;;OAEG;IACH,SAAS,EAAE,KAAK;CACP,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of metric value operations for increment decrement counter metrics.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MetricCounterOperation = {\n\t/**\n\t * Increment Counter.\n\t */\n\tIncrement: \"inc\",\n\n\t/**\n\t * Decrement Counter.\n\t */\n\tDecrement: \"dec\"\n} as const;\n\n/**\n * The types of metric counter operations.\n */\nexport type MetricCounterOperation =\n\t(typeof MetricCounterOperation)[keyof typeof MetricCounterOperation];\n"]}

package/dist/es/models/metricType.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of metrics.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MetricType = {
+    /**
+     * Counter.
+     */
+    Counter: 0,
+    /**
+     * Increment Decrement Counter.
+     */
+    IncDecCounter: 1,
+    /**
+     * Gauge.
+     */
+    Gauge: 2
+};
+//# sourceMappingURL=metricType.js.map

package/dist/es/models/metricType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metricType.js","sourceRoot":"","sources":["../../../src/models/metricType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB;;OAEG;IACH,OAAO,EAAE,CAAC;IAEV;;OAEG;IACH,aAAa,EAAE,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,CAAC;CACC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of metrics.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MetricType = {\n\t/**\n\t * Counter.\n\t */\n\tCounter: 0,\n\n\t/**\n\t * Increment Decrement Counter.\n\t */\n\tIncDecCounter: 1,\n\n\t/**\n\t * Gauge.\n\t */\n\tGauge: 2\n} as const;\n\n/**\n * The types of metrics.\n */\nexport type MetricType = (typeof MetricType)[keyof typeof MetricType];\n"]}

package/dist/types/connectors/multiTelemetryConnector.d.ts

@@ -0,0 +1,124 @@
+import type { IMultiTelemetryConnectorConstructorOptions } from "../models/IMultiTelemetryConnectorConstructorOptions.js";
+import type { ITelemetryConnector } from "../models/ITelemetryConnector.js";
+import type { ITelemetryMetric } from "../models/ITelemetryMetric.js";
+import type { ITelemetryMetricValue } from "../models/ITelemetryMetricValue.js";
+import type { ITelemetryMetricValueEntry } from "../models/ITelemetryMetricValueEntry.js";
+import type { MetricCounterOperation } from "../models/metricCounterOperation.js";
+import { MetricType } from "../models/metricType.js";
+/**
+ * Class for performing telemetry operations on multiple connectors.
+ */
+export declare class MultiTelemetryConnector implements ITelemetryConnector {
+    /**
+     * The namespace for the class.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of MultiTelemetryConnector.
+     * @param options The options for the connector.
+     */
+    constructor(options: IMultiTelemetryConnectorConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Create one or more metrics.
+     * @param metric The metric details, or the details of several metrics.
+     * @returns A promise that resolves when the metrics have been created on all connectors.
+     */
+    createMetric(metric: ITelemetryMetric | 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;
+    }>;
+    /**
+     * Get a specific metric value by its id.
+     * @param id The id of the metric.
+     * @param valueId The id of the metric value.
+     * @returns The metric value.
+     */
+    getMetricValue(id: string, valueId: string): Promise<ITelemetryMetricValue>;
+    /**
+     * Update metric.
+     * @param metric The metric details.
+     * @returns A promise that resolves when the metric has been updated on all connectors.
+     */
+    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: MetricCounterOperation | number, customData?: {
+        [key: string]: unknown;
+    }): Promise<string>;
+    /**
+     * Add multiple metric values.
+     * @param values The metric values to add.
+     * @returns The created metric value ids, in the order the values were supplied.
+     */
+    addMetricValues(values: ITelemetryMetricValueEntry[]): Promise<string[]>;
+    /**
+     * Remove metric.
+     * @param id The id of the metric.
+     * @returns A promise that resolves when the metric has been removed from all connectors.
+     */
+    removeMetric(id: string): Promise<void>;
+    /**
+     * Query the metrics.
+     * @param type The type of the metric.
+     * @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, limit?: 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 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, limit?: 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;
+    }>;
+}