@twin.org/dataspace-models 0.0.3-next.25 → 0.0.3-next.27

package/docs/reference/interfaces/IActivityTaskEntry.md

@@ -0,0 +1,67 @@
+# Interface: IActivityTaskEntry
+
+Denotes a task associated with a Dataspace App
+
+## Properties
+
+### taskId {#taskid}
+
+> **taskId**: `string`
+
+Task Id.
+
+***
+
+### dataspaceAppId {#dataspaceappid}
+
+> **dataspaceAppId**: `string`
+
+Dataspace App Id.
+
+***
+
+### status {#status}
+
+> **status**: [`ActivityTaskStatus`](../type-aliases/ActivityTaskStatus.md)
+
+Task status.
+
+***
+
+### processingGroupId? {#processinggroupid}
+
+> `optional` **processingGroupId?**: `string`
+
+Processing Group Id.
+
+***
+
+### startDate? {#startdate}
+
+> `optional` **startDate?**: `string`
+
+Task processing start timestamp
+
+***
+
+### endDate? {#enddate}
+
+> `optional` **endDate?**: `string`
+
+Task processing end timestamp
+
+***
+
+### result? {#result}
+
+> `optional` **result?**: `unknown`
+
+The result of the task processing, if completed.
+
+***
+
+### error? {#error}
+
+> `optional` **error?**: `IError`
+
+The error occurred during task processing, if any.

package/docs/reference/interfaces/IAppDatasetCreateRequest.md

@@ -0,0 +1,37 @@
+# Interface: IAppDatasetCreateRequest
+
+API request to register an app dataset.
+
+The owning `tenantId` is captured automatically from the request's tenant
+context — callers do not supply it.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the request.
+
+#### id?
+
+> `optional` **id?**: `string`
+
+Optional explicit id for the stored dataset record. If omitted, the
+Control Plane derives the id from `dataset["@id"]` if present, or
+generates a UUID otherwise. The resolved id is returned via the
+`Location` response header.
+
+#### appId
+
+> **appId**: `string`
+
+The dataspace app this dataset belongs to. Matches the app's
+registered name in `DataspaceAppFactory` (typically the app's URI).
+
+#### dataset
+
+> **dataset**: `IDataspaceProtocolDataset`
+
+The dataset payload. System-stamped fields like `dcterms:publisher`
+may be omitted — the Control Plane fills them in at publish time.

package/docs/reference/interfaces/IAppDatasetCreateResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAppDatasetCreateResponse
+
+API response from registering an app dataset.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers of the response, including the location of the new app dataset.
+
+#### location
+
+> **location**: `string`
+
+***
+
+### statusCode {#statuscode}
+
+> **statusCode**: `HttpStatusCode`
+
+HTTP status code (201 on success).

package/docs/reference/interfaces/IAppDatasetDeleteRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAppDatasetDeleteRequest
+
+API request to delete a stored app dataset record.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+Path parameters containing the stored dataset id.
+
+#### id
+
+> **id**: `string`
+
+The stored dataset id.

package/docs/reference/interfaces/IAppDatasetGetRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAppDatasetGetRequest
+
+API request to fetch a single app dataset record.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+Path parameters containing the stored app dataset id.
+
+#### id
+
+> **id**: `string`
+
+The stored app dataset id (entity primary key).

package/docs/reference/interfaces/IAppDatasetGetResponse.md

@@ -0,0 +1,11 @@
+# Interface: IAppDatasetGetResponse
+
+API response for a single stored app dataset record.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`IDataspaceAppDataset`](IDataspaceAppDataset.md)
+
+The body of the response.

package/docs/reference/interfaces/IAppDatasetListRequest.md

@@ -0,0 +1,23 @@
+# Interface: IAppDatasetListRequest
+
+API request to list the app datasets owned by the calling tenant.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+Query parameters for paging. Always strings on the wire.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+Cursor returned from a previous list call to fetch the next page.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Maximum number of entries to return (string-encoded; parsed on the server).

package/docs/reference/interfaces/IAppDatasetListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAppDatasetListResponse
+
+API response listing the app datasets owned by the calling tenant.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the response.
+
+#### entities
+
+> **entities**: [`IDataspaceAppDataset`](IDataspaceAppDataset.md)[]
+
+The stored datasets.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+Cursor to fetch the next page if more entries exist.

package/docs/reference/interfaces/IAppDatasetUpdateRequest.md

@@ -0,0 +1,38 @@
+# Interface: IAppDatasetUpdateRequest
+
+API request to update an existing app dataset record.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+Path parameters containing the stored app dataset id.
+
+#### id
+
+> **id**: `string`
+
+The stored app dataset id.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The body of the request.
+
+#### appId
+
+> **appId**: `string`
+
+The dataspace app this dataset belongs to. May change appId on
+update if the tenant wants to retarget the dataset.
+
+#### dataset
+
+> **dataset**: `IDataspaceProtocolDataset`
+
+The dataset payload.

package/docs/reference/interfaces/IDataspaceApp.md

@@ -8,6 +8,20 @@ Interface describes a Dataspace App.
 
 ## Methods
 
+### processingGroups()? {#processinggroups}
+
+> `optional` **processingGroups**(): `object`
+
+The settings for the processing groups for tasks.
+
+#### Returns
+
+`object`
+
+The options for each process group.
+
+***
+
 ### activitiesHandled() {#activitieshandled}
 
 > **activitiesHandled**(): [`IActivityQuery`](IActivityQuery.md)[]
@@ -22,17 +36,35 @@ A query that describes the set of activities handled by the App.
 
 ***
 
-### datasetsHandled() {#datasetshandled}
+### datasetsHandled()? {#datasetshandled}
 
-> **datasetsHandled**(): `Promise`\<`IDataspaceProtocolDataset`[]\>
+> `optional` **datasetsHandled**(`payload`, `tenantId`): `Promise`\<`IDataspaceProtocolDataset`[]\>
+
+Optional override called by the Control Plane when publishing a stored dataset for this app.
+The Control Plane always calls `populateDefaults` (e.g. `dcterms:publisher`)
+on every dataset returned here, so apps don't need to populate publisher themselves.
+
+#### Parameters
+
+##### payload
+
+`IDataspaceProtocolDataset`
+
+The user-stored dataset payload.
+
+##### tenantId
+
+`string`
 
-The datasets handled by the App.
+The owning tenant for this dataset. Empty string on
+single-tenant nodes (no `TWIN_TENANT_ENABLED`).
 
 #### Returns
 
 `Promise`\<`IDataspaceProtocolDataset`[]\>
 
-The Dataspace Protocol compliant datasets handled by the App.
+One or more datasets to publish to the catalogue. System-stamped
+fields like `dcterms:publisher` may be omitted — the Control Plane fills them in.
 
 ***
 

package/docs/reference/interfaces/IDataspaceAppDataset.md

@@ -0,0 +1,43 @@
+# Interface: IDataspaceAppDataset
+
+Stored dataset record returned by the Control Plane's dataset CRUD surface.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The stored dataset id (matches the dataset's JSON-LD `@id`).
+
+***
+
+### appId {#appid}
+
+> **appId**: `string`
+
+The dataspace app this dataset belongs to.
+
+***
+
+### dataset {#dataset}
+
+> **dataset**: `IDataspaceProtocolDataset`
+
+The dataset payload.
+
+***
+
+### dateCreated {#datecreated}
+
+> **dateCreated**: `string`
+
+Creation timestamp (ISO string).
+
+***
+
+### dateModified {#datemodified}
+
+> **dateModified**: `string`
+
+Last-modified timestamp (ISO string).

package/docs/reference/interfaces/IDataspaceControlPlaneComponent.md

@@ -406,3 +406,145 @@ Trust payload containing authorization information (JWT, VC, etc.).
 `Promise`\<`IDataspaceProtocolTransferProcess` \| `IDataspaceProtocolTransferError`\>
 
 Transfer Process (DSP compliant) with current state, or TransferError if the operation fails.
+
+***
+
+### createAppDataset() {#createappdataset}
+
+> **createAppDataset**(`id`, `appId`, `dataset`): `Promise`\<`string`\>
+
+Register an app dataset for a dataspace app, owned by the calling tenant.
+
+#### Parameters
+
+##### id
+
+`string` \| `undefined`
+
+Optional explicit id. If omitted, derived from `dataset["@id"]`
+or generated.
+
+##### appId
+
+`string`
+
+The dataspace app this dataset belongs to (matches
+`DataspaceAppFactory` registration name).
+
+##### dataset
+
+`IDataspaceProtocolDataset`
+
+The dataset payload (may omit system-stamped fields).
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The resolved dataset id.
+
+***
+
+### getAppDataset() {#getappdataset}
+
+> **getAppDataset**(`id`): `Promise`\<[`IDataspaceAppDataset`](IDataspaceAppDataset.md)\>
+
+Get an app dataset record owned by the calling tenant.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The stored app dataset id.
+
+#### Returns
+
+`Promise`\<[`IDataspaceAppDataset`](IDataspaceAppDataset.md)\>
+
+The stored app dataset record.
+
+***
+
+### listAppDatasets() {#listappdatasets}
+
+> **listAppDatasets**(`cursor?`, `limit?`): `Promise`\<\{ `entities`: [`IDataspaceAppDataset`](IDataspaceAppDataset.md)[]; `cursor?`: `string`; \}\>
+
+List the app datasets owned by the calling tenant.
+
+#### Parameters
+
+##### cursor?
+
+`string`
+
+Optional pagination cursor.
+
+##### limit?
+
+`number`
+
+Optional maximum number of entries to return.
+
+#### Returns
+
+`Promise`\<\{ `entities`: [`IDataspaceAppDataset`](IDataspaceAppDataset.md)[]; `cursor?`: `string`; \}\>
+
+The stored app datasets and the next-page cursor if more exist.
+
+***
+
+### updateAppDataset() {#updateappdataset}
+
+> **updateAppDataset**(`id`, `appId`, `dataset`): `Promise`\<`void`\>
+
+Update an app dataset record owned by the calling tenant.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The stored app dataset id.
+
+##### appId
+
+`string`
+
+The dataspace app this dataset belongs to.
+
+##### dataset
+
+`IDataspaceProtocolDataset`
+
+The dataset payload.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### deleteAppDataset() {#deleteappdataset}
+
+> **deleteAppDataset**(`id`): `Promise`\<`void`\>
+
+Delete an app dataset record owned by the calling tenant.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The stored app dataset id.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.

package/docs/reference/interfaces/IDataspaceDataPlaneComponent.md

@@ -11,7 +11,7 @@ Implements the Data Plane functionality for the Eclipse Dataspace Protocol.
 
 ### notifyActivity() {#notifyactivity}
 
-> **notifyActivity**(`activity`): `Promise`\<`string`\>
+> **notifyActivity**(`activity`): `Promise`\<`string` \| [`IActivityLogEntry`](IActivityLogEntry.md)\>
 
 Notify an Activity to the Dataspace Data Plane Activity Stream.
 
@@ -25,9 +25,9 @@ The Activity notified.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`string` \| [`IActivityLogEntry`](IActivityLogEntry.md)\>
 
-The Activity's identifier.
+The activity's entry.
 
 ***
 

package/docs/reference/interfaces/IExecutionPayload.md

@@ -20,8 +20,8 @@ The activity
 
 ***
 
-### executorApp {#executorapp}
+### dataspaceAppId {#dataspaceappid}
 
-> **executorApp**: `string`
+> **dataspaceAppId**: `string`
 
-The executor App.
+The dataspace App ID.

package/docs/reference/interfaces/IProcessingGroupOptions.md

@@ -0,0 +1,28 @@
+# Interface: IProcessingGroupOptions
+
+Interface describes the options for a processing group, which determines how many tasks can be processed in parallel for a given group of activities.
+
+## Properties
+
+### concurrentTasks? {#concurrenttasks}
+
+> `optional` **concurrentTasks?**: `number`
+
+The number of concurrent tasks that can be processed for this processing group.
+
+***
+
+### idleShutdownTimeout? {#idleshutdowntimeout}
+
+> `optional` **idleShutdownTimeout?**: `number`
+
+Terminate the worker after it has been idle for the specified timeout in milliseconds,
+defaults to 0 for immediate shutdown, set to -1 to keep workers alive.
+
+***
+
+### retryCount? {#retrycount}
+
+> `optional` **retryCount?**: `number`
+
+The number of times a task in this processing group should be retried in case of failure.

package/docs/reference/type-aliases/ActivityTaskStatus.md

@@ -0,0 +1,5 @@
+# Type Alias: ActivityTaskStatus
+
+> **ActivityTaskStatus** = *typeof* [`ActivityTaskStatus`](../variables/ActivityTaskStatus.md)\[keyof *typeof* [`ActivityTaskStatus`](../variables/ActivityTaskStatus.md)\]
+
+Activity task statuses.

package/docs/reference/type-aliases/DataspaceTransferFormat.md

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceTransferFormat
+
+> **DataspaceTransferFormat** = *typeof* [`DataspaceTransferFormat`](../variables/DataspaceTransferFormat.md)\[keyof *typeof* [`DataspaceTransferFormat`](../variables/DataspaceTransferFormat.md)\]
+
+Type for the DataspaceTransferFormat const values.

package/docs/reference/variables/ActivityTaskStatus.md

@@ -0,0 +1,31 @@
+# Variable: ActivityTaskStatus
+
+> `const` **ActivityTaskStatus**: `object`
+
+Activity task statuses.
+
+## Type Declaration
+
+### Pending {#pending}
+
+> `readonly` **Pending**: `"pending"` = `"pending"`
+
+Pending.
+
+### Processing {#processing}
+
+> `readonly` **Processing**: `"processing"` = `"processing"`
+
+Processing.
+
+### Success {#success}
+
+> `readonly` **Success**: `"success"` = `"success"`
+
+Success.
+
+### Failed {#failed}
+
+> `readonly` **Failed**: `"failed"` = `"failed"`
+
+Failed.

package/docs/reference/variables/DataspaceTransferFormat.md

@@ -0,0 +1,32 @@
+# Variable: DataspaceTransferFormat
+
+> `const` **DataspaceTransferFormat**: `object`
+
+TWIN transfer format identifiers used in TransferRequestMessage.format.
+Follows the Eclipse EDC canonical pattern: <DestinationType-FlowType>.
+See RFC-007 Data Transfer Profile.
+
+## Type Declaration
+
+### HttpProxyPull {#httpproxypull}
+
+> `readonly` **HttpProxyPull**: `"HttpProxy-PULL"` = `"HttpProxy-PULL"`
+
+PULL mode: consumer queries data via a bearer-token-protected endpoint.
+Data flows: Consumer GET provider endpoint (with token).
+
+### HttpProxyPush {#httpproxypush}
+
+> `readonly` **HttpProxyPush**: `"HttpProxy-PUSH"` = `"HttpProxy-PUSH"`
+
+Consumer-initiated PUSH mode: consumer supplies their /inbox endpoint in the
+TransferRequestMessage. Provider pushes ActivityStreams objects to that endpoint.
+Data flows: Provider POST to consumer's /inbox.
+
+### HttpProxyPost {#httpproxypost}
+
+> `readonly` **HttpProxyPost**: `"HttpProxy-POST"` = `"HttpProxy-POST"`
+
+Provider-initiated PUSH mode (inverted flow): consumer supplies no dataAddress.
+Provider returns its own /inbox URL + signed JWT. Consumer then posts data there.
+Data flows: Consumer POST to provider's /inbox.

package/docs/reference/variables/DataspaceTypes.md

@@ -9,3 +9,5 @@ The types concerning dataspace
 ### Activity {#activity}
 
 > `readonly` **Activity**: `"Activity"` = `"Activity"`
+
+Activity type.

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/dataspace-models",
-	"version": "0.0.3-next.25",
+	"version": "0.0.3-next.27",
 	"description": "Defines shared entities, interfaces, and data types used by control plane and data plane components.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/dataspace.git",
+		"url": "git+https://github.com/iotaledger/dataspace.git",
 		"directory": "packages/dataspace-models"
 	},
 	"author": "jose.cantera@iota.org",
@@ -56,7 +56,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/dataspace/issues"
+		"url": "git+https://github.com/iotaledger/dataspace/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/models/IActivityLogDates.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IActivityLogDates.js","sourceRoot":"","sources":["../../../src/models/IActivityLogDates.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Activity log dates.\n */\nexport interface IActivityLogDates {\n\t/**\n\t * Task processing start timestamp\n\t */\n\tstartDate: string;\n\n\t/**\n\t * Task processing end timestamp\n\t */\n\tendDate?: string;\n}\n"]}

package/dist/es/models/ITaskApp.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ITaskApp.js","sourceRoot":"","sources":["../../../src/models/ITaskApp.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2025 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Denotes a task associated with a Dataspace App\n */\nexport interface ITaskApp {\n\t/**\n\t * Task Id.\n\t */\n\ttaskId: string;\n\n\t/**\n\t * Dataspace App Id.\n\t */\n\tdataspaceAppId: string;\n}\n"]}