npm - @twin.org/standards-dataspace-protocol - Versions diffs - 0.0.3-next.6 → 0.0.3-next.61 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (316) hide show

package/docs/reference/interfaces/{IContractAgreementVerificationMessage.md → IDataspaceProtocolContractAgreementVerificationMessage.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractAgreementVerificationMessage
+# Interface: IDataspaceProtocolContractAgreementVerificationMessage
 Interface for Dataspace Protocol Contract Agreement Verification Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractAgreementVerificationMessage"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,7 +29,7 @@ The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`

package/docs/reference/interfaces/{IContractNegotiation.md → IDataspaceProtocolContractNegotiation.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractNegotiation
+# Interface: IDataspaceProtocolContractNegotiation
 Interface for Dataspace Protocol Contract Agreement Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractNegotiation"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,7 +29,7 @@ The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -37,8 +37,8 @@ The consumer id for the contract.
 ***
-### state
+### state {#state}
-> **state**: [`ContractNegotiationStateType`](../type-aliases/ContractNegotiationStateType.md)
+> **state**: [`DataspaceProtocolContractNegotiationStateType`](../type-aliases/DataspaceProtocolContractNegotiationStateType.md)
 The offer being requested.

package/docs/reference/interfaces/{IContractNegotiationError.md → IDataspaceProtocolContractNegotiationError.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractNegotiationError
+# Interface: IDataspaceProtocolContractNegotiationError
 Interface for Dataspace Protocol Contract Negotiation Error Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractNegotiationError"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,7 +29,7 @@ The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -37,16 +37,16 @@ The consumer id for the contract.
 ***
-### code?
+### code? {#code}
-> `optional` **code**: `string`
+> `optional` **code?**: `string`
 The error code.
 ***
-### reason?
+### reason? {#reason}
-> `optional` **reason**: `any`[]
+> `optional` **reason?**: `any`[]
 The error reason(s).

package/docs/reference/interfaces/{IContractNegotiationEventMessage.md → IDataspaceProtocolContractNegotiationEventMessage.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractNegotiationEventMessage
+# Interface: IDataspaceProtocolContractNegotiationEventMessage
 Interface for Dataspace Protocol Contract Negotiation Event Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractNegotiationEventMessage"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,7 +29,7 @@ The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -37,8 +37,8 @@ The consumer id for the contract.
 ***
-### event
+### event {#event}
-> **event**: [`ContractNegotiationEventType`](../type-aliases/ContractNegotiationEventType.md)
+> **event**: [`DataspaceProtocolContractNegotiationEventType`](../type-aliases/DataspaceProtocolContractNegotiationEventType.md)
 The event type.

package/docs/reference/interfaces/{IContractNegotiationTerminationMessage.md → IDataspaceProtocolContractNegotiationTerminationMessage.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractNegotiationTerminationMessage
+# Interface: IDataspaceProtocolContractNegotiationTerminationMessage
 Interface for Dataspace Protocol Contract Negotiation Termination Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractNegotiationTerminationMessage"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,7 +29,7 @@ The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -37,16 +37,16 @@ The consumer id for the contract.
 ***
-### 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/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractOfferMessage
+# Interface: IDataspaceProtocolContractOfferMessage
 Interface for Dataspace Protocol Contract Offer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,15 +13,15 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractOfferMessage"`
 The type of the message.
 ***
-### providerPid
+### providerPid {#providerpid}
 > **providerPid**: `string`
@@ -29,24 +29,24 @@ The provider id for the contract.
 ***
-### consumerPid?
+### consumerPid? {#consumerpid}
-> `optional` **consumerPid**: `string`
+> `optional` **consumerPid?**: `string`
 The consumer id for the contract.
 ***
-### offer
+### offer {#offer}
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)
 The offer being requested.
 ***
-### callbackAddress?
+### callbackAddress? {#callbackaddress}
-> `optional` **callbackAddress**: `string`
+> `optional` **callbackAddress?**: `string`
 The base callback address for the provider to update the consumer on the state of the negotiation.

package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md} RENAMED Viewed

@@ -1,11 +1,11 @@
-# Interface: IContractRequestMessage
+# Interface: IDataspaceProtocolContractRequestMessage
 Interface for Dataspace Protocol Contract Request Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -13,23 +13,23 @@ The JSON-LD context.
 ***
-### @type
+### @type {#type}
-> **@type**: `string`
+> **@type**: `"ContractRequestMessage"`
 The type of the message.
 ***
-### providerPid?
+### providerPid? {#providerpid}
-> `optional` **providerPid**: `string`
+> `optional` **providerPid?**: `string`
 The provider id for the contract.
 ***
-### consumerPid
+### consumerPid {#consumerpid}
 > **consumerPid**: `string`
@@ -37,16 +37,16 @@ The consumer id for the contract.
 ***
-### offer
+### offer {#offer}
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)
 The offer being requested.
 ***
-### callbackAddress?
+### callbackAddress? {#callbackaddress}
-> `optional` **callbackAddress**: `string`
+> `optional` **callbackAddress?**: `string`
 The base callback address for the provider to update the consumer on the state of the negotiation.

package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md} RENAMED Viewed

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