@twin.org/standards-dataspace-protocol 0.0.3-next.66 → 0.0.3-next.68

package/docs/reference/interfaces/IDataspaceProtocolCatalog.md

@@ -1,23 +1,10 @@
 # Interface: IDataspaceProtocolCatalog
 
-Catalog interface compliant with Eclipse Data Space Protocol.
-
-This interface extends ICatalog  and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- participantId MUST be present (REQUIRED)
-
-**Type System Design:**
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
+Catalog compliant with Eclipse Data Space Protocol, requiring a context, id, and participantId.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -29,7 +16,7 @@ by overriding properties with more specific types and constraints.
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
-LD Context. Required per Eclipse Data Space Protocol.
+The JSON-LD context.
 
 ***
 
@@ -63,7 +50,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 > **participantId**: `string`
 
-Participant Id
+The participant identifier.
 
 #### Inherited from
 
@@ -75,7 +62,7 @@ Participant Id
 
 > `optional` **catalog?**: [`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md)[]
 
-Other concerned catalogs
+Nested catalogs.
 
 #### Inherited from
 
@@ -87,7 +74,7 @@ Other concerned catalogs
 
 > `optional` **dataset?**: [`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md)[]
 
-Datasets registered
+Datasets registered in this catalog.
 
 #### Inherited from
 
@@ -99,7 +86,7 @@ Datasets registered
 
 > `optional` **distribution?**: [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)[]
 
-Catalog's distributions
+Distributions for this catalog.
 
 #### Inherited from
 
@@ -111,7 +98,7 @@ Catalog's distributions
 
 > `optional` **service?**: [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)[]
 
-Data services registered-
+Data services registered in this catalog.
 
 #### Inherited from
 

package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md

@@ -1,23 +1,10 @@
 # Interface: IDataspaceProtocolCatalogBase
 
-Catalog interface compliant with Eclipse Data Space Protocol.
-
-This interface extends ICatalog  and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- participantId MUST be present (REQUIRED)
-
-**Type System Design:**
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
+Base catalog interface compliant with Eclipse Data Space Protocol, requiring an id and participantId.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -55,7 +42,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 > **participantId**: `string`
 
-Participant Id
+The participant identifier.
 
 ***
 
@@ -63,7 +50,7 @@ Participant Id
 
 > `optional` **catalog?**: `IDataspaceProtocolCatalogBase`[]
 
-Other concerned catalogs
+Nested catalogs.
 
 ***
 
@@ -71,7 +58,7 @@ Other concerned catalogs
 
 > `optional` **dataset?**: [`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md)[]
 
-Datasets registered
+Datasets registered in this catalog.
 
 ***
 
@@ -79,7 +66,7 @@ Datasets registered
 
 > `optional` **distribution?**: [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)[]
 
-Catalog's distributions
+Distributions for this catalog.
 
 ***
 
@@ -87,7 +74,7 @@ Catalog's distributions
 
 > `optional` **service?**: [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)[]
 
-Data services registered-
+Data services registered in this catalog.
 
 ***
 

package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolCatalogError
 
-Interface for Dataspace Protocol Catalog Error.
+Interface for the Dataspace Protocol catalog error response.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolCatalogRequestMessage
 
-Interface for Dataspace Protocol Catalog Request Messages.
+Interface for the Dataspace Protocol catalog request message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractAgreementMessage
 
-Interface for Dataspace Protocol Contract Agreement Messages.
+Interface for the Dataspace Protocol contract agreement message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractAgreementVerificationMessage
 
-Interface for Dataspace Protocol Contract Agreement Verification Messages.
+Interface for the Dataspace Protocol contract agreement verification message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractNegotiation.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractNegotiation
 
-Interface for Dataspace Protocol Contract Agreement Messages.
+Interface for the Dataspace Protocol contract negotiation acknowledgment.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
 
 ## Properties
@@ -41,4 +44,4 @@ The consumer id for the contract.
 
 > **state**: [`DataspaceProtocolContractNegotiationStateType`](../type-aliases/DataspaceProtocolContractNegotiationStateType.md)
 
-The offer being requested.
+The current state of the contract negotiation.

package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractNegotiationError
 
-Interface for Dataspace Protocol Contract Negotiation Error Messages.
+Interface for the Dataspace Protocol contract negotiation error response.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationEventMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractNegotiationEventMessage
 
-Interface for Dataspace Protocol Contract Negotiation Event Messages.
+Interface for the Dataspace Protocol contract negotiation event message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractNegotiationTerminationMessage
 
-Interface for Dataspace Protocol Contract Negotiation Termination Messages.
+Interface for the Dataspace Protocol contract negotiation termination message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractOfferMessage
 
-Interface for Dataspace Protocol Contract Offer Messages.
+Interface for the Dataspace Protocol contract offer message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolContractRequestMessage
 
-Interface for Dataspace Protocol Contract Request Messages.
+Interface for the Dataspace Protocol contract request message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolDataAddress
 
-Interface for Dataspace Protocol Transfer Messages.
+Interface for a Dataspace Protocol data address.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
 
 ## Properties
@@ -9,7 +12,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level
 
 > **@type**: `"DataAddress"`
 
-LD Type
+The JSON-LD type.
 
 ***
 
@@ -17,7 +20,7 @@ LD Type
 
 > **endpointType**: `string`
 
-The type of endpoint of this data address.
+The endpoint type identifier.
 
 ***
 
@@ -25,7 +28,7 @@ The type of endpoint of this data address.
 
 > `optional` **endpoint?**: `string`
 
-The endpoint of the data address
+The endpoint URL or address.
 
 ***
 
@@ -33,4 +36,4 @@ The endpoint of the data address
 
 > `optional` **endpointProperties?**: [`IDataspaceProtocolEndpointProperty`](IDataspaceProtocolEndpointProperty.md)[]
 
-Properties associated to the endpoint which might depend on the endpoint type.
+Transport-specific endpoint properties.

package/docs/reference/interfaces/IDataspaceProtocolDataService.md

@@ -1,23 +1,10 @@
 # Interface: IDataspaceProtocolDataService
 
-Data Service interface compliant with Eclipse Data Space Protocol.
-
-This interface extends IDataService  and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- endpointURL MUST be present (REQUIRED)
-
-**Type System Design:**
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
+Data service compliant with Eclipse Data Space Protocol, requiring an id and endpointURL.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -29,7 +16,7 @@ by overriding properties with more specific types and constraints.
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
-LD Context. Required per Eclipse Data Space Protocol.
+The JSON-LD context.
 
 ***
 

package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md

@@ -1,23 +1,10 @@
 # Interface: IDataspaceProtocolDataServiceBase
 
-Data Service interface compliant with Eclipse Data Space Protocol.
-
-This interface extends IDataService  and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- endpointURL MUST be present (REQUIRED)
-
-**Type System Design:**
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
+Base data service interface compliant with Eclipse Data Space Protocol, requiring an id and endpointURL.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 

package/docs/reference/interfaces/IDataspaceProtocolDataset.md

@@ -1,35 +1,10 @@
 # Interface: IDataspaceProtocolDataset
 
-Dataset interface compliant with Eclipse Data Space Protocol.
-
-This interface extends IDataset and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- `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`
-- `dcat:distribution` MUST be present (REQUIRED)
-
-**Type System Design:**
-- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
-- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
-
-**Future Compatibility:**
-- Currently only one Offer per dataset is supported
-- Array structure allows future support for multiple offers
+Dataset compliant with Eclipse Data Space Protocol, requiring an id, hasPolicy, and distribution.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
- - IOdrlOffer from @twin.org/standards-w3c-odrl
- - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -41,7 +16,7 @@ by overriding properties with more specific types and constraints.
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
-LD Context. Required per Eclipse Data Space Protocol.
+The JSON-LD context.
 
 ***
 
@@ -75,12 +50,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 > **hasPolicy**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)[]
 
-Array of ODRL policies (Offers) as required by DS Protocol.
-
-REQUIRED per Eclipse Data Space Protocol spec.
-Must contain at least one IOdrlOffer.
-Currently only single offer is supported, but array structure
-allows for future multi-offer support.
+Array of ODRL offers; must contain at least one entry.
 
 #### Inherited from
 
@@ -92,8 +62,7 @@ allows for future multi-offer support.
 
 > **distribution**: [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)[]
 
-Distribution of the dataset.
-REQUIRED per Eclipse Data Space Protocol.
+Distributions of this dataset; must contain at least one entry.
 
 #### Inherited from
 

package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md

@@ -1,35 +1,10 @@
 # Interface: IDataspaceProtocolDatasetBase
 
-Dataset interface compliant with Eclipse Data Space Protocol.
-
-This interface extends IDataset and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- `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`
-- `dcat:distribution` MUST be present (REQUIRED)
-
-**Type System Design:**
-- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
-- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
-
-**Future Compatibility:**
-- Currently only one Offer per dataset is supported
-- Array structure allows future support for multiple offers
+Base dataset interface compliant with Eclipse Data Space Protocol, requiring an id, hasPolicy, and distribution.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
- - IOdrlOffer from @twin.org/standards-w3c-odrl
- - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -67,12 +42,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 > **hasPolicy**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)[]
 
-Array of ODRL policies (Offers) as required by DS Protocol.
-
-REQUIRED per Eclipse Data Space Protocol spec.
-Must contain at least one IOdrlOffer.
-Currently only single offer is supported, but array structure
-allows for future multi-offer support.
+Array of ODRL offers; must contain at least one entry.
 
 ***
 
@@ -80,8 +50,7 @@ allows for future multi-offer support.
 
 > **distribution**: [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)[]
 
-Distribution of the dataset.
-REQUIRED per Eclipse Data Space Protocol.
+Distributions of this dataset; must contain at least one entry.
 
 ***
 

package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md

@@ -1,6 +1,9 @@
 # Interface: IDataspaceProtocolDatasetRequestMessage
 
-Interface for Dataspace Protocol Dataset Request Messages.
+Interface for the Dataspace Protocol dataset request message.
+
+## See
+
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
 
 ## Properties

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md

@@ -1,34 +1,10 @@
 # Interface: IDataspaceProtocolDistribution
 
-Distribution interface compliant with Eclipse Data Space Protocol.
-
-This interface extends IDistribution  and enforces DS Protocol-specific requirements
-by overriding properties with more specific types and constraints.
-
-**Requirements per DS Protocol:**
-- `@id` MUST be present for dataset identification (REQUIRED)
-- `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)
-- Array MUST contain at least one IOdrlOffer
-- Each Offer MUST have `@type`: "Offer"
-- `format` is REQUIRED.
-
-**Type System Design:**
-- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
-- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
-- Interface extension allows TypeScript to override inherited property types
-- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
-- DS Protocol-specific constraints are defined here
-
-**Future Compatibility:**
-- Currently only one Offer per dataset is supported
-- Array structure allows future support for multiple offers
+Distribution compliant with Eclipse Data Space Protocol, requiring an id and format.
 
 ## See
 
- - https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
- - https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
- - IOdrlOffer from @twin.org/standards-w3c-odrl
- - IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
+https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
 
 ## Extends
 
@@ -40,7 +16,7 @@ by overriding properties with more specific types and constraints.
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
-LD Context. Required per Eclipse Data Space Protocol.
+The JSON-LD context.
 
 ***
 
@@ -48,8 +24,7 @@ LD Context. Required per Eclipse Data Space Protocol.
 
 > **@id**: `string`
 
-Unique identifier for the distribution.
-REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
+Unique identifier for the distribution; required on standalone distribution objects.
 
 #### Overrides
 
@@ -74,12 +49,7 @@ REQUIRED per Eclipse Data Space Protocol.
 
 > `optional` **hasPolicy?**: [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)[]
 
-Array of ODRL policies (Offers) as required by DS Protocol.
-
-REQUIRED per Eclipse Data Space Protocol spec.
-Must contain at least one IOdrlOffer.
-Currently only single offer is supported, but array structure
-allows for future multi-offer support.
+Optional array of ODRL offers; when present, must contain at least one entry.
 
 #### Inherited from
 
@@ -91,8 +61,7 @@ allows for future multi-offer support.
 
 > **accessService**: `string` \| [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)
 
-Access service.
-It can be a URI pointing to an access service or inline the access service itself.
+Access service URI or inline access service definition.
 
 #### Inherited from
 
@@ -104,8 +73,7 @@ It can be a URI pointing to an access service or inline the access service itsel
 
 > **format**: `string`
 
-Distribution format.
-REQUIRED per Eclipse Data Space Protocol.
+Distribution format identifier.
 
 #### Inherited from