@twin.org/telemetry-service 0.0.1-next.5 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -482,7 +482,6 @@ class TelemetryService {
     /**
      * 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) {
         this._telemetryConnector = telemetryModels.TelemetryConnectorFactory.get(options?.telemetryConnectorType ?? "telemetry");

package/dist/esm/index.mjs

@@ -480,7 +480,6 @@ class TelemetryService {
     /**
      * 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) {
         this._telemetryConnector = TelemetryConnectorFactory.get(options?.telemetryConnectorType ?? "telemetry");

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./telemetryRoutes";
 export * from "./telemetryService";
 export * from "./restEntryPoints";
+export * from "./models/ITelemetryServiceConstructorOptions";

package/dist/types/models/ITelemetryServiceConstructorOptions.d.ts

@@ -0,0 +1,10 @@
+/**
+ * The options for the telemetry service constructor.
+ */
+export interface ITelemetryServiceConstructorOptions {
+    /**
+     * The type of the telemetry connector to use.
+     * @default telemetry
+     */
+    telemetryConnectorType?: string;
+}

package/dist/types/telemetryService.d.ts

@@ -1,4 +1,5 @@
 import { type ITelemetryComponent, type ITelemetryMetric, type ITelemetryMetricValue, type MetricType } from "@twin.org/telemetry-models";
+import type { ITelemetryServiceConstructorOptions } from "./models/ITelemetryServiceConstructorOptions";
 /**
  * Service for performing telemetry operations to a connector.
  */
@@ -14,11 +15,8 @@ export declare class TelemetryService implements ITelemetryComponent {
     /**
      * 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;
-    });
+    constructor(options?: ITelemetryServiceConstructorOptions);
     /**
      * Create a new metric.
      * @param metric The metric details.

package/docs/changelog.md

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

package/docs/reference/classes/TelemetryService.md

@@ -16,13 +16,11 @@ Create a new instance of TelemetryService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.telemetryConnectorType?**: `string`
+[`ITelemetryServiceConstructorOptions`](../interfaces/ITelemetryServiceConstructorOptions.md)
 
-The type of the telemetry connector to use, defaults to "telemetry".
+The options for the connector.
 
 #### Returns
 
@@ -58,7 +56,9 @@ Create a new metric.
 
 #### Parameters
 
-• **metric**: `ITelemetryMetric`
+##### metric
+
+`ITelemetryMetric`
 
 The metric details.
 
@@ -76,30 +76,24 @@ Nothing.
 
 ### getMetric()
 
-> **getMetric**(`id`): `Promise`\<`object`\>
+> **getMetric**(`id`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `value`: `ITelemetryMetricValue`; \}\>
 
 Get the metric details and it's most recent value.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The metric id.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `metric`: `ITelemetryMetric`; `value`: `ITelemetryMetricValue`; \}\>
 
 The metric details and it's most recent value.
 
-##### metric
-
-> **metric**: `ITelemetryMetric`
-
-##### value
-
-> **value**: `ITelemetryMetricValue`
-
 #### Implementation of
 
 `ITelemetryComponent.getMetric`
@@ -114,7 +108,9 @@ Update metric.
 
 #### Parameters
 
-• **metric**: `Omit`\<`ITelemetryMetric`, `"type"`\>
+##### metric
+
+`Omit`\<`ITelemetryMetric`, `"type"`\>
 
 The metric details.
 
@@ -138,15 +134,19 @@ Add a metric value.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the metric.
 
-• **value**: `number` \| `"inc"` \| `"dec"`
+##### value
 
 The value for the add operation.
 
-• **customData?**
+`number` | `"inc"` | `"dec"`
+
+##### customData?
 
 The custom data for the add operation.
 
@@ -170,7 +170,9 @@ Remove metric.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the metric.
 
@@ -188,43 +190,37 @@ Nothing.
 
 ### query()
 
-> **query**(`type`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`type`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor`: `string`; \}\>
 
 Query the metrics.
 
 #### Parameters
 
-• **type?**: `MetricType`
+##### type?
+
+`MetricType`
 
 The type of the metric.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`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.
 
-##### entities
-
-> **entities**: `ITelemetryMetric`[]
-
-The metrics.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more values.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.
@@ -237,57 +233,49 @@ NotImplementedError if the implementation does not support retrieval.
 
 ### queryValues()
 
-> **queryValues**(`id`, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **queryValues**(`id`, `timeStart`?, `timeEnd`?, `cursor`?, `pageSize`?): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor`: `string`; \}\>
 
 Query the metric values.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the metric.
 
-• **timeStart?**: `number`
+##### timeStart?
+
+`number`
 
 The inclusive time as the start of the metric entries.
 
-• **timeEnd?**: `number`
+##### timeEnd?
+
+`number`
 
 The inclusive time as the end of the metric entries.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`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.
 
-##### metric
-
-> **metric**: `ITelemetryMetric`
-
-The metric details.
-
-##### entities
-
-> **entities**: `ITelemetryMetricValue`[]
-
-The values for the metric.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more values.
-
 #### Throws
 
 NotImplementedError if the implementation does not support retrieval.

package/docs/reference/functions/generateRestRoutesTelemetry.md

@@ -6,11 +6,15 @@ The REST routes for telemetry.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 

package/docs/reference/functions/telemetryAddMetricValue.md

@@ -6,15 +6,21 @@ Add a telemetry metric value.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryAddMetricValueRequest`
+### request
+
+`ITelemetryAddMetricValueRequest`
 
 The request.
 

package/docs/reference/functions/telemetryCreateMetric.md

@@ -6,15 +6,21 @@ Create a new telemetry metric.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryCreateMetricRequest`
+### request
+
+`ITelemetryCreateMetricRequest`
 
 The request.
 

package/docs/reference/functions/telemetryGetMetric.md

@@ -6,15 +6,21 @@ Gets a telemetry metric.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryGetMetricRequest`
+### request
+
+`ITelemetryGetMetricRequest`
 
 The request.
 

package/docs/reference/functions/telemetryMetricList.md

@@ -6,15 +6,21 @@ Get a list of the telemetry metrics.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryListRequest`
+### request
+
+`ITelemetryListRequest`
 
 The request.
 

package/docs/reference/functions/telemetryMetricValueList.md

@@ -6,15 +6,21 @@ Get a list of the telemetry metric values.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryValuesListRequest`
+### request
+
+`ITelemetryValuesListRequest`
 
 The request.
 

package/docs/reference/functions/telemetryRemoveMetric.md

@@ -6,15 +6,21 @@ Removes a telemetry metric.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryRemoveMetricRequest`
+### request
+
+`ITelemetryRemoveMetricRequest`
 
 The request.
 

package/docs/reference/functions/telemetryUpdateMetric.md

@@ -6,15 +6,21 @@ Updates a telemetry metric.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `ITelemetryUpdateMetricRequest`
+### request
+
+`ITelemetryUpdateMetricRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -4,6 +4,10 @@
 
 - [TelemetryService](classes/TelemetryService.md)
 
+## Interfaces
+
+- [ITelemetryServiceConstructorOptions](interfaces/ITelemetryServiceConstructorOptions.md)
+
 ## Variables
 
 - [restEntryPoints](variables/restEntryPoints.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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/telemetry-service",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"description": "Telemetry contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/telemetry-models": "0.0.1-next.5",
+		"@twin.org/telemetry-models": "0.0.1-next.7",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -30,7 +30,7 @@
 			"import": "./dist/esm/index.mjs",
 			"types": "./dist/types/index.d.ts"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",