@twin.org/standards-dataspace-protocol 0.0.3-next.5 → 0.0.3-next.51

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**: `string`
+
+Unique identifier for the policy.
+
+***
+
+### @context
+
+> **@context**: `OdrlContextType`
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+`Omit.@context`
+
+***
+
+### @type
+
+> **@type**: `PolicyType`
+
+The type of policy.
+Must be one of: "Set", "Offer", "Agreement"
+
+#### Inherited from
+
+`Omit.@type`
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assignee`
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+`Omit.target`
+
+***
+
+### action?
+
+> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+`Omit.action`
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+`Omit.inheritFrom`
+
+***
+
+### conflict?
+
+> `optional` **conflict**: `ConflictStrategyType`
+
+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?
+
+> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.permission`
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.prohibition`
+
+***
+
+### obligation?
+
+> `optional` **obligation**: `IOdrlDuty` \| `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**: `string`
+
+Unique identifier for the set.
+
+***
+
+### @context
+
+> **@context**: `OdrlContextType`
+
+The context for the policy.
+Must include "https://www.w3.org/ns/odrl.jsonld"
+
+#### Inherited from
+
+`Omit.@context`
+
+***
+
+### profile?
+
+> `optional` **profile**: `string` \| `string`[]
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+`Omit.profile`
+
+***
+
+### assigner?
+
+> `optional` **assigner**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+
+The assigner of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assigner`
+
+***
+
+### assignee?
+
+> `optional` **assignee**: `string` \| `IOdrlParty` \| `IOdrlPartyCollection` \| (`string` \| `IOdrlParty` \| `IOdrlPartyCollection`)[]
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+`Omit.assignee`
+
+***
+
+### target?
+
+> `optional` **target**: `string` \| `IOdrlAsset` \| `IOdrlAssetCollection` \| (`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`)[]
+
+The target asset for the rule.
+
+#### Inherited from
+
+`Omit.target`
+
+***
+
+### action?
+
+> `optional` **action**: `string` \| `IOdrlAction` \| (`string` \| `IOdrlAction`)[]
+
+The action associated with the rule.
+
+#### Inherited from
+
+`Omit.action`
+
+***
+
+### inheritFrom?
+
+> `optional` **inheritFrom**: `string` \| `string`[]
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+`Omit.inheritFrom`
+
+***
+
+### conflict?
+
+> `optional` **conflict**: `ConflictStrategyType`
+
+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?
+
+> `optional` **permission**: `IOdrlPermission` \| `IOdrlPermission`[]
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.permission`
+
+***
+
+### prohibition?
+
+> `optional` **prohibition**: `IOdrlProhibition` \| `IOdrlProhibition`[]
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.prohibition`
+
+***
+
+### obligation?
+
+> `optional` **obligation**: `IOdrlDuty` \| `IOdrlDuty`[]
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+`Omit.obligation`
+
+***
+
+### @type
+
+> **@type**: `"Set"`
+
+The type must be "Set".
+
+#### Inherited from
+
+`Omit.@type`

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

@@ -1,4 +1,4 @@
-# Interface: ITransferCompletionMessage
+# Interface: IDataspaceProtocolTransferCompletionMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferCompletionMessage"`
 
 LD Type
 

package/docs/reference/interfaces/{ITransferError.md → IDataspaceProtocolTransferError.md}

@@ -1,4 +1,4 @@
-# Interface: ITransferError
+# Interface: IDataspaceProtocolTransferError
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferError"`
 
 LD Type
 

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/{ITransferRequestMessage.md → IDataspaceProtocolTransferRequestMessage.md}

@@ -1,4 +1,4 @@
-# Interface: ITransferRequestMessage
+# Interface: IDataspaceProtocolTransferRequestMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferRequestMessage"`
 
 LD Type
 
@@ -56,7 +56,7 @@ This is generally obtained from the Provider's Catalog.
 
 ### 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,4 +1,4 @@
-# Interface: ITransferStartMessage
+# Interface: IDataspaceProtocolTransferStartMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferStartMessage"`
 
 LD Type
 
@@ -39,7 +39,7 @@ MUST refer to the transfer identifier of the Provider side.
 
 ### 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,4 +1,4 @@
-# Interface: ITransferSuspensionMessage
+# Interface: IDataspaceProtocolTransferSuspensionMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferSuspensionMessage"`
 
 LD Type
 

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

@@ -1,4 +1,4 @@
-# Interface: ITransferTerminationMessage
+# Interface: IDataspaceProtocolTransferTerminationMessage
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message
@@ -15,7 +15,7 @@ LD Context
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"TransferTerminationMessage"`
 
 LD Type
 

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) \| \[*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 Protocol JSON-LD context type.
+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/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/type-aliases/IDataspaceProtocolAgreementNoContext.md

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolAgreementNoContext
+
+> **IDataspaceProtocolAgreementNoContext** = `Omit`\<[`IDataspaceProtocolAgreement`](../interfaces/IDataspaceProtocolAgreement.md), `"@context"`\>
+
+Agreement interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolCatalogNoContext
+
+> **IDataspaceProtocolCatalogNoContext** = `Omit`\<[`IDataspaceProtocolCatalog`](../interfaces/IDataspaceProtocolCatalog.md), `"@context"`\>
+
+Catalog interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolDataServiceNoContext
+
+> **IDataspaceProtocolDataServiceNoContext** = `Omit`\<[`IDataspaceProtocolDataService`](../interfaces/IDataspaceProtocolDataService.md), `"@context"`\>
+
+Data Service interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolDatasetNoContext
+
+> **IDataspaceProtocolDatasetNoContext** = `Omit`\<[`IDataspaceProtocolDataset`](../interfaces/IDataspaceProtocolDataset.md), `"@context"`\>
+
+Dataset interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolDistributionNoContext
+
+> **IDataspaceProtocolDistributionNoContext** = `Omit`\<[`IDataspaceProtocolDistribution`](../interfaces/IDataspaceProtocolDistribution.md), `"@context"`\>
+
+Distribution interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolOfferNoContext
+
+> **IDataspaceProtocolOfferNoContext** = `Omit`\<[`IDataspaceProtocolOffer`](../interfaces/IDataspaceProtocolOffer.md), `"@context"`\>
+
+Offer interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolPolicyNoContext
+
+> **IDataspaceProtocolPolicyNoContext** = `Omit`\<[`IDataspaceProtocolPolicy`](../interfaces/IDataspaceProtocolPolicy.md), `"@context"`\>
+
+Policy interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.

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

@@ -0,0 +1,5 @@
+# Type Alias: IDataspaceProtocolSetNoContext
+
+> **IDataspaceProtocolSetNoContext** = `Omit`\<[`IDataspaceProtocolSet`](../interfaces/IDataspaceProtocolSet.md), `"@context"`\>
+
+Set interface compliant with Eclipse Data Space Protocol, excluding the `@context` property.