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

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,19 @@
 # Changelog
 
+## [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 +359,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/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.19",
+	"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.19",
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next"
 	},