@twin.org/standards-dataspace-protocol 0.0.3-next.4 → 0.0.3-next.5

package/dist/types/models/transferProcess/transferProcessTypes.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The types for Dataspace Protocol Transfer Process.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
+ */
+export declare const TransferProcessTypes: {
+    /**
+     * Transfer Request Message.
+     */
+    TransferRequestMessage: string;
+    /**
+     * Transfer Start Message.
+     */
+    TransferStartMessage: string;
+    /**
+     * Transfer Suspension Message.
+     */
+    TransferSuspensionMessage: string;
+    /**
+     * Transfer Completion Message.
+     */
+    TransferCompletionMessage: string;
+    /**
+     * Transfer Termination Message.
+     */
+    TransferTerminationMessage: string;
+    /**
+     * Data Address
+     */
+    DataAddress: string;
+    /**
+     * Endpoint property.
+     */
+    EndpointProperty: string;
+    /**
+     * Transfer Process
+     */
+    TransferProcess: string;
+    /**
+     * Transfer Error.
+     */
+    TransferError: string;
+};
+/**
+ * The types for Dataspace Protocol Transfer.
+ */
+export type TransferProcessTypes = (typeof TransferProcessTypes)[keyof typeof TransferProcessTypes];

package/dist/types/models/transferProcess/types/transferProcessStateType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The states for Dataspace Protocol Transfer Process.
+ * https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
+ */
+export declare const TransferProcessStateType: {
+    /**
+     * Completed
+     */
+    COMPLETED: string;
+    /**
+     * Requested
+     */
+    REQUESTED: string;
+    /**
+     * Started
+     */
+    STARTED: string;
+    /**
+     * Suspended
+     */
+    SUSPENDED: string;
+    /**
+     * Terminated
+     */
+    TERMINATED: string;
+};
+/**
+ * The types for Dataspace Protocol Transfer.
+ */
+export type TransferProcessStateType = (typeof TransferProcessStateType)[keyof typeof TransferProcessStateType];

package/docs/changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.0.3-next.5](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.4...standards-dataspace-protocol-v0.0.3-next.5) (2025-11-28)
+
+
+### Features
+
+* ds protocol - data transfer ([#77](https://github.com/twinfoundation/standards/issues/77)) ([1bf0375](https://github.com/twinfoundation/standards/commit/1bf03750c74daaa0eb133b03927a0f40eb27a1e3))
+
+
+### Bug Fixes
+
+* filter is array in catalog request (please merge after [#77](https://github.com/twinfoundation/standards/issues/77)) ([#78](https://github.com/twinfoundation/standards/issues/78)) ([72a234c](https://github.com/twinfoundation/standards/commit/72a234c6620466ac4a5aded677af7590ccf94077))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/standards-w3c-dcat bumped from 0.0.3-next.4 to 0.0.3-next.5
+    * @twin.org/standards-w3c-odrl bumped from 0.0.3-next.4 to 0.0.3-next.5
+
 ## [0.0.3-next.4](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.3...standards-dataspace-protocol-v0.0.3-next.4) (2025-11-18)
 
 

package/docs/reference/classes/CatalogDataTypes.md

@@ -0,0 +1,25 @@
+# Class: CatalogDataTypes
+
+Handle all the catalog data types for Dataspace Protocol.
+
+## Constructors
+
+### Constructor
+
+> **new CatalogDataTypes**(): `CatalogDataTypes`
+
+#### Returns
+
+`CatalogDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/classes/ContractNegotiationDataTypes.md

@@ -0,0 +1,25 @@
+# Class: ContractNegotiationDataTypes
+
+Handle all the contract negotiation data types for Dataspace Protocol.
+
+## Constructors
+
+### Constructor
+
+> **new ContractNegotiationDataTypes**(): `ContractNegotiationDataTypes`
+
+#### Returns
+
+`ContractNegotiationDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/classes/TransferProcessDataTypes.md

@@ -0,0 +1,25 @@
+# Class: TransferProcessDataTypes
+
+Handle all the transfer process data types for Dataspace Protocol.
+
+## Constructors
+
+### Constructor
+
+> **new TransferProcessDataTypes**(): `TransferProcessDataTypes`
+
+#### Returns
+
+`TransferProcessDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -2,7 +2,10 @@
 
 ## Classes
 
+- [CatalogDataTypes](classes/CatalogDataTypes.md)
+- [ContractNegotiationDataTypes](classes/ContractNegotiationDataTypes.md)
 - [DataspaceProtocolDataTypes](classes/DataspaceProtocolDataTypes.md)
+- [TransferProcessDataTypes](classes/TransferProcessDataTypes.md)
 
 ## Interfaces
 
@@ -17,6 +20,15 @@
 - [IContractNegotiationTerminationMessage](interfaces/IContractNegotiationTerminationMessage.md)
 - [IContractOfferMessage](interfaces/IContractOfferMessage.md)
 - [IContractRequestMessage](interfaces/IContractRequestMessage.md)
+- [IDataAddress](interfaces/IDataAddress.md)
+- [IEndpointProperty](interfaces/IEndpointProperty.md)
+- [ITransferCompletionMessage](interfaces/ITransferCompletionMessage.md)
+- [ITransferError](interfaces/ITransferError.md)
+- [ITransferProcess](interfaces/ITransferProcess.md)
+- [ITransferRequestMessage](interfaces/ITransferRequestMessage.md)
+- [ITransferStartMessage](interfaces/ITransferStartMessage.md)
+- [ITransferSuspensionMessage](interfaces/ITransferSuspensionMessage.md)
+- [ITransferTerminationMessage](interfaces/ITransferTerminationMessage.md)
 
 ## Type Aliases
 
@@ -26,6 +38,8 @@
 - [ContractNegotiationStateType](type-aliases/ContractNegotiationStateType.md)
 - [DataspaceProtocolContextType](type-aliases/DataspaceProtocolContextType.md)
 - [DataspaceProtocolContexts](type-aliases/DataspaceProtocolContexts.md)
+- [TransferProcessTypes](type-aliases/TransferProcessTypes.md)
+- [TransferProcessStateType](type-aliases/TransferProcessStateType.md)
 
 ## Variables
 
@@ -34,3 +48,5 @@
 - [ContractNegotiationEventType](variables/ContractNegotiationEventType.md)
 - [ContractNegotiationStateType](variables/ContractNegotiationStateType.md)
 - [DataspaceProtocolContexts](variables/DataspaceProtocolContexts.md)
+- [TransferProcessTypes](variables/TransferProcessTypes.md)
+- [TransferProcessStateType](variables/TransferProcessStateType.md)

package/docs/reference/interfaces/ICatalogError.md

@@ -29,8 +29,8 @@ The error code.
 
 ***
 
-### reasons?
+### reason?
 
-> `optional` **reasons**: `string`[]
+> `optional` **reason**: `any`[]
 
-An optional array of error reasons.
+The error reason(s).

package/docs/reference/interfaces/ICatalogRequestMessage.md

@@ -23,6 +23,6 @@ The type of the message.
 
 ### filter?
 
-> `optional` **filter**: `unknown`
+> `optional` **filter**: `unknown`[]
 
 An implementation-specific query or filter expression.

package/docs/reference/interfaces/IContractNegotiationError.md

@@ -47,30 +47,6 @@ The error code.
 
 ### reason?
 
-> `optional` **reason**: `object`[]
+> `optional` **reason**: `any`[]
 
 The error reason(s).
-
-#### @value
-
-> **@value**: `string`
-
-#### @language?
-
-> `optional` **@language**: `string`
-
-***
-
-### description?
-
-> `optional` **description**: `object`[]
-
-The error description(s).
-
-#### @value
-
-> **@value**: `string`
-
-#### @language?
-
-> `optional` **@language**: `string`

package/docs/reference/interfaces/IDataAddress.md

@@ -0,0 +1,36 @@
+# Interface: IDataAddress
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
+
+## Properties
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### endpointType
+
+> **endpointType**: `string`
+
+The type of endpoint of this data address.
+
+***
+
+### endpoint?
+
+> `optional` **endpoint**: `string`
+
+The endpoint of the data address
+
+***
+
+### endpointProperties?
+
+> `optional` **endpointProperties**: [`IEndpointProperty`](IEndpointProperty.md)[]
+
+Properties associated to the endpoint which might depend on the endpoint type.

package/docs/reference/interfaces/IEndpointProperty.md

@@ -0,0 +1,28 @@
+# Interface: IEndpointProperty
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
+
+## Properties
+
+### @type
+
+> **@type**: `string`
+
+LD Type.
+
+***
+
+### name
+
+> **name**: `string`
+
+Property name.
+
+***
+
+### value
+
+> **value**: `string`
+
+Property value.

package/docs/reference/interfaces/ITransferCompletionMessage.md

@@ -0,0 +1,36 @@
+# Interface: ITransferCompletionMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.

package/docs/reference/interfaces/ITransferError.md

@@ -0,0 +1,52 @@
+# Interface: ITransferError
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### code?
+
+> `optional` **code**: `string`
+
+The error code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The error reason(s).

package/docs/reference/interfaces/ITransferProcess.md

@@ -0,0 +1,74 @@
+# Interface: ITransferProcess
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### state
+
+> **state**: `object`
+
+The transfer process state.
+
+#### COMPLETED
+
+> **COMPLETED**: `string` = `"COMPLETED"`
+
+Completed
+
+#### REQUESTED
+
+> **REQUESTED**: `string` = `"REQUESTED"`
+
+Requested
+
+#### STARTED
+
+> **STARTED**: `string` = `"STARTED"`
+
+Started
+
+#### SUSPENDED
+
+> **SUSPENDED**: `string` = `"SUSPENDED"`
+
+Suspended
+
+#### TERMINATED
+
+> **TERMINATED**: `string` = `"TERMINATED"`
+
+Terminated

package/docs/reference/interfaces/ITransferRequestMessage.md

@@ -0,0 +1,62 @@
+# Interface: ITransferRequestMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### agreementId
+
+> **agreementId**: `string`
+
+MUST refer to an existing Agreement between the Consumer and Provider.
+
+***
+
+### callbackAddress
+
+> **callbackAddress**: `string`
+
+MUST be a URI indicating where messages to the Consumer SHOULD be sent.
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### format
+
+> **format**: `string`
+
+The format property is a format specified by a Distribution for the Dataset associated with the Agreement.
+This is generally obtained from the Provider's Catalog.
+
+***
+
+### dataAddress?
+
+> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+
+If defined MUST contain a transport-specific set of properties for pushing the data.
+It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType.

package/docs/reference/interfaces/ITransferStartMessage.md

@@ -0,0 +1,45 @@
+# Interface: ITransferStartMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### dataAddress?
+
+> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+
+MUST be provided if the current transfer is a pull transfer and
+contains a transport-specific endpoint address for obtaining the data.

package/docs/reference/interfaces/ITransferSuspensionMessage.md

@@ -0,0 +1,52 @@
+# Interface: ITransferSuspensionMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `string`
+
+LD Type
+
+***
+
+### consumerPid
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### code?
+
+> `optional` **code**: `string`
+
+The suspension code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The suspension reason(s).