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

package/docs/reference/interfaces/ITransferProcess.md

@@ -0,0 +1,137 @@
+# Interface: ITransferProcess
+
+Transfer Process for internal storage.
+Combines DSP protocol fields with internal TWIN fields.
+This is NOT the DSP wire format (use ITransferProcess from standards for that).
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Internal UUID (primary key for entity storage).
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+Consumer Process ID from the DSP protocol.
+Refers to the transfer identifier on the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+Provider Process ID from the DSP protocol.
+Refers to the transfer identifier on the Provider side.
+
+***
+
+### state
+
+> **state**: `DataspaceProtocolTransferProcessStateType`
+
+Transfer Process state from the DSP protocol.
+One of: REQUESTED, STARTED, COMPLETED, SUSPENDED, TERMINATED.
+
+***
+
+### agreementId
+
+> **agreementId**: `string`
+
+Agreement ID linking to the rights-management Agreement.
+Used to resolve policies and permissions.
+
+***
+
+### datasetId
+
+> **datasetId**: `string`
+
+Dataset ID for DSC resolution.
+Identifies the dataset being transferred.
+
+***
+
+### offerId
+
+> **offerId**: `string`
+
+Offer ID from the original Catalog offer.
+
+***
+
+### policies?
+
+> `optional` **policies**: `IOdrlPolicy`[]
+
+Policies from the Agreement.
+Used by DSC for runtime policy enforcement.
+
+***
+
+### consumerIdentity?
+
+> `optional` **consumerIdentity**: `string`
+
+Consumer identity (DID or URI).
+Used for auditing and access control.
+
+***
+
+### providerIdentity?
+
+> `optional` **providerIdentity**: `string`
+
+Provider identity (DID or URI).
+Used for auditing.
+
+***
+
+### callbackAddress?
+
+> `optional` **callbackAddress**: `string`
+
+Callback address for Consumer notifications.
+URI where messages to the Consumer should be sent.
+
+***
+
+### format?
+
+> `optional` **format**: `string`
+
+Data format from the Dataset Distribution.
+Specified by a Distribution for the Dataset associated with the Agreement.
+
+***
+
+### 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.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `Date`
+
+Creation timestamp.
+
+***
+
+### dateModified
+
+> **dateModified**: `Date`
+
+Last update timestamp.

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

@@ -0,0 +1,5 @@
+# Type Alias: ActivityProcessingStatus
+
+> **ActivityProcessingStatus** = *typeof* [`ActivityProcessingStatus`](../variables/ActivityProcessingStatus.md)\[keyof *typeof* [`ActivityProcessingStatus`](../variables/ActivityProcessingStatus.md)\]
+
+The type exported.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataRequestType
+
+> **DataRequestType** = *typeof* [`DataRequestType`](../variables/DataRequestType.md)\[keyof *typeof* [`DataRequestType`](../variables/DataRequestType.md)\]
+
+Data Request Types.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataRequest
+
+> **IDataRequest** = [`IDataAssetEntitiesRequest`](../interfaces/IDataAssetEntitiesRequest.md) \| [`IQueryDataAssetRequest`](../interfaces/IQueryDataAssetRequest.md)
+
+Data Request type for representing data requests received by Dataspace Data Plane Apps.

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

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

package/docs/reference/variables/ActivityProcessingStatus.md

@@ -0,0 +1,37 @@
+# Variable: ActivityProcessingStatus
+
+> `const` **ActivityProcessingStatus**: `object`
+
+Activity processing statuses.
+
+## Type Declaration
+
+### Pending
+
+> `readonly` **Pending**: `"pending"` = `"pending"`
+
+Pending: Activity Processing has not started yet.
+
+### Running
+
+> `readonly` **Running**: `"running"` = `"running"`
+
+Running Activity processing is running.
+
+### Completed
+
+> `readonly` **Completed**: `"completed"` = `"completed"`
+
+Completed: Activity processing completed without error.
+
+### Error
+
+> `readonly` **Error**: `"error"` = `"error"`
+
+Error: Activity processing cannot be performed and marked as in error. (Depends on application).
+
+### Registering
+
+> `readonly` **Registering**: `"registering"` = `"registering"`
+
+Transient state. The background tasks associated with the activity are still being registered.

package/docs/reference/variables/DataRequestType.md

@@ -0,0 +1,19 @@
+# Variable: DataRequestType
+
+> `const` **DataRequestType**: `object`
+
+Data Request Types.
+
+## Type Declaration
+
+### DataAssetEntities
+
+> `readonly` **DataAssetEntities**: `"DataAssetEntities"` = `"DataAssetEntities"`
+
+Data Asset Entities
+
+### QueryDataAsset
+
+> `readonly` **QueryDataAsset**: `"QueryDataAsset"` = `"QueryDataAsset"`
+
+Query over a data asset

package/docs/reference/variables/DataspaceAppFactory.md

@@ -0,0 +1,5 @@
+# Variable: DataspaceAppFactory
+
+> `const` **DataspaceAppFactory**: `Factory`\<[`IDataspaceApp`](../interfaces/IDataspaceApp.md)\>
+
+Factory for creating dataspace apps.

package/docs/reference/variables/TransferProcessRole.md

@@ -0,0 +1,20 @@
+# Variable: TransferProcessRole
+
+> `const` **TransferProcessRole**: `object`
+
+The role of a participant in a Transfer Process.
+Determines whether the party is acting as Consumer or Provider.
+
+## Type Declaration
+
+### Consumer
+
+> `readonly` **Consumer**: `"consumer"` = `"consumer"`
+
+Consumer role - the party requesting data.
+
+### Provider
+
+> `readonly` **Provider**: `"provider"` = `"provider"`
+
+Provider role - the party providing data.

package/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "@twin.org/dataspace-models",
+	"version": "0.0.3-next.15",
+	"description": "Models which define the structure of the Dataspace (Control Plane and Data Plane)",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/dataspace.git",
+		"directory": "packages/dataspace-models"
+	},
+	"author": "jose.cantera@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/background-task-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-dataspace-protocol": "next",
+		"@twin.org/standards-schema-org": "next",
+		"@twin.org/standards-w3c-activity-streams": "next",
+		"@twin.org/standards-w3c-dcat": "next",
+		"@twin.org/standards-w3c-odrl": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"dataspace",
+		"adapter",
+		"integration",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/dataspace/issues"
+	},
+	"homepage": "https://twindev.org"
+}