@twin.org/dataspace-data-plane-service 0.0.3-next.44 → 0.0.3-next.45

package/dist/es/dataspaceDataPlaneSocketRoutes.js

@@ -20,12 +20,12 @@ export function generateSocketRoutesDataspaceDataPlane(baseRouteName, componentN
     return [activityLogStatusWsRoute];
 }
 /**
- * Provides an status update.
+ * Handles an activity log subscribe or unsubscribe operation over a WebSocket.
  * @param socketRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
  * @param emitter The emitter to send message back.
- * @returns The response object with additional http response properties.
+ * @returns A promise that resolves when the subscribe or unsubscribe operation is complete.
  */
 export async function activityLogStatusUpdate(socketRequestContext, componentName, request, emitter) {
     Guards.object(ROUTES_SOURCE, "request", request);
@@ -49,6 +49,7 @@ export async function activityLogStatusUpdate(socketRequestContext, componentNam
  * Executes when there is a disconnection.
  * @param socketRequestContext Socket Request Context
  * @param componentName Component name.
+ * @returns A promise that resolves when the socket subscription has been removed.
  */
 export async function activityLogStatusDisconnected(socketRequestContext, componentName) {
     const logger = ComponentFactory.getIfExists(socketRequestContext.loggingComponentType);
@@ -64,8 +65,9 @@ export async function activityLogStatusDisconnected(socketRequestContext, compon
     await component.unSubscribeToActivityLog(socketRequestContext.socketId);
 }
 /**
- * Executes when there is a disconnection.
+ * Executes when a new socket connection is established.
  * @param socketRequestContext Socket Request Context
+ * @returns A promise that resolves when the connection event has been logged.
  */
 export async function activityLogStatusConnected(socketRequestContext) {
     const logger = ComponentFactory.getIfExists(socketRequestContext.loggingComponentType);

package/dist/es/dataspaceDataPlaneSocketRoutes.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataspaceDataPlaneSocketRoutes.js","sourceRoot":"","sources":["../../src/dataspaceDataPlaneSocketRoutes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAS1D;;GAEG;AACH,MAAM,aAAa,GAAG,gCAAgC,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,UAAU,sCAAsC,CACrD,aAAqB,EACrB,aAAqB;IAErB,MAAM,wBAAwB,GAG1B;QACH,WAAW,EAAE,aAAa;QAC1B,IAAI,EAAE,GAAG,aAAa,uBAAuB;QAC7C,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CACzD,uBAAuB,CAAC,oBAAoB,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/E,SAAS,EAAE,KAAK,EAAC,oBAAoB,EAAC,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,CAAC;QACzF,YAAY,EAAE,KAAK,EAAC,oBAAoB,EAAC,EAAE,CAC1C,6BAA6B,CAAC,oBAAoB,EAAE,aAAa,CAAC;KACnE,CAAC;IAEF,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC5C,oBAA2C,EAC3C,aAAqB,EACrB,OAAkC,EAClC,OAA0F;IAE1F,MAAM,CAAC,MAAM,CAA4B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAClF,MAAM,CAAC,WAAW,CAAC,aAAa,4BAAkC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1F,MAAM,CAAC,WAAW,CACjB,aAAa,iCAEb,OAAO,CAAC,IAAI,CAAC,cAAc,CAC3B,CAAC;IAEF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA+B,aAAa,CAAC,CAAC;IAEpF,QAAQ,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QAChC,KAAK,WAAW;YACf,MAAM,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;gBACpD,MAAM,OAAO,CAAC,SAAS,EAAE;oBACxB,IAAI,EAAE,KAAK;iBACX,CAAC,CAAC;YACJ,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAChC,MAAM;QACP,KAAK,aAAa;YACjB,MAAM,SAAS,CAAC,wBAAwB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM;IACR,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAClD,oBAA2C,EAC3C,aAAqB;IAErB,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAC1C,oBAAoB,CAAC,oBAAoB,CACzC,CAAC;IACF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA+B,aAAa,CAAC,CAAC;IAEpF,MAAM,MAAM,EAAE,GAAG,CAAC;QACjB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,+BAA+B;QACxC,IAAI,EAAE;YACL,QAAQ,EAAE,oBAAoB,CAAC,QAAQ;SACvC;KACD,CAAC,CAAC;IAEH,MAAM,SAAS,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,oBAA2C;IAE3C,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAC1C,oBAAoB,CAAC,oBAAoB,CACzC,CAAC;IAEF,MAAM,MAAM,EAAE,GAAG,CAAC;QACjB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE;YACL,QAAQ,EAAE,oBAAoB,CAAC,QAAQ;SACvC;KACD,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISocketRequestContext, ISocketRoute } from \"@twin.org/api-models\";\nimport { ComponentFactory, Guards } from \"@twin.org/core\";\nimport type {\n\tIActivityLogStatusNotificationPayload,\n\tIActivityLogStatusRequest,\n\tIDataspaceDataPlaneComponent\n} from \"@twin.org/dataspace-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * The source used when communicating about these routes.\n */\nconst ROUTES_SOURCE = \"dataspaceDataPlaneSocketRoutes\";\n\n/**\n * The socket routes for the Dataspace Data Plane.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateSocketRoutesDataspaceDataPlane(\n\tbaseRouteName: string,\n\tcomponentName: string\n): ISocketRoute[] {\n\tconst activityLogStatusWsRoute: ISocketRoute<\n\t\tIActivityLogStatusRequest,\n\t\tIActivityLogStatusNotificationPayload\n\t> = {\n\t\toperationId: \"statusQuery\",\n\t\tpath: `${baseRouteName}/activity-logs/status`,\n\t\thandler: async (socketRequestContext, request, emitter) =>\n\t\t\tactivityLogStatusUpdate(socketRequestContext, componentName, request, emitter),\n\t\tconnected: async socketRequestContext => activityLogStatusConnected(socketRequestContext),\n\t\tdisconnected: async socketRequestContext =>\n\t\t\tactivityLogStatusDisconnected(socketRequestContext, componentName)\n\t};\n\n\treturn [activityLogStatusWsRoute];\n}\n\n/**\n * Provides an status update.\n * @param socketRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @param emitter The emitter to send message back.\n * @returns The response object with additional http response properties.\n */\nexport async function activityLogStatusUpdate(\n\tsocketRequestContext: ISocketRequestContext,\n\tcomponentName: string,\n\trequest: IActivityLogStatusRequest,\n\temitter: (topic: string, response: IActivityLogStatusNotificationPayload) => Promise<void>\n): Promise<void> {\n\tGuards.object<IActivityLogStatusRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.body.operation), request.body.operation);\n\tGuards.stringValue(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body.subscriptionId),\n\t\trequest.body.subscriptionId\n\t);\n\n\tconst component = ComponentFactory.get<IDataspaceDataPlaneComponent>(componentName);\n\n\tswitch (request.body.operation) {\n\t\tcase \"subscribe\":\n\t\t\tawait component.subscribeToActivityLog(async event => {\n\t\t\t\tawait emitter(\"publish\", {\n\t\t\t\t\tbody: event\n\t\t\t\t});\n\t\t\t}, request.body.subscriptionId);\n\t\t\tbreak;\n\t\tcase \"unsubscribe\":\n\t\t\tawait component.unSubscribeToActivityLog(request.body.subscriptionId);\n\t\t\tbreak;\n\t}\n}\n\n/**\n * Executes when there is a disconnection.\n * @param socketRequestContext Socket Request Context\n * @param componentName Component name.\n */\nexport async function activityLogStatusDisconnected(\n\tsocketRequestContext: ISocketRequestContext,\n\tcomponentName: string\n): Promise<void> {\n\tconst logger = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\tsocketRequestContext.loggingComponentType\n\t);\n\tconst component = ComponentFactory.get<IDataspaceDataPlaneComponent>(componentName);\n\n\tawait logger?.log({\n\t\tsource: ROUTES_SOURCE,\n\t\tlevel: \"debug\",\n\t\tmessage: \"activityLogStatusDisconnected\",\n\t\tdata: {\n\t\t\tsocketId: socketRequestContext.socketId\n\t\t}\n\t});\n\n\tawait component.unSubscribeToActivityLog(socketRequestContext.socketId);\n}\n\n/**\n * Executes when there is a disconnection.\n * @param socketRequestContext Socket Request Context\n */\nexport async function activityLogStatusConnected(\n\tsocketRequestContext: ISocketRequestContext\n): Promise<void> {\n\tconst logger = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\tsocketRequestContext.loggingComponentType\n\t);\n\n\tawait logger?.log({\n\t\tsource: ROUTES_SOURCE,\n\t\tlevel: \"debug\",\n\t\tmessage: \"activityLogStatusConnected\",\n\t\tdata: {\n\t\t\tsocketId: socketRequestContext.socketId\n\t\t}\n\t});\n}\n"]}
+{"version":3,"file":"dataspaceDataPlaneSocketRoutes.js","sourceRoot":"","sources":["../../src/dataspaceDataPlaneSocketRoutes.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAS1D;;GAEG;AACH,MAAM,aAAa,GAAG,gCAAgC,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,UAAU,sCAAsC,CACrD,aAAqB,EACrB,aAAqB;IAErB,MAAM,wBAAwB,GAG1B;QACH,WAAW,EAAE,aAAa;QAC1B,IAAI,EAAE,GAAG,aAAa,uBAAuB;QAC7C,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,CACzD,uBAAuB,CAAC,oBAAoB,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/E,SAAS,EAAE,KAAK,EAAC,oBAAoB,EAAC,EAAE,CAAC,0BAA0B,CAAC,oBAAoB,CAAC;QACzF,YAAY,EAAE,KAAK,EAAC,oBAAoB,EAAC,EAAE,CAC1C,6BAA6B,CAAC,oBAAoB,EAAE,aAAa,CAAC;KACnE,CAAC;IAEF,OAAO,CAAC,wBAAwB,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC5C,oBAA2C,EAC3C,aAAqB,EACrB,OAAkC,EAClC,OAA0F;IAE1F,MAAM,CAAC,MAAM,CAA4B,aAAa,aAAmB,OAAO,CAAC,CAAC;IAClF,MAAM,CAAC,WAAW,CAAC,aAAa,4BAAkC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC1F,MAAM,CAAC,WAAW,CACjB,aAAa,iCAEb,OAAO,CAAC,IAAI,CAAC,cAAc,CAC3B,CAAC;IAEF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA+B,aAAa,CAAC,CAAC;IAEpF,QAAQ,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;QAChC,KAAK,WAAW;YACf,MAAM,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;gBACpD,MAAM,OAAO,CAAC,SAAS,EAAE;oBACxB,IAAI,EAAE,KAAK;iBACX,CAAC,CAAC;YACJ,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAChC,MAAM;QACP,KAAK,aAAa;YACjB,MAAM,SAAS,CAAC,wBAAwB,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACtE,MAAM;IACR,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAClD,oBAA2C,EAC3C,aAAqB;IAErB,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAC1C,oBAAoB,CAAC,oBAAoB,CACzC,CAAC;IACF,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAA+B,aAAa,CAAC,CAAC;IAEpF,MAAM,MAAM,EAAE,GAAG,CAAC;QACjB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,+BAA+B;QACxC,IAAI,EAAE;YACL,QAAQ,EAAE,oBAAoB,CAAC,QAAQ;SACvC;KACD,CAAC,CAAC;IAEH,MAAM,SAAS,CAAC,wBAAwB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC/C,oBAA2C;IAE3C,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAC1C,oBAAoB,CAAC,oBAAoB,CACzC,CAAC;IAEF,MAAM,MAAM,EAAE,GAAG,CAAC;QACjB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,OAAO;QACd,OAAO,EAAE,4BAA4B;QACrC,IAAI,EAAE;YACL,QAAQ,EAAE,oBAAoB,CAAC,QAAQ;SACvC;KACD,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISocketRequestContext, ISocketRoute } from \"@twin.org/api-models\";\nimport { ComponentFactory, Guards } from \"@twin.org/core\";\nimport type {\n\tIActivityLogStatusNotificationPayload,\n\tIActivityLogStatusRequest,\n\tIDataspaceDataPlaneComponent\n} from \"@twin.org/dataspace-models\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * The source used when communicating about these routes.\n */\nconst ROUTES_SOURCE = \"dataspaceDataPlaneSocketRoutes\";\n\n/**\n * The socket routes for the Dataspace Data Plane.\n * @param baseRouteName Prefix to prepend to the paths.\n * @param componentName The name of the component to use in the routes stored in the ComponentFactory.\n * @returns The generated routes.\n */\nexport function generateSocketRoutesDataspaceDataPlane(\n\tbaseRouteName: string,\n\tcomponentName: string\n): ISocketRoute[] {\n\tconst activityLogStatusWsRoute: ISocketRoute<\n\t\tIActivityLogStatusRequest,\n\t\tIActivityLogStatusNotificationPayload\n\t> = {\n\t\toperationId: \"statusQuery\",\n\t\tpath: `${baseRouteName}/activity-logs/status`,\n\t\thandler: async (socketRequestContext, request, emitter) =>\n\t\t\tactivityLogStatusUpdate(socketRequestContext, componentName, request, emitter),\n\t\tconnected: async socketRequestContext => activityLogStatusConnected(socketRequestContext),\n\t\tdisconnected: async socketRequestContext =>\n\t\t\tactivityLogStatusDisconnected(socketRequestContext, componentName)\n\t};\n\n\treturn [activityLogStatusWsRoute];\n}\n\n/**\n * Handles an activity log subscribe or unsubscribe operation over a WebSocket.\n * @param socketRequestContext The request context for the API.\n * @param componentName The name of the component to use in the routes.\n * @param request The request.\n * @param emitter The emitter to send message back.\n * @returns A promise that resolves when the subscribe or unsubscribe operation is complete.\n */\nexport async function activityLogStatusUpdate(\n\tsocketRequestContext: ISocketRequestContext,\n\tcomponentName: string,\n\trequest: IActivityLogStatusRequest,\n\temitter: (topic: string, response: IActivityLogStatusNotificationPayload) => Promise<void>\n): Promise<void> {\n\tGuards.object<IActivityLogStatusRequest>(ROUTES_SOURCE, nameof(request), request);\n\tGuards.stringValue(ROUTES_SOURCE, nameof(request.body.operation), request.body.operation);\n\tGuards.stringValue(\n\t\tROUTES_SOURCE,\n\t\tnameof(request.body.subscriptionId),\n\t\trequest.body.subscriptionId\n\t);\n\n\tconst component = ComponentFactory.get<IDataspaceDataPlaneComponent>(componentName);\n\n\tswitch (request.body.operation) {\n\t\tcase \"subscribe\":\n\t\t\tawait component.subscribeToActivityLog(async event => {\n\t\t\t\tawait emitter(\"publish\", {\n\t\t\t\t\tbody: event\n\t\t\t\t});\n\t\t\t}, request.body.subscriptionId);\n\t\t\tbreak;\n\t\tcase \"unsubscribe\":\n\t\t\tawait component.unSubscribeToActivityLog(request.body.subscriptionId);\n\t\t\tbreak;\n\t}\n}\n\n/**\n * Executes when there is a disconnection.\n * @param socketRequestContext Socket Request Context\n * @param componentName Component name.\n * @returns A promise that resolves when the socket subscription has been removed.\n */\nexport async function activityLogStatusDisconnected(\n\tsocketRequestContext: ISocketRequestContext,\n\tcomponentName: string\n): Promise<void> {\n\tconst logger = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\tsocketRequestContext.loggingComponentType\n\t);\n\tconst component = ComponentFactory.get<IDataspaceDataPlaneComponent>(componentName);\n\n\tawait logger?.log({\n\t\tsource: ROUTES_SOURCE,\n\t\tlevel: \"debug\",\n\t\tmessage: \"activityLogStatusDisconnected\",\n\t\tdata: {\n\t\t\tsocketId: socketRequestContext.socketId\n\t\t}\n\t});\n\n\tawait component.unSubscribeToActivityLog(socketRequestContext.socketId);\n}\n\n/**\n * Executes when a new socket connection is established.\n * @param socketRequestContext Socket Request Context\n * @returns A promise that resolves when the connection event has been logged.\n */\nexport async function activityLogStatusConnected(\n\tsocketRequestContext: ISocketRequestContext\n): Promise<void> {\n\tconst logger = ComponentFactory.getIfExists<ILoggingComponent>(\n\t\tsocketRequestContext.loggingComponentType\n\t);\n\n\tawait logger?.log({\n\t\tsource: ROUTES_SOURCE,\n\t\tlevel: \"debug\",\n\t\tmessage: \"activityLogStatusConnected\",\n\t\tdata: {\n\t\t\tsocketId: socketRequestContext.socketId\n\t\t}\n\t});\n}\n"]}

package/dist/es/entities/pushSubscription.js

@@ -6,13 +6,22 @@ import { entity, property, SortDirection } from "@twin.org/entity";
  * Primary key = consumerPid (same as TransferProcess).
  */
 let PushSubscription = class PushSubscription {
+    /**
+     * Consumer process ID identifying the transfer. Also the primary key for this entity.
+     */
     consumerPid;
+    /**
+     * Provider process ID from the DSP Transfer Process.
+     */
     providerPid;
     /**
      * ID of the Follow activity that created this subscription.
      * Used by Undo to reference it on teardown.
      */
     followActivityId;
+    /**
+     * Dataset ID identifying which dataset is being delivered.
+     */
     datasetId;
     /**
      * The tenant that owns this subscription, captured from the request context at
@@ -21,13 +30,23 @@ let PushSubscription = class PushSubscription {
      * into `consumerEndpoint` so cross-node push deliveries route to the right tenant.
      */
     tenantId;
+    /**
+     * The consumer's /inbox endpoint URL where activities are POSTed.
+     */
     consumerEndpoint;
+    /**
+     * Pre-packaged bearer token for authenticating pushes to the consumer endpoint.
+     * When absent a fresh JWT is generated at delivery time.
+     */
     consumerAuthToken;
     /**
      * When true deliveries are skipped (transfer SUSPENDED).
      * When false deliveries are flowing normally.
      */
     paused;
+    /**
+     * Creation timestamp (ISO string format).
+     */
     dateCreated;
     /**
      * Last-modified timestamp. Updated on suspend/resume (when `paused` flips) and on

package/dist/es/entities/pushSubscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"pushSubscription.js","sourceRoot":"","sources":["../../../src/entities/pushSubscription.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;;GAGG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAErB,WAAW,CAAU;IAGrB,WAAW,CAAU;IAE5B;;;OAGG;IAEI,gBAAgB,CAAU;IAG1B,SAAS,CAAU;IAE1B;;;;;OAKG;IAEI,QAAQ,CAAU;IAGlB,gBAAgB,CAAU;IAG1B,iBAAiB,CAAU;IAElC;;;OAGG;IAEI,MAAM,CAAW;IAGjB,WAAW,CAAU;IAE5B;;;;OAIG;IAEI,YAAY,CAAU;CAC7B,CAAA;AA/CO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;qDAClB;AAGrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;qDACD;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;0DACI;AAG1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;mDACH;AASnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACpB;AAGlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;0DACI;AAG1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACX;AAO3B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;;gDACN;AAGjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;qDAC/D;AAQrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;sDACrB;AAhDjB,gBAAgB;IAD5B,MAAM,EAAE;GACI,gBAAgB,CAiD5B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Persists a push subscription. One row per active push transfer.\n * Primary key = consumerPid (same as TransferProcess).\n */\n@entity()\nexport class PushSubscription {\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic consumerPid!: string;\n\n\t@property({ type: \"string\" })\n\tpublic providerPid!: string;\n\n\t/**\n\t * ID of the Follow activity that created this subscription.\n\t * Used by Undo to reference it on teardown.\n\t */\n\t@property({ type: \"string\" })\n\tpublic followActivityId!: string;\n\n\t@property({ type: \"string\" })\n\tpublic datasetId!: string;\n\n\t/**\n\t * The tenant that owns this subscription, captured from the request context at\n\t * write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`) register\n\t * subscriptions without a tenant context. The encrypted tenant token is also baked\n\t * into `consumerEndpoint` so cross-node push deliveries route to the right tenant.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic tenantId?: string;\n\n\t@property({ type: \"string\" })\n\tpublic consumerEndpoint!: string;\n\n\t@property({ type: \"string\", optional: true })\n\tpublic consumerAuthToken?: string;\n\n\t/**\n\t * When true deliveries are skipped (transfer SUSPENDED).\n\t * When false deliveries are flowing normally.\n\t */\n\t@property({ type: \"boolean\" })\n\tpublic paused!: boolean;\n\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last-modified timestamp. Updated on suspend/resume (when `paused` flips) and on\n\t * any subscription mutation. Matches the codebase convention of pairing `dateCreated`\n\t * with `dateModified` on entities whose state mutates.\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n}\n"]}
+{"version":3,"file":"pushSubscription.js","sourceRoot":"","sources":["../../../src/entities/pushSubscription.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;;GAGG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAC5B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;OAEG;IAEI,WAAW,CAAU;IAE5B;;;OAGG;IAEI,gBAAgB,CAAU;IAEjC;;OAEG;IAEI,SAAS,CAAU;IAE1B;;;;;OAKG;IAEI,QAAQ,CAAU;IAEzB;;OAEG;IAEI,gBAAgB,CAAU;IAEjC;;;OAGG;IAEI,iBAAiB,CAAU;IAElC;;;OAGG;IAEI,MAAM,CAAW;IAExB;;OAEG;IAEI,WAAW,CAAU;IAE5B;;;;OAIG;IAEI,YAAY,CAAU;CAC7B,CAAA;AA/DO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;qDAClB;AAMrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;qDACD;AAOrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;0DACI;AAM1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;mDACH;AASnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACpB;AAMlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;0DACI;AAO1B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;2DACX;AAO3B;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;;gDACN;AAMjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;qDAC/D;AAQrB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;;sDACrB;AAnEjB,gBAAgB;IAD5B,MAAM,EAAE;GACI,gBAAgB,CAoE5B","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Persists a push subscription. One row per active push transfer.\n * Primary key = consumerPid (same as TransferProcess).\n */\n@entity()\nexport class PushSubscription {\n\t/**\n\t * Consumer process ID identifying the transfer. Also the primary key for this entity.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic consumerPid!: string;\n\n\t/**\n\t * Provider process ID from the DSP Transfer Process.\n\t */\n\t@property({ type: \"string\" })\n\tpublic providerPid!: string;\n\n\t/**\n\t * ID of the Follow activity that created this subscription.\n\t * Used by Undo to reference it on teardown.\n\t */\n\t@property({ type: \"string\" })\n\tpublic followActivityId!: string;\n\n\t/**\n\t * Dataset ID identifying which dataset is being delivered.\n\t */\n\t@property({ type: \"string\" })\n\tpublic datasetId!: string;\n\n\t/**\n\t * The tenant that owns this subscription, captured from the request context at\n\t * write time. Optional — single-tenant nodes (no `TWIN_TENANT_ENABLED`) register\n\t * subscriptions without a tenant context. The encrypted tenant token is also baked\n\t * into `consumerEndpoint` so cross-node push deliveries route to the right tenant.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic tenantId?: string;\n\n\t/**\n\t * The consumer's /inbox endpoint URL where activities are POSTed.\n\t */\n\t@property({ type: \"string\" })\n\tpublic consumerEndpoint!: string;\n\n\t/**\n\t * Pre-packaged bearer token for authenticating pushes to the consumer endpoint.\n\t * When absent a fresh JWT is generated at delivery time.\n\t */\n\t@property({ type: \"string\", optional: true })\n\tpublic consumerAuthToken?: string;\n\n\t/**\n\t * When true deliveries are skipped (transfer SUSPENDED).\n\t * When false deliveries are flowing normally.\n\t */\n\t@property({ type: \"boolean\" })\n\tpublic paused!: boolean;\n\n\t/**\n\t * Creation timestamp (ISO string format).\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n\n\t/**\n\t * Last-modified timestamp. Updated on suspend/resume (when `paused` flips) and on\n\t * any subscription mutation. Matches the codebase convention of pairing `dateCreated`\n\t * with `dateModified` on entities whose state mutates.\n\t */\n\t@property({ type: \"string\", format: \"date-time\" })\n\tpublic dateModified!: string;\n}\n"]}

package/dist/es/restEntryPoints.js

@@ -1,4 +1,8 @@
 import { generateRestRoutesDataspaceDataPlane, tagsDataspaceDataPlane } from "./dataspaceDataPlaneRoutes.js";
+/**
+ * Entry points for the REST API.
+ * Defines REST routes for the Dataspace Data Plane.
+ */
 export const restEntryPoints = [
     {
         name: "dataspace-data-plane",

package/dist/es/restEntryPoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,oCAAoC,EACpC,sBAAsB,EACtB,MAAM,+BAA+B,CAAC;AAEvC,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,sBAAsB;QAC5B,gBAAgB,EAAE,sBAAsB;QACxC,IAAI,EAAE,sBAAsB;QAC5B,cAAc,EAAE,oCAAoC;KACpD;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport {\n\tgenerateRestRoutesDataspaceDataPlane,\n\ttagsDataspaceDataPlane\n} from \"./dataspaceDataPlaneRoutes.js\";\n\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"dataspace-data-plane\",\n\t\tdefaultBaseRoute: \"dataspace-data-plane\",\n\t\ttags: tagsDataspaceDataPlane,\n\t\tgenerateRoutes: generateRestRoutesDataspaceDataPlane\n\t}\n];\n"]}
+{"version":3,"file":"restEntryPoints.js","sourceRoot":"","sources":["../../src/restEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EACN,oCAAoC,EACpC,sBAAsB,EACtB,MAAM,+BAA+B,CAAC;AAEvC;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAA2B;IACtD;QACC,IAAI,EAAE,sBAAsB;QAC5B,gBAAgB,EAAE,sBAAsB;QACxC,IAAI,EAAE,sBAAsB;QAC5B,cAAc,EAAE,oCAAoC;KACpD;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IRestRouteEntryPoint } from \"@twin.org/api-models\";\nimport {\n\tgenerateRestRoutesDataspaceDataPlane,\n\ttagsDataspaceDataPlane\n} from \"./dataspaceDataPlaneRoutes.js\";\n\n/**\n * Entry points for the REST API.\n * Defines REST routes for the Dataspace Data Plane.\n */\nexport const restEntryPoints: IRestRouteEntryPoint[] = [\n\t{\n\t\tname: \"dataspace-data-plane\",\n\t\tdefaultBaseRoute: \"dataspace-data-plane\",\n\t\ttags: tagsDataspaceDataPlane,\n\t\tgenerateRoutes: generateRestRoutesDataspaceDataPlane\n\t}\n];\n"]}

package/dist/es/socketEntryPoints.js

@@ -1,5 +1,9 @@
 import { tagsDataspaceDataPlane } from "./dataspaceDataPlaneRoutes.js";
 import { generateSocketRoutesDataspaceDataPlane } from "./dataspaceDataPlaneSocketRoutes.js";
+/**
+ * Entry points for the WebSocket API.
+ * Defines socket routes for the Dataspace Data Plane activity log subscription.
+ */
 export const socketEntryPoints = [
     {
         name: "dataspace-data-plane",

package/dist/es/socketEntryPoints.js.map

@@ -1 +1 @@
-{"version":3,"file":"socketEntryPoints.js","sourceRoot":"","sources":["../../src/socketEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,sCAAsC,EAAE,MAAM,qCAAqC,CAAC;AAE7F,MAAM,CAAC,MAAM,iBAAiB,GAA6B;IAC1D;QACC,IAAI,EAAE,sBAAsB;QAC5B,gBAAgB,EAAE,sBAAsB;QACxC,IAAI,EAAE,sBAAsB;QAC5B,cAAc,EAAE,sCAAsC;KACtD;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISocketRouteEntryPoint } from \"@twin.org/api-models\";\nimport { tagsDataspaceDataPlane } from \"./dataspaceDataPlaneRoutes.js\";\nimport { generateSocketRoutesDataspaceDataPlane } from \"./dataspaceDataPlaneSocketRoutes.js\";\n\nexport const socketEntryPoints: ISocketRouteEntryPoint[] = [\n\t{\n\t\tname: \"dataspace-data-plane\",\n\t\tdefaultBaseRoute: \"dataspace-data-plane\",\n\t\ttags: tagsDataspaceDataPlane,\n\t\tgenerateRoutes: generateSocketRoutesDataspaceDataPlane\n\t}\n];\n"]}
+{"version":3,"file":"socketEntryPoints.js","sourceRoot":"","sources":["../../src/socketEntryPoints.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,sCAAsC,EAAE,MAAM,qCAAqC,CAAC;AAE7F;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAA6B;IAC1D;QACC,IAAI,EAAE,sBAAsB;QAC5B,gBAAgB,EAAE,sBAAsB;QACxC,IAAI,EAAE,sBAAsB;QAC5B,cAAc,EAAE,sCAAsC;KACtD;CACD,CAAC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISocketRouteEntryPoint } from \"@twin.org/api-models\";\nimport { tagsDataspaceDataPlane } from \"./dataspaceDataPlaneRoutes.js\";\nimport { generateSocketRoutesDataspaceDataPlane } from \"./dataspaceDataPlaneSocketRoutes.js\";\n\n/**\n * Entry points for the WebSocket API.\n * Defines socket routes for the Dataspace Data Plane activity log subscription.\n */\nexport const socketEntryPoints: ISocketRouteEntryPoint[] = [\n\t{\n\t\tname: \"dataspace-data-plane\",\n\t\tdefaultBaseRoute: \"dataspace-data-plane\",\n\t\ttags: tagsDataspaceDataPlane,\n\t\tgenerateRoutes: generateSocketRoutesDataspaceDataPlane\n\t}\n];\n"]}

package/dist/types/dataspaceDataPlaneService.d.ts

@@ -27,6 +27,7 @@ export declare class DataspaceDataPlaneService implements IDataspaceDataPlaneCom
     /**
      * The service needs to be started when the application is initialized.
      * @param nodeLoggingComponentType The node logging component type.
+     * @returns A promise that resolves when the push-delivery handler and cleanup task are registered.
      */
     start(nodeLoggingComponentType?: string): Promise<void>;
     /**
@@ -44,17 +45,21 @@ export declare class DataspaceDataPlaneService implements IDataspaceDataPlaneCom
      */
     subscribeToActivityLog(callback: (notification: IActivityLogStatusNotification) => Promise<void>, subscriptionId?: string): Promise<string>;
     /**
-     * Subscribes to the activity log.
-     * @param subscriptionId The Subscription Id.
+     * Unsubscribes from the activity log.
+     * @param subscriptionId The subscription Id to remove.
+     * @returns A promise that resolves when the subscription has been removed.
      */
     unSubscribeToActivityLog(subscriptionId: string): Promise<void>;
     /**
-     * Returns the activity processing details of an activity.
+     * Returns Activity Log Entry which contains the Activity processing details.
+     * Verifies the trust payload and asserts the caller is the entry's generator.
      * @param logEntryId The Id of the Activity Log Entry (a URI).
+     * @param trustPayload Trust payload to verify the requester's identity.
      * @returns the Activity Log Entry with the processing details.
      * @throws NotFoundError if activity log entry is not known.
+     * @throws UnauthorizedError if trustPayload is absent or the verified identity is not the entry generator.
      */
-    getActivityLogEntry(logEntryId: string): Promise<IActivityLogEntry>;
+    getActivityLogEntry(logEntryId: string, trustPayload?: unknown): Promise<IActivityLogEntry>;
     /**
      * Get Data Asset entities. Allows to retrieve entities by their type or id.
      * @param entitySet The set of entities to be retrieved.
@@ -120,6 +125,7 @@ export declare class DataspaceDataPlaneService implements IDataspaceDataPlaneCom
     /**
      * Schedule a push delivery when the app has new outbound data.
      * @param activity The outbound activity carrying the data payload.
+     * @returns A promise that resolves when the push delivery task has been scheduled.
      */
     processOutboxActivity(activity: IActivityStreamsActivity): Promise<void>;
 }

package/dist/types/dataspaceDataPlaneSocketRoutes.d.ts

@@ -8,22 +8,24 @@ import type { IActivityLogStatusNotificationPayload, IActivityLogStatusRequest }
  */
 export declare function generateSocketRoutesDataspaceDataPlane(baseRouteName: string, componentName: string): ISocketRoute[];
 /**
- * Provides an status update.
+ * Handles an activity log subscribe or unsubscribe operation over a WebSocket.
  * @param socketRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
  * @param emitter The emitter to send message back.
- * @returns The response object with additional http response properties.
+ * @returns A promise that resolves when the subscribe or unsubscribe operation is complete.
  */
 export declare function activityLogStatusUpdate(socketRequestContext: ISocketRequestContext, componentName: string, request: IActivityLogStatusRequest, emitter: (topic: string, response: IActivityLogStatusNotificationPayload) => Promise<void>): Promise<void>;
 /**
  * Executes when there is a disconnection.
  * @param socketRequestContext Socket Request Context
  * @param componentName Component name.
+ * @returns A promise that resolves when the socket subscription has been removed.
  */
 export declare function activityLogStatusDisconnected(socketRequestContext: ISocketRequestContext, componentName: string): Promise<void>;
 /**
- * Executes when there is a disconnection.
+ * Executes when a new socket connection is established.
  * @param socketRequestContext Socket Request Context
+ * @returns A promise that resolves when the connection event has been logged.
  */
 export declare function activityLogStatusConnected(socketRequestContext: ISocketRequestContext): Promise<void>;

package/dist/types/entities/pushSubscription.d.ts

@@ -3,13 +3,22 @@
  * Primary key = consumerPid (same as TransferProcess).
  */
 export declare class PushSubscription {
+    /**
+     * Consumer process ID identifying the transfer. Also the primary key for this entity.
+     */
     consumerPid: string;
+    /**
+     * Provider process ID from the DSP Transfer Process.
+     */
     providerPid: string;
     /**
      * ID of the Follow activity that created this subscription.
      * Used by Undo to reference it on teardown.
      */
     followActivityId: string;
+    /**
+     * Dataset ID identifying which dataset is being delivered.
+     */
     datasetId: string;
     /**
      * The tenant that owns this subscription, captured from the request context at
@@ -18,13 +27,23 @@ export declare class PushSubscription {
      * into `consumerEndpoint` so cross-node push deliveries route to the right tenant.
      */
     tenantId?: string;
+    /**
+     * The consumer's /inbox endpoint URL where activities are POSTed.
+     */
     consumerEndpoint: string;
+    /**
+     * Pre-packaged bearer token for authenticating pushes to the consumer endpoint.
+     * When absent a fresh JWT is generated at delivery time.
+     */
     consumerAuthToken?: string;
     /**
      * When true deliveries are skipped (transfer SUSPENDED).
      * When false deliveries are flowing normally.
      */
     paused: boolean;
+    /**
+     * Creation timestamp (ISO string format).
+     */
     dateCreated: string;
     /**
      * Last-modified timestamp. Updated on suspend/resume (when `paused` flips) and on

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,6 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * Entry points for the REST API.
+ * Defines REST routes for the Dataspace Data Plane.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/socketEntryPoints.d.ts

@@ -1,2 +1,6 @@
 import type { ISocketRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * Entry points for the WebSocket API.
+ * Defines socket routes for the Dataspace Data Plane activity log subscription.
+ */
 export declare const socketEntryPoints: ISocketRouteEntryPoint[];

package/docs/changelog.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## [0.0.3-next.45](https://github.com/iotaledger/twin-dataspace/compare/dataspace-data-plane-service-v0.0.3-next.44...dataspace-data-plane-service-v0.0.3-next.45) (2026-06-17)
+
+
+### Features
+
+* get activity log add trust payload ([#201](https://github.com/iotaledger/twin-dataspace/issues/201)) ([cdb5486](https://github.com/iotaledger/twin-dataspace/commit/cdb5486942c1b94ddf6435236b9b9d190bea0407))
+
+
+### Bug Fixes
+
+* remove incorrect comment ([c846908](https://github.com/iotaledger/twin-dataspace/commit/c846908c4c20a7ea4fb7184739b524a95b5086db))
+* use async getStore in tests ([739531e](https://github.com/iotaledger/twin-dataspace/commit/739531e1a159f728301835cd39cf06eab7a7bf4a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/dataspace-app-runner bumped from 0.0.3-next.44 to 0.0.3-next.45
+    * @twin.org/dataspace-models bumped from 0.0.3-next.44 to 0.0.3-next.45
+  * devDependencies
+    * @twin.org/dataspace-test-app bumped from 0.0.3-next.44 to 0.0.3-next.45
+
 ## [0.0.3-next.44](https://github.com/iotaledger/twin-dataspace/compare/dataspace-data-plane-service-v0.0.3-next.43...dataspace-data-plane-service-v0.0.3-next.44) (2026-06-12)
 
 

package/docs/open-api/spec.json

@@ -138,16 +138,20 @@
 						},
 						"style": "simple",
 						"example": "urn:x-activity-log:1234567"
-					}
-				],
-				"security": [
+					},
 					{
-						"jwtBearerAuthScheme": []
+						"name": "authorization",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
 					}
 				],
 				"responses": {
 					"200": {
-						"description": "Service Offering response",
+						"description": "Response containing a single activity log entry.",
 						"content": {
 							"application/json": {
 								"schema": {
@@ -195,24 +199,6 @@
 							}
 						}
 					},
-					"401": {
-						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
-						"content": {
-							"application/json": {
-								"schema": {
-									"$ref": "#/components/schemas/Error"
-								},
-								"examples": {
-									"exampleResponse": {
-										"value": {
-											"name": "UnauthorizedError",
-											"message": "errorMessage"
-										}
-									}
-								}
-							}
-						}
-					},
 					"500": {
 						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
 						"content": {

package/docs/reference/classes/DataspaceDataPlaneService.md

@@ -80,6 +80,8 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
+A promise that resolves when the push-delivery handler and cleanup task are registered.
+
 #### Implementation of
 
 `IDataspaceDataPlaneComponent.start`
@@ -154,7 +156,7 @@ The subscription Id.
 
 > **unSubscribeToActivityLog**(`subscriptionId`): `Promise`\<`void`\>
 
-Subscribes to the activity log.
+Unsubscribes from the activity log.
 
 #### Parameters
 
@@ -162,12 +164,14 @@ Subscribes to the activity log.
 
 `string`
 
-The Subscription Id.
+The subscription Id to remove.
 
 #### Returns
 
 `Promise`\<`void`\>
 
+A promise that resolves when the subscription has been removed.
+
 #### Implementation of
 
 `IDataspaceDataPlaneComponent.unSubscribeToActivityLog`
@@ -176,9 +180,10 @@ The Subscription Id.
 
 ### getActivityLogEntry() {#getactivitylogentry}
 
-> **getActivityLogEntry**(`logEntryId`): `Promise`\<`IActivityLogEntry`\>
+> **getActivityLogEntry**(`logEntryId`, `trustPayload?`): `Promise`\<`IActivityLogEntry`\>
 
-Returns the activity processing details of an activity.
+Returns Activity Log Entry which contains the Activity processing details.
+Verifies the trust payload and asserts the caller is the entry's generator.
 
 #### Parameters
 
@@ -188,6 +193,12 @@ Returns the activity processing details of an activity.
 
 The Id of the Activity Log Entry (a URI).
 
+##### trustPayload?
+
+`unknown`
+
+Trust payload to verify the requester's identity.
+
 #### Returns
 
 `Promise`\<`IActivityLogEntry`\>
@@ -198,6 +209,10 @@ the Activity Log Entry with the processing details.
 
 NotFoundError if activity log entry is not known.
 
+#### Throws
+
+UnauthorizedError if trustPayload is absent or the verified identity is not the entry generator.
+
 #### Implementation of
 
 `IDataspaceDataPlaneComponent.getActivityLogEntry`
@@ -470,6 +485,8 @@ The outbound activity carrying the data payload.
 
 `Promise`\<`void`\>
 
+A promise that resolves when the push delivery task has been scheduled.
+
 #### Implementation of
 
 `IDataspaceDataPlaneComponent.processOutboxActivity`

package/docs/reference/classes/PushSubscription.md

@@ -19,12 +19,16 @@ Primary key = consumerPid (same as TransferProcess).
 
 > **consumerPid**: `string`
 
+Consumer process ID identifying the transfer. Also the primary key for this entity.
+
 ***
 
 ### providerPid {#providerpid}
 
 > **providerPid**: `string`
 
+Provider process ID from the DSP Transfer Process.
+
 ***
 
 ### followActivityId {#followactivityid}
@@ -40,6 +44,8 @@ Used by Undo to reference it on teardown.
 
 > **datasetId**: `string`
 
+Dataset ID identifying which dataset is being delivered.
+
 ***
 
 ### tenantId? {#tenantid}
@@ -57,12 +63,17 @@ into `consumerEndpoint` so cross-node push deliveries route to the right tenant.
 
 > **consumerEndpoint**: `string`
 
+The consumer's /inbox endpoint URL where activities are POSTed.
+
 ***
 
 ### consumerAuthToken? {#consumerauthtoken}
 
 > `optional` **consumerAuthToken?**: `string`
 
+Pre-packaged bearer token for authenticating pushes to the consumer endpoint.
+When absent a fresh JWT is generated at delivery time.
+
 ***
 
 ### paused {#paused}
@@ -78,6 +89,8 @@ When false deliveries are flowing normally.
 
 > **dateCreated**: `string`
 
+Creation timestamp (ISO string format).
+
 ***
 
 ### dateModified {#datemodified}

package/docs/reference/functions/activityLogStatusConnected.md

@@ -2,7 +2,7 @@
 
 > **activityLogStatusConnected**(`socketRequestContext`): `Promise`\<`void`\>
 
-Executes when there is a disconnection.
+Executes when a new socket connection is established.
 
 ## Parameters
 
@@ -15,3 +15,5 @@ Socket Request Context
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the connection event has been logged.

package/docs/reference/functions/activityLogStatusDisconnected.md

@@ -21,3 +21,5 @@ Component name.
 ## Returns
 
 `Promise`\<`void`\>
+
+A promise that resolves when the socket subscription has been removed.

package/docs/reference/functions/activityLogStatusUpdate.md

@@ -2,7 +2,7 @@
 
 > **activityLogStatusUpdate**(`socketRequestContext`, `componentName`, `request`, `emitter`): `Promise`\<`void`\>
 
-Provides an status update.
+Handles an activity log subscribe or unsubscribe operation over a WebSocket.
 
 ## Parameters
 
@@ -34,4 +34,4 @@ The emitter to send message back.
 
 `Promise`\<`void`\>
 
-The response object with additional http response properties.
+A promise that resolves when the subscribe or unsubscribe operation is complete.

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,6 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+Entry points for the REST API.
+Defines REST routes for the Dataspace Data Plane.

package/docs/reference/variables/socketEntryPoints.md

@@ -1,3 +1,6 @@
 # Variable: socketEntryPoints
 
 > `const` **socketEntryPoints**: `ISocketRouteEntryPoint`[]
+
+Entry points for the WebSocket API.
+Defines socket routes for the Dataspace Data Plane activity log subscription.

package/locales/en.json

@@ -21,6 +21,7 @@
 			"invalidProcessingGroupId": "Invalid processing group id \"{processingGroupId}\" specified in activity query",
 			"missingHandleActivity": "Handler App \"{dataspaceAppId}\" does not export a \"handleActivity\" function",
 			"pushSubscriptionNotFound": "Push subscription not found for consumerPid \"{notFoundId}\"",
+			"activityLogEntryNotAuthorized": "Unauthorised access to activity log entry — the verified identity is not the entry generator",
 			"pushActivityNotAuthorized": "Unauthorized push activity — no matching STARTED transfer found for the activity generator",
 			"pushActivityNotPermittedByPolicy": "Push activity rejected — the transfer's agreement (\"{agreementId}\") does not permit the activity for consumerPid \"{consumerPid}\"",
 			"processOutboxActivityMultipleTo": "processOutboxActivity does not support multiple recipients — activity.to contains {count} values, expected exactly one consumerPid",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/dataspace-data-plane-service",
-	"version": "0.0.3-next.44",
+	"version": "0.0.3-next.45",
 	"description": "Processes activities and data requests while enforcing transfer and policy constraints in the data plane.",
 	"repository": {
 		"type": "git",
@@ -21,8 +21,8 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/dataspace-app-runner": "0.0.3-next.44",
-		"@twin.org/dataspace-models": "0.0.3-next.44",
+		"@twin.org/dataspace-app-runner": "0.0.3-next.45",
+		"@twin.org/dataspace-models": "0.0.3-next.45",
 		"@twin.org/engine-models": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",