@twin.org/standards-dataspace-protocol 0.0.3-next.48 → 0.0.3-next.49

package/docs/reference/index.md

@@ -27,6 +27,8 @@
 - [IDataspaceProtocolDistribution](interfaces/IDataspaceProtocolDistribution.md)
 - [IDataspaceProtocolAgreement](interfaces/IDataspaceProtocolAgreement.md)
 - [IDataspaceProtocolOffer](interfaces/IDataspaceProtocolOffer.md)
+- [IDataspaceProtocolPolicy](interfaces/IDataspaceProtocolPolicy.md)
+- [IDataspaceProtocolSet](interfaces/IDataspaceProtocolSet.md)
 - [IDataspaceProtocolDataAddress](interfaces/IDataspaceProtocolDataAddress.md)
 - [IDataspaceProtocolEndpointProperty](interfaces/IDataspaceProtocolEndpointProperty.md)
 - [IDataspaceProtocolTransferCompletionMessage](interfaces/IDataspaceProtocolTransferCompletionMessage.md)
@@ -45,6 +47,14 @@
 - [DataspaceProtocolContractNegotiationStateType](type-aliases/DataspaceProtocolContractNegotiationStateType.md)
 - [DataspaceProtocolContextType](type-aliases/DataspaceProtocolContextType.md)
 - [DataspaceProtocolContexts](type-aliases/DataspaceProtocolContexts.md)
+- [IDataspaceProtocolCatalogNoContext](type-aliases/IDataspaceProtocolCatalogNoContext.md)
+- [IDataspaceProtocolDataServiceNoContext](type-aliases/IDataspaceProtocolDataServiceNoContext.md)
+- [IDataspaceProtocolDatasetNoContext](type-aliases/IDataspaceProtocolDatasetNoContext.md)
+- [IDataspaceProtocolDistributionNoContext](type-aliases/IDataspaceProtocolDistributionNoContext.md)
+- [IDataspaceProtocolAgreementNoContext](type-aliases/IDataspaceProtocolAgreementNoContext.md)
+- [IDataspaceProtocolOfferNoContext](type-aliases/IDataspaceProtocolOfferNoContext.md)
+- [IDataspaceProtocolPolicyNoContext](type-aliases/IDataspaceProtocolPolicyNoContext.md)
+- [IDataspaceProtocolSetNoContext](type-aliases/IDataspaceProtocolSetNoContext.md)
 - [DataspaceProtocolTransferProcessTypes](type-aliases/DataspaceProtocolTransferProcessTypes.md)
 - [DataspaceProtocolEndpointType](type-aliases/DataspaceProtocolEndpointType.md)
 - [DataspaceProtocolTransferProcessStateType](type-aliases/DataspaceProtocolTransferProcessStateType.md)

package/docs/reference/interfaces/IDataspaceProtocolAgreement.md

@@ -13,7 +13,7 @@ Extends IOdrlAgreement with DS Protocol-specific constraints:
 
 ## Extends
 
-- `Omit`\<`IOdrlAgreement`, `"@context"` \| `"uid"`\>
+- `Omit`\<`IOdrlAgreement`, `"uid"`\>
 
 ## Properties
 
@@ -63,6 +63,19 @@ Required for Agreement policies.
 
 ***
 
+### @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`[]

package/docs/reference/interfaces/IDataspaceProtocolCatalog.md

@@ -65,7 +65,7 @@ Participant Id
 
 ### catalog?
 
-> `optional` **catalog**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<`IDataspaceProtocolCatalog`\>\>
+> `optional` **catalog**: [`IDataspaceProtocolCatalogNoContext`](../type-aliases/IDataspaceProtocolCatalogNoContext.md) \| [`IDataspaceProtocolCatalogNoContext`](../type-aliases/IDataspaceProtocolCatalogNoContext.md)[]
 
 Other concerned catalogs
 
@@ -73,7 +73,7 @@ Other concerned catalogs
 
 ### dataset?
 
-> `optional` **dataset**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)\>\>
+> `optional` **dataset**: [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md) \| [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md)[]
 
 Datasets registered
 
@@ -81,7 +81,7 @@ Datasets registered
 
 ### distribution?
 
-> `optional` **distribution**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)\>\>
+> `optional` **distribution**: [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md) \| [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md)[]
 
 Catalog's distributions
 
@@ -89,7 +89,7 @@ Catalog's distributions
 
 ### service?
 
-> `optional` **service**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md)\>\>
+> `optional` **service**: [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md) \| [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md)[]
 
 Data services registered-
 

package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### agreement
 
-> **agreement**: [`IDataspaceProtocolAgreement`](IDataspaceProtocolAgreement.md)
+> **agreement**: [`IDataspaceProtocolAgreementNoContext`](../type-aliases/IDataspaceProtocolAgreementNoContext.md)
 
 The agreement being sent.
 

package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: [`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)
+> **offer**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md

@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: [`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)
+> **offer**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/IDataspaceProtocolDataService.md

@@ -65,7 +65,7 @@ Endpoint URL
 
 ### servesDataset?
 
-> `optional` **servesDataset**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)\>\>
+> `optional` **servesDataset**: [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md) \| [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md)[]
 
 Datasets served.
 

package/docs/reference/interfaces/IDataspaceProtocolDataset.md

@@ -10,7 +10,7 @@ by overriding properties with more specific types and constraints.
 - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
 - Array MUST contain at least one IOdrlOffer
 - Each Offer MUST have `@type`: "Offer"
-- Each Offer MUST have `@id` or `uid` for identification
+- Each Offer MUST have `@id`
 - `dcat:distribution` MUST be present (REQUIRED)
 
 **Type System Design:**
@@ -69,7 +69,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 ### hasPolicy
 
-> **hasPolicy**: `ObjectOrArray`\<[`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)\>
+> **hasPolicy**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md) \| [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)[]
 
 Array of ODRL policies (Offers) as required by DS Protocol.
 
@@ -82,7 +82,7 @@ allows for future multi-offer support.
 
 ### distribution
 
-> **distribution**: `ObjectOrArray`\<`JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)\>\>
+> **distribution**: [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md) \| [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md)[]
 
 Distribution of the dataset.
 REQUIRED per Eclipse Data Space Protocol.

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md

@@ -68,7 +68,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 ### hasPolicy?
 
-> `optional` **hasPolicy**: `ObjectOrArray`\<[`IDataspaceProtocolOffer`](IDataspaceProtocolOffer.md)\>
+> `optional` **hasPolicy**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md) \| [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)[]
 
 Array of ODRL policies (Offers) as required by DS Protocol.
 
@@ -81,7 +81,7 @@ allows for future multi-offer support.
 
 ### accessService
 
-> **accessService**: `string` \| `JsonLdObjectWithNoContext`\<[`IDataspaceProtocolDataService`](IDataspaceProtocolDataService.md)\>
+> **accessService**: `string` \| [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md)
 
 Access service.
 It can be a URI pointing to an access service or inline the access service itself

package/docs/reference/interfaces/IDataspaceProtocolOffer.md

@@ -13,7 +13,7 @@ Extends IOdrlOffer with DS Protocol-specific constraints:
 
 ## Extends
 
-- `Omit`\<`IOdrlOffer`, `"@context"` \| `"uid"`\>
+- `Omit`\<`IOdrlOffer`, `"uid"`\>
 
 ## Properties
 
@@ -50,6 +50,19 @@ Required for Offer policies.
 
 ***
 
+### @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`[]

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