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

package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md

@@ -0,0 +1,381 @@
+# Interface: IDataspaceProtocolDistributionBase
+
+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
+
+- `Omit`\<`IDcatDistributionBase`, `"odrl:hasPolicy"` \| `"@type"` \| `"dcterms:format"`\>
+
+## Extended by
+
+- [`IDataspaceProtocolDistribution`](IDataspaceProtocolDistribution.md)
+
+## Properties
+
+### @type {#type}
+
+> **@type**: `"Distribution"`
+
+The type identifier for the Distribution.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+Unique identifier for the distribution.
+OPTIONAL for embedded distributions (may use JSON-LD blank nodes).
+REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
+
+#### Overrides
+
+`Omit.@id`
+
+***
+
+### 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.
+
+***
+
+### 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.
+
+***
+
+### format {#format}
+
+> **format**: `string`
+
+Distribution format.
+REQUIRED per Eclipse Data Space Protocol.
+
+***
+
+### 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
+
+`Omit.dcterms:title`
+
+***
+
+### 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
+
+`Omit.dcterms:description`
+
+***
+
+### 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
+
+`Omit.dcterms:issued`
+
+***
+
+### 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
+
+`Omit.dcterms:modified`
+
+***
+
+### 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
+
+`Omit.dcterms:license`
+
+***
+
+### 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
+
+`Omit.dcterms:accessRights`
+
+***
+
+### 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
+
+`Omit.dcterms:rights`
+
+***
+
+### 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
+
+`Omit.dcat:accessURL`
+
+***
+
+### 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
+
+`Omit.dcat:accessService`
+
+***
+
+### 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
+
+`Omit.dcat:downloadURL`
+
+***
+
+### 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
+
+`Omit.dcat:byteSize`
+
+***
+
+### 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
+
+`Omit.dcat:spatialResolutionInMeters`
+
+***
+
+### 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
+
+`Omit.dcat:temporalResolution`
+
+***
+
+### 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
+
+`Omit.dcterms:conformsTo`
+
+***
+
+### 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
+
+`Omit.dcat:mediaType`
+
+***
+
+### 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
+
+`Omit.dcat:compressFormat`
+
+***
+
+### 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
+
+`Omit.dcat:packageFormat`
+
+***
+
+### 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
+
+`Omit.spdx:checksum`

package/docs/reference/interfaces/{IEndpointProperty.md → IDataspaceProtocolEndpointProperty.md}

@@ -1,19 +1,19 @@
-# Interface: IEndpointProperty
+# Interface: IDataspaceProtocolEndpointProperty
 
 Interface for Dataspace Protocol Transfer Messages.
 https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types
 
 ## Properties
 
-### @type
+### @type {#type}
 
-> **@type**: `string`
+> **@type**: `"EndpointProperty"`
 
 LD Type.
 
 ***
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -21,7 +21,7 @@ Property name.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `string`
 

package/docs/reference/interfaces/IDataspaceProtocolOffer.md

@@ -0,0 +1,178 @@
+# Interface: IDataspaceProtocolOffer
+
+Offer interface compliant with Eclipse Data Space Protocol.
+
+Extends IOdrlOffer with DS Protocol-specific constraints:
+- `@id` is REQUIRED (used as the primary offer 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
+ - IOdrlOffer from @twin.org/standards-w3c-odrl
+
+## Extends
+
+- [`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)
+
+## Properties
+
+### @id {#id}
+
+> **@id**: `string`
+
+Unique identifier for the offer.
+
+#### Overrides
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`@id`](IDataspaceProtocolOfferBase.md#id)
+
+***
+
+### @context {#context}
+
+> **@context**: `OdrlContextType`
+
+LD Context.
+
+***
+
+### @type {#type}
+
+> **@type**: `"Offer"`
+
+The type must be "Offer".
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`@type`](IDataspaceProtocolOfferBase.md#type)
+
+***
+
+### assigner {#assigner}
+
+> **assigner**: `string` \| `IOdrlParty`
+
+The assigner of the offer.
+Required for Offer policies.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`assigner`](IDataspaceProtocolOfferBase.md#assigner)
+
+***
+
+### profile? {#profile}
+
+> `optional` **profile?**: `ObjectOrArray`\<`string`\>
+
+The profile(s) this policy conforms to.
+IRIs identifying the ODRL Profile(s).
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`profile`](IDataspaceProtocolOfferBase.md#profile)
+
+***
+
+### assignee? {#assignee}
+
+> `optional` **assignee?**: `ObjectOrArray`\<`string` \| `IOdrlParty` \| `IOdrlPartyCollection`\>
+
+The assignee of the policy.
+Applies to all rules unless overridden at rule level.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`assignee`](IDataspaceProtocolOfferBase.md#assignee)
+
+***
+
+### target? {#target}
+
+> `optional` **target?**: `ObjectOrArray`\<`string` \| `IOdrlAsset` \| `IOdrlAssetCollection`\>
+
+The target asset for the rule.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`target`](IDataspaceProtocolOfferBase.md#target)
+
+***
+
+### action? {#action}
+
+> `optional` **action?**: `ObjectOrArray`\<`string` \| `IOdrlAction`\>
+
+The action associated with the rule.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`action`](IDataspaceProtocolOfferBase.md#action)
+
+***
+
+### inheritFrom? {#inheritfrom}
+
+> `optional` **inheritFrom?**: `ObjectOrArray`\<`string`\>
+
+The parent policy(ies) this policy inherits from.
+IRIs identifying the parent Policy(ies).
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`inheritFrom`](IDataspaceProtocolOfferBase.md#inheritfrom)
+
+***
+
+### conflict? {#conflict}
+
+> `optional` **conflict?**: `OdrlConflictStrategyType`
+
+The conflict resolution strategy.
+- perm: Permissions override Prohibitions
+- prohibit: Prohibitions override Permissions
+- invalid: Policy is void if conflicts exist (default)
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`conflict`](IDataspaceProtocolOfferBase.md#conflict)
+
+***
+
+### permission? {#permission}
+
+> `optional` **permission?**: `ObjectOrArray`\<`IOdrlPermission`\>
+
+The permissions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`permission`](IDataspaceProtocolOfferBase.md#permission)
+
+***
+
+### prohibition? {#prohibition}
+
+> `optional` **prohibition?**: `ObjectOrArray`\<`IOdrlProhibition`\>
+
+The prohibitions in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`prohibition`](IDataspaceProtocolOfferBase.md#prohibition)
+
+***
+
+### obligation? {#obligation}
+
+> `optional` **obligation?**: `ObjectOrArray`\<`IOdrlDuty`\>
+
+The obligations in the policy.
+At least one of permission, prohibition, or obligation must be present.
+
+#### Inherited from
+
+[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md).[`obligation`](IDataspaceProtocolOfferBase.md#obligation)