@twin.org/dataspace-models 0.0.3-next.15

package/docs/reference/interfaces/IEntitySet.md

@@ -0,0 +1,19 @@
+# Interface: IEntitySet
+
+Part of the Data Request interface to represent a set of entities either by id or by type
+
+## Properties
+
+### entityId?
+
+> `optional` **entityId**: `string`[]
+
+Entity Id.
+
+***
+
+### entityType
+
+> **entityType**: `string`
+
+The entity type.

package/docs/reference/interfaces/IExecutionPayload.md

@@ -0,0 +1,27 @@
+# Interface: IExecutionPayload
+
+Execution payload.
+
+## Properties
+
+### activityLogEntryId
+
+> **activityLogEntryId**: `string`
+
+The Activity Log Entry Id.
+
+***
+
+### activity
+
+> **activity**: `IActivityStreamsActivity`
+
+The activity
+
+***
+
+### executorApp
+
+> **executorApp**: `string`
+
+The executor App.

package/docs/reference/interfaces/IFilteringQuery.md

@@ -0,0 +1,27 @@
+# Interface: IFilteringQuery
+
+A query over a data asset that to be processed by a Dataspace Data Plane App.
+
+## Properties
+
+### type
+
+> **type**: `string`
+
+The query type.
+
+***
+
+### q
+
+> **q**: `unknown`
+
+The representation of the query.
+
+***
+
+### jsonLdContext?
+
+> `optional` **jsonLdContext**: `IJsonLdContextDefinitionElement`[]
+
+The JSON-LD context to be applied over the query terms.

package/docs/reference/interfaces/IGetTransferProcessRequest.md

@@ -0,0 +1,29 @@
+# Interface: IGetTransferProcessRequest
+
+API request for getting a transfer process state.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+Path parameters containing the process ID.
+
+#### pid
+
+> **pid**: `string`
+
+Process ID (consumerPid or providerPid).
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Authorization header containing the Base64-encoded trust payload.
+
+#### authorization
+
+> **authorization**: `string`

package/docs/reference/interfaces/IGetTransferProcessResponse.md

@@ -0,0 +1,19 @@
+# Interface: IGetTransferProcessResponse
+
+API response for getting a transfer process state.
+
+## Properties
+
+### body
+
+> **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
+
+Transfer Process (DSP compliant) with current state, or error.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+HTTP status code for the response.

package/docs/reference/interfaces/INegotiationCallback.md

@@ -0,0 +1,106 @@
+# Interface: INegotiationCallback
+
+Callback interface for negotiation state change notifications.
+Upstream modules register an implementation of this interface
+via IDataspaceControlPlaneComponent.registerNegotiationCallback()
+to be notified when PNP callbacks fire.
+
+## Methods
+
+### onStateChanged()
+
+> **onStateChanged**(`negotiationId`, `state`, `data?`): `Promise`\<`void`\>
+
+Called when the negotiation state changes (offer received, agreement received).
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The negotiation ID.
+
+##### state
+
+`DataspaceProtocolContractNegotiationStateType`
+
+The new state.
+
+##### data?
+
+Optional data associated with the state change.
+
+###### offer?
+
+`IOdrlOffer`
+
+The offer received from the provider.
+
+###### agreement?
+
+`IOdrlAgreement`
+
+The agreement received from the provider.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### onCompleted()
+
+> **onCompleted**(`negotiationId`, `agreementId`): `Promise`\<`void`\>
+
+Called when the negotiation completes successfully (finalized).
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The negotiation ID.
+
+##### agreementId
+
+`string`
+
+The agreement ID (from agreement.uid).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### onFailed()
+
+> **onFailed**(`negotiationId`, `reason`): `Promise`\<`void`\>
+
+Called when the negotiation fails (terminated or stalled).
+
+#### Parameters
+
+##### negotiationId
+
+`string`
+
+The negotiation ID.
+
+##### reason
+
+`string`
+
+The failure reason.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IQueryDataAssetRequest.md

@@ -0,0 +1,27 @@
+# Interface: IQueryDataAssetRequest
+
+Data Request type for representing data requests received by Dataspace Apps.
+
+## Properties
+
+### type
+
+> **type**: `"QueryDataAsset"`
+
+Data Asset Entities type.
+
+***
+
+### dataAsset
+
+> **dataAsset**: `IDataspaceProtocolDataset`
+
+The data asset we are referring to.
+
+***
+
+### query
+
+> **query**: [`IFilteringQuery`](IFilteringQuery.md)
+
+Query to perform filtering.

package/docs/reference/interfaces/IRequestTransferRequest.md

@@ -0,0 +1,23 @@
+# Interface: IRequestTransferRequest
+
+API request for requesting a transfer process.
+
+## Properties
+
+### headers
+
+> **headers**: `object`
+
+Authorization header containing the Base64-encoded trust payload.
+
+#### authorization
+
+> **authorization**: `string`
+
+***
+
+### body
+
+> **body**: `IDataspaceProtocolTransferRequestMessage`
+
+Transfer request message (DSP compliant).

package/docs/reference/interfaces/IRequestTransferResponse.md

@@ -0,0 +1,19 @@
+# Interface: IRequestTransferResponse
+
+API response for requesting a transfer process.
+
+## Properties
+
+### body
+
+> **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
+
+Transfer Process (DSP compliant) with state REQUESTED, or error.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+HTTP status code for the response.

package/docs/reference/interfaces/IStartTransferRequest.md

@@ -0,0 +1,37 @@
+# Interface: IStartTransferRequest
+
+API request for starting a transfer process.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+Path parameters containing the process ID.
+
+#### pid
+
+> **pid**: `string`
+
+Process ID (consumerPid).
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Authorization header containing the Base64-encoded trust payload.
+
+#### authorization
+
+> **authorization**: `string`
+
+***
+
+### body
+
+> **body**: `IDataspaceProtocolTransferStartMessage`
+
+Transfer start message (DSP compliant).

package/docs/reference/interfaces/IStartTransferResponse.md

@@ -0,0 +1,19 @@
+# Interface: IStartTransferResponse
+
+API response for starting a transfer process.
+
+## Properties
+
+### body
+
+> **body**: `IDataspaceProtocolTransferError` \| `IDataspaceProtocolTransferStartMessage`
+
+Transfer Start Message (DSP compliant) with dataAddress for PULL transfers, or error.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+HTTP status code for the response.

package/docs/reference/interfaces/ISuspendTransferRequest.md

@@ -0,0 +1,37 @@
+# Interface: ISuspendTransferRequest
+
+API request for suspending a transfer process.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+Path parameters containing the process ID.
+
+#### pid
+
+> **pid**: `string`
+
+Process ID (consumerPid).
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Authorization header containing the Base64-encoded trust payload.
+
+#### authorization
+
+> **authorization**: `string`
+
+***
+
+### body
+
+> **body**: `IDataspaceProtocolTransferSuspensionMessage`
+
+Transfer suspension message (DSP compliant).

package/docs/reference/interfaces/ISuspendTransferResponse.md

@@ -0,0 +1,19 @@
+# Interface: ISuspendTransferResponse
+
+API response for suspending a transfer process.
+
+## Properties
+
+### body
+
+> **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
+
+Transfer Process (DSP compliant) with state SUSPENDED, or error.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+HTTP status code for the response.

package/docs/reference/interfaces/ITaskApp.md

@@ -0,0 +1,19 @@
+# Interface: ITaskApp
+
+Denotes a task associated with a Dataspace App
+
+## Properties
+
+### taskId
+
+> **taskId**: `string`
+
+Task Id.
+
+***
+
+### dataspaceAppId
+
+> **dataspaceAppId**: `string`
+
+Dataspace App Id.

package/docs/reference/interfaces/ITerminateTransferRequest.md

@@ -0,0 +1,37 @@
+# Interface: ITerminateTransferRequest
+
+API request for terminating a transfer process.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+Path parameters containing the process ID.
+
+#### pid
+
+> **pid**: `string`
+
+Process ID (consumerPid).
+
+***
+
+### headers
+
+> **headers**: `object`
+
+Authorization header containing the Base64-encoded trust payload.
+
+#### authorization
+
+> **authorization**: `string`
+
+***
+
+### body
+
+> **body**: `IDataspaceProtocolTransferTerminationMessage`
+
+Transfer termination message (DSP compliant).

package/docs/reference/interfaces/ITerminateTransferResponse.md

@@ -0,0 +1,19 @@
+# Interface: ITerminateTransferResponse
+
+API response for terminating a transfer process.
+
+## Properties
+
+### body
+
+> **body**: `IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`
+
+Transfer Process (DSP compliant) with state TERMINATED, or error.
+
+***
+
+### statusCode?
+
+> `optional` **statusCode**: `HttpStatusCode`
+
+HTTP status code for the response.

package/docs/reference/interfaces/ITransferContext.md

@@ -0,0 +1,84 @@
+# Interface: ITransferContext
+
+Transfer Context data structure.
+Contains all information needed by DSC to execute queries.
+This is NOT part of the DSP protocol - it's a TWIN internal API
+used by dataspace-control-plane to resolve consumerPid to datasetId and policies.
+
+## Properties
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+Consumer Process ID.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+Provider Process ID.
+
+***
+
+### agreement
+
+> **agreement**: `IOdrlAgreement`
+
+Agreement associated with this Transfer Process.
+Contains permissions, obligations, and prohibitions that DSC uses for runtime policy enforcement.
+
+***
+
+### datasetId
+
+> **datasetId**: `string`
+
+Dataset ID - what the DSC needs to execute the query.
+Convenience field extracted from agreement.target for quick access.
+
+***
+
+### offerId
+
+> **offerId**: `string`
+
+Offer ID.
+
+***
+
+### state
+
+> **state**: `DataspaceProtocolTransferProcessStateType`
+
+Current Transfer Process state.
+DSC should only allow queries if state is STARTED.
+
+***
+
+### consumerIdentity?
+
+> `optional` **consumerIdentity**: `string`
+
+Consumer identity (for auditing).
+
+***
+
+### providerIdentity?
+
+> `optional` **providerIdentity**: `string`
+
+Provider identity (for auditing).
+Extracted from Agreement's assigner field.
+
+***
+
+### dataAddress?
+
+> `optional` **dataAddress**: `IDataspaceProtocolDataAddress`
+
+Data address for push mode transfers.
+Contains endpoint information where data should be pushed (for Activity Stream push mode).
+Only present when format is Http-Push-Activity-Stream-Format or Http-Post-Activity-Stream-Format.

package/docs/reference/interfaces/ITransferContextResponse.md

@@ -0,0 +1,13 @@
+# Interface: ITransferContextResponse
+
+Transfer Context Response (INTERNAL API for DSC).
+This is NOT part of the DSP protocol - it's a TWIN internal API
+used by dataspace-control-plane to resolve consumerPid to datasetId and policies.
+
+## Properties
+
+### body
+
+> **body**: [`ITransferContext`](ITransferContext.md)
+
+Request body