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

package/docs/reference/interfaces/{IContractOfferMessage.md → IDataspaceProtocolContractOfferMessage.md}

@@ -1,4 +1,4 @@
-# Interface: IContractOfferMessage
+# Interface: IDataspaceProtocolContractOfferMessage
 
 Interface for Dataspace Protocol Contract Offer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
@@ -15,7 +15,7 @@ The JSON-LD context.
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"ContractOfferMessage"`
 
 The type of the message.
 
@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/{IContractRequestMessage.md → IDataspaceProtocolContractRequestMessage.md}

@@ -1,4 +1,4 @@
-# Interface: IContractRequestMessage
+# Interface: IDataspaceProtocolContractRequestMessage
 
 Interface for Dataspace Protocol Contract Request Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
@@ -15,7 +15,7 @@ The JSON-LD context.
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"ContractRequestMessage"`
 
 The type of the message.
 
@@ -39,7 +39,7 @@ The consumer id for the contract.
 
 ### offer
 
-> **offer**: `IOdrlOffer`
+> **offer**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)
 
 The offer being requested.
 

package/docs/reference/interfaces/{IDataAddress.md → IDataspaceProtocolDataAddress.md}

@@ -1,4 +1,4 @@
-# Interface: IDataAddress
+# Interface: IDataspaceProtocolDataAddress
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
@@ -7,7 +7,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level
 
 ### @type
 
-> **@type**: `string`
+> **@type**: `"DataAddress"`
 
 LD Type
 
@@ -31,6 +31,6 @@ The endpoint of the data address
 
 ### endpointProperties?
 
-> `optional` **endpointProperties**: [`IEndpointProperty`](IEndpointProperty.md)[]
+> `optional` **endpointProperties**: [`IDataspaceProtocolEndpointProperty`](IDataspaceProtocolEndpointProperty.md)[]
 
 Properties associated to the endpoint which might depend on the endpoint type.

package/docs/reference/interfaces/IDataspaceProtocolDataService.md

@@ -0,0 +1,391 @@
+# 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
+
+## 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
+
+## Extends
+
+- `Omit`\<`IDcatDataService`, `"@type"` \| `"@context"` \| `"dcat:servesDataset"` \| `"dcat:endpointURL"`\>
+
+## Properties
+
+### @context
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context. Required per Eclipse Data Space Protocol.
+
+***
+
+### @type
+
+> **@type**: `"DataService"`
+
+The type identifier for the Data Service.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id
+
+> **@id**: `string`
+
+Unique identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+#### Overrides
+
+`Omit.@id`
+
+***
+
+### endpointURL
+
+> **endpointURL**: `string`
+
+Endpoint URL
+
+***
+
+### servesDataset?
+
+> `optional` **servesDataset**: [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md) \| [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md)[]
+
+Datasets served.
+
+***
+
+### dcat:endpointDescription?
+
+> `optional` **dcat:endpointDescription**: `string`
+
+A description of the services available via the end-points, including their
+operations, parameters, etc.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_description
+
+#### Inherited from
+
+`Omit.dcat:endpointDescription`
+
+***
+
+### dcterms:title?
+
+> `optional` **dcterms:title**: `DcatLiteralType`
+
+A name given to the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
+
+#### Inherited from
+
+`Omit.dcterms:title`
+
+***
+
+### dcterms:description?
+
+> `optional` **dcterms:description**: `DcatLiteralType`
+
+A free-text account of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
+
+#### Inherited from
+
+`Omit.dcterms:description`
+
+***
+
+### dcterms:identifier?
+
+> `optional` **dcterms:identifier**: `DcatLiteralType`
+
+A unique identifier of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
+
+#### Inherited from
+
+`Omit.dcterms:identifier`
+
+***
+
+### dcterms:issued?
+
+> `optional` **dcterms:issued**: `string`
+
+Date of formal issuance (publication) of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
+
+#### Inherited from
+
+`Omit.dcterms:issued`
+
+***
+
+### dcterms:modified?
+
+> `optional` **dcterms:modified**: `string`
+
+Most recent date on which the resource was changed, updated or modified.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
+
+#### Inherited from
+
+`Omit.dcterms:modified`
+
+***
+
+### dcterms:language?
+
+> `optional` **dcterms:language**: `string` \| `string`[]
+
+A language of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
+
+#### Inherited from
+
+`Omit.dcterms:language`
+
+***
+
+### dcterms:publisher?
+
+> `optional` **dcterms:publisher**: `string` \| `IFoafAgentWithAliases`
+
+An entity responsible for making the resource available.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
+
+#### Inherited from
+
+`Omit.dcterms:publisher`
+
+***
+
+### dcterms:creator?
+
+> `optional` **dcterms:creator**: `string` \| `IFoafAgentWithAliases`
+
+An entity responsible for producing the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
+
+#### Inherited from
+
+`Omit.dcterms:creator`
+
+***
+
+### dcterms:accessRights?
+
+> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
+
+Information about who can access the resource or an indication of its security status.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
+
+#### Inherited from
+
+`Omit.dcterms:accessRights`
+
+***
+
+### dcterms:license?
+
+> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
+
+A legal document under which the resource is made available.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
+
+#### Inherited from
+
+`Omit.dcterms:license`
+
+***
+
+### dcterms:rights?
+
+> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
+
+Information about rights held in and over the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
+
+#### Inherited from
+
+`Omit.dcterms:rights`
+
+***
+
+### dcterms:conformsTo?
+
+> `optional` **dcterms:conformsTo**: `string` \| `string`[]
+
+An established standard to which the resource conforms.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
+
+#### Inherited from
+
+`Omit.dcterms:conformsTo`
+
+***
+
+### dcterms:type?
+
+> `optional` **dcterms:type**: `string`
+
+The nature or genre of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
+
+#### Inherited from
+
+`Omit.dcterms:type`
+
+***
+
+### dcat:contactPoint?
+
+> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+
+Relevant contact information for the catalogued resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
+
+#### Inherited from
+
+`Omit.dcat:contactPoint`
+
+***
+
+### dcat:keyword?
+
+> `optional` **dcat:keyword**: `DcatLiteralType`
+
+A keyword or tag describing the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
+
+#### Inherited from
+
+`Omit.dcat:keyword`
+
+***
+
+### dcat:theme?
+
+> `optional` **dcat:theme**: `string` \| `string`[]
+
+A main category of the resource. A resource can have multiple themes.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
+
+#### Inherited from
+
+`Omit.dcat:theme`
+
+***
+
+### dcat:landingPage?
+
+> `optional` **dcat:landingPage**: `string` \| `string`[]
+
+A Web page that can be navigated to gain access to the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
+
+#### Inherited from
+
+`Omit.dcat:landingPage`
+
+***
+
+### dcat:qualifiedRelation?
+
+> `optional` **dcat:qualifiedRelation**: `string` \| `IDcatRelationship`
+
+Link to a description of a relationship with another resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
+
+#### Inherited from
+
+`Omit.dcat:qualifiedRelation`
+
+***
+
+### odrl:hasPolicy?
+
+> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+
+An ODRL conformant policy expressing the rights associated with the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy
+
+#### Inherited from
+
+`Omit.odrl:hasPolicy`