@twin.org/tracing-rest-client 0.9.2-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

@@ -0,0 +1,21 @@
+# TWIN Tracing Rest Client
+
+Provides a client for interacting with tracing service endpoints from applications and services.
+
+## Installation
+
+```shell
+npm install @twin.org/tracing-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)

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./tracingRestClient.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,wBAAwB,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./tracingRestClient.js\";\n"]}

package/dist/es/tracingRestClient.js

@@ -0,0 +1,108 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Coerce, Guards } from "@twin.org/core";
+import { SpanHelper } from "@twin.org/tracing-models";
+import { HttpMethod } from "@twin.org/web";
+/**
+ * Client for performing tracing through to REST endpoints.
+ */
+export class TracingRestClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "TracingRestClient";
+    /**
+     * Create a new instance of TracingRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super(TracingRestClient.CLASS_NAME, config, "tracing");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TracingRestClient.CLASS_NAME;
+    }
+    /**
+     * Start a new span.
+     * @param name The name of the span.
+     * @param options The options for the span.
+     * @returns The started span, including its minted context.
+     */
+    async startSpan(name, options) {
+        Guards.stringValue(TracingRestClient.CLASS_NAME, "name", name);
+        const response = await this.fetch("/", HttpMethod.POST, {
+            body: {
+                name,
+                options
+            }
+        });
+        return response.body;
+    }
+    /**
+     * End a span, finalizing its status and duration.
+     * @param span The span to end.
+     * @param status The status to set on the span, defaults to ok.
+     * @returns A promise that resolves when the span has been ended.
+     */
+    async endSpan(span, status) {
+        Guards.object(TracingRestClient.CLASS_NAME, "span", span);
+        Guards.object(TracingRestClient.CLASS_NAME, "span.context", span.context);
+        Guards.stringValue(TracingRestClient.CLASS_NAME, "span.context.spanId", span.context.spanId);
+        // Finalize the caller's span locally (status/endTs/durationMs) so a REST caller's span
+        // matches the in-process path; the server honours the resulting endTs carried in the body.
+        SpanHelper.endSpan(span, status);
+        await this.fetch("/:spanId", HttpMethod.PUT, {
+            pathParams: {
+                spanId: span.context.spanId
+            },
+            body: span
+        });
+    }
+    /**
+     * Query the spans.
+     * @param traceId The id of the trace to filter by.
+     * @param spanId The id of the span to filter by.
+     * @param status The status to filter by.
+     * @param kind The kind to filter by.
+     * @param timeStart The inclusive start time to filter the span start by, as a timestamp in ms.
+     * @param timeEnd The inclusive end time to filter the span start by, as a timestamp in ms.
+     * @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.
+     */
+    async query(traceId, spanId, status, kind, timeStart, timeEnd, cursor, limit) {
+        const response = await this.fetch("/", HttpMethod.GET, {
+            query: {
+                traceId,
+                spanId,
+                status,
+                kind,
+                timeStart: Coerce.string(timeStart),
+                timeEnd: Coerce.string(timeEnd),
+                cursor,
+                limit: Coerce.string(limit)
+            }
+        });
+        return response.body;
+    }
+    /**
+     * Get all the spans belonging to a trace, ordered by their start time.
+     * @param traceId The id of the trace to retrieve.
+     * @returns The spans belonging to the trace, ordered by their start time ascending.
+     */
+    async getTrace(traceId) {
+        Guards.stringValue(TracingRestClient.CLASS_NAME, "traceId", traceId);
+        const response = await this.fetch("/trace/:traceId", HttpMethod.GET, {
+            pathParams: {
+                traceId
+            }
+        });
+        return response.body.spans;
+    }
+}
+//# sourceMappingURL=tracingRestClient.js.map

package/dist/es/tracingRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracingRestClient.js","sourceRoot":"","sources":["../../src/tracingRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAEhD,OAAO,EACN,UAAU,EAaV,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C;;GAEG;AACH,MAAM,OAAO,iBAAkB,SAAQ,cAAc;IACpD;;OAEG;IACI,MAAM,CAAU,UAAU,uBAAuC;IAExE;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,iBAAiB,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,iBAAiB,CAAC,UAAU,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY,EAAE,OAAsB;QAC1D,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAErE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,UAAU,CAAC,IAAI,EACf;YACC,IAAI,EAAE;gBACL,IAAI;gBACJ,OAAO;aACP;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,IAAW,EAAE,MAAmB;QACpD,MAAM,CAAC,MAAM,CAAQ,iBAAiB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,UAAU,kBAAwB,IAAI,CAAC,OAAO,CAAC,CAAC;QAChF,MAAM,CAAC,WAAW,CACjB,iBAAiB,CAAC,UAAU,yBAE5B,IAAI,CAAC,OAAO,CAAC,MAAM,CACnB,CAAC;QAEF,uFAAuF;QACvF,2FAA2F;QAC3F,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAEjC,MAAM,IAAI,CAAC,KAAK,CAA6C,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE;YACxF,UAAU,EAAE;gBACX,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;aAC3B;YACD,IAAI,EAAE,IAAI;SACV,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,KAAK,CACjB,OAAgB,EAChB,MAAe,EACf,MAAmB,EACnB,IAAe,EACf,SAAkB,EAClB,OAAgB,EAChB,MAAe,EACf,KAAc;QAWd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,UAAU,CAAC,GAAG,EACd;YACC,KAAK,EAAE;gBACN,OAAO;gBACP,MAAM;gBACN,MAAM;gBACN,IAAI;gBACJ,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,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAe;QACpC,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,iBAAiB,EACjB,UAAU,CAAC,GAAG,EACd;YACC,UAAU,EAAE;gBACX,OAAO;aACP;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;IAC5B,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, INoContentResponse } from \"@twin.org/api-models\";\nimport { Coerce, Guards } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tSpanHelper,\n\ttype ISpan,\n\ttype ISpanOptions,\n\ttype ITracingComponent,\n\ttype ITracingGetTraceRequest,\n\ttype ITracingGetTraceResponse,\n\ttype ITracingListRequest,\n\ttype ITracingListResponse,\n\ttype ITracingSpanEndRequest,\n\ttype ITracingSpanStartRequest,\n\ttype ITracingSpanStartResponse,\n\ttype SpanKind,\n\ttype SpanStatus\n} from \"@twin.org/tracing-models\";\nimport { HttpMethod } from \"@twin.org/web\";\n\n/**\n * Client for performing tracing through to REST endpoints.\n */\nexport class TracingRestClient extends BaseRestClient implements ITracingComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TracingRestClient>();\n\n\t/**\n\t * Create a new instance of TracingRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(TracingRestClient.CLASS_NAME, config, \"tracing\");\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 TracingRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Start a new span.\n\t * @param name The name of the span.\n\t * @param options The options for the span.\n\t * @returns The started span, including its minted context.\n\t */\n\tpublic async startSpan(name: string, options?: ISpanOptions): Promise<ISpan> {\n\t\tGuards.stringValue(TracingRestClient.CLASS_NAME, nameof(name), name);\n\n\t\tconst response = await this.fetch<ITracingSpanStartRequest, ITracingSpanStartResponse>(\n\t\t\t\"/\",\n\t\t\tHttpMethod.POST,\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tname,\n\t\t\t\t\toptions\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 * End a span, finalizing its status and duration.\n\t * @param span The span to end.\n\t * @param status The status to set on the span, defaults to ok.\n\t * @returns A promise that resolves when the span has been ended.\n\t */\n\tpublic async endSpan(span: ISpan, status?: SpanStatus): Promise<void> {\n\t\tGuards.object<ISpan>(TracingRestClient.CLASS_NAME, nameof(span), span);\n\t\tGuards.object(TracingRestClient.CLASS_NAME, nameof(span.context), span.context);\n\t\tGuards.stringValue(\n\t\t\tTracingRestClient.CLASS_NAME,\n\t\t\tnameof(span.context.spanId),\n\t\t\tspan.context.spanId\n\t\t);\n\n\t\t// Finalize the caller's span locally (status/endTs/durationMs) so a REST caller's span\n\t\t// matches the in-process path; the server honours the resulting endTs carried in the body.\n\t\tSpanHelper.endSpan(span, status);\n\n\t\tawait this.fetch<ITracingSpanEndRequest, INoContentResponse>(\"/:spanId\", HttpMethod.PUT, {\n\t\t\tpathParams: {\n\t\t\t\tspanId: span.context.spanId\n\t\t\t},\n\t\t\tbody: span\n\t\t});\n\t}\n\n\t/**\n\t * Query the spans.\n\t * @param traceId The id of the trace to filter by.\n\t * @param spanId The id of the span to filter by.\n\t * @param status The status to filter by.\n\t * @param kind The kind to filter by.\n\t * @param timeStart The inclusive start time to filter the span start by, as a timestamp in ms.\n\t * @param timeEnd The inclusive end time to filter the span start by, as a timestamp in ms.\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 */\n\tpublic async query(\n\t\ttraceId?: string,\n\t\tspanId?: string,\n\t\tstatus?: SpanStatus,\n\t\tkind?: SpanKind,\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 spans.\n\t\t */\n\t\tentities: ISpan[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call query to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<ITracingListRequest, ITracingListResponse>(\n\t\t\t\"/\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\ttraceId,\n\t\t\t\t\tspanId,\n\t\t\t\t\tstatus,\n\t\t\t\t\tkind,\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 response.body;\n\t}\n\n\t/**\n\t * Get all the spans belonging to a trace, ordered by their start time.\n\t * @param traceId The id of the trace to retrieve.\n\t * @returns The spans belonging to the trace, ordered by their start time ascending.\n\t */\n\tpublic async getTrace(traceId: string): Promise<ISpan[]> {\n\t\tGuards.stringValue(TracingRestClient.CLASS_NAME, nameof(traceId), traceId);\n\n\t\tconst response = await this.fetch<ITracingGetTraceRequest, ITracingGetTraceResponse>(\n\t\t\t\"/trace/:traceId\",\n\t\t\tHttpMethod.GET,\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\ttraceId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body.spans;\n\t}\n}\n"]}

package/dist/types/index.d.ts

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

package/dist/types/tracingRestClient.d.ts

@@ -0,0 +1,65 @@
+import { BaseRestClient } from "@twin.org/api-core";
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import { type ISpan, type ISpanOptions, type ITracingComponent, type SpanKind, type SpanStatus } from "@twin.org/tracing-models";
+/**
+ * Client for performing tracing through to REST endpoints.
+ */
+export declare class TracingRestClient extends BaseRestClient implements ITracingComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of TracingRestClient.
+     * @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;
+    /**
+     * Start a new span.
+     * @param name The name of the span.
+     * @param options The options for the span.
+     * @returns The started span, including its minted context.
+     */
+    startSpan(name: string, options?: ISpanOptions): Promise<ISpan>;
+    /**
+     * End a span, finalizing its status and duration.
+     * @param span The span to end.
+     * @param status The status to set on the span, defaults to ok.
+     * @returns A promise that resolves when the span has been ended.
+     */
+    endSpan(span: ISpan, status?: SpanStatus): Promise<void>;
+    /**
+     * Query the spans.
+     * @param traceId The id of the trace to filter by.
+     * @param spanId The id of the span to filter by.
+     * @param status The status to filter by.
+     * @param kind The kind to filter by.
+     * @param timeStart The inclusive start time to filter the span start by, as a timestamp in ms.
+     * @param timeEnd The inclusive end time to filter the span start by, as a timestamp in ms.
+     * @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.
+     */
+    query(traceId?: string, spanId?: string, status?: SpanStatus, kind?: SpanKind, timeStart?: number, timeEnd?: number, cursor?: string, limit?: number): Promise<{
+        /**
+         * The spans.
+         */
+        entities: ISpan[];
+        /**
+         * An optional cursor, when defined can be used to call query to get more entities.
+         */
+        cursor?: string;
+    }>;
+    /**
+     * Get all the spans belonging to a trace, ordered by their start time.
+     * @param traceId The id of the trace to retrieve.
+     * @returns The spans belonging to the trace, ordered by their start time ascending.
+     */
+    getTrace(traceId: string): Promise<ISpan[]>;
+}

package/docs/changelog.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [0.9.2-next.1](https://github.com/iotaledger/twin-tracing/compare/tracing-rest-client-v0.9.2-next.0...tracing-rest-client-v0.9.2-next.1) (2026-08-07)
+
+
+### Features
+
+* add twin-tracing repository with OTel-aligned tracing API ([59b914c](https://github.com/iotaledger/twin-tracing/commit/59b914ca631c0b765973dfa5099a8f4e6115e325))
+* add twin-tracing repository with OTel-aligned tracing API ([affcd6c](https://github.com/iotaledger/twin-tracing/commit/affcd6c1cf2fbfd34d9a8849e860e5fe66a011e3))
+* linting and dependency update ([c1a2b98](https://github.com/iotaledger/twin-tracing/commit/c1a2b988441deb59592d69c7d3b6527bcb9018b2))
+* linting and dependency update ([b65c083](https://github.com/iotaledger/twin-tracing/commit/b65c083d4f8f83c2046d29d53444b45c7a4188c7))
+
+
+### Bug Fixes
+
+* address PR review on tracing packages ([0832b5f](https://github.com/iotaledger/twin-tracing/commit/0832b5fc0e7414b4e0fd2393532df00e07ff1f43))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/tracing-models bumped from 0.9.2-next.0 to 0.9.2-next.1
+
+## Changelog

package/docs/examples.md

@@ -0,0 +1,25 @@
+# Tracing Rest Client Examples
+
+The client implements the tracing component contract against a remote tracing service.
+
+## Construct the client
+
+```typescript
+import { TracingRestClient } from '@twin.org/tracing-rest-client';
+
+const client = new TracingRestClient({ endpoint: 'https://localhost' });
+```
+
+## Record and query spans
+
+```typescript
+import { SpanKind, SpanStatus } from '@twin.org/tracing-models';
+
+const span = await client.startSpan('handle-request', { kind: SpanKind.Server });
+
+await client.endSpan(span, SpanStatus.Ok);
+
+const spans = await client.query(span.context.traceId);
+
+const trace = await client.getTrace(span.context.traceId);
+```

package/docs/reference/classes/TracingRestClient.md

@@ -0,0 +1,220 @@
+# Class: TracingRestClient
+
+Client for performing tracing through to REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `ITracingComponent`
+
+## Constructors
+
+### Constructor
+
+> **new TracingRestClient**(`config`): `TracingRestClient`
+
+Create a new instance of TracingRestClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`TracingRestClient`
+
+#### 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
+
+`ITracingComponent.className`
+
+***
+
+### startSpan() {#startspan}
+
+> **startSpan**(`name`, `options?`): `Promise`\<`ISpan`\>
+
+Start a new span.
+
+#### Parameters
+
+##### name
+
+`string`
+
+The name of the span.
+
+##### options?
+
+`ISpanOptions`
+
+The options for the span.
+
+#### Returns
+
+`Promise`\<`ISpan`\>
+
+The started span, including its minted context.
+
+#### Implementation of
+
+`ITracingComponent.startSpan`
+
+***
+
+### endSpan() {#endspan}
+
+> **endSpan**(`span`, `status?`): `Promise`\<`void`\>
+
+End a span, finalizing its status and duration.
+
+#### Parameters
+
+##### span
+
+`ISpan`
+
+The span to end.
+
+##### status?
+
+`SpanStatus`
+
+The status to set on the span, defaults to ok.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the span has been ended.
+
+#### Implementation of
+
+`ITracingComponent.endSpan`
+
+***
+
+### query() {#query}
+
+> **query**(`traceId?`, `spanId?`, `status?`, `kind?`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ISpan`[]; `cursor?`: `string`; \}\>
+
+Query the spans.
+
+#### Parameters
+
+##### traceId?
+
+`string`
+
+The id of the trace to filter by.
+
+##### spanId?
+
+`string`
+
+The id of the span to filter by.
+
+##### status?
+
+`SpanStatus`
+
+The status to filter by.
+
+##### kind?
+
+`SpanKind`
+
+The kind to filter by.
+
+##### timeStart?
+
+`number`
+
+The inclusive start time to filter the span start by, as a timestamp in ms.
+
+##### timeEnd?
+
+`number`
+
+The inclusive end time to filter the span start by, as a timestamp in ms.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+#### Returns
+
+`Promise`\<\{ `entities`: `ISpan`[]; `cursor?`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Implementation of
+
+`ITracingComponent.query`
+
+***
+
+### getTrace() {#gettrace}
+
+> **getTrace**(`traceId`): `Promise`\<`ISpan`[]\>
+
+Get all the spans belonging to a trace, ordered by their start time.
+
+#### Parameters
+
+##### traceId
+
+`string`
+
+The id of the trace to retrieve.
+
+#### Returns
+
+`Promise`\<`ISpan`[]\>
+
+The spans belonging to the trace, ordered by their start time ascending.
+
+#### Implementation of
+
+`ITracingComponent.getTrace`

package/docs/reference/index.md

@@ -0,0 +1,5 @@
+# @twin.org/tracing-rest-client
+
+## Classes
+
+- [TracingRestClient](classes/TracingRestClient.md)

package/locales/en.json

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

package/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "@twin.org/tracing-rest-client",
+	"version": "0.9.2-next.1",
+	"description": "Provides a client for interacting with tracing service endpoints from applications and services.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/iotaledger/twin-tracing.git",
+		"directory": "packages/tracing-rest-client"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-core": "next",
+		"@twin.org/api-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/tracing-models": "0.9.2-next.1",
+		"@twin.org/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",
+		"tracing"
+	],
+	"bugs": {
+		"url": "git+https://github.com/iotaledger/twin-tracing/issues"
+	},
+	"homepage": "https://twindev.org"
+}