@twin.org/dataspace-data-plane-socket-client 0.0.3-next.18 → 0.0.3-next.20

package/README.md

@@ -1,6 +1,8 @@
-# TWIN Dataspace Data Plane Socket Client
+# Dataspace Data Plane Socket Client
 
-Dataspace Data Plane contract implementation which can connect to WebSocket endpoints.
+This package provides a WebSocket client for subscribing to activity log status notifications. It enables event-driven integrations that require timely status updates as activities progress through processing stages.
+
+It complements request-response clients by covering real-time notification scenarios.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.0.3-next.20](https://github.com/twinfoundation/dataspace/compare/dataspace-data-plane-socket-client-v0.0.3-next.19...dataspace-data-plane-socket-client-v0.0.3-next.20) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **dataspace-data-plane-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.19 to 0.0.3-next.20
+
+## [0.0.3-next.19](https://github.com/twinfoundation/dataspace/compare/dataspace-data-plane-socket-client-v0.0.3-next.18...dataspace-data-plane-socket-client-v0.0.3-next.19) (2026-03-12)
+
+
+### Miscellaneous Chores
+
+* **dataspace-data-plane-socket-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-models bumped from 0.0.3-next.18 to 0.0.3-next.19
+
 ## [0.0.3-next.18](https://github.com/twinfoundation/dataspace/compare/dataspace-data-plane-socket-client-v0.0.3-next.17...dataspace-data-plane-socket-client-v0.0.3-next.18) (2026-03-09)
 
 
@@ -345,4 +373,4 @@
   * dependencies
     * @twin.org/dataspace-models bumped from 0.0.1-next.0 to 0.0.1-next.1
 
-## @twin.org/dataspace-socket-client - Changelog
+## Changelog

package/docs/examples.md

@@ -1 +1,92 @@
-# @twin.org/dataspace-socket-client - Examples
+# Data Plane Socket Client Examples
+
+Use these snippets to consume activity updates over sockets and manage local subscription callbacks.
+
+## DataspaceDataPlaneSocketClient
+
+```typescript
+import { DataspaceDataPlaneSocketClient } from '@twin.org/dataspace-data-plane-socket-client';
+
+const client = new DataspaceDataPlaneSocketClient({
+  config: {
+    endpoint: 'ws://localhost:8090'
+  },
+  loggingComponentType: 'logging'
+});
+
+console.log(client.className()); // DataspaceDataPlaneSocketClient
+```
+
+```typescript
+import { DataspaceDataPlaneSocketClient } from '@twin.org/dataspace-data-plane-socket-client';
+
+const client = new DataspaceDataPlaneSocketClient({
+  config: {
+    endpoint: 'ws://localhost:8090'
+  }
+});
+
+const subscriptionId = await client.subscribeToActivityLog(async notification => {
+  console.log(notification.id); // urn:activity-log:2001
+  console.log(notification.status); // completed
+});
+
+await client.unSubscribeToActivityLog(subscriptionId);
+```
+
+```typescript
+import { DataspaceDataPlaneSocketClient } from '@twin.org/dataspace-data-plane-socket-client';
+
+const client = new DataspaceDataPlaneSocketClient({
+  config: {
+    endpoint: 'ws://localhost:8090'
+  }
+});
+
+try {
+  await client.getActivityLogEntry('urn:activity-log:2001');
+} catch (error) {
+  console.log(error instanceof Error); // true
+}
+
+try {
+  await client.getDataAssetEntities(
+    { entityType: 'https://vocabulary.uncefact.org/Consignment' },
+    'consumer-process-id',
+    undefined,
+    10,
+    'eyJhbGciOi...'
+  );
+} catch (error) {
+  console.log(error instanceof Error); // true
+}
+
+try {
+  await client.queryDataAsset('consumer-process-id', { query: {} }, undefined, 10, 'eyJhbGciOi...');
+} catch (error) {
+  console.log(error instanceof Error); // true
+}
+```
+
+```typescript
+import { DataspaceDataPlaneSocketClient } from '@twin.org/dataspace-data-plane-socket-client';
+import type { IActivityStreamsActivity } from '@twin.org/standards-w3c-activity-streams';
+
+const client = new DataspaceDataPlaneSocketClient({
+  config: {
+    endpoint: 'ws://localhost:8090'
+  }
+});
+
+const activity: IActivityStreamsActivity = {
+  '@context': 'https://www.w3.org/ns/activitystreams',
+  id: 'urn:activity:2001',
+  type: 'Create'
+};
+
+try {
+  await client.notifyActivity(activity);
+} catch (error) {
+  console.log(error instanceof Error); // true
+}
+```

package/docs/reference/classes/DataspaceDataPlaneSocketClient.md

@@ -36,7 +36,7 @@ Options for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### notifyActivity()
+### notifyActivity() {#notifyactivity}
 
 > **notifyActivity**(`activity`): `Promise`\<`string`\>
 
@@ -88,7 +88,7 @@ The Activity's identifier.
 
 ***
 
-### subscribeToActivityLog()
+### subscribeToActivityLog() {#subscribetoactivitylog}
 
 > **subscribeToActivityLog**(`callback`, `subscriptionId?`): `Promise`\<`string`\>
 
@@ -120,7 +120,7 @@ The subscription Id.
 
 ***
 
-### unSubscribeToActivityLog()
+### unSubscribeToActivityLog() {#unsubscribetoactivitylog}
 
 > **unSubscribeToActivityLog**(`subscriptionId`): `Promise`\<`void`\>
 
@@ -146,7 +146,7 @@ The subscription Id.
 
 ***
 
-### getActivityLogEntry()
+### getActivityLogEntry() {#getactivitylogentry}
 
 > **getActivityLogEntry**(`logEntryId`): `Promise`\<`IActivityLogEntry`\>
 
@@ -176,7 +176,7 @@ NotFoundError if activity log entry is not known.
 
 ***
 
-### getDataAssetEntities()
+### getDataAssetEntities() {#getdataassetentities}
 
 > **getDataAssetEntities**(`entitySet`, `consumerPid`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<`IDataAssetItemListResult`\>
 
@@ -227,7 +227,7 @@ The item list and optional cursor for pagination via Link headers.
 
 ***
 
-### queryDataAsset()
+### queryDataAsset() {#querydataasset}
 
 > **queryDataAsset**(`consumerPid`, `query`, `cursor?`, `limit?`, `trustPayload?`): `Promise`\<`IDataAssetItemListResult`\>
 
@@ -278,7 +278,7 @@ The item list and optional cursor for pagination via Link headers.
 
 ***
 
-### handleConnected()
+### handleConnected() {#handleconnected}
 
 > `protected` **handleConnected**(): `Promise`\<`void`\>
 
@@ -294,7 +294,7 @@ Handle the socket connection.
 
 ***
 
-### handleError()
+### handleError() {#handleerror}
 
 > `protected` **handleError**(`err`): `Promise`\<`void`\>
 

package/docs/reference/interfaces/IDataspaceDataPlaneSocketClientConstructorOptions.md

@@ -4,7 +4,7 @@ The options for the dataspace data plane socket client.
 
 ## Properties
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
 > `optional` **loggingComponentType**: `string`
 
@@ -12,7 +12,7 @@ The type of logging component to use.
 
 ***
 
-### config
+### config {#config}
 
 > **config**: [`IDataspaceDataPlaneSocketClientConfig`](IDataspaceDataPlaneSocketClientConfig.md)
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/dataspace-data-plane-socket-client",
-	"version": "0.0.3-next.18",
-	"description": "Dataspace Data Plane Socket client implementation",
+	"version": "0.0.3-next.20",
+	"description": "Provides a WebSocket client for subscribing to activity log status notifications.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/dataspace.git",
@@ -18,7 +18,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/dataspace-models": "0.0.3-next.18",
+		"@twin.org/dataspace-models": "0.0.3-next.20",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},