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

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

@@ -0,0 +1,180 @@
+# Interface: IDataspaceProtocolPolicy
+
+Policy interface compliant with Eclipse Data Space Protocol.
+
+Extends IOdrlPolicy with DS Protocol-specific constraints:
+- `@id` is REQUIRED (used as the primary policy identifier in DS Protocol)
+- `@context` is omitted (inherited from the parent Dataset/Distribution)
+
+## See
+
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ - IOdrlPolicy from @twin.org/standards-w3c-odrl
+
+## Extends
+
+- `Omit`\<`IOdrlPolicy`, `"uid"`\>
+
+## Properties
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the policy.
+
+***
+
+### @context {#context}
+
+> **@context**: `OdrlContextType`
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+`Omit.@context`
+
+***
+
+### @type {#type}
+
+> **@type**: `OdrlPolicyType`
+
+The type of policy.
+Must be one of: "Set", "Offer", "Agreement"
+
+#### Inherited from
+
+`Omit.@type`
+
+***
+
+### profile? {#profile}
+
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### assigner? {#assigner}
+
+> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### 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/IDataspaceProtocolSet.md

@@ -0,0 +1,179 @@
+# Interface: IDataspaceProtocolSet
+
+Set interface compliant with Eclipse Data Space Protocol.
+
+Extends IOdrlSet with DS Protocol-specific constraints:
+- `@id` is REQUIRED (used as the primary set identifier in DS Protocol)
+- `@context` is omitted (inherited from the parent Dataset/Distribution)
+
+## See
+
+ - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
+ - IOdrlSet from @twin.org/standards-w3c-odrl
+
+## Extends
+
+- `Omit`\<`IOdrlSet`, `"uid"`\>
+
+## Properties
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the set.
+
+***
+
+### @context {#context}
+
+> **@context**: `OdrlContextType`
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+`Omit.@context`
+
+***
+
+### profile? {#profile}
+
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### assigner? {#assigner}
+
+> `optional` **assigner?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### 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`
+
+***
+
+### @type {#type}
+
+> **@type**: `"Set"`
+
+The type must be "Set".
+
+#### Inherited from
+
+`Omit.@type`

package/docs/reference/interfaces/{ITransferCompletionMessage.md → IDataspaceProtocolTransferCompletionMessage.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferCompletionMessage
+# Interface: IDataspaceProtocolTransferCompletionMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferCompletionMessage"`
 
 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/{ITransferError.md → IDataspaceProtocolTransferError.md}

@@ -1,11 +1,11 @@
-# Interface: ITransferError
+# Interface: IDataspaceProtocolTransferError
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,15 +13,15 @@ LD Context
 
 ***
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"TransferError"`
 
 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

@@ -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}
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context
+
+***
+
+### @type {#type}
+
+> **@type**: `"TransferProcess"`
+
+LD Type
+
+***
+
+### consumerPid {#consumerpid}
+
+> **consumerPid**: `string`
+
+MUST refer to the transfer identifier of the Consumer side.
+
+***
+
+### providerPid {#providerpid}
+
+> **providerPid**: `string`
+
+MUST refer to the transfer identifier of the Provider side.
+
+***
+
+### state {#state}
+
+> **state**: [`DataspaceProtocolTransferProcessStateType`](../type-aliases/DataspaceProtocolTransferProcessStateType.md)
+
+The transfer process state.