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

package/docs/reference/interfaces/IActivityLogStatusNotification.md

@@ -0,0 +1,45 @@
+# Interface: IActivityLogStatusNotification
+
+The status supplied to clients of the Dataspace Data Plane
+
+## Properties
+
+### activityLogEntryId
+
+> **activityLogEntryId**: `string`
+
+The activity log entry id.
+
+***
+
+### activityId?
+
+> `optional` **activityId**: `string`
+
+The activity Id.
+
+***
+
+### taskProcessingStatus
+
+> **taskProcessingStatus**: `object`
+
+The activity processing status through the associated tasks.
+
+#### taskId
+
+> **taskId**: `string`
+
+The task reported.
+
+#### dataspaceAppId
+
+> **dataspaceAppId**: `string`
+
+The Dataspace App.
+
+#### taskStatus
+
+> **taskStatus**: `TaskStatus`
+
+The status of the task reported. Only terminated and error are reported.

package/docs/reference/interfaces/IActivityLogStatusNotificationPayload.md

@@ -0,0 +1,11 @@
+# Interface: IActivityLogStatusNotificationPayload
+
+The status supplied to clients of the Dataspace Data Plane
+
+## Properties
+
+### body
+
+> **body**: [`IActivityLogStatusNotification`](IActivityLogStatusNotification.md)
+
+Body

package/docs/reference/interfaces/IActivityLogStatusRequest.md

@@ -0,0 +1,23 @@
+# Interface: IActivityLogStatusRequest
+
+Activity log status
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+Empty body.
+
+#### operation
+
+> **operation**: `"subscribe"` \| `"unsubscribe"`
+
+The operation to perform.
+
+#### subscriptionId
+
+> **subscriptionId**: `string`
+
+The subscription Id.

package/docs/reference/interfaces/IActivityQuery.md

@@ -0,0 +1,27 @@
+# Interface: IActivityQuery
+
+(Activity,Object,Target) query for denoting combinations to be handled by a Dataspace App.
+
+## Properties
+
+### activityType?
+
+> `optional` **activityType**: `string`
+
+FQN of the Activity type.
+
+***
+
+### objectType
+
+> **objectType**: `string`
+
+FQN of the Object Type.
+
+***
+
+### targetType?
+
+> `optional` **targetType**: `string`
+
+FQN of the target type.

package/docs/reference/interfaces/IActivityStreamNotifyRequest.md

@@ -0,0 +1,11 @@
+# Interface: IActivityStreamNotifyRequest
+
+Activity Stream Notify Request.
+
+## Properties
+
+### body
+
+> **body**: `IActivityStreamsActivity`
+
+The Activity sent to the Stream.

package/docs/reference/interfaces/IActivityTask.md

@@ -0,0 +1,19 @@
+# Interface: IActivityTask
+
+Denotes a task associated with an Activity
+
+## Properties
+
+### activityLogEntryId
+
+> **activityLogEntryId**: `string`
+
+The activity log entry.
+
+***
+
+### associatedTasks
+
+> **associatedTasks**: [`ITaskApp`](ITaskApp.md)[]
+
+The associated tasks

package/docs/reference/interfaces/ICompleteTransferRequest.md

@@ -0,0 +1,37 @@
+# Interface: ICompleteTransferRequest
+
+API request for completing 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**: `IDataspaceProtocolTransferCompletionMessage`
+
+Transfer completion message (DSP compliant).

package/docs/reference/interfaces/ICompleteTransferResponse.md

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

package/docs/reference/interfaces/IDataAssetEntitiesRequest.md

@@ -0,0 +1,27 @@
+# Interface: IDataAssetEntitiesRequest
+
+Data Request type for representing data requests received by Dataspace Apps.
+
+## Properties
+
+### type
+
+> **type**: `"DataAssetEntities"`
+
+Data Asset Entities type.
+
+***
+
+### dataAsset
+
+> **dataAsset**: `IDataspaceProtocolDataset`
+
+The data asset we are referring to.
+
+***
+
+### entitySet
+
+> **entitySet**: [`IEntitySet`](IEntitySet.md)
+
+The entity set.

package/docs/reference/interfaces/IDataAssetEntitiesResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDataAssetEntitiesResponse
+
+Response containing data asset entities with optional pagination Link header.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+Optional headers.
+
+#### link?
+
+> `optional` **link**: `string` \| `string`[]
+
+***
+
+### body
+
+> **body**: [`IDataAssetItemList`](IDataAssetItemList.md)
+
+The response payload.

package/docs/reference/interfaces/IDataAssetGetEntitiesRequest.md

@@ -0,0 +1,61 @@
+# Interface: IDataAssetGetEntitiesRequest
+
+Get Request Data Asset Entities
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### authorization?
+
+> `optional` **authorization**: `string`
+
+***
+
+### query
+
+> **query**: `object`
+
+The parameters from the query.
+
+#### id?
+
+> `optional` **id**: `string`
+
+The ID of the entity(ies) to get. (comma separated list)
+
+#### type
+
+> **type**: `string`
+
+The type of the entity to get.
+
+#### consumerPid
+
+> **consumerPid**: `string`
+
+The consumer Process ID from the DSP Transfer Process.
+Mandatory - used to determine the Dataset, Distribution, and Agreement.
+The datasetId is resolved from the Transfer Process using this ID.
+
+#### dataServiceId?
+
+> `optional` **dataServiceId**: `string`
+
+The Id of the data service that offers the data asset
+
+#### limit?
+
+> `optional` **limit**: `string`
+
+The maximum number of entities to retrieve.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+Cursor to control pagination.

package/docs/reference/interfaces/IDataAssetItemList.md

@@ -0,0 +1,28 @@
+# Interface: IDataAssetItemList
+
+Interface describing a list of entities that are within a Data Asset.
+Pagination is handled via HTTP Link headers.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.org"`
+
+The LD Context.
+
+***
+
+### type
+
+> **type**: `"ItemList"`
+
+The type
+
+***
+
+### itemListElement
+
+> **itemListElement**: `IJsonLdNodeObject`[]
+
+The components of the Collection

package/docs/reference/interfaces/IDataAssetItemListResult.md

@@ -0,0 +1,21 @@
+# Interface: IDataAssetItemListResult
+
+Result containing the data asset item list and optional pagination cursor.
+The cursor is returned via HTTP Link headers (RFC 8288), not in the response body.
+
+## Properties
+
+### itemList
+
+> **itemList**: [`IDataAssetItemList`](IDataAssetItemList.md)
+
+The item list data.
+
+***
+
+### cursor?
+
+> `optional` **cursor**: `string`
+
+Pagination cursor for retrieving the next page.
+This is used to generate the Link header, not included in the response body.

package/docs/reference/interfaces/IDataAssetQuery.md

@@ -0,0 +1,19 @@
+# Interface: IDataAssetQuery
+
+Data Asset query for internal service matching of datasets to apps.
+
+This interface is used internally by the Dataspace Data Plane service to match
+datasets with their corresponding apps. Apps should use `datasetsHandled(): IDataset[]`
+to declare which datasets they handle.
+
+## See
+
+IDataspaceDataPlaneApp.datasetsHandled
+
+## Properties
+
+### datasetId
+
+> **datasetId**: `string`
+
+Id of the dataset in the Catalogue (dataset @id).

package/docs/reference/interfaces/IDataAssetQueryRequest.md

@@ -0,0 +1,58 @@
+# Interface: IDataAssetQueryRequest
+
+Request to query data asset entities.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### authorization?
+
+> `optional` **authorization**: `string`
+
+***
+
+### body
+
+> **body**: `object`
+
+Request body containing the data asset and query criteria.
+
+#### consumerPid
+
+> **consumerPid**: `string`
+
+The consumer Process ID from the DSP Transfer Process.
+Mandatory - used to determine the Dataset, Distribution, and Agreement.
+The datasetId is resolved from the Transfer Process using this ID.
+
+#### query
+
+> **query**: [`IFilteringQuery`](IFilteringQuery.md)
+
+The filtering query.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+Optional query parameters for pagination.
+Used when following Link header URLs.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+Opaque cursor token for pagination.
+
+#### limit?
+
+> `optional` **limit**: `string`
+
+Maximum number of items to return.

package/docs/reference/interfaces/IDataspaceApp.md

@@ -0,0 +1,111 @@
+# Interface: IDataspaceApp
+
+Interface describes a Dataspace App.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### activitiesHandled()
+
+> **activitiesHandled**(): [`IActivityQuery`](IActivityQuery.md)[]
+
+The activities handled by the App.
+
+#### Returns
+
+[`IActivityQuery`](IActivityQuery.md)[]
+
+A query that describes the set of activities handled by the App.
+
+***
+
+### datasetsHandled()
+
+> **datasetsHandled**(): `Promise`\<`IDataspaceProtocolDataset`[]\>
+
+The datasets handled by the App.
+
+#### Returns
+
+`Promise`\<`IDataspaceProtocolDataset`[]\>
+
+The Dataspace Protocol compliant datasets handled by the App.
+
+***
+
+### supportedQueryTypes()
+
+> **supportedQueryTypes**(): `string`[]
+
+The types of queries supported.
+
+#### Returns
+
+`string`[]
+
+The types of queries supported by the Dataspace App to retrieve data.
+
+***
+
+### handleActivity()?
+
+> `optional` **handleActivity**\<`T`\>(`activity`): `Promise`\<`T`\>
+
+Handles an Activity and report about results through the Dataspace Data Plane Callback
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### activity
+
+`IActivityStreamsActivity`
+
+The Activity to be handled
+
+#### Returns
+
+`Promise`\<`T`\>
+
+The result of executing the Activity.
+
+***
+
+### handleDataRequest()?
+
+> `optional` **handleDataRequest**(`dataRequest`, `cursor?`, `limit?`): `Promise`\<\{ `data`: `IJsonLdDocument`; `cursor?`: `string`; \}\>
+
+Handles a Data Request.
+
+#### Parameters
+
+##### dataRequest
+
+[`IDataRequest`](../type-aliases/IDataRequest.md)
+
+The data request.
+
+##### cursor?
+
+`string`
+
+Cursor that points to the next item in the result set.
+
+##### limit?
+
+`number`
+
+Maximum number of entries retrieved or to be retrieved.
+
+#### Returns
+
+`Promise`\<\{ `data`: `IJsonLdDocument`; `cursor?`: `string`; \}\>
+
+Data as JSON-Ld.