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

package/docs/reference/classes/TelemetryService.md

@@ -0,0 +1,285 @@
+# Class: TelemetryService
+
+Service for performing telemetry operations to a connector.
+
+## Implements
+
+- `ITelemetryComponent`
+
+## Constructors
+
+### new TelemetryService()
+
+> **new TelemetryService**(`options`?): [`TelemetryService`](TelemetryService.md)
+
+Create a new instance of TelemetryService.
+
+#### Parameters
+
+##### options?
+
+[`ITelemetryServiceConstructorOptions`](../interfaces/ITelemetryServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+[`TelemetryService`](TelemetryService.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"telemetry"`
+
+The namespace supported by the telemetry service.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`ITelemetryComponent.CLASS_NAME`
+
+## Methods
+
+### createMetric()
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create a new metric.
+
+#### Parameters
+
+##### metric
+
+`ITelemetryMetric`
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ITelemetryComponent.createMetric`
+
+***
+
+### getMetric()
+
+> **getMetric**(`id`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `value`: `ITelemetryMetricValue`; \}\>
+
+Get the metric details and it's most recent value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The metric id.
+
+#### Returns
+
+`Promise`\<\{ `metric`: `ITelemetryMetric`; `value`: `ITelemetryMetricValue`; \}\>
+
+The metric details and it's most recent value.
+
+#### Implementation of
+
+`ITelemetryComponent.getMetric`
+
+***
+
+### updateMetric()
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<`ITelemetryMetric`, `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ITelemetryComponent.updateMetric`
+
+***
+
+### addMetricValue()
+
+> **addMetricValue**(`id`, `value`, `customData`?): `Promise`\<`string`\>
+
+Add a metric value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### value
+
+The value for the add operation.
+
+`number` | `"inc"` | `"dec"`
+
+##### customData?
+
+The custom data for the add operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+#### Implementation of
+
+`ITelemetryComponent.addMetricValue`
+
+***
+
+### removeMetric()
+
+> **removeMetric**(`id`): `Promise`\<`void`\>
+
+Remove metric.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`ITelemetryComponent.removeMetric`
+
+***
+
+### query()
+
+> **query**(`type`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
+
+Query the metrics.
+
+#### Parameters
+
+##### type?
+
+`MetricType`
+
+The type of the metric.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
+
+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.
+
+#### Implementation of
+
+`ITelemetryComponent.query`
+
+***
+
+### queryValues()
+
+> **queryValues**(`id`, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
+
+Query the metric values.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### timeStart?
+
+`number`
+
+The inclusive time as the start of the metric entries.
+
+##### timeEnd?
+
+`number`
+
+The inclusive time as the end of the metric entries.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next page of entities.
+
+##### pageSize?
+
+`number`
+
+The maximum number of entities in a page.
+
+#### Returns
+
+`Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
+
+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.
+
+#### Implementation of
+
+`ITelemetryComponent.queryValues`

package/docs/reference/functions/generateRestRoutesTelemetry.md

@@ -0,0 +1,25 @@
+# Function: generateRestRoutesTelemetry()
+
+> **generateRestRoutesTelemetry**(`baseRouteName`, `componentName`): `IRestRoute`[]
+
+The REST routes for telemetry.
+
+## Parameters
+
+### baseRouteName
+
+`string`
+
+Prefix to prepend to the paths.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+## Returns
+
+`IRestRoute`[]
+
+The generated routes.

package/docs/reference/functions/telemetryAddMetricValue.md

@@ -0,0 +1,31 @@
+# Function: telemetryAddMetricValue()
+
+> **telemetryAddMetricValue**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Add a telemetry metric value.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryAddMetricValueRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryCreateMetric.md

@@ -0,0 +1,31 @@
+# Function: telemetryCreateMetric()
+
+> **telemetryCreateMetric**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ICreatedResponse`\>
+
+Create a new telemetry metric.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryCreateMetricRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ICreatedResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryGetMetric.md

@@ -0,0 +1,31 @@
+# Function: telemetryGetMetric()
+
+> **telemetryGetMetric**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ITelemetryGetMetricResponse`\>
+
+Gets a telemetry metric.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryGetMetricRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ITelemetryGetMetricResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryMetricList.md

@@ -0,0 +1,31 @@
+# Function: telemetryMetricList()
+
+> **telemetryMetricList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ITelemetryListResponse`\>
+
+Get a list of the telemetry metrics.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ITelemetryListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryMetricValueList.md

@@ -0,0 +1,31 @@
+# Function: telemetryMetricValueList()
+
+> **telemetryMetricValueList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`ITelemetryValuesListResponse`\>
+
+Get a list of the telemetry metric values.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryValuesListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`ITelemetryValuesListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryRemoveMetric.md

@@ -0,0 +1,31 @@
+# Function: telemetryRemoveMetric()
+
+> **telemetryRemoveMetric**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Removes a telemetry metric.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryRemoveMetricRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/telemetryUpdateMetric.md

@@ -0,0 +1,31 @@
+# Function: telemetryUpdateMetric()
+
+> **telemetryUpdateMetric**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Updates a telemetry metric.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`ITelemetryUpdateMetricRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -0,0 +1,25 @@
+# @twin.org/telemetry-service
+
+## Classes
+
+- [TelemetryService](classes/TelemetryService.md)
+
+## Interfaces
+
+- [ITelemetryServiceConstructorOptions](interfaces/ITelemetryServiceConstructorOptions.md)
+
+## Variables
+
+- [restEntryPoints](variables/restEntryPoints.md)
+- [tagsTelemetry](variables/tagsTelemetry.md)
+
+## Functions
+
+- [generateRestRoutesTelemetry](functions/generateRestRoutesTelemetry.md)
+- [telemetryCreateMetric](functions/telemetryCreateMetric.md)
+- [telemetryGetMetric](functions/telemetryGetMetric.md)
+- [telemetryUpdateMetric](functions/telemetryUpdateMetric.md)
+- [telemetryAddMetricValue](functions/telemetryAddMetricValue.md)
+- [telemetryRemoveMetric](functions/telemetryRemoveMetric.md)
+- [telemetryMetricList](functions/telemetryMetricList.md)
+- [telemetryMetricValueList](functions/telemetryMetricValueList.md)

package/docs/reference/interfaces/ITelemetryServiceConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: ITelemetryServiceConstructorOptions
+
+The options for the telemetry service constructor.
+
+## Properties
+
+### telemetryConnectorType?
+
+> `optional` **telemetryConnectorType**: `string`
+
+The type of the telemetry connector to use.
+
+#### Default
+
+```ts
+telemetry
+```

package/docs/reference/variables/restEntryPoints.md

@@ -0,0 +1,3 @@
+# Variable: restEntryPoints
+
+> `const` **restEntryPoints**: `IRestRouteEntryPoint`[]

package/docs/reference/variables/tagsTelemetry.md

@@ -0,0 +1,5 @@
+# Variable: tagsTelemetry
+
+> `const` **tagsTelemetry**: `ITag`[]
+
+The tag to associate with the routes.

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@twin.org/telemetry-service",
+	"version": "0.0.1-next.10",
+	"description": "Telemetry contract implementation and REST endpoint definitions",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/telemetry.git",
+		"directory": "packages/telemetry-service"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/telemetry-models": "0.0.1-next.10",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}