@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.60

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md

@@ -0,0 +1,400 @@
+# 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
+
+## 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
+
+- [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)
+
+## Properties
+
+### @context {#context}
+
+> **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
+
+LD Context. Required per Eclipse Data Space Protocol.
+
+***
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the distribution.
+REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
+
+#### Overrides
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`@id`](IDataspaceProtocolDistributionBase.md#id)
+
+***
+
+### @type {#type}
+
+> **@type**: `"Distribution"`
+
+The type identifier for the Distribution.
+REQUIRED per Eclipse Data Space Protocol.
+
+#### Inherited from
+
+`IDataspaceProtocolDistribution`.[`@type`](#type)
+
+***
+
+### hasPolicy? {#haspolicy}
+
+> `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.
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`hasPolicy`](IDataspaceProtocolDistributionBase.md#haspolicy)
+
+***
+
+### accessService {#accessservice}
+
+> **accessService**: `string` \| [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)
+
+Access service.
+It can be a URI pointing to an access service or inline the access service itself.
+
+#### Inherited from
+
+`IDataspaceProtocolDistribution`.[`accessService`](#accessservice)
+
+***
+
+### format {#format}
+
+> **format**: `string`
+
+Distribution format.
+REQUIRED per Eclipse Data Space Protocol.
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`format`](IDataspaceProtocolDistributionBase.md#format)
+
+***
+
+### dcterms:title? {#dctermstitle}
+
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
+
+A name given to the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:title`](IDataspaceProtocolDistributionBase.md#dctermstitle)
+
+***
+
+### dcterms:description? {#dctermsdescription}
+
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
+
+A free-text account of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:description`](IDataspaceProtocolDistributionBase.md#dctermsdescription)
+
+***
+
+### dcterms:issued? {#dctermsissued}
+
+> `optional` **dcterms:issued?**: `string`
+
+Date of formal issuance of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:issued`](IDataspaceProtocolDistributionBase.md#dctermsissued)
+
+***
+
+### dcterms:modified? {#dctermsmodified}
+
+> `optional` **dcterms:modified?**: `string`
+
+Most recent date on which the distribution was changed, updated or modified.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:modified`](IDataspaceProtocolDistributionBase.md#dctermsmodified)
+
+***
+
+### dcterms:license? {#dctermslicense}
+
+> `optional` **dcterms:license?**: `string`
+
+A legal document under which the distribution is made available.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:license`](IDataspaceProtocolDistributionBase.md#dctermslicense)
+
+***
+
+### dcterms:accessRights? {#dctermsaccessrights}
+
+> `optional` **dcterms:accessRights?**: `string`
+
+Information about who can access the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:accessRights`](IDataspaceProtocolDistributionBase.md#dctermsaccessrights)
+
+***
+
+### dcterms:rights? {#dctermsrights}
+
+> `optional` **dcterms:rights?**: `string`
+
+Information about rights held in and over the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:rights`](IDataspaceProtocolDistributionBase.md#dctermsrights)
+
+***
+
+### dcat:accessURL? {#dcataccessurl}
+
+> `optional` **dcat:accessURL?**: `string`
+
+A URL of the resource that gives access to a distribution of the dataset.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:accessURL`](IDataspaceProtocolDistributionBase.md#dcataccessurl)
+
+***
+
+### dcat:accessService? {#dcataccessservice}
+
+> `optional` **dcat:accessService?**: `string`
+
+A data service that gives access to the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:accessService`](IDataspaceProtocolDistributionBase.md#dcataccessservice)
+
+***
+
+### dcat:downloadURL? {#dcatdownloadurl}
+
+> `optional` **dcat:downloadURL?**: `string`
+
+The URL of the downloadable file in a given format.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:downloadURL`](IDataspaceProtocolDistributionBase.md#dcatdownloadurl)
+
+***
+
+### dcat:byteSize? {#dcatbytesize}
+
+> `optional` **dcat:byteSize?**: `number`
+
+The size of the distribution in bytes.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:byteSize`](IDataspaceProtocolDistributionBase.md#dcatbytesize)
+
+***
+
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
+
+> `optional` **dcat:spatialResolutionInMeters?**: `number`
+
+The minimum spatial separation resolvable in a distribution, measured in meters.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:spatialResolutionInMeters`](IDataspaceProtocolDistributionBase.md#dcatspatialresolutioninmeters)
+
+***
+
+### dcat:temporalResolution? {#dcattemporalresolution}
+
+> `optional` **dcat:temporalResolution?**: `string`
+
+Minimum time period resolvable in the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:temporalResolution`](IDataspaceProtocolDistributionBase.md#dcattemporalresolution)
+
+***
+
+### dcterms:conformsTo? {#dctermsconformsto}
+
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
+
+An established standard to which the distribution conforms.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:conformsTo`](IDataspaceProtocolDistributionBase.md#dctermsconformsto)
+
+***
+
+### dcat:mediaType? {#dcatmediatype}
+
+> `optional` **dcat:mediaType?**: `string`
+
+The media type of the distribution as defined by IANA.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:mediaType`](IDataspaceProtocolDistributionBase.md#dcatmediatype)
+
+***
+
+### dcat:compressFormat? {#dcatcompressformat}
+
+> `optional` **dcat:compressFormat?**: `string`
+
+The compression format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:compressFormat`](IDataspaceProtocolDistributionBase.md#dcatcompressformat)
+
+***
+
+### dcat:packageFormat? {#dcatpackageformat}
+
+> `optional` **dcat:packageFormat?**: `string`
+
+The package format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:packageFormat`](IDataspaceProtocolDistributionBase.md#dcatpackageformat)
+
+***
+
+### spdx:checksum? {#spdxchecksum}
+
+> `optional` **spdx:checksum?**: `string`
+
+The checksum property provides a mechanism to verify the data integrity.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
+
+#### Inherited from
+
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`spdx:checksum`](IDataspaceProtocolDistributionBase.md#spdxchecksum)