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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Telemetry REST Client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+REST client for interacting with telemetry service endpoints.
+
+## Installation
+
+```shell
+npm install @3sixty/telemetry-rest-client
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-telemetry](https://github.com/iotaledger/twin-telemetry/tree/next/packages/telemetry-rest-client) repository.

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./telemetryRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,0BAA0B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./telemetryRestClient.js\";\n"]}

package/dist/es/telemetryRestClient.js

@@ -0,0 +1,181 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@3sixty/api-core";
+import { HttpHeaderHelper } from "@3sixty/api-models";
+import { Coerce, Guards } from "@3sixty/core";
+import { HttpMethod } from "@3sixty/web";
+/**
+ * Client for performing telemetry through to REST endpoints.
+ */
+export class TelemetryRestClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TelemetryRestClient";
+    /**
+     * Create a new instance of TelemetryRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super(TelemetryRestClient.CLASS_NAME, config, "telemetry");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TelemetryRestClient.CLASS_NAME;
+    }
+    /**
+     * 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.
+     */
+    async createMetric(metric) {
+        Guards.defined(TelemetryRestClient.CLASS_NAME, "metric", metric);
+        await this.fetch("/metric", HttpMethod.POST, {
+            body: metric
+        });
+    }
+    /**
+     * 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.
+     */
+    async getMetric(id) {
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "id", id);
+        const response = await this.fetch("/metric/:id", HttpMethod.GET, {
+            pathParams: {
+                id
+            }
+        });
+        return response.body;
+    }
+    /**
+     * 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.
+     */
+    async getMetricValue(id, valueId) {
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "id", id);
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "valueId", valueId);
+        const response = await this.fetch("/metric/:id/value/:valueId", HttpMethod.GET, {
+            pathParams: { id, valueId }
+        });
+        return response.body;
+    }
+    /**
+     * Update metric.
+     * @param metric The metric details.
+     * @returns A promise that resolves when the metric has been updated.
+     */
+    async updateMetric(metric) {
+        Guards.object(TelemetryRestClient.CLASS_NAME, "metric", metric);
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "metric.id", metric.id);
+        await this.fetch("/metric/:id", HttpMethod.PUT, {
+            pathParams: {
+                id: metric.id
+            },
+            body: {
+                label: metric.label,
+                description: metric.description,
+                unit: metric.unit
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    async addMetricValue(id, value, customData) {
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "id", id);
+        Guards.defined(TelemetryRestClient.CLASS_NAME, "value", value);
+        const response = await this.fetch("/metric/:id/value", HttpMethod.POST, {
+            pathParams: {
+                id
+            },
+            body: {
+                value,
+                customData
+            }
+        });
+        return HttpHeaderHelper.extractId(response.headers, `${this.getPathPrefix()}/metric/:metricId/value/:id`);
+    }
+    /**
+     * Add multiple metric values.
+     * @param values The metric values to add.
+     * @returns The created metric value ids, in the order the values were supplied.
+     */
+    async addMetricValues(values) {
+        Guards.array(TelemetryRestClient.CLASS_NAME, "values", values);
+        // The REST surface records one value per request, so each value becomes a request.
+        const valueIds = [];
+        for (const entry of values) {
+            valueIds.push(await this.addMetricValue(entry.id, entry.value, entry.customData));
+        }
+        return valueIds;
+    }
+    /**
+     * Remove metric.
+     * @param id The id of the metric.
+     * @returns A promise that resolves when the metric and all its values have been removed.
+     */
+    async removeMetric(id) {
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "id", id);
+        await this.fetch("/metric/:id", HttpMethod.DELETE, {
+            pathParams: {
+                id
+            }
+        });
+    }
+    /**
+     * 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.
+     */
+    async query(type, cursor, limit) {
+        const result = await this.fetch("/metric", HttpMethod.GET, {
+            query: {
+                type: Coerce.string(type),
+                cursor,
+                limit: Coerce.string(limit)
+            }
+        });
+        return result.body;
+    }
+    /**
+     * 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.
+     */
+    async queryValues(id, timeStart, timeEnd, cursor, limit) {
+        Guards.stringValue(TelemetryRestClient.CLASS_NAME, "id", id);
+        const result = await this.fetch("/metric/:id/value", HttpMethod.GET, {
+            pathParams: {
+                id
+            },
+            query: {
+                timeStart: Coerce.string(timeStart),
+                timeEnd: Coerce.string(timeEnd),
+                cursor,
+                limit: Coerce.string(limit)
+            }
+        });
+        return result.body;
+    }
+}
+//# sourceMappingURL=telemetryRestClient.js.map

package/dist/es/telemetryRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetryRestClient.js","sources":["../../src/telemetryRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EACN,gBAAgB,EAIhB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAsB9C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACtD;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,qBAAqB,CAAC;IAElE;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,mBAAmB,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,mBAAmB,CAAC,UAAU,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAA6C;QACtE,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAEjE,MAAM,IAAI,CAAC,KAAK,CAAkD,SAAS,EAAE,UAAU,CAAC,IAAI,EAAE;YAC7F,IAAI,EAAE,MAAM;SACZ,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,EAAU;QAIhC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,aAAa,EACb,UAAU,CAAC,GAAG,EACd;YACC,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,EAAU,EAAE,OAAe;QACtD,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAEvE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,4BAA4B,EAAE,UAAU,CAAC,GAAG,EAAE;YAC/C,UAAU,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE;SAC3B,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,MAAsC;QAC/D,MAAM,CAAC,MAAM,CAAmB,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClF,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,WAAW,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAE3E,MAAM,IAAI,CAAC,KAAK,CACf,aAAa,EACb,UAAU,CAAC,GAAG,EACd;YACC,UAAU,EAAE;gBACX,EAAE,EAAE,MAAM,CAAC,EAAE;aACb;YACD,IAAI,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;aACjB;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CAC1B,EAAU,EACV,KAAsC,EACtC,UAAuC;QAEvC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAC7D,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAE/D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,mBAAmB,EACnB,UAAU,CAAC,IAAI,EACf;YACC,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,KAAK;gBACL,UAAU;aACV;SACD,CACD,CAAC;QAEF,OAAO,gBAAgB,CAAC,SAAS,CAChC,QAAQ,CAAC,OAAO,EAChB,GAAG,IAAI,CAAC,aAAa,EAAE,6BAA6B,CACpD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,MAAoC;QAChE,MAAM,CAAC,KAAK,CACX,mBAAmB,CAAC,UAAU,EAC9B,QAAQ,EACR,MAAM,CACN,CAAC;QAEF,mFAAmF;QACnF,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;QACnF,CAAC;QACD,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,EAAU;QACnC,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,KAAK,CACf,aAAa,EACb,UAAU,CAAC,MAAM,EACjB;YACC,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,KAAK,CACjB,IAAiB,EACjB,MAAe,EACf,KAAc;QAYd,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC9B,SAAS,EACT,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACzB,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CACD,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW,CACvB,EAAU,EACV,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,KAAc;QAed,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QAE7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC9B,mBAAmB,EACnB,UAAU,CAAC,GAAG,EACd;YACC,UAAU,EAAE;gBACX,EAAE;aACF;YACD,KAAK,EAAE;gBACN,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;gBACnC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC/B,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CACD,CAAC;QAEF,OAAO,MAAM,CAAC,IAAI,CAAC;IACpB,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@3sixty/api-core\";\nimport {\n\tHttpHeaderHelper,\n\ttype IBaseRestClientConfig,\n\ttype ICreatedResponse,\n\ttype INoContentResponse\n} from \"@3sixty/api-models\";\nimport { Coerce, Guards } from \"@3sixty/core\";\n\nimport type {\n\tITelemetryAddMetricValueRequest,\n\tITelemetryComponent,\n\tITelemetryCreateMetricRequest,\n\tITelemetryGetMetricRequest,\n\tITelemetryGetMetricResponse,\n\tITelemetryGetMetricValueRequest,\n\tITelemetryGetMetricValueResponse,\n\tITelemetryListRequest,\n\tITelemetryMetricValueEntry,\n\tITelemetryListResponse,\n\tITelemetryMetric,\n\tITelemetryMetricValue,\n\tITelemetryRemoveMetricRequest,\n\tITelemetryUpdateMetricRequest,\n\tITelemetryValuesListRequest,\n\tITelemetryValuesListResponse,\n\tMetricCounterOperation,\n\tMetricType\n} from \"@3sixty/telemetry-models\";\nimport { HttpMethod } from \"@3sixty/web\";\n\n/**\n * Client for performing telemetry through to REST endpoints.\n */\nexport class TelemetryRestClient extends BaseRestClient implements ITelemetryComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"TelemetryRestClient\";\n\n\t/**\n\t * Create a new instance of TelemetryRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(TelemetryRestClient.CLASS_NAME, config, \"telemetry\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn TelemetryRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create one or more metrics.\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\tpublic async createMetric(metric: ITelemetryMetric | ITelemetryMetric[]): Promise<void> {\n\t\tGuards.defined(TelemetryRestClient.CLASS_NAME, \"metric\", metric);\n\n\t\tawait this.fetch<ITelemetryCreateMetricRequest, ICreatedResponse>(\"/metric\", HttpMethod.POST, {\n\t\t\tbody: metric\n\t\t});\n\t}\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\tpublic async getMetric(id: string): Promise<{\n\t\tmetric: ITelemetryMetric;\n\t\tvalue?: ITelemetryMetricValue;\n\t}> {\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"id\", id);\n\n\t\tconst response = await this.fetch<ITelemetryGetMetricRequest, ITelemetryGetMetricResponse>(\n\t\t\t\"/metric/:id\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\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\tpublic async getMetricValue(id: string, valueId: string): Promise<ITelemetryMetricValue> {\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"id\", id);\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"valueId\", valueId);\n\n\t\tconst response = await this.fetch<\n\t\t\tITelemetryGetMetricValueRequest,\n\t\t\tITelemetryGetMetricValueResponse\n\t\t>(\"/metric/:id/value/:valueId\", HttpMethod.GET, {\n\t\t\tpathParams: { id, valueId }\n\t\t});\n\n\t\treturn response.body;\n\t}\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\tpublic async updateMetric(metric: Omit<ITelemetryMetric, \"type\">): Promise<void> {\n\t\tGuards.object<ITelemetryMetric>(TelemetryRestClient.CLASS_NAME, \"metric\", metric);\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"metric.id\", metric.id);\n\n\t\tawait this.fetch<ITelemetryUpdateMetricRequest, INoContentResponse>(\n\t\t\t\"/metric/:id\",\n\t\t\tHttpMethod.PUT,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid: metric.id\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tlabel: metric.label,\n\t\t\t\t\tdescription: metric.description,\n\t\t\t\t\tunit: metric.unit\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\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\tpublic async addMetricValue(\n\t\tid: string,\n\t\tvalue: MetricCounterOperation | number,\n\t\tcustomData?: { [key: string]: unknown }\n\t): Promise<string> {\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"id\", id);\n\t\tGuards.defined(TelemetryRestClient.CLASS_NAME, \"value\", value);\n\n\t\tconst response = await this.fetch<ITelemetryAddMetricValueRequest, ICreatedResponse>(\n\t\t\t\"/metric/:id/value\",\n\t\t\tHttpMethod.POST,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tvalue,\n\t\t\t\t\tcustomData\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn HttpHeaderHelper.extractId(\n\t\t\tresponse.headers,\n\t\t\t`${this.getPathPrefix()}/metric/:metricId/value/:id`\n\t\t);\n\t}\n\n\t/**\n\t * Add multiple metric values.\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\tpublic async addMetricValues(values: ITelemetryMetricValueEntry[]): Promise<string[]> {\n\t\tGuards.array<ITelemetryMetricValueEntry>(\n\t\t\tTelemetryRestClient.CLASS_NAME,\n\t\t\t\"values\",\n\t\t\tvalues\n\t\t);\n\n\t\t// The REST surface records one value per request, so each value becomes a request.\n\t\tconst valueIds: string[] = [];\n\t\tfor (const entry of values) {\n\t\t\tvalueIds.push(await this.addMetricValue(entry.id, entry.value, entry.customData));\n\t\t}\n\t\treturn valueIds;\n\t}\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\tpublic async removeMetric(id: string): Promise<void> {\n\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"id\", id);\n\n\t\tawait this.fetch<ITelemetryRemoveMetricRequest, INoContentResponse>(\n\t\t\t\"/metric/:id\",\n\t\t\tHttpMethod.DELETE,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\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\tpublic async query(\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\t\tconst result = await this.fetch<ITelemetryListRequest, ITelemetryListResponse>(\n\t\t\t\"/metric\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\ttype: Coerce.string(type),\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn result.body;\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\tpublic async queryValues(\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\t\t/**\n\t\t * The values for the metric.\n\t\t */\n\t\tentities: ITelemetryMetricValue[];\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\t\tGuards.stringValue(TelemetryRestClient.CLASS_NAME, \"id\", id);\n\n\t\tconst result = await this.fetch<ITelemetryValuesListRequest, ITelemetryValuesListResponse>(\n\t\t\t\"/metric/:id/value\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t},\n\t\t\t\tquery: {\n\t\t\t\t\ttimeStart: Coerce.string(timeStart),\n\t\t\t\t\ttimeEnd: Coerce.string(timeEnd),\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn result.body;\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./telemetryRestClient.js";

package/dist/types/telemetryRestClient.d.ts

@@ -0,0 +1,116 @@
+import { BaseRestClient } from "@3sixty/api-core";
+import { type IBaseRestClientConfig } from "@3sixty/api-models";
+import type { ITelemetryComponent, ITelemetryMetricValueEntry, ITelemetryMetric, ITelemetryMetricValue, MetricCounterOperation, MetricType } from "@3sixty/telemetry-models";
+/**
+ * Client for performing telemetry through to REST endpoints.
+ */
+export declare class TelemetryRestClient extends BaseRestClient implements ITelemetryComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TelemetryRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config: IBaseRestClientConfig);
+    /**
+     * 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.
+     */
+    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.
+     */
+    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 and all its values have been removed.
+     */
+    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;
+    }>;
+}

package/docs/changelog.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/telemetry/compare/telemetry-rest-client-v0.20.0-next.0...telemetry-rest-client-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([e488a8c](https://github.com/3sixtyglobal/telemetry/commit/e488a8cbe26251de694077a0164af480cab61c3a))
+* updated ts compile ([4490a7b](https://github.com/3sixtyglobal/telemetry/commit/4490a7b854bdea72a79946d2dbb708a47e81b56f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @3sixty/telemetry-models bumped from 0.20.0-next.0 to 0.20.0-next.1

package/docs/examples.md

@@ -0,0 +1,70 @@
+# Telemetry Rest Client Examples
+
+These snippets show how to call telemetry endpoints from application code and process the returned metric data.
+
+## TelemetryRestClient
+
+```typescript
+import { MetricType } from '@3sixty/telemetry-models';
+import { TelemetryRestClient } from '@3sixty/telemetry-rest-client';
+
+const client = new TelemetryRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+console.log(client.className()); // telemetryRestClient
+
+await client.createMetric({
+  id: 'cpu-usage',
+  label: 'CPU Usage',
+  description: 'Current process CPU usage',
+  unit: 'percent',
+  type: MetricType.Gauge
+});
+
+const addedValueId = await client.addMetricValue('cpu-usage', 42.3, {
+  process: 'worker-a'
+});
+
+console.log(addedValueId.length > 0); // true
+```
+
+```typescript
+import { MetricType } from '@3sixty/telemetry-models';
+import { TelemetryRestClient } from '@3sixty/telemetry-rest-client';
+
+const client = new TelemetryRestClient({ endpoint: 'http://localhost:8080' });
+
+await client.updateMetric({
+  id: 'cpu-usage',
+  label: 'CPU Utilisation',
+  description: 'Current CPU utilisation',
+  unit: '%'
+});
+
+const latestMetric = await client.getMetric('cpu-usage');
+console.log(latestMetric.metric.label); // CPU Utilisation
+
+const metrics = await client.query(MetricType.Gauge, undefined, 20);
+console.log(metrics.entities.length); // 1
+
+const values = await client.queryValues(
+  'cpu-usage',
+  Date.now() - 900_000,
+  Date.now(),
+  undefined,
+  10
+);
+console.log(values.entities.length); // 1
+```
+
+```typescript
+import { TelemetryRestClient } from '@3sixty/telemetry-rest-client';
+
+const client = new TelemetryRestClient({ endpoint: 'http://localhost:8080' });
+
+await client.removeMetric('cpu-usage');
+
+const remaining = await client.query(undefined, undefined, 20);
+console.log(remaining.entities.length); // 0
+```

package/docs/reference/classes/TelemetryRestClient.md

@@ -0,0 +1,359 @@
+# Class: TelemetryRestClient
+
+Client for performing telemetry through to REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `ITelemetryComponent`
+
+## Constructors
+
+### Constructor
+
+> **new TelemetryRestClient**(`config`): `TelemetryRestClient`
+
+Create a new instance of TelemetryRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`TelemetryRestClient`
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ITelemetryComponent.className`
+
+***
+
+### createMetric() {#createmetric}
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create one or more metrics.
+
+#### Parameters
+
+##### metric
+
+`ITelemetryMetric` \| `ITelemetryMetric`[]
+
+The metric details, or the details of several metrics.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metrics have been created.
+
+#### Implementation of
+
+`ITelemetryComponent.createMetric`
+
+***
+
+### getMetric() {#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`
+
+***
+
+### getMetricValue() {#getmetricvalue}
+
+> **getMetricValue**(`id`, `valueId`): `Promise`\<`ITelemetryMetricValue`\>
+
+Get a specific metric value by its id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### valueId
+
+`string`
+
+The id of the metric value.
+
+#### Returns
+
+`Promise`\<`ITelemetryMetricValue`\>
+
+The metric value.
+
+#### Implementation of
+
+`ITelemetryComponent.getMetricValue`
+
+***
+
+### updateMetric() {#updatemetric}
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<`ITelemetryMetric`, `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been updated.
+
+#### Implementation of
+
+`ITelemetryComponent.updateMetric`
+
+***
+
+### addMetricValue() {#addmetricvalue}
+
+> **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
+
+Add a metric value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### value
+
+`number` \| `MetricCounterOperation`
+
+The value for the add operation.
+
+##### customData?
+
+\{\[`key`: `string`\]: `unknown`; \}
+
+The custom data for the add operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+#### Implementation of
+
+`ITelemetryComponent.addMetricValue`
+
+***
+
+### addMetricValues() {#addmetricvalues}
+
+> **addMetricValues**(`values`): `Promise`\<`string`[]\>
+
+Add multiple metric values.
+
+#### Parameters
+
+##### values
+
+`ITelemetryMetricValueEntry`[]
+
+The metric values to add.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The created metric value ids, in the order the values were supplied.
+
+#### Implementation of
+
+`ITelemetryComponent.addMetricValues`
+
+***
+
+### removeMetric() {#removemetric}
+
+> **removeMetric**(`id`): `Promise`\<`void`\>
+
+Remove metric.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric and all its values have been removed.
+
+#### Implementation of
+
+`ITelemetryComponent.removeMetric`
+
+***
+
+### query() {#query}
+
+> **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
+
+Query the metrics.
+
+#### Parameters
+
+##### type?
+
+`MetricType`
+
+The type of the metric.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+#### 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}
+
+> **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `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 chunk of entities.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+#### 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/index.md

@@ -0,0 +1,5 @@
+# @3sixty/telemetry-rest-client
+
+## Classes
+
+- [TelemetryRestClient](classes/TelemetryRestClient.md)

package/locales/en.json

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

package/package.json

@@ -1,6 +1,53 @@
 {
-  "name": "@3sixty/telemetry-rest-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/telemetry-rest-client",
+	"version": "0.20.0-next.1",
+	"description": "REST client for interacting with telemetry service endpoints.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/telemetry.git",
+		"directory": "packages/telemetry-rest-client"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/api-core": "next",
+		"@3sixty/api-models": "next",
+		"@3sixty/core": "next",
+		"@3sixty/entity": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/telemetry-models": "0.20.0-next.1",
+		"@3sixty/web": "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"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/telemetry/issues"
+	},
+	"homepage": "https://3sixty.global"
+}