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

package/docs/reference/interfaces/ITelemetryMetric.md

@@ -0,0 +1,52 @@
+# Interface: ITelemetryMetric
+
+Interface describing a telemetry metric.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the metric.
+
+***
+
+### label {#label}
+
+> **label**: `string`
+
+The label of the metric.
+
+***
+
+### type {#type}
+
+> **type**: [`MetricType`](../type-aliases/MetricType.md)
+
+The type of the metric.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+Description.
+
+***
+
+### unit? {#unit}
+
+> `optional` **unit?**: `string`
+
+The unit the metric describes.
+
+***
+
+### maxHistory? {#maxhistory}
+
+> `optional` **maxHistory?**: `number`
+
+The maximum number of values to retain; oldest are trimmed on each addMetricValue call.
+Unlimited when absent.

package/docs/reference/interfaces/ITelemetryMetricValue.md

@@ -0,0 +1,39 @@
+# Interface: ITelemetryMetricValue
+
+Interface describing a telemetry metric value.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the metric value.
+
+***
+
+### ts {#ts}
+
+> **ts**: `number`
+
+The timestamp of the metric.
+
+***
+
+### value {#value}
+
+> **value**: `number`
+
+The value of the metric.
+
+***
+
+### customData? {#customdata}
+
+> `optional` **customData?**: `object`
+
+The custom data for the metric value.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`

package/docs/reference/interfaces/ITelemetryMetricValueEntry.md

@@ -0,0 +1,31 @@
+# Interface: ITelemetryMetricValueEntry
+
+A single metric value in a batch add operation.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the metric.
+
+***
+
+### value {#value}
+
+> **value**: `number` \| [`MetricCounterOperation`](../type-aliases/MetricCounterOperation.md)
+
+The value for the add operation.
+
+***
+
+### customData? {#customdata}
+
+> `optional` **customData?**: `object`
+
+The custom data for the metric value.
+
+#### Index Signature
+
+\[`key`: `string`\]: `unknown`

package/docs/reference/interfaces/ITelemetryRemoveMetricRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITelemetryRemoveMetricRequest
+
+Remove a telemetry metric and it's values.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.

package/docs/reference/interfaces/ITelemetryUpdateMetricRequest.md

@@ -0,0 +1,43 @@
+# Interface: ITelemetryUpdateMetricRequest
+
+Update a telemetry metric.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The data to be used in the update.
+
+#### label
+
+> **label**: `string`
+
+The label of the metric.
+
+#### description?
+
+> `optional` **description?**: `string`
+
+The description of the metric.
+
+#### unit?
+
+> `optional` **unit?**: `string`
+
+The unit of the metric.

package/docs/reference/interfaces/ITelemetryValuesListRequest.md

@@ -0,0 +1,49 @@
+# Interface: ITelemetryValuesListRequest
+
+Get the a list of the telemetry values.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### timeStart?
+
+> `optional` **timeStart?**: `string`
+
+The start time of the metrics to retrieve as a timestamp in ms.
+
+#### timeEnd?
+
+> `optional` **timeEnd?**: `string`
+
+The end time of the metrics to retrieve as a timestamp in ms.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The optional cursor to get next chunk.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Limit the number of entities to return.

package/docs/reference/interfaces/ITelemetryValuesListResponse.md

@@ -0,0 +1,29 @@
+# Interface: ITelemetryValuesListResponse
+
+Response for telemetry list request.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response payload.
+
+#### metric
+
+> **metric**: [`ITelemetryMetric`](ITelemetryMetric.md)
+
+The main metric details.
+
+#### entities
+
+> **entities**: [`ITelemetryMetricValue`](ITelemetryMetricValue.md)[]
+
+The metric values.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/type-aliases/MetricCounterOperation.md

@@ -0,0 +1,5 @@
+# Type Alias: MetricCounterOperation
+
+> **MetricCounterOperation** = *typeof* [`MetricCounterOperation`](../variables/MetricCounterOperation.md)\[keyof *typeof* [`MetricCounterOperation`](../variables/MetricCounterOperation.md)\]
+
+The types of metric counter operations.

package/docs/reference/type-aliases/MetricType.md

@@ -0,0 +1,5 @@
+# Type Alias: MetricType
+
+> **MetricType** = *typeof* [`MetricType`](../variables/MetricType.md)\[keyof *typeof* [`MetricType`](../variables/MetricType.md)\]
+
+The types of metrics.

package/docs/reference/variables/MetricCounterOperation.md

@@ -0,0 +1,19 @@
+# Variable: MetricCounterOperation
+
+> `const` **MetricCounterOperation**: `object`
+
+The types of metric value operations for increment decrement counter metrics.
+
+## Type Declaration
+
+### Increment {#increment}
+
+> `readonly` **Increment**: `"inc"` = `"inc"`
+
+Increment Counter.
+
+### Decrement {#decrement}
+
+> `readonly` **Decrement**: `"dec"` = `"dec"`
+
+Decrement Counter.

package/docs/reference/variables/MetricType.md

@@ -0,0 +1,25 @@
+# Variable: MetricType
+
+> `const` **MetricType**: `object`
+
+The types of metrics.
+
+## Type Declaration
+
+### Counter {#counter}
+
+> `readonly` **Counter**: `0` = `0`
+
+Counter.
+
+### IncDecCounter {#incdeccounter}
+
+> `readonly` **IncDecCounter**: `1` = `1`
+
+Increment Decrement Counter.
+
+### Gauge {#gauge}
+
+> `readonly` **Gauge**: `2` = `2`
+
+Gauge.

package/docs/reference/variables/MetricsProducerFactory.md

@@ -0,0 +1,9 @@
+# Variable: MetricsProducerFactory
+
+> `const` **MetricsProducerFactory**: `Factory`\<[`IMetricsProducer`](../interfaces/IMetricsProducer.md)\>
+
+Factory for `IMetricsProducer` implementations.
+
+The engine registers producers with `MetricsProducerFactory` during
+initialisation. Third-party apps can also register their own producers
+before `engine.start()` is called.

package/docs/reference/variables/TelemetryConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: TelemetryConnectorFactory
+
+> `const` **TelemetryConnectorFactory**: `Factory`\<[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md)\>
+
+Factory for creating telemetry connectors.

package/locales/en.json

@@ -0,0 +1,7 @@
+{
+	"error": {
+		"multiTelemetryConnector": {
+			"notSupported": "The method \"{methodName}\" is not supported on multi telemetry connector."
+		}
+	}
+}

package/package.json

@@ -1,6 +1,52 @@
 {
-  "name": "@3sixty/telemetry-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/telemetry-models",
+	"version": "0.20.0-next.1",
+	"description": "Shared telemetry models for connectors and services.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/telemetry.git",
+		"directory": "packages/telemetry-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"telemetry",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/telemetry/issues"
+	},
+	"homepage": "https://3sixty.global"
+}