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

package/docs/changelog.md

@@ -0,0 +1,306 @@
+# Changelog
+
+## [0.0.3-next.15](https://github.com/twinfoundation/dataspace/compare/dataspace-data-plane-socket-client-v0.0.3-next.14...dataspace-data-plane-socket-client-v0.0.3-next.15) (2026-03-02)
+
+
+### Features
+
+* unification of the data exchange and the data space connector ([#57](https://github.com/twinfoundation/dataspace/issues/57)) ([df2644d](https://github.com/twinfoundation/dataspace/commit/df2644d989471e07dadd83d27bef736179e31bf4))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.14 to 0.0.3-next.15
+
+## [0.0.3-next.12](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.11...dataspace-socket-client-v0.0.3-next.12) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.11 to 0.0.3-next.12
+
+## [0.0.3-next.11](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.10...dataspace-socket-client-v0.0.3-next.11) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.10 to 0.0.3-next.11
+
+## [0.0.3-next.10](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.9...dataspace-socket-client-v0.0.3-next.10) (2026-01-19)
+
+
+### Features
+
+* replace registerApp with factory pattern ([#51](https://github.com/twinfoundation/dataspace/issues/51)) ([a7ef328](https://github.com/twinfoundation/dataspace/commit/a7ef32873f5781f7b1f8aa3670f5fb612dd17018))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.8...dataspace-socket-client-v0.0.3-next.9) (2026-01-19)
+
+
+### Features
+
+* update data space connector to use trust service ([#47](https://github.com/twinfoundation/dataspace/issues/47)) ([41c5113](https://github.com/twinfoundation/dataspace/commit/41c5113512cdc477c2f9508b27dfaff84529d841))
+* update order of trustPayload parameter ([0656ddd](https://github.com/twinfoundation/dataspace/commit/0656ddd328accda0370d979a6cb5f947071e700b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.7...dataspace-socket-client-v0.0.3-next.8) (2026-01-16)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.6...dataspace-socket-client-v0.0.3-next.7) (2026-01-16)
+
+
+### Features
+
+* implement Link headers for pagination ([#43](https://github.com/twinfoundation/dataspace/issues/43)) ([ce2a31f](https://github.com/twinfoundation/dataspace/commit/ce2a31fab1b5a1338d34b8514e96a203705c68d1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.5...dataspace-socket-client-v0.0.3-next.6) (2026-01-15)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.4...dataspace-socket-client-v0.0.3-next.5) (2026-01-07)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.3...dataspace-socket-client-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* update standards dependencies ([8534ad7](https://github.com/twinfoundation/dataspace/commit/8534ad74b996610ed5994b5213c857989c2bf57a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.2...dataspace-socket-client-v0.0.3-next.3) (2025-12-01)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.1...dataspace-socket-client-v0.0.3-next.2) (2025-11-28)
+
+
+### Bug Fixes
+
+* not supported error handling ([b946505](https://github.com/twinfoundation/dataspace/commit/b9465059f2b4bdce1d79fbca596b3abd7eadc918))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.3-next.0...dataspace-socket-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#26](https://github.com/twinfoundation/dataspace/issues/26)) ([6429a16](https://github.com/twinfoundation/dataspace/commit/6429a160dac9499304fdfb93a9dbdce37277ca7d))
+* add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
+* add validate-locales ([c0b08a7](https://github.com/twinfoundation/dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
+* eslint migration to flat config ([b84e875](https://github.com/twinfoundation/dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
+* expose client methods ([3de1ecb](https://github.com/twinfoundation/dataspace/commit/3de1ecbd345d36cef352e9d4dce26353f21b3f99))
+* query interface data space connector ([#18](https://github.com/twinfoundation/dataspace/issues/18)) ([b12eca1](https://github.com/twinfoundation/dataspace/commit/b12eca124a8f46d290c168e364b7ed4bf72001d8))
+* update framework components ([4d9ca95](https://github.com/twinfoundation/dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
+* use new engine extensions config ([80bdb5b](https://github.com/twinfoundation/dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.1-next.8](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.7...dataspace-socket-client-v0.0.1-next.8) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([c0b08a7](https://github.com/twinfoundation/dataspace/commit/c0b08a73268f9fd3eb6ac3079b49d1ab0c01f118))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.7 to 0.0.1-next.8
+
+## [0.0.1-next.7](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.6...dataspace-socket-client-v0.0.1-next.7) (2025-10-02)
+
+
+### Features
+
+* use new engine extensions config ([80bdb5b](https://github.com/twinfoundation/dataspace/commit/80bdb5b298b65b5b22fa9927a0ad031cb9a3534d))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.6 to 0.0.1-next.7
+
+## [0.0.1-next.6](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.5...dataspace-socket-client-v0.0.1-next.6) (2025-09-29)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.5 to 0.0.1-next.6
+
+## [0.0.1-next.5](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.4...dataspace-socket-client-v0.0.1-next.5) (2025-09-29)
+
+
+### Features
+
+* update framework components ([4d9ca95](https://github.com/twinfoundation/dataspace/commit/4d9ca95879bd6cae9d031595292b6a872bf5b5fd))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.4 to 0.0.1-next.5
+
+## [0.0.1-next.4](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.3...dataspace-socket-client-v0.0.1-next.4) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([b84e875](https://github.com/twinfoundation/dataspace/commit/b84e87530aa249891618096ab6e072b21ff9f63a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.3 to 0.0.1-next.4
+
+## [0.0.1-next.3](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.2...dataspace-socket-client-v0.0.1-next.3) (2025-08-25)
+
+
+### Miscellaneous Chores
+
+* **dataspace-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.2 to 0.0.1-next.3
+
+## [0.0.1-next.2](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.1...dataspace-socket-client-v0.0.1-next.2) (2025-08-25)
+
+
+### Features
+
+* add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
+* expose client methods ([3de1ecb](https://github.com/twinfoundation/dataspace/commit/3de1ecbd345d36cef352e9d4dce26353f21b3f99))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.1 to 0.0.1-next.2
+
+## [0.0.1-next.1](https://github.com/twinfoundation/dataspace/compare/dataspace-socket-client-v0.0.1-next.0...dataspace-socket-client-v0.0.1-next.1) (2025-08-25)
+
+
+### Features
+
+* add rest and socket clients ([950bf70](https://github.com/twinfoundation/dataspace/commit/950bf705e6df4e709bbbe58e93968510067b9ddc))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.1-next.0 to 0.0.1-next.1
+
+## @twin.org/dataspace-socket-client - Changelog

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/dataspace-socket-client - Examples

package/docs/reference/classes/DataspaceDataPlaneSocketClient.md

@@ -0,0 +1,317 @@
+# Class: DataspaceDataPlaneSocketClient
+
+Dataspace data plane client which publishes using REST API and websockets.
+
+## Extends
+
+- `BaseSocketClient`
+
+## Implements
+
+- `IDataspaceDataPlaneComponent`
+
+## Constructors
+
+### Constructor
+
+> **new DataspaceDataPlaneSocketClient**(`options`): `DataspaceDataPlaneSocketClient`
+
+Create a new instance of DataspaceDataPlaneSocketClient.
+
+#### Parameters
+
+##### options
+
+[`IDataspaceDataPlaneSocketClientConstructorOptions`](../interfaces/IDataspaceDataPlaneSocketClientConstructorOptions.md)
+
+Options for the client.
+
+#### Returns
+
+`DataspaceDataPlaneSocketClient`
+
+#### Overrides
+
+`BaseSocketClient.constructor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.className`
+
+***
+
+### notifyActivity()
+
+> **notifyActivity**(`activity`): `Promise`\<`string`\>
+
+Notify an Activity to the Dataspace Activity Stream - implemented in REST Client.
+
+#### Parameters
+
+##### activity
+
+`IActivityStreamsActivity`
+
+The Activity notified.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The Activity's identifier.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.notifyActivity`
+
+***
+
+### subscribeToActivityLog()
+
+> **subscribeToActivityLog**(`callback`, `subscriptionId?`): `Promise`\<`string`\>
+
+Subscribes to the activity log.
+
+#### Parameters
+
+##### callback
+
+(`notification`) => `Promise`\<`void`\>
+
+The callback to be called when Activity Log is called.
+
+##### subscriptionId?
+
+`string`
+
+The subscription Id.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The subscription Id.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.subscribeToActivityLog`
+
+***
+
+### unSubscribeToActivityLog()
+
+> **unSubscribeToActivityLog**(`subscriptionId`): `Promise`\<`void`\>
+
+Unsubscribes to the activity log.
+
+#### Parameters
+
+##### subscriptionId
+
+`string`
+
+The subscription Id.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+The subscription Id.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.unSubscribeToActivityLog`
+
+***
+
+### getActivityLogEntry()
+
+> **getActivityLogEntry**(`logEntryId`): `Promise`\<`IActivityLogEntry`\>
+
+Returns Activity Log Entry which contains the Activity processing details - implemented in REST Client.
+
+#### Parameters
+
+##### logEntryId
+
+`string`
+
+The Id of the Activity Log Entry (a URI).
+
+#### Returns
+
+`Promise`\<`IActivityLogEntry`\>
+
+the Activity Log Entry with the processing details.
+
+#### Throws
+
+NotFoundError if activity log entry is not known.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.getActivityLogEntry`
+
+***
+
+### getDataAssetEntities()
+
+> **getDataAssetEntities**(`entitySet`, `consumerPid`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<`IDataAssetItemListResult`\>
+
+Get Data Asset entities. Allows to retrieve entities by their type or id.
+
+#### Parameters
+
+##### entitySet
+
+`IEntitySet` & `object`
+
+The set of entities to be retrieved.
+
+##### consumerPid
+
+`string`
+
+The consumer Process ID from the DSP Transfer Process.
+Used to resolve datasetId from the Transfer Process.
+
+##### cursor?
+
+`string`
+
+Pagination details - cursor.
+
+##### limit?
+
+`number`
+
+Pagination details - max number of entities.
+
+##### trustPayload?
+
+`unknown`
+
+Trust payload to verify the requesters identity.
+
+#### Returns
+
+`Promise`\<`IDataAssetItemListResult`\>
+
+The item list and optional cursor for pagination via Link headers.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.getDataAssetEntities`
+
+***
+
+### queryDataAsset()
+
+> **queryDataAsset**(`consumerPid`, `query`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<`IDataAssetItemListResult`\>
+
+Queries a data asset controlled by this Dataspace App.
+
+#### Parameters
+
+##### consumerPid
+
+`string`
+
+The consumer Process ID from the DSP Transfer Process.
+Used to resolve datasetId from the Transfer Process.
+
+##### query
+
+`IFilteringQuery`
+
+The filtering query.
+
+##### cursor?
+
+`string`
+
+Pagination details - cursor.
+
+##### limit?
+
+`number`
+
+Pagination details - max number of entities.
+
+##### trustPayload?
+
+`unknown`
+
+Trust payload to verify the requesters identity.
+
+#### Returns
+
+`Promise`\<`IDataAssetItemListResult`\>
+
+The item list and optional cursor for pagination via Link headers.
+
+#### Implementation of
+
+`IDataspaceDataPlaneComponent.queryDataAsset`
+
+***
+
+### handleConnected()
+
+> `protected` **handleConnected**(): `Promise`\<`void`\>
+
+Handle the socket connection.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`BaseSocketClient.handleConnected`
+
+***
+
+### handleError()
+
+> `protected` **handleError**(`err`): `Promise`\<`void`\>
+
+Handle an error.
+
+#### Parameters
+
+##### err
+
+`IError`
+
+The error to handle.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+`BaseSocketClient.handleError`

package/docs/reference/index.md

@@ -0,0 +1,10 @@
+# @twin.org/dataspace-data-plane-socket-client
+
+## Classes
+
+- [DataspaceDataPlaneSocketClient](classes/DataspaceDataPlaneSocketClient.md)
+
+## Interfaces
+
+- [IDataspaceDataPlaneSocketClientConfig](interfaces/IDataspaceDataPlaneSocketClientConfig.md)
+- [IDataspaceDataPlaneSocketClientConstructorOptions](interfaces/IDataspaceDataPlaneSocketClientConstructorOptions.md)

package/docs/reference/interfaces/IDataspaceDataPlaneSocketClientConfig.md

@@ -0,0 +1,7 @@
+# Interface: IDataspaceDataPlaneSocketClientConfig
+
+Definition of Dataspace Data Plane client configuration.
+
+## Extends
+
+- `IBaseSocketClientConfig`

package/docs/reference/interfaces/IDataspaceDataPlaneSocketClientConstructorOptions.md

@@ -0,0 +1,19 @@
+# Interface: IDataspaceDataPlaneSocketClientConstructorOptions
+
+The options for the dataspace data plane socket client.
+
+## Properties
+
+### loggingComponentType?
+
+> `optional` **loggingComponentType**: `string`
+
+The type of logging component to use.
+
+***
+
+### config
+
+> **config**: [`IDataspaceDataPlaneSocketClientConfig`](IDataspaceDataPlaneSocketClientConfig.md)
+
+The configuration for the dataspace data plane socket client.

package/locales/en.json

@@ -0,0 +1,15 @@
+{
+	"error": {
+		"dataspaceDataPlaneSocketClient": {
+			"socketConnect": "Failure during socket connect",
+			"callback": "Error when calling local callback",
+			"notSupportedOnClient": "The method \"{methodName}\" is not supported on the socket client, it can only be used on a server side component"
+		}
+	},
+	"info": {
+		"dataspaceDataPlaneSocketClient": {
+			"subscribeActivityLogs": "Subscription created for topic activity logs with id \"{subscriptionId}\"",
+			"unsubscribeActivityLogs": "Subscription removed for topic activity logs with id \"{subscriptionId}\""
+		}
+	}
+}