@twin.org/dataspace-models 0.9.2-next.10 → 0.9.2-next.11

package/dist/es/models/controlPlane/INegotiationCallback.js.map

@@ -1 +1 @@
-{"version":3,"file":"INegotiationCallback.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/INegotiationCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolContractNegotiationStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Callback interface for negotiation state change notifications.\n * Upstream modules register an implementation of this interface\n * via IDataspaceControlPlaneComponent.registerNegotiationCallback()\n * to be notified when PNP callbacks fire.\n */\nexport interface INegotiationCallback {\n\t/**\n\t * Called when the negotiation state changes (offer received, agreement received).\n\t * @param negotiationId The negotiation ID.\n\t * @param state The new state.\n\t * @param data Optional data associated with the state change.\n\t * @param data.offer The offer received from the provider.\n\t * @param data.agreement The agreement received from the provider.\n\t * @returns Nothing.\n\t */\n\tonStateChanged(\n\t\tnegotiationId: string,\n\t\tstate: DataspaceProtocolContractNegotiationStateType,\n\t\tdata?: { offer?: IDataspaceProtocolOffer; agreement?: IDataspaceProtocolAgreement }\n\t): Promise<void>;\n\n\t/**\n\t * Called when the negotiation finalizes.\n\t * @param negotiationId The negotiation ID, or undefined for implicit-trust agreements.\n\t * @param agreementId The agreement ID (from agreement.uid).\n\t * @returns Nothing.\n\t */\n\tonFinalized(negotiationId: string | undefined, agreementId: string): Promise<void>;\n\n\t/**\n\t * Called when the negotiation fails (terminated or stalled).\n\t * @param negotiationId The negotiation ID.\n\t * @param reason The failure reason.\n\t * @returns Nothing.\n\t */\n\tonFailed(negotiationId: string, reason: string): Promise<void>;\n\n\t/**\n\t * Called when the negotiation times out, i.e. the provider did not progress it within the configured\n\t * window. Optional: implement it to be notified specifically of a non-response (otherwise the\n\t * control plane falls back to `onFailed(negotiationId, \"negotiationStalled\")`).\n\t * @param negotiationId The negotiation ID.\n\t * @returns Nothing.\n\t */\n\tonTimeout?(negotiationId: string): Promise<void>;\n}\n"]}
+{"version":3,"file":"INegotiationCallback.js","sourceRoot":"","sources":["../../../../src/models/controlPlane/INegotiationCallback.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tDataspaceProtocolContractNegotiationStateType,\n\tIDataspaceProtocolAgreement,\n\tIDataspaceProtocolOffer\n} from \"@twin.org/standards-dataspace-protocol\";\n\n/**\n * Callback interface for negotiation state change notifications.\n * Upstream modules register an implementation of this interface\n * via IDataspaceControlPlaneComponent.registerNegotiationCallback()\n * to be notified when PNP callbacks fire.\n */\nexport interface INegotiationCallback {\n\t/**\n\t * Called when the negotiation state changes (offer received, agreement received).\n\t * @param negotiationId The negotiation ID.\n\t * @param state The new state.\n\t * @param data Optional data associated with the state change.\n\t * @param data.offer The offer received from the provider.\n\t * @param data.agreement The agreement received from the provider.\n\t * @returns Nothing.\n\t */\n\tonStateChanged(\n\t\tnegotiationId: string,\n\t\tstate: DataspaceProtocolContractNegotiationStateType,\n\t\tdata?: { offer?: IDataspaceProtocolOffer; agreement?: IDataspaceProtocolAgreement }\n\t): Promise<void>;\n\n\t/**\n\t * Called when the negotiation finalizes.\n\t * @param negotiationId The negotiation ID, or undefined for implicit-trust or agreement-reuse paths.\n\t * @param agreementId The agreement ID (from agreement.uid).\n\t * @param offerId The offer ID that triggered the negotiation; present when negotiationId is undefined so\n\t * callers with concurrent negotiations can discriminate which finalization belongs to them.\n\t * @returns Nothing.\n\t */\n\tonFinalized(\n\t\tnegotiationId: string | undefined,\n\t\tagreementId: string,\n\t\tofferId?: string\n\t): Promise<void>;\n\n\t/**\n\t * Called when the negotiation fails (terminated or stalled).\n\t * @param negotiationId The negotiation ID.\n\t * @param reason The failure reason.\n\t * @returns Nothing.\n\t */\n\tonFailed(negotiationId: string, reason: string): Promise<void>;\n\n\t/**\n\t * Called when the negotiation times out, i.e. the provider did not progress it within the configured\n\t * window. Optional: implement it to be notified specifically of a non-response (otherwise the\n\t * control plane falls back to `onFailed(negotiationId, \"negotiationStalled\")`).\n\t * @param negotiationId The negotiation ID.\n\t * @returns Nothing.\n\t */\n\tonTimeout?(negotiationId: string): Promise<void>;\n}\n"]}

package/dist/types/models/controlPlane/INegotiationCallback.d.ts

@@ -21,11 +21,13 @@ export interface INegotiationCallback {
     }): Promise<void>;
     /**
      * Called when the negotiation finalizes.
-     * @param negotiationId The negotiation ID, or undefined for implicit-trust agreements.
+     * @param negotiationId The negotiation ID, or undefined for implicit-trust or agreement-reuse paths.
      * @param agreementId The agreement ID (from agreement.uid).
+     * @param offerId The offer ID that triggered the negotiation; present when negotiationId is undefined so
+     * callers with concurrent negotiations can discriminate which finalization belongs to them.
      * @returns Nothing.
      */
-    onFinalized(negotiationId: string | undefined, agreementId: string): Promise<void>;
+    onFinalized(negotiationId: string | undefined, agreementId: string, offerId?: string): Promise<void>;
     /**
      * Called when the negotiation fails (terminated or stalled).
      * @param negotiationId The negotiation ID.

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.9.2-next.11](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.10...dataspace-models-v0.9.2-next.11) (2026-08-23)
+
+
+### Features
+
+* add correlation callbacks ([#354](https://github.com/iotaledger/twin-dataspace/issues/354)) ([d362fb6](https://github.com/iotaledger/twin-dataspace/commit/d362fb6b0816a62f72a77478d78fb3959a437b3c))
+
 ## [0.9.2-next.10](https://github.com/iotaledger/twin-dataspace/compare/dataspace-models-v0.9.2-next.9...dataspace-models-v0.9.2-next.10) (2026-08-16)
 
 

package/docs/reference/interfaces/INegotiationCallback.md

@@ -53,7 +53,7 @@ Nothing.
 
 ### onFinalized() {#onfinalized}
 
-> **onFinalized**(`negotiationId`, `agreementId`): `Promise`\<`void`\>
+> **onFinalized**(`negotiationId`, `agreementId`, `offerId?`): `Promise`\<`void`\>
 
 Called when the negotiation finalizes.
 
@@ -63,7 +63,7 @@ Called when the negotiation finalizes.
 
 `string` \| `undefined`
 
-The negotiation ID, or undefined for implicit-trust agreements.
+The negotiation ID, or undefined for implicit-trust or agreement-reuse paths.
 
 ##### agreementId
 
@@ -71,6 +71,13 @@ The negotiation ID, or undefined for implicit-trust agreements.
 
 The agreement ID (from agreement.uid).
 
+##### offerId?
+
+`string`
+
+The offer ID that triggered the negotiation; present when negotiationId is undefined so
+callers with concurrent negotiations can discriminate which finalization belongs to them.
+
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/dataspace-models",
-	"version": "0.9.2-next.10",
+	"version": "0.9.2-next.11",
 	"description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
 	"repository": {
 		"type": "git",