@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.60

package/docs/reference/interfaces/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferRequestMessage
+# Interface: IDataspaceProtocolTransferRequestMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferRequestMessage"`
 
 LD Type
 
 ***
 
-### agreementId
+### agreementId {#agreementid}
 
 > **agreementId**: `string`
 
@@ -29,7 +29,7 @@ MUST refer to an existing Agreement between the Consumer and Provider.
 
 ***
 
-### callbackAddress
+### callbackAddress {#callbackaddress}
 
 > **callbackAddress**: `string`
 
@@ -37,7 +37,7 @@ MUST be a URI indicating where messages to the Consumer SHOULD be sent.
 
 ***
 
-### consumerPid
+### consumerPid {#consumerpid}
 
 > **consumerPid**: `string`
 
@@ -45,7 +45,7 @@ MUST refer to the transfer identifier of the Consumer side.
 
 ***
 
-### format
+### format {#format}
 
 > **format**: `string`
 
@@ -54,9 +54,9 @@ This is generally obtained from the Provider's Catalog.
 
 ***
 
-### dataAddress?
+### dataAddress? {#dataaddress}
 
-> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+> `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/{ITransferStartMessage.md → IDataspaceProtocolTransferStartMessage.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferStartMessage
+# Interface: IDataspaceProtocolTransferStartMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferStartMessage"`
 
 LD Type
 
 ***
 
-### consumerPid
+### consumerPid {#consumerpid}
 
 > **consumerPid**: `string`
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
 
 ***
 
-### providerPid
+### providerPid {#providerpid}
 
 > **providerPid**: `string`
 
@@ -37,9 +37,9 @@ MUST refer to the transfer identifier of the Provider side.
 
 ***
 
-### dataAddress?
+### dataAddress? {#dataaddress}
 
-> `optional` **dataAddress**: [`IDataAddress`](IDataAddress.md)
+> `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/{ITransferSuspensionMessage.md → IDataspaceProtocolTransferSuspensionMessage.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferSuspensionMessage
+# Interface: IDataspaceProtocolTransferSuspensionMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferSuspensionMessage"`
 
 LD Type
 
 ***
 
-### consumerPid
+### consumerPid {#consumerpid}
 
 > **consumerPid**: `string`
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
 
 ***
 
-### providerPid
+### providerPid {#providerpid}
 
 > **providerPid**: `string`
 
@@ -37,16 +37,16 @@ MUST refer to the transfer identifier of the Provider side.
 
 ***
 
-### code?
+### code? {#code}
 
-> `optional` **code**: `string`
+> `optional` **code?**: `string`
 
 The suspension code.
 
 ***
 
-### reason?
+### reason? {#reason}
 
-> `optional` **reason**: `any`[]
+> `optional` **reason?**: `any`[]
 
 The suspension reason(s).

package/docs/reference/interfaces/{ITransferTerminationMessage.md → IDataspaceProtocolTransferTerminationMessage.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferTerminationMessage
+# Interface: IDataspaceProtocolTransferTerminationMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferTerminationMessage"`
 
 LD Type
 
 ***
 
-### consumerPid
+### consumerPid {#consumerpid}
 
 > **consumerPid**: `string`
 
@@ -29,7 +29,7 @@ MUST refer to the transfer identifier of the Consumer side.
 
 ***
 
-### providerPid
+### providerPid {#providerpid}
 
 > **providerPid**: `string`
 
@@ -37,16 +37,16 @@ MUST refer to the transfer identifier of the Provider side.
 
 ***
 
-### code?
+### code? {#code}
 
-> `optional` **code**: `string`
+> `optional` **code?**: `string`
 
 The termination code.
 
 ***
 
-### reason?
+### reason? {#reason}
 
-> `optional` **reason**: `any`[]
+> `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

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

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/DataspaceProtocolEndpointType.md

@@ -0,0 +1,12 @@
+# Type Alias: DataspaceProtocolEndpointType
+
+> **DataspaceProtocolEndpointType** = *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\[keyof *typeof* [`DataspaceProtocolEndpointType`](../variables/DataspaceProtocolEndpointType.md)\]
+
+Type representing all valid Dataspace Protocol endpoint types.
+
+All values are valid URIs as required by the DS Protocol JSON-LD context
+which defines endpointType as @type:@vocab.
+
+Includes:
+- TWIN RFC 006 types: HttpsQueryEndpoint, HttpsActivityStreamEndpoint
+- IDSA W3ID types: HTTP, HTTPS

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

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

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,74 @@
+# 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 {#catalogrequestmessage}
+
+> `readonly` **CatalogRequestMessage**: `"CatalogRequestMessage"` = `"CatalogRequestMessage"`
+
+Catalog Request Message.
+
+### DatasetRequestMessage {#datasetrequestmessage}
+
+> `readonly` **DatasetRequestMessage**: `"DatasetRequestMessage"` = `"DatasetRequestMessage"`
+
+Dataset Request Message.
+
+### CatalogError {#catalogerror}
+
+> `readonly` **CatalogError**: `"CatalogError"` = `"CatalogError"`
+
+Catalog Error.
+
+### Dataset {#dataset}
+
+> `readonly` **Dataset**: `"Dataset"` = `"Dataset"`
+
+Dataset.
+
+### DataService {#dataservice}
+
+> `readonly` **DataService**: `"DataService"` = `"DataService"`
+
+Data Service.
+
+### Distribution {#distribution}
+
+> `readonly` **Distribution**: `"Distribution"` = `"Distribution"`
+
+Distribution.
+
+### Catalog {#catalog}
+
+> `readonly` **Catalog**: `"Catalog"` = `"Catalog"`
+
+Catalog.
+
+### Policy {#policy}
+
+> `readonly` **Policy**: `"Policy"` = `"Policy"`
+
+Policy.
+
+### Offer {#offer}
+
+> `readonly` **Offer**: `"Offer"` = `"Offer"`
+
+Offer.
+
+### Agreement {#agreement}
+
+> `readonly` **Agreement**: `"Agreement"` = `"Agreement"`
+
+Agreement.
+
+### Set {#set}
+
+> `readonly` **Set**: `"Set"` = `"Set"`
+
+Set.

package/docs/reference/variables/DataspaceProtocolContexts.md

@@ -6,14 +6,26 @@ The contexts for Dataspace Protocol Protocol.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace {#namespace}
 
-> `readonly` **ContextRoot**: `"https://w3id.org/dspace/2025/1/context.json"` = `"https://w3id.org/dspace/2025/1/context.json"`
+> `readonly` **Namespace**: `"https://w3id.org/dspace/2025/1/"` = `"https://w3id.org/dspace/2025/1/"`
 
-The context root for Dataspace Protocol Protocol.
+The canonical RDF namespace URI.
 
-### ContextRedirect
+### Context {#context}
 
-> `readonly` **ContextRedirect**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
+> `readonly` **Context**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
 
-The context redirect for Dataspace Protocol Protocol.
+The value to use in @context.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://w3id.org/dspace/2025/1/context.jsonld"` = `"https://w3id.org/dspace/2025/1/context.jsonld"`
+
+The JSON-LD Context URL.
+
+### JsonSchemaNamespace {#jsonschemanamespace}
+
+> `readonly` **JsonSchemaNamespace**: `"https://schema.twindev.org/dataspace-protocol/"` = `"https://schema.twindev.org/dataspace-protocol/"`
+
+The namespace location of the hosted version of the JSON Schema.

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

@@ -1,19 +1,19 @@
-# 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
 
 ## Type Declaration
 
-### ACCEPTED
+### ACCEPTED {#accepted}
 
 > `readonly` **ACCEPTED**: `"ACCEPTED"` = `"ACCEPTED"`
 
 Accepted.
 
-### FINALIZED
+### FINALIZED {#finalized}
 
 > `readonly` **FINALIZED**: `"FINALIZED"` = `"FINALIZED"`
 

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

@@ -1,49 +1,49 @@
-# 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
 
 ## Type Declaration
 
-### REQUESTED
+### REQUESTED {#requested}
 
 > `readonly` **REQUESTED**: `"REQUESTED"` = `"REQUESTED"`
 
 Requested.
 
-### OFFERED
+### OFFERED {#offered}
 
 > `readonly` **OFFERED**: `"OFFERED"` = `"OFFERED"`
 
 Offered.
 
-### ACCEPTED
+### ACCEPTED {#accepted}
 
 > `readonly` **ACCEPTED**: `"ACCEPTED"` = `"ACCEPTED"`
 
 Accepted.
 
-### AGREED
+### AGREED {#agreed}
 
 > `readonly` **AGREED**: `"AGREED"` = `"AGREED"`
 
 Agreed.
 
-### VERIFIED
+### VERIFIED {#verified}
 
 > `readonly` **VERIFIED**: `"VERIFIED"` = `"VERIFIED"`
 
 Verified.
 
-### FINALIZED
+### FINALIZED {#finalized}
 
 > `readonly` **FINALIZED**: `"FINALIZED"` = `"FINALIZED"`
 
 Finalized.
 
-### TERMINATED
+### TERMINATED {#terminated}
 
 > `readonly` **TERMINATED**: `"TERMINATED"` = `"TERMINATED"`
 

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 {#contractnegotiation}
+
+> `readonly` **ContractNegotiation**: `"ContractNegotiation"` = `"ContractNegotiation"`
+
+Contract Negotiation.
+
+### ContractRequestMessage {#contractrequestmessage}
+
+> `readonly` **ContractRequestMessage**: `"ContractRequestMessage"` = `"ContractRequestMessage"`
+
+Contract Request Message.
+
+### ContractOfferMessage {#contractoffermessage}
+
+> `readonly` **ContractOfferMessage**: `"ContractOfferMessage"` = `"ContractOfferMessage"`
+
+Contract Offer Message.
+
+### ContractAgreementMessage {#contractagreementmessage}
+
+> `readonly` **ContractAgreementMessage**: `"ContractAgreementMessage"` = `"ContractAgreementMessage"`
+
+Contract Agreement Message.
+
+### ContractAgreementVerificationMessage {#contractagreementverificationmessage}
+
+> `readonly` **ContractAgreementVerificationMessage**: `"ContractAgreementVerificationMessage"` = `"ContractAgreementVerificationMessage"`
+
+Contract Agreement Verification Message.
+
+### ContractNegotiationEventMessage {#contractnegotiationeventmessage}
+
+> `readonly` **ContractNegotiationEventMessage**: `"ContractNegotiationEventMessage"` = `"ContractNegotiationEventMessage"`
+
+Contract Negotiation Event Message.
+
+### ContractNegotiationTerminationMessage {#contractnegotiationterminationmessage}
+
+> `readonly` **ContractNegotiationTerminationMessage**: `"ContractNegotiationTerminationMessage"` = `"ContractNegotiationTerminationMessage"`
+
+Contract Negotiation Termination Message.
+
+### ContractNegotiationError {#contractnegotiationerror}
+
+> `readonly` **ContractNegotiationError**: `"ContractNegotiationError"` = `"ContractNegotiationError"`
+
+Contract Negotiation Error.
+
+### ContractNegotiationEventType {#contractnegotiationeventtype}
+
+> `readonly` **ContractNegotiationEventType**: `"ContractNegotiationEventType"` = `"ContractNegotiationEventType"`
+
+Contract Negotiation Event Type.
+
+### ContractNegotiationStateType {#contractnegotiationstatetype}
+
+> `readonly` **ContractNegotiationStateType**: `"ContractNegotiationStateType"` = `"ContractNegotiationStateType"`
+
+Contract Negotiation State Type.