@twin.org/standards-dataspace-protocol 0.0.3-next.2 → 0.0.3-next.20

package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md

@@ -0,0 +1,36 @@
+# Interface: IDataspaceProtocolTransferCompletionMessage
+
+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**: `"TransferCompletionMessage"`
+
+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/IDataspaceProtocolTransferError.md

@@ -0,0 +1,52 @@
+# Interface: IDataspaceProtocolTransferError
+
+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**: `"TransferError"`
+
+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/IDataspaceProtocolTransferProcess.md

@@ -0,0 +1,44 @@
+# Interface: IDataspaceProtocolTransferProcess
+
+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**: `"TransferProcess"`
+
+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**: [`DataspaceProtocolTransferProcessStateType`](../type-aliases/DataspaceProtocolTransferProcessStateType.md)
+
+The transfer process state.

package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md

@@ -0,0 +1,62 @@
+# Interface: IDataspaceProtocolTransferRequestMessage
+
+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**: `"TransferRequestMessage"`
+
+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**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.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/IDataspaceProtocolTransferStartMessage.md

@@ -0,0 +1,45 @@
+# Interface: IDataspaceProtocolTransferStartMessage
+
+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**: `"TransferStartMessage"`
+
+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**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.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/IDataspaceProtocolTransferSuspensionMessage.md

@@ -0,0 +1,52 @@
+# Interface: IDataspaceProtocolTransferSuspensionMessage
+
+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**: `"TransferSuspensionMessage"`
+
+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).

package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md

@@ -0,0 +1,52 @@
+# Interface: IDataspaceProtocolTransferTerminationMessage
+
+Interface for Dataspace Protocol Transfer Messages.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type
+
+> **@type**: `"TransferTerminationMessage"`
+
+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 termination code.
+
+***
+
+### reason?
+
+> `optional` **reason**: `any`[]
+
+The termination reason(s).

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolCatalogTypes
+
+> **DataspaceProtocolCatalogTypes** = *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\[keyof *typeof* [`DataspaceProtocolCatalogTypes`](../variables/DataspaceProtocolCatalogTypes.md)\]
+
+The types for Dataspace Protocol Catalog Protocol.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContextType
+
+> **DataspaceProtocolContextType** = *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context) \| \[*typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context)\] \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`Context`](../variables/DataspaceProtocolContexts.md#context), `...IJsonLdContextDefinitionElement[]`\]
+
+The Dataspace Protocol JSON-LD context type.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContexts
+
+> **DataspaceProtocolContexts** = *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\[keyof *typeof* [`DataspaceProtocolContexts`](../variables/DataspaceProtocolContexts.md)\]
+
+The contexts for Dataspace Protocol Protocol.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContractNegotiationEventType
+
+> **DataspaceProtocolContractNegotiationEventType** = *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationEventType`](../variables/DataspaceProtocolContractNegotiationEventType.md)\]
+
+The types for Dataspace Protocol Contract Negotiation Events.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContractNegotiationStateType
+
+> **DataspaceProtocolContractNegotiationStateType** = *typeof* [`DataspaceProtocolContractNegotiationStateType`](../variables/DataspaceProtocolContractNegotiationStateType.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationStateType`](../variables/DataspaceProtocolContractNegotiationStateType.md)\]
+
+The types for Dataspace Protocol Contract Negotiation States.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolContractNegotiationTypes
+
+> **DataspaceProtocolContractNegotiationTypes** = *typeof* [`DataspaceProtocolContractNegotiationTypes`](../variables/DataspaceProtocolContractNegotiationTypes.md)\[keyof *typeof* [`DataspaceProtocolContractNegotiationTypes`](../variables/DataspaceProtocolContractNegotiationTypes.md)\]
+
+The types for Dataspace Protocol Contract Negotiation.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolTransferProcessStateType
+
+> **DataspaceProtocolTransferProcessStateType** = *typeof* [`DataspaceProtocolTransferProcessStateType`](../variables/DataspaceProtocolTransferProcessStateType.md)\[keyof *typeof* [`DataspaceProtocolTransferProcessStateType`](../variables/DataspaceProtocolTransferProcessStateType.md)\]
+
+The types for Dataspace Protocol Transfer.

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

@@ -0,0 +1,5 @@
+# Type Alias: DataspaceProtocolTransferProcessTypes
+
+> **DataspaceProtocolTransferProcessTypes** = *typeof* [`DataspaceProtocolTransferProcessTypes`](../variables/DataspaceProtocolTransferProcessTypes.md)\[keyof *typeof* [`DataspaceProtocolTransferProcessTypes`](../variables/DataspaceProtocolTransferProcessTypes.md)\]
+
+The types for Dataspace Protocol Transfer.

package/docs/reference/variables/DataspaceProtocolCatalogTypes.md

@@ -0,0 +1,50 @@
+# Variable: DataspaceProtocolCatalogTypes
+
+> `const` **DataspaceProtocolCatalogTypes**: `object`
+
+The types for Dataspace Protocol Catalog Protocol.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
+
+## Type Declaration
+
+### CatalogRequestMessage
+
+> `readonly` **CatalogRequestMessage**: `"CatalogRequestMessage"` = `"CatalogRequestMessage"`
+
+Catalog Request Message.
+
+### DatasetRequestMessage
+
+> `readonly` **DatasetRequestMessage**: `"DatasetRequestMessage"` = `"DatasetRequestMessage"`
+
+Dataset Request Message.
+
+### CatalogError
+
+> `readonly` **CatalogError**: `"CatalogError"` = `"CatalogError"`
+
+Catalog Error.
+
+### Dataset
+
+> `readonly` **Dataset**: `"Dataset"` = `"Dataset"`
+
+Dataset.
+
+### DataService
+
+> `readonly` **DataService**: `"DataService"` = `"DataService"`
+
+Data Service.
+
+### Distribution
+
+> `readonly` **Distribution**: `"Distribution"` = `"Distribution"`
+
+Distribution.
+
+### Catalog
+
+> `readonly` **Catalog**: `"Catalog"` = `"Catalog"`
+
+Catalog.

package/docs/reference/variables/DataspaceProtocolContexts.md

@@ -0,0 +1,25 @@
+# Variable: DataspaceProtocolContexts
+
+> `const` **DataspaceProtocolContexts**: `object`
+
+The contexts for Dataspace Protocol Protocol.
+
+## Type Declaration
+
+### Namespace
+
+> `readonly` **Namespace**: `"https://w3id.org/dspace/2025/1/"` = `"https://w3id.org/dspace/2025/1/"`
+
+The canonical RDF namespace URI.
+
+### Context
+
+> `readonly` **Context**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
+
+The value to use in @context.
+
+### JsonLdContext
+
+> `readonly` **JsonLdContext**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
+
+The JSON-LD Context URL.

package/docs/reference/variables/{ContractNegotiationEventType.md → DataspaceProtocolContractNegotiationEventType.md}

@@ -1,6 +1,6 @@
-# Variable: ContractNegotiationEventType
+# Variable: DataspaceProtocolContractNegotiationEventType
 
-> `const` **ContractNegotiationEventType**: `object`
+> `const` **DataspaceProtocolContractNegotiationEventType**: `object`
 
 The types for Dataspace Protocol Contract Negotiation Events.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message

package/docs/reference/variables/{ContractNegotiationStateType.md → DataspaceProtocolContractNegotiationStateType.md}

@@ -1,6 +1,6 @@
-# Variable: ContractNegotiationStateType
+# Variable: DataspaceProtocolContractNegotiationStateType
 
-> `const` **ContractNegotiationStateType**: `object`
+> `const` **DataspaceProtocolContractNegotiationStateType**: `object`
 
 The types for Dataspace Protocol Contract Negotiation States.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states

package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md

@@ -0,0 +1,68 @@
+# Variable: DataspaceProtocolContractNegotiationTypes
+
+> `const` **DataspaceProtocolContractNegotiationTypes**: `object`
+
+The types for Dataspace Protocol Contract Negotiation.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
+
+## Type Declaration
+
+### ContractNegotiation
+
+> `readonly` **ContractNegotiation**: `"ContractNegotiation"` = `"ContractNegotiation"`
+
+Contract Negotiation.
+
+### ContractRequestMessage
+
+> `readonly` **ContractRequestMessage**: `"ContractRequestMessage"` = `"ContractRequestMessage"`
+
+Contract Request Message.
+
+### ContractOfferMessage
+
+> `readonly` **ContractOfferMessage**: `"ContractOfferMessage"` = `"ContractOfferMessage"`
+
+Contract Offer Message.
+
+### ContractAgreementMessage
+
+> `readonly` **ContractAgreementMessage**: `"ContractAgreementMessage"` = `"ContractAgreementMessage"`
+
+Contract Agreement Message.
+
+### ContractAgreementVerificationMessage
+
+> `readonly` **ContractAgreementVerificationMessage**: `"ContractAgreementVerificationMessage"` = `"ContractAgreementVerificationMessage"`
+
+Contract Agreement Verification Message.
+
+### ContractNegotiationEventMessage
+
+> `readonly` **ContractNegotiationEventMessage**: `"ContractNegotiationEventMessage"` = `"ContractNegotiationEventMessage"`
+
+Contract Negotiation Event Message.
+
+### ContractNegotiationTerminationMessage
+
+> `readonly` **ContractNegotiationTerminationMessage**: `"ContractNegotiationTerminationMessage"` = `"ContractNegotiationTerminationMessage"`
+
+Contract Negotiation Termination Message.
+
+### ContractNegotiationError
+
+> `readonly` **ContractNegotiationError**: `"ContractNegotiationError"` = `"ContractNegotiationError"`
+
+Contract Negotiation Error.
+
+### ContractNegotiationEventType
+
+> `readonly` **ContractNegotiationEventType**: `"ContractNegotiationEventType"` = `"ContractNegotiationEventType"`
+
+Contract Negotiation Event Type.
+
+### ContractNegotiationStateType
+
+> `readonly` **ContractNegotiationStateType**: `"ContractNegotiationStateType"` = `"ContractNegotiationStateType"`
+
+Contract Negotiation State Type.

package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md

@@ -0,0 +1,38 @@
+# Variable: DataspaceProtocolTransferProcessStateType
+
+> `const` **DataspaceProtocolTransferProcessStateType**: `object`
+
+The states for Dataspace Protocol Transfer Process.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#ack-transfer-process
+
+## Type Declaration
+
+### COMPLETED
+
+> `readonly` **COMPLETED**: `"COMPLETED"` = `"COMPLETED"`
+
+Completed
+
+### REQUESTED
+
+> `readonly` **REQUESTED**: `"REQUESTED"` = `"REQUESTED"`
+
+Requested
+
+### STARTED
+
+> `readonly` **STARTED**: `"STARTED"` = `"STARTED"`
+
+Started
+
+### SUSPENDED
+
+> `readonly` **SUSPENDED**: `"SUSPENDED"` = `"SUSPENDED"`
+
+Suspended
+
+### TERMINATED
+
+> `readonly` **TERMINATED**: `"TERMINATED"` = `"TERMINATED"`
+
+Terminated

package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md

@@ -0,0 +1,62 @@
+# Variable: DataspaceProtocolTransferProcessTypes
+
+> `const` **DataspaceProtocolTransferProcessTypes**: `object`
+
+The types for Dataspace Protocol Transfer Process.
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#message-types-1
+
+## Type Declaration
+
+### TransferRequestMessage
+
+> `readonly` **TransferRequestMessage**: `"TransferRequestMessage"` = `"TransferRequestMessage"`
+
+Transfer Request Message.
+
+### TransferStartMessage
+
+> `readonly` **TransferStartMessage**: `"TransferStartMessage"` = `"TransferStartMessage"`
+
+Transfer Start Message.
+
+### TransferSuspensionMessage
+
+> `readonly` **TransferSuspensionMessage**: `"TransferSuspensionMessage"` = `"TransferSuspensionMessage"`
+
+Transfer Suspension Message.
+
+### TransferCompletionMessage
+
+> `readonly` **TransferCompletionMessage**: `"TransferCompletionMessage"` = `"TransferCompletionMessage"`
+
+Transfer Completion Message.
+
+### TransferTerminationMessage
+
+> `readonly` **TransferTerminationMessage**: `"TransferTerminationMessage"` = `"TransferTerminationMessage"`
+
+Transfer Termination Message.
+
+### DataAddress
+
+> `readonly` **DataAddress**: `"DataAddress"` = `"DataAddress"`
+
+Data Address
+
+### EndpointProperty
+
+> `readonly` **EndpointProperty**: `"EndpointProperty"` = `"EndpointProperty"`
+
+Endpoint property.
+
+### TransferProcess
+
+> `readonly` **TransferProcess**: `"TransferProcess"` = `"TransferProcess"`
+
+Transfer Process
+
+### TransferError
+
+> `readonly` **TransferError**: `"TransferError"` = `"TransferError"`
+
+Transfer Error.

package/locales/en.json

@@ -1 +1,7 @@
-{}
+{
+	"error": {
+		"dataspaceProtocolHelper": {
+			"schemaNotRegistered": "JSON Schema \"{schemaId}\" is not registered in DataTypeHandlerFactory"
+		}
+	}
+}