@twin.org/dataspace-data-plane-socket-client 0.0.3-next.15

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 Dataspace Data Plane Socket Client
+
+Dataspace Data Plane contract implementation which can connect to WebSocket endpoints.
+
+## Installation
+
+```shell
+npm install @twin.org/dataspace-data-plane-socket-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/dataspaceDataPlaneSocketClient.js

@@ -0,0 +1,236 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseSocketClient } from "@twin.org/api-core";
+import { BaseError, ComponentFactory, Converter, Guards, Is, NotImplementedError, NotSupportedError, RandomHelper } from "@twin.org/core";
+/**
+ * Dataspace data plane client which publishes using REST API and websockets.
+ */
+export class DataspaceDataPlaneSocketClient extends BaseSocketClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DataspaceDataPlaneSocketClient";
+    /**
+     * The topic for activity log events.
+     * @internal
+     */
+    static _ACTIVITY_LOG_TOPIC = "activity-log";
+    /**
+     * Activity processing details route.
+     */
+    static _ACTIVITY_LOG_STATUS_ROUTE = "activity-logs/status";
+    /**
+     * The logging service for information.
+     * @internal
+     */
+    _logging;
+    /**
+     * Subscriptions to the events.
+     * @internal
+     */
+    _activityLogSubscriptions;
+    /**
+     * Create a new instance of DataspaceDataPlaneSocketClient.
+     * @param options Options for the client.
+     */
+    constructor(options) {
+        super("DataspaceDataPlaneSocketClient", options?.config, "dataspace-data-plane");
+        this._activityLogSubscriptions = {
+            subscriberCallbacks: {}
+        };
+        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
+        super.onEvent("publish", async (data) => this.incomingPublishActivityLog(data));
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return DataspaceDataPlaneSocketClient.CLASS_NAME;
+    }
+    /**
+     * Notify an Activity to the Dataspace Activity Stream - implemented in REST Client.
+     * @param activity The Activity notified.
+     * @returns The Activity's identifier.
+     */
+    async notifyActivity(activity) {
+        // This method is in the REST client
+        throw new NotImplementedError(DataspaceDataPlaneSocketClient.CLASS_NAME, "notifyActivity");
+    }
+    /**
+     * Subscribes to the activity log.
+     * @param callback The callback to be called when Activity Log is called.
+     * @param subscriptionId The subscription Id.
+     * @returns The subscription Id.
+     */
+    async subscribeToActivityLog(callback, subscriptionId) {
+        Guards.function(DataspaceDataPlaneSocketClient.CLASS_NAME, "callback", callback);
+        let needsConnect = false;
+        // If we don't yet have an activity log subscription id then create one.
+        // we will also need to connect to the socket.
+        if (!Is.stringValue(this._activityLogSubscriptions.subscriptionId)) {
+            this._activityLogSubscriptions.subscriptionId = Converter.bytesToHex(RandomHelper.generate(16));
+            needsConnect = true;
+        }
+        // Store the callback for the specific local subscription
+        const localSubscriptionId = subscriptionId ?? Converter.bytesToHex(RandomHelper.generate(16));
+        this._activityLogSubscriptions.subscriberCallbacks[localSubscriptionId] = callback;
+        // If this the first subscription for the activity logs then send a subscribe to the socket.
+        if (needsConnect && super.socketConnect()) {
+            const request = {
+                body: {
+                    operation: "subscribe",
+                    subscriptionId: this._activityLogSubscriptions.subscriptionId
+                }
+            };
+            super.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, request);
+        }
+        await this._logging?.log({
+            level: "info",
+            source: DataspaceDataPlaneSocketClient.CLASS_NAME,
+            ts: Date.now(),
+            message: "subscribeActivityLogs",
+            data: {
+                topic: DataspaceDataPlaneSocketClient._ACTIVITY_LOG_TOPIC,
+                subscriptionId: this._activityLogSubscriptions.subscriptionId
+            }
+        });
+        return localSubscriptionId;
+    }
+    /**
+     * Unsubscribes to the activity log.
+     * @param subscriptionId The subscription Id.
+     * @returns The subscription Id.
+     */
+    async unSubscribeToActivityLog(subscriptionId) {
+        Guards.stringValue(DataspaceDataPlaneSocketClient.CLASS_NAME, "subscriptionId", subscriptionId);
+        if (this._activityLogSubscriptions.subscriberCallbacks[subscriptionId]) {
+            await this._logging?.log({
+                level: "info",
+                source: DataspaceDataPlaneSocketClient.CLASS_NAME,
+                ts: Date.now(),
+                message: "unsubscribeActivityLogs",
+                data: {
+                    subscriptionId
+                }
+            });
+            // We found the subscription id so remove it.
+            delete this._activityLogSubscriptions.subscriberCallbacks[subscriptionId];
+            // If there are no more subscriptions for the activity logs then send an unsubscribe to the socket.
+            if (super.socketConnect() && Is.stringValue(this._activityLogSubscriptions.subscriptionId)) {
+                const request = {
+                    body: {
+                        operation: "unsubscribe",
+                        subscriptionId: this._activityLogSubscriptions.subscriptionId
+                    }
+                };
+                super.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, request);
+            }
+        }
+        // There are no more subscriptions so disconnect the socket
+        if (Is.empty(this._activityLogSubscriptions.subscriptionId)) {
+            super.socketDisconnect();
+        }
+    }
+    /**
+     * Returns Activity Log Entry which contains the Activity processing details - implemented in REST Client.
+     * @param logEntryId The Id of the Activity Log Entry (a URI).
+     * @returns the Activity Log Entry with the processing details.
+     * @throws NotFoundError if activity log entry is not known.
+     */
+    async getActivityLogEntry(logEntryId) {
+        // This method is in the REST client
+        throw new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "getActivityLogEntry"
+        });
+    }
+    /**
+     * Get Data Asset entities. Allows to retrieve entities by their type or id.
+     * @param entitySet The set of entities to be retrieved.
+     * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.
+     * @param consumerPid The consumer Process ID from the DSP Transfer Process.
+     * Used to resolve datasetId from the Transfer Process.
+     * @param cursor Pagination details - cursor.
+     * @param limit Pagination details - max number of entities.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns The item list and optional cursor for pagination via Link headers.
+     */
+    async getDataAssetEntities(entitySet, consumerPid, cursor, limit, trustPayload) {
+        throw new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "getDataAssetEntities"
+        });
+    }
+    /**
+     * Queries a data asset controlled by this Dataspace App.
+     * @param consumerPid The consumer Process ID from the DSP Transfer Process.
+     * Used to resolve datasetId from the Transfer Process.
+     * @param query The filtering query.
+     * @param cursor Pagination details - cursor.
+     * @param limit Pagination details - max number of entities.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns The item list and optional cursor for pagination via Link headers.
+     */
+    async queryDataAsset(consumerPid, query, cursor, limit, trustPayload) {
+        throw new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "queryDataAsset"
+        });
+    }
+    /**
+     * Handle the socket connection.
+     */
+    async handleConnected() {
+        // The socket has reconnected so send subscribe requests
+        // for all the current subscriptions
+        if (Object.keys(this._activityLogSubscriptions.subscriberCallbacks).length > 0 &&
+            Is.stringValue(this._activityLogSubscriptions.subscriptionId)) {
+            const subscribeEmit = {
+                body: {
+                    operation: "subscribe",
+                    subscriptionId: this._activityLogSubscriptions.subscriptionId
+                }
+            };
+            super.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, subscribeEmit);
+        }
+    }
+    /**
+     * Handle an error.
+     * @param err The error to handle.
+     */
+    async handleError(err) {
+        await this._logging?.log({
+            level: "error",
+            source: DataspaceDataPlaneSocketClient.CLASS_NAME,
+            ts: Date.now(),
+            message: "socketConnect",
+            error: err
+        });
+    }
+    /**
+     * Handle an incoming publish event.
+     * @param topic The incoming topic.
+     * @param event The incoming data.
+     * @internal
+     */
+    async incomingPublishActivityLog(event) {
+        if (!Is.empty(event.body)) {
+            for (const subscriptionId in this._activityLogSubscriptions.subscriberCallbacks) {
+                try {
+                    await this._activityLogSubscriptions.subscriberCallbacks[subscriptionId](event.body);
+                }
+                catch (error) {
+                    await this._logging?.log({
+                        level: "error",
+                        source: DataspaceDataPlaneSocketClient.CLASS_NAME,
+                        ts: Date.now(),
+                        message: "callback",
+                        error: BaseError.fromError(error),
+                        data: {
+                            subscriptionId
+                        }
+                    });
+                }
+            }
+        }
+    }
+}
+//# sourceMappingURL=dataspaceDataPlaneSocketClient.js.map

package/dist/es/dataspaceDataPlaneSocketClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataspaceDataPlaneSocketClient.js","sourceRoot":"","sources":["../../src/dataspaceDataPlaneSocketClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EACN,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,MAAM,EAEN,EAAE,EACF,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,MAAM,gBAAgB,CAAC;AAgBxB;;GAEG;AACH,MAAM,OAAO,8BACZ,SAAQ,gBAAgB;IAGxB;;OAEG;IACI,MAAM,CAAU,UAAU,oCAAoD;IAErF;;;OAGG;IACK,MAAM,CAAU,mBAAmB,GAAG,cAAc,CAAC;IAE7D;;OAEG;IACK,MAAM,CAAU,0BAA0B,GAAG,sBAAsB,CAAC;IAE5E;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,yBAAyB,CAKxC;IAEF;;;OAGG;IACH,YAAY,OAA0D;QACrE,KAAK,mCAA2C,OAAO,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC;QAEzF,IAAI,CAAC,yBAAyB,GAAG;YAChC,mBAAmB,EAAE,EAAE;SACvB,CAAC;QAEF,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAAC,CAAC;QAEzF,KAAK,CAAC,OAAO,CAAgD,SAAS,EAAE,KAAK,EAAC,IAAI,EAAC,EAAE,CACpF,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,CACrC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,8BAA8B,CAAC,UAAU,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAkC;QAC7D,oCAAoC;QACpC,MAAM,IAAI,mBAAmB,CAAC,8BAA8B,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CAClC,QAAyE,EACzE,cAAuB;QAEvB,MAAM,CAAC,QAAQ,CAAC,8BAA8B,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEvF,IAAI,YAAY,GAAG,KAAK,CAAC;QAEzB,wEAAwE;QACxE,8CAA8C;QAC9C,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,yBAAyB,CAAC,cAAc,GAAG,SAAS,CAAC,UAAU,CACnE,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CACzB,CAAC;YACF,YAAY,GAAG,IAAI,CAAC;QACrB,CAAC;QAED,yDAAyD;QACzD,MAAM,mBAAmB,GAAG,cAAc,IAAI,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9F,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,GAAG,QAAQ,CAAC;QAEnF,4FAA4F;QAC5F,IAAI,YAAY,IAAI,KAAK,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3C,MAAM,OAAO,GAA8B;gBAC1C,IAAI,EAAE;oBACL,SAAS,EAAE,WAAW;oBACtB,cAAc,EAAE,IAAI,CAAC,yBAAyB,CAAC,cAAc;iBAC7D;aACD,CAAC;YACF,KAAK,CAAC,SAAS,CAAC,8BAA8B,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;QACrF,CAAC;QAED,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,8BAA8B,CAAC,UAAU;YACjD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,uBAAuB;YAChC,IAAI,EAAE;gBACL,KAAK,EAAE,8BAA8B,CAAC,mBAAmB;gBACzD,cAAc,EAAE,IAAI,CAAC,yBAAyB,CAAC,cAAc;aAC7D;SACD,CAAC,CAAC;QAEH,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,wBAAwB,CAAC,cAAsB;QAC3D,MAAM,CAAC,WAAW,CACjB,8BAA8B,CAAC,UAAU,oBAEzC,cAAc,CACd,CAAC;QAEF,IAAI,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,cAAc,CAAC,EAAE,CAAC;YACxE,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,8BAA8B,CAAC,UAAU;gBACjD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,yBAAyB;gBAClC,IAAI,EAAE;oBACL,cAAc;iBACd;aACD,CAAC,CAAC;YAEH,6CAA6C;YAC7C,OAAO,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;YAE1E,mGAAmG;YACnG,IAAI,KAAK,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC5F,MAAM,OAAO,GAA8B;oBAC1C,IAAI,EAAE;wBACL,SAAS,EAAE,aAAa;wBACxB,cAAc,EAAE,IAAI,CAAC,yBAAyB,CAAC,cAAc;qBAC7D;iBACD,CAAC;gBACF,KAAK,CAAC,SAAS,CAAC,8BAA8B,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;YACrF,CAAC;QACF,CAAC;QAED,2DAA2D;QAC3D,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAAE,CAAC;YAC7D,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,mBAAmB,CAAC,UAAkB;QAClD,oCAAoC;QACpC,MAAM,IAAI,iBAAiB,CAAC,8BAA8B,CAAC,UAAU,EAAE,sBAAsB,EAAE;YAC9F,UAAU,EAAE,qBAAqB;SACjC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,oBAAoB,CAChC,SAEC,EACD,WAAmB,EACnB,MAAe,EACf,KAAc,EACd,YAAsB;QAEtB,MAAM,IAAI,iBAAiB,CAAC,8BAA8B,CAAC,UAAU,EAAE,sBAAsB,EAAE;YAC9F,UAAU,EAAE,sBAAsB;SAClC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,cAAc,CAC1B,WAAmB,EACnB,KAAsB,EACtB,MAAe,EACf,KAAc,EACd,YAAsB;QAEtB,MAAM,IAAI,iBAAiB,CAAC,8BAA8B,CAAC,UAAU,EAAE,sBAAsB,EAAE;YAC9F,UAAU,EAAE,gBAAgB;SAC5B,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,eAAe;QAC9B,wDAAwD;QACxD,oCAAoC;QACpC,IACC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,CAAC,MAAM,GAAG,CAAC;YAC1E,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,yBAAyB,CAAC,cAAc,CAAC,EAC5D,CAAC;YACF,MAAM,aAAa,GAA8B;gBAChD,IAAI,EAAE;oBACL,SAAS,EAAE,WAAW;oBACtB,cAAc,EAAE,IAAI,CAAC,yBAAyB,CAAC,cAAc;iBAC7D;aACD,CAAC;YACF,KAAK,CAAC,SAAS,CAAC,8BAA8B,CAAC,0BAA0B,EAAE,aAAa,CAAC,CAAC;QAC3F,CAAC;IACF,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,WAAW,CAAC,GAAW;QACtC,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,8BAA8B,CAAC,UAAU;YACjD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,eAAe;YACxB,KAAK,EAAE,GAAG;SACV,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,0BAA0B,CACvC,KAAoD;QAEpD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,KAAK,MAAM,cAAc,IAAI,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,EAAE,CAAC;gBACjF,IAAI,CAAC;oBACJ,MAAM,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtF,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBAChB,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;wBACxB,KAAK,EAAE,OAAO;wBACd,MAAM,EAAE,8BAA8B,CAAC,UAAU;wBACjD,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;wBACd,OAAO,EAAE,UAAU;wBACnB,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;wBACjC,IAAI,EAAE;4BACL,cAAc;yBACd;qBACD,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseSocketClient } from \"@twin.org/api-core\";\nimport type { IHttpResponse } from \"@twin.org/api-models\";\nimport {\n\tBaseError,\n\tComponentFactory,\n\tConverter,\n\tGuards,\n\ttype IError,\n\tIs,\n\tNotImplementedError,\n\tNotSupportedError,\n\tRandomHelper\n} from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type {\n\tIActivityLogEntry,\n\tIActivityLogStatusNotification,\n\tIActivityLogStatusRequest,\n\tIDataAssetItemListResult,\n\tIDataspaceDataPlaneComponent,\n\tIEntitySet,\n\tIFilteringQuery\n} from \"@twin.org/dataspace-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IActivityStreamsActivity } from \"@twin.org/standards-w3c-activity-streams\";\nimport type { IDataspaceDataPlaneSocketClientConstructorOptions } from \"./models/IDataspaceDataPlaneSocketClientConstructorOptions.js\";\n\n/**\n * Dataspace data plane client which publishes using REST API and websockets.\n */\nexport class DataspaceDataPlaneSocketClient\n\textends BaseSocketClient\n\timplements IDataspaceDataPlaneComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DataspaceDataPlaneSocketClient>();\n\n\t/**\n\t * The topic for activity log events.\n\t * @internal\n\t */\n\tprivate static readonly _ACTIVITY_LOG_TOPIC = \"activity-log\";\n\n\t/**\n\t * Activity processing details route.\n\t */\n\tprivate static readonly _ACTIVITY_LOG_STATUS_ROUTE = \"activity-logs/status\";\n\n\t/**\n\t * The logging service for information.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * Subscriptions to the events.\n\t * @internal\n\t */\n\tprivate readonly _activityLogSubscriptions: {\n\t\tsubscriptionId?: string;\n\t\tsubscriberCallbacks: {\n\t\t\t[subscriptionId: string]: (notification: IActivityLogStatusNotification) => Promise<void>;\n\t\t};\n\t};\n\n\t/**\n\t * Create a new instance of DataspaceDataPlaneSocketClient.\n\t * @param options Options for the client.\n\t */\n\tconstructor(options: IDataspaceDataPlaneSocketClientConstructorOptions) {\n\t\tsuper(nameof<DataspaceDataPlaneSocketClient>(), options?.config, \"dataspace-data-plane\");\n\n\t\tthis._activityLogSubscriptions = {\n\t\t\tsubscriberCallbacks: {}\n\t\t};\n\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? \"logging\");\n\n\t\tsuper.onEvent<IHttpResponse<IActivityLogStatusNotification>>(\"publish\", async data =>\n\t\t\tthis.incomingPublishActivityLog(data)\n\t\t);\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 DataspaceDataPlaneSocketClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Notify an Activity to the Dataspace Activity Stream - implemented in REST Client.\n\t * @param activity The Activity notified.\n\t * @returns The Activity's identifier.\n\t */\n\tpublic async notifyActivity(activity: IActivityStreamsActivity): Promise<string> {\n\t\t// This method is in the REST client\n\t\tthrow new NotImplementedError(DataspaceDataPlaneSocketClient.CLASS_NAME, \"notifyActivity\");\n\t}\n\n\t/**\n\t * Subscribes to the activity log.\n\t * @param callback The callback to be called when Activity Log is called.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tpublic async subscribeToActivityLog(\n\t\tcallback: (notification: IActivityLogStatusNotification) => Promise<void>,\n\t\tsubscriptionId?: string\n\t): Promise<string> {\n\t\tGuards.function(DataspaceDataPlaneSocketClient.CLASS_NAME, nameof(callback), callback);\n\n\t\tlet needsConnect = false;\n\n\t\t// If we don't yet have an activity log subscription id then create one.\n\t\t// we will also need to connect to the socket.\n\t\tif (!Is.stringValue(this._activityLogSubscriptions.subscriptionId)) {\n\t\t\tthis._activityLogSubscriptions.subscriptionId = Converter.bytesToHex(\n\t\t\t\tRandomHelper.generate(16)\n\t\t\t);\n\t\t\tneedsConnect = true;\n\t\t}\n\n\t\t// Store the callback for the specific local subscription\n\t\tconst localSubscriptionId = subscriptionId ?? Converter.bytesToHex(RandomHelper.generate(16));\n\t\tthis._activityLogSubscriptions.subscriberCallbacks[localSubscriptionId] = callback;\n\n\t\t// If this the first subscription for the activity logs then send a subscribe to the socket.\n\t\tif (needsConnect && super.socketConnect()) {\n\t\t\tconst request: IActivityLogStatusRequest = {\n\t\t\t\tbody: {\n\t\t\t\t\toperation: \"subscribe\",\n\t\t\t\t\tsubscriptionId: this._activityLogSubscriptions.subscriptionId\n\t\t\t\t}\n\t\t\t};\n\t\t\tsuper.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, request);\n\t\t}\n\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: DataspaceDataPlaneSocketClient.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"subscribeActivityLogs\",\n\t\t\tdata: {\n\t\t\t\ttopic: DataspaceDataPlaneSocketClient._ACTIVITY_LOG_TOPIC,\n\t\t\t\tsubscriptionId: this._activityLogSubscriptions.subscriptionId\n\t\t\t}\n\t\t});\n\n\t\treturn localSubscriptionId;\n\t}\n\n\t/**\n\t * Unsubscribes to the activity log.\n\t * @param subscriptionId The subscription Id.\n\t * @returns The subscription Id.\n\t */\n\tpublic async unSubscribeToActivityLog(subscriptionId: string): Promise<void> {\n\t\tGuards.stringValue(\n\t\t\tDataspaceDataPlaneSocketClient.CLASS_NAME,\n\t\t\tnameof(subscriptionId),\n\t\t\tsubscriptionId\n\t\t);\n\n\t\tif (this._activityLogSubscriptions.subscriberCallbacks[subscriptionId]) {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: DataspaceDataPlaneSocketClient.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"unsubscribeActivityLogs\",\n\t\t\t\tdata: {\n\t\t\t\t\tsubscriptionId\n\t\t\t\t}\n\t\t\t});\n\n\t\t\t// We found the subscription id so remove it.\n\t\t\tdelete this._activityLogSubscriptions.subscriberCallbacks[subscriptionId];\n\n\t\t\t// If there are no more subscriptions for the activity logs then send an unsubscribe to the socket.\n\t\t\tif (super.socketConnect() && Is.stringValue(this._activityLogSubscriptions.subscriptionId)) {\n\t\t\t\tconst request: IActivityLogStatusRequest = {\n\t\t\t\t\tbody: {\n\t\t\t\t\t\toperation: \"unsubscribe\",\n\t\t\t\t\t\tsubscriptionId: this._activityLogSubscriptions.subscriptionId\n\t\t\t\t\t}\n\t\t\t\t};\n\t\t\t\tsuper.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, request);\n\t\t\t}\n\t\t}\n\n\t\t// There are no more subscriptions so disconnect the socket\n\t\tif (Is.empty(this._activityLogSubscriptions.subscriptionId)) {\n\t\t\tsuper.socketDisconnect();\n\t\t}\n\t}\n\n\t/**\n\t * Returns Activity Log Entry which contains the Activity processing details - implemented in REST Client.\n\t * @param logEntryId The Id of the Activity Log Entry (a URI).\n\t * @returns the Activity Log Entry with the processing details.\n\t * @throws NotFoundError if activity log entry is not known.\n\t */\n\tpublic async getActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry> {\n\t\t// This method is in the REST client\n\t\tthrow new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"getActivityLogEntry\"\n\t\t});\n\t}\n\n\t/**\n\t * Get Data Asset entities. Allows to retrieve entities by their type or id.\n\t * @param entitySet The set of entities to be retrieved.\n\t * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tpublic async getDataAssetEntities(\n\t\tentitySet: IEntitySet & {\n\t\t\tjsonLdContext?: IJsonLdContextDefinitionElement[];\n\t\t},\n\t\tconsumerPid: string,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult> {\n\t\tthrow new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"getDataAssetEntities\"\n\t\t});\n\t}\n\n\t/**\n\t * Queries a data asset controlled by this Dataspace App.\n\t * @param consumerPid The consumer Process ID from the DSP Transfer Process.\n\t * Used to resolve datasetId from the Transfer Process.\n\t * @param query The filtering query.\n\t * @param cursor Pagination details - cursor.\n\t * @param limit Pagination details - max number of entities.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The item list and optional cursor for pagination via Link headers.\n\t */\n\tpublic async queryDataAsset(\n\t\tconsumerPid: string,\n\t\tquery: IFilteringQuery,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\ttrustPayload?: unknown\n\t): Promise<IDataAssetItemListResult> {\n\t\tthrow new NotSupportedError(DataspaceDataPlaneSocketClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"queryDataAsset\"\n\t\t});\n\t}\n\n\t/**\n\t * Handle the socket connection.\n\t */\n\tprotected async handleConnected(): Promise<void> {\n\t\t// The socket has reconnected so send subscribe requests\n\t\t// for all the current subscriptions\n\t\tif (\n\t\t\tObject.keys(this._activityLogSubscriptions.subscriberCallbacks).length > 0 &&\n\t\t\tIs.stringValue(this._activityLogSubscriptions.subscriptionId)\n\t\t) {\n\t\t\tconst subscribeEmit: IActivityLogStatusRequest = {\n\t\t\t\tbody: {\n\t\t\t\t\toperation: \"subscribe\",\n\t\t\t\t\tsubscriptionId: this._activityLogSubscriptions.subscriptionId\n\t\t\t\t}\n\t\t\t};\n\t\t\tsuper.sendEvent(DataspaceDataPlaneSocketClient._ACTIVITY_LOG_STATUS_ROUTE, subscribeEmit);\n\t\t}\n\t}\n\n\t/**\n\t * Handle an error.\n\t * @param err The error to handle.\n\t */\n\tprotected async handleError(err: IError): Promise<void> {\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"error\",\n\t\t\tsource: DataspaceDataPlaneSocketClient.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"socketConnect\",\n\t\t\terror: err\n\t\t});\n\t}\n\n\t/**\n\t * Handle an incoming publish event.\n\t * @param topic The incoming topic.\n\t * @param event The incoming data.\n\t * @internal\n\t */\n\tprivate async incomingPublishActivityLog(\n\t\tevent: IHttpResponse<IActivityLogStatusNotification>\n\t): Promise<void> {\n\t\tif (!Is.empty(event.body)) {\n\t\t\tfor (const subscriptionId in this._activityLogSubscriptions.subscriberCallbacks) {\n\t\t\t\ttry {\n\t\t\t\t\tawait this._activityLogSubscriptions.subscriberCallbacks[subscriptionId](event.body);\n\t\t\t\t} catch (error) {\n\t\t\t\t\tawait this._logging?.log({\n\t\t\t\t\t\tlevel: \"error\",\n\t\t\t\t\t\tsource: DataspaceDataPlaneSocketClient.CLASS_NAME,\n\t\t\t\t\t\tts: Date.now(),\n\t\t\t\t\t\tmessage: \"callback\",\n\t\t\t\t\t\terror: BaseError.fromError(error),\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tsubscriptionId\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2025 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataspaceDataPlaneSocketClient.js";
+export * from "./models/IDataspaceDataPlaneSocketClientConfig.js";
+export * from "./models/IDataspaceDataPlaneSocketClientConstructorOptions.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,qCAAqC,CAAC;AACpD,cAAc,mDAAmD,CAAC;AAClE,cAAc,+DAA+D,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataspaceDataPlaneSocketClient.js\";\nexport * from \"./models/IDataspaceDataPlaneSocketClientConfig.js\";\nexport * from \"./models/IDataspaceDataPlaneSocketClientConstructorOptions.js\";\n"]}

package/dist/es/models/IDataspaceDataPlaneSocketClientConfig.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceDataPlaneSocketClientConfig.js.map

package/dist/es/models/IDataspaceDataPlaneSocketClientConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceDataPlaneSocketClientConfig.js","sourceRoot":"","sources":["../../../src/models/IDataspaceDataPlaneSocketClientConfig.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IBaseSocketClientConfig } from \"@twin.org/api-models\";\n\n/**\n * Definition of Dataspace Data Plane client configuration.\n */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface IDataspaceDataPlaneSocketClientConfig extends IBaseSocketClientConfig {}\n"]}

package/dist/es/models/IDataspaceDataPlaneSocketClientConstructorOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataspaceDataPlaneSocketClientConstructorOptions.js.map

package/dist/es/models/IDataspaceDataPlaneSocketClientConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataspaceDataPlaneSocketClientConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IDataspaceDataPlaneSocketClientConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDataspaceDataPlaneSocketClientConfig } from \"./IDataspaceDataPlaneSocketClientConfig.js\";\n\n/**\n * The options for the dataspace data plane socket client.\n */\nexport interface IDataspaceDataPlaneSocketClientConstructorOptions {\n\t/**\n\t * The type of logging component to use.\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the dataspace data plane socket client.\n\t */\n\tconfig: IDataspaceDataPlaneSocketClientConfig;\n}\n"]}

package/dist/types/dataspaceDataPlaneSocketClient.d.ts

@@ -0,0 +1,89 @@
+import { BaseSocketClient } from "@twin.org/api-core";
+import { type IError } from "@twin.org/core";
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { IActivityLogEntry, IActivityLogStatusNotification, IDataAssetItemListResult, IDataspaceDataPlaneComponent, IEntitySet, IFilteringQuery } from "@twin.org/dataspace-models";
+import type { IActivityStreamsActivity } from "@twin.org/standards-w3c-activity-streams";
+import type { IDataspaceDataPlaneSocketClientConstructorOptions } from "./models/IDataspaceDataPlaneSocketClientConstructorOptions.js";
+/**
+ * Dataspace data plane client which publishes using REST API and websockets.
+ */
+export declare class DataspaceDataPlaneSocketClient extends BaseSocketClient implements IDataspaceDataPlaneComponent {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Activity processing details route.
+     */
+    private static readonly _ACTIVITY_LOG_STATUS_ROUTE;
+    /**
+     * Create a new instance of DataspaceDataPlaneSocketClient.
+     * @param options Options for the client.
+     */
+    constructor(options: IDataspaceDataPlaneSocketClientConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Notify an Activity to the Dataspace Activity Stream - implemented in REST Client.
+     * @param activity The Activity notified.
+     * @returns The Activity's identifier.
+     */
+    notifyActivity(activity: IActivityStreamsActivity): Promise<string>;
+    /**
+     * Subscribes to the activity log.
+     * @param callback The callback to be called when Activity Log is called.
+     * @param subscriptionId The subscription Id.
+     * @returns The subscription Id.
+     */
+    subscribeToActivityLog(callback: (notification: IActivityLogStatusNotification) => Promise<void>, subscriptionId?: string): Promise<string>;
+    /**
+     * Unsubscribes to the activity log.
+     * @param subscriptionId The subscription Id.
+     * @returns The subscription Id.
+     */
+    unSubscribeToActivityLog(subscriptionId: string): Promise<void>;
+    /**
+     * Returns Activity Log Entry which contains the Activity processing details - implemented in REST Client.
+     * @param logEntryId The Id of the Activity Log Entry (a URI).
+     * @returns the Activity Log Entry with the processing details.
+     * @throws NotFoundError if activity log entry is not known.
+     */
+    getActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;
+    /**
+     * Get Data Asset entities. Allows to retrieve entities by their type or id.
+     * @param entitySet The set of entities to be retrieved.
+     * @param entitySet.jsonLdContext The JSON-LD Context to be used to expand the referred entityType.
+     * @param consumerPid The consumer Process ID from the DSP Transfer Process.
+     * Used to resolve datasetId from the Transfer Process.
+     * @param cursor Pagination details - cursor.
+     * @param limit Pagination details - max number of entities.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns The item list and optional cursor for pagination via Link headers.
+     */
+    getDataAssetEntities(entitySet: IEntitySet & {
+        jsonLdContext?: IJsonLdContextDefinitionElement[];
+    }, consumerPid: string, cursor?: string, limit?: number, trustPayload?: unknown): Promise<IDataAssetItemListResult>;
+    /**
+     * Queries a data asset controlled by this Dataspace App.
+     * @param consumerPid The consumer Process ID from the DSP Transfer Process.
+     * Used to resolve datasetId from the Transfer Process.
+     * @param query The filtering query.
+     * @param cursor Pagination details - cursor.
+     * @param limit Pagination details - max number of entities.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns The item list and optional cursor for pagination via Link headers.
+     */
+    queryDataAsset(consumerPid: string, query: IFilteringQuery, cursor?: string, limit?: number, trustPayload?: unknown): Promise<IDataAssetItemListResult>;
+    /**
+     * Handle the socket connection.
+     */
+    protected handleConnected(): Promise<void>;
+    /**
+     * Handle an error.
+     * @param err The error to handle.
+     */
+    protected handleError(err: IError): Promise<void>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dataspaceDataPlaneSocketClient.js";
+export * from "./models/IDataspaceDataPlaneSocketClientConfig.js";
+export * from "./models/IDataspaceDataPlaneSocketClientConstructorOptions.js";

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

@@ -0,0 +1,6 @@
+import type { IBaseSocketClientConfig } from "@twin.org/api-models";
+/**
+ * Definition of Dataspace Data Plane client configuration.
+ */
+export interface IDataspaceDataPlaneSocketClientConfig extends IBaseSocketClientConfig {
+}

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

@@ -0,0 +1,14 @@
+import type { IDataspaceDataPlaneSocketClientConfig } from "./IDataspaceDataPlaneSocketClientConfig.js";
+/**
+ * The options for the dataspace data plane socket client.
+ */
+export interface IDataspaceDataPlaneSocketClientConstructorOptions {
+    /**
+     * The type of logging component to use.
+     */
+    loggingComponentType?: string;
+    /**
+     * The configuration for the dataspace data plane socket client.
+     */
+    config: IDataspaceDataPlaneSocketClientConfig;
+}