@twin.org/standards-dataspace-protocol 0.0.3-next.54 → 0.0.3-next.56

package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md

@@ -0,0 +1,171 @@
+# Interface: IDataspaceProtocolOfferBase
+
+Offer interface compliant with Eclipse Data Space Protocol without JSON-LD context.
+This is the context-free variant of IDataspaceProtocolOffer, intended for embedding
+offers inline within other objects where the context is provided by the enclosing document.
+
+Extends IOdrlOffer with DS Protocol-specific constraints:
+- '@id' is REQUIRED (used as the primary offer identifier in DS Protocol)
+- '@context' is omitted (context is inherited from the parent object)
+
+## See
+
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+
+## Extends
+
+- `Omit`\<`IOdrlOffer`, `"uid"` \| `"@context"`\>
+
+## Extended by
+
+- [`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)
+
+## Properties
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the offer.
+
+***
+
+### @type {#type}
+
+> **@type**: `"Offer"`
+
+The type must be "Offer".
+
+#### Inherited from
+
+`Omit.@type`
+
+***
+
+### assigner {#assigner}
+
+> **assigner**: `string` \| `IOdrlParty`
+
+The assigner of the offer.
+Required for Offer policies.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### profile? {#profile}
+
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### assignee? {#assignee}
+
+> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assignee`
+
+***
+
+### target? {#target}
+
+> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
+
+The target asset for the rule.
+
+#### Inherited from
+
+`Omit.target`
+
+***
+
+### action? {#action}
+
+> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
+
+The action associated with the rule.
+
+#### Inherited from
+
+`Omit.action`
+
+***
+
+### inheritFrom? {#inheritfrom}
+
+> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+`Omit.inheritFrom`
+
+***
+
+### conflict? {#conflict}
+
+> `optional` **conflict?**: `OdrlConflictStrategyType`
+
+The conflict resolution strategy.
+- perm: Permissions override Prohibitions
+- prohibit: Prohibitions override Permissions
+- invalid: Policy is void if conflicts exist (default)
+
+#### Inherited from
+
+`Omit.conflict`
+
+***
+
+### permission? {#permission}
+
+> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.permission`
+
+***
+
+### prohibition? {#prohibition}
+
+> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.prohibition`
+
+***
+
+### obligation? {#obligation}
+
+> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.obligation`

package/docs/reference/interfaces/IDataspaceProtocolPolicy.md

@@ -17,7 +17,7 @@ Extends IOdrlPolicy with DS Protocol-specific constraints:
 
 ## Properties
 
-### @id
+### @id {#id}
 
 > **@id**: `string`
 
@@ -25,7 +25,7 @@ Unique identifier for the policy.
 
 ***
 
-### @context
+### @context {#context}
 
 > **@context**: `OdrlContextType`
 
@@ -38,9 +38,9 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `PolicyType`
+> **@type**: `OdrlPolicyType`
 
 The type of policy.
 Must be one of: "Set", "Offer", "Agreement"
@@ -51,9 +51,9 @@ Must be one of: "Set", "Offer", "Agreement"
 
 ***
 
-### profile?
+### profile? {#profile}
 
-> `optional` **profile**: `string` \| `string`[]
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
 
 The profile(s) this policy conforms to.
 IRIs identifying the ODRL Profile(s).
@@ -64,9 +64,9 @@ IRIs identifying the ODRL Profile(s).
 
 ***
 
-### assigner?
+### assigner? {#assigner}
 
-> `optional` **assigner**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
 
 The assigner of the policy.
 Applies to all rules unless overridden at rule level.
@@ -77,9 +77,9 @@ Applies to all rules unless overridden at rule level.
 
 ***
 
-### assignee?
+### assignee? {#assignee}
 
-> `optional` **assignee**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
 
 The assignee of the policy.
 Applies to all rules unless overridden at rule level.
@@ -90,9 +90,9 @@ Applies to all rules unless overridden at rule level.
 
 ***
 
-### target?
+### target? {#target}
 
-> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
+> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
 
 The target asset for the rule.
 
@@ -102,9 +102,9 @@ The target asset for the rule.
 
 ***
 
-### action?
+### action? {#action}
 
-> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
+> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
 
 The action associated with the rule.
 
@@ -114,9 +114,9 @@ The action associated with the rule.
 
 ***
 
-### inheritFrom?
+### inheritFrom? {#inheritfrom}
 
-> `optional` **inheritFrom**: `string` \| `string`[]
+> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
 
 The parent policy(ies) this policy inherits from.
 IRIs identifying the parent Policy(ies).
@@ -127,9 +127,9 @@ IRIs identifying the parent Policy(ies).
 
 ***
 
-### conflict?
+### conflict? {#conflict}
 
-> `optional` **conflict**: `ConflictStrategyType`
+> `optional` **conflict?**: `OdrlConflictStrategyType`
 
 The conflict resolution strategy.
 - perm: Permissions override Prohibitions
@@ -142,9 +142,9 @@ The conflict resolution strategy.
 
 ***
 
-### permission?
+### permission? {#permission}
 
-> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
+> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
 
 The permissions in the policy.
 At least one of permission, prohibition, or obligation must be present.
@@ -155,9 +155,9 @@ At least one of permission, prohibition, or obligation must be present.
 
 ***
 
-### prohibition?
+### prohibition? {#prohibition}
 
-> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
+> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
 
 The prohibitions in the policy.
 At least one of permission, prohibition, or obligation must be present.
@@ -168,9 +168,9 @@ At least one of permission, prohibition, or obligation must be present.
 
 ***
 
-### obligation?
+### obligation? {#obligation}
 
-> `optional` **obligation**: `IOdrlDuty` \| `IOdrlDuty`[]
+> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
 
 The obligations in the policy.
 At least one of permission, prohibition, or obligation must be present.

package/docs/reference/interfaces/IDataspaceProtocolSet.md

@@ -17,7 +17,7 @@ Extends IOdrlSet with DS Protocol-specific constraints:
 
 ## Properties
 
-### @id
+### @id {#id}
 
 > **@id**: `string`
 
@@ -25,7 +25,7 @@ Unique identifier for the set.
 
 ***
 
-### @context
+### @context {#context}
 
 > **@context**: `OdrlContextType`
 
@@ -38,9 +38,9 @@ Must include "https://www.w3.org/ns/odrl.jsonld"
 
 ***
 
-### profile?
+### profile? {#profile}
 
-> `optional` **profile**: `string` \| `string`[]
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
 
 The profile(s) this policy conforms to.
 IRIs identifying the ODRL Profile(s).
@@ -51,9 +51,9 @@ IRIs identifying the ODRL Profile(s).
 
 ***
 
-### assigner?
+### assigner? {#assigner}
 
-> `optional` **assigner**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
 
 The assigner of the policy.
 Applies to all rules unless overridden at rule level.
@@ -64,9 +64,9 @@ Applies to all rules unless overridden at rule level.
 
 ***
 
-### assignee?
+### assignee? {#assignee}
 
-> `optional` **assignee**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
 
 The assignee of the policy.
 Applies to all rules unless overridden at rule level.
@@ -77,9 +77,9 @@ Applies to all rules unless overridden at rule level.
 
 ***
 
-### target?
+### target? {#target}
 
-> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
+> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
 
 The target asset for the rule.
 
@@ -89,9 +89,9 @@ The target asset for the rule.
 
 ***
 
-### action?
+### action? {#action}
 
-> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
+> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
 
 The action associated with the rule.
 
@@ -101,9 +101,9 @@ The action associated with the rule.
 
 ***
 
-### inheritFrom?
+### inheritFrom? {#inheritfrom}
 
-> `optional` **inheritFrom**: `string` \| `string`[]
+> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
 
 The parent policy(ies) this policy inherits from.
 IRIs identifying the parent Policy(ies).
@@ -114,9 +114,9 @@ IRIs identifying the parent Policy(ies).
 
 ***
 
-### conflict?
+### conflict? {#conflict}
 
-> `optional` **conflict**: `ConflictStrategyType`
+> `optional` **conflict?**: `OdrlConflictStrategyType`
 
 The conflict resolution strategy.
 - perm: Permissions override Prohibitions
@@ -129,9 +129,9 @@ The conflict resolution strategy.
 
 ***
 
-### permission?
+### permission? {#permission}
 
-> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
+> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
 
 The permissions in the policy.
 At least one of permission, prohibition, or obligation must be present.
@@ -142,9 +142,9 @@ At least one of permission, prohibition, or obligation must be present.
 
 ***
 
-### prohibition?
+### prohibition? {#prohibition}
 
-> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
+> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
 
 The prohibitions in the policy.
 At least one of permission, prohibition, or obligation must be present.
@@ -155,9 +155,9 @@ At least one of permission, prohibition, or obligation must be present.
 
 ***
 
-### obligation?
+### obligation? {#obligation}
 
-> `optional` **obligation**: `IOdrlDuty` \| `IOdrlDuty`[]
+> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
 
 The obligations in the policy.
 At least one of permission, prohibition, or obligation must be present.
@@ -168,7 +168,7 @@ At least one of permission, prohibition, or obligation must be present.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"Set"`
 

package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-co
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"TransferCompletionMessage"`
 
@@ -21,7 +21,7 @@ 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`
 

package/docs/reference/interfaces/IDataspaceProtocolTransferError.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transf
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"TransferError"`
 
@@ -21,7 +21,7 @@ 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 error code.
 
 ***
 
-### reason?
+### reason? {#reason}
 
-> `optional` **reason**: `any`[]
+> `optional` **reason?**: `any`[]
 
 The error reason(s).

package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfe
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"TransferProcess"`
 
@@ -21,7 +21,7 @@ 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,7 +37,7 @@ MUST refer to the transfer identifier of the Provider side.
 
 ***
 
-### state
+### state {#state}
 
 > **state**: [`DataspaceProtocolTransferProcessStateType`](../type-aliases/DataspaceProtocolTransferProcessStateType.md)
 

package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-re
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"TransferRequestMessage"`
 
@@ -21,7 +21,7 @@ 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**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.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/IDataspaceProtocolTransferStartMessage.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-st
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"TransferStartMessage"`
 
@@ -21,7 +21,7 @@ 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**: [`IDataspaceProtocolDataAddress`](IDataspaceProtocolDataAddress.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.