@twin.org/standards-dataspace-protocol 0.0.3-next.53 → 0.0.3-next.55

package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md

@@ -0,0 +1,484 @@
+# 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
+
+## 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
+
+## Extends
+
+- `Omit`\<`IDcatDatasetBase`, `"odrl:hasPolicy"` \| `"dcat:distribution"` \| `"@type"`\>
+
+## Extended by
+
+- [`IDataspaceProtocolDataset`](IDataspaceProtocolDataset.md)
+
+## Properties
+
+### @type {#type}
+
+> **@type**: `"Dataset"`
+
+The type identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+#### Overrides
+
+`Omit.@id`
+
+***
+
+### hasPolicy {#haspolicy}
+
+> **hasPolicy**: `ObjectOrArray`\<[`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.
+
+***
+
+### distribution {#distribution}
+
+> **distribution**: `ObjectOrArray`\<[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)\>
+
+Distribution of the dataset.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### dcterms:accrualPeriodicity? {#dctermsaccrualperiodicity}
+
+> `optional` **dcterms:accrualPeriodicity**: `string`
+
+The frequency at which the dataset is published.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
+
+#### Inherited from
+
+`Omit.dcterms:accrualPeriodicity`
+
+***
+
+### dcat:inSeries? {#dcatinseries}
+
+> `optional` **dcat:inSeries**: `string`
+
+A dataset series of which the dataset is part.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
+
+#### Inherited from
+
+`Omit.dcat:inSeries`
+
+***
+
+### dcterms:spatial? {#dctermsspatial}
+
+> `optional` **dcterms:spatial**: `string` \| `string`[] \| `IJsonLdNodeObject`
+
+The geographical area covered by the dataset.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
+
+#### Inherited from
+
+`Omit.dcterms:spatial`
+
+***
+
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
+
+> `optional` **dcat:spatialResolutionInMeters**: `number`
+
+Minimum spatial separation resolvable in a dataset, measured in meters.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
+
+#### Inherited from
+
+`Omit.dcat:spatialResolutionInMeters`
+
+***
+
+### dcterms:temporal? {#dctermstemporal}
+
+> `optional` **dcterms:temporal**: `IDublinCorePeriodOfTime`
+
+The temporal period that the dataset covers.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
+
+#### Inherited from
+
+`Omit.dcterms:temporal`
+
+***
+
+### dcat:temporalResolution? {#dcattemporalresolution}
+
+> `optional` **dcat:temporalResolution**: `string`
+
+Minimum time period resolvable in the dataset.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
+
+#### Inherited from
+
+`Omit.dcat:temporalResolution`
+
+***
+
+### prov:wasGeneratedBy? {#provwasgeneratedby}
+
+> `optional` **prov:wasGeneratedBy**: `string` \| `IJsonLdNodeObject`
+
+An activity that generated, or provides the business context for, the creation of the dataset.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
+
+#### Inherited from
+
+`Omit.prov:wasGeneratedBy`
+
+***
+
+### dcterms:title? {#dctermstitle}
+
+> `optional` **dcterms:title**: `ObjectOrArray`\<`string`\>
+
+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? {#dctermsdescription}
+
+> `optional` **dcterms:description**: `ObjectOrArray`\<`string`\>
+
+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? {#dctermsidentifier}
+
+> `optional` **dcterms:identifier**: `ObjectOrArray`\<`string`\>
+
+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? {#dctermsissued}
+
+> `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? {#dctermsmodified}
+
+> `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? {#dctermslanguage}
+
+> `optional` **dcterms:language**: `ObjectOrArray`\<`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? {#dctermspublisher}
+
+> `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? {#dctermscreator}
+
+> `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? {#dctermsaccessrights}
+
+> `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? {#dctermslicense}
+
+> `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? {#dctermsrights}
+
+> `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? {#dctermsconformsto}
+
+> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`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? {#dctermstype}
+
+> `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? {#dcatcontactpoint}
+
+> `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? {#dcatkeyword}
+
+> `optional` **dcat:keyword**: `ObjectOrArray`\<`string`\>
+
+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? {#dcattheme}
+
+> `optional` **dcat:theme**: `ObjectOrArray`\<`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? {#dcatlandingpage}
+
+> `optional` **dcat:landingPage**: `ObjectOrArray`\<`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? {#dcatqualifiedrelation}
+
+> `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`

package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md

@@ -5,7 +5,7 @@ https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#data
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
 
@@ -13,7 +13,7 @@ The JSON-LD context.
 
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"DatasetRequestMessage"`
 
@@ -21,7 +21,7 @@ The type of the message.
 
 ***
 
-### dataset
+### dataset {#dataset}
 
 > **dataset**: `string`