npm - @twin.org/standards-dataspace-protocol - Versions diffs - 0.0.3-next.54 → 0.0.3-next.56 - Mend

@twin.org/standards-dataspace-protocol 0.0.3-next.54 → 0.0.3-next.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (171) hide show

package/docs/reference/interfaces/IDataspaceProtocolDistribution.md CHANGED Viewed

@@ -32,11 +32,11 @@ by overriding properties with more specific types and constraints.
 ## Extends
-- `Omit`\<`IDcatDistribution`, `"odrl:hasPolicy"` \| `"@type"` \| `"@context"` \| `"dcterms:format"`\>
+- [`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -44,31 +44,35 @@ LD Context. Required per Eclipse Data Space Protocol.
 ***
-### @type
+### @id {#id}
-> **@type**: `"Distribution"`
+> **@id**: `string`
-The type identifier for the Distribution.
-REQUIRED per Eclipse Data Space Protocol.
+Unique identifier for the distribution.
+REQUIRED on standalone Distribution objects per Eclipse Data Space Protocol.
+#### Overrides
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`@id`](IDataspaceProtocolDistributionBase.md#id)
 ***
-### @id
+### @type {#type}
-> **@id**: `string`
+> **@type**: `"Distribution"`
-Unique identifier for the dataset.
+The type identifier for the Distribution.
 REQUIRED per Eclipse Data Space Protocol.
-#### Overrides
+#### Inherited from
-`Omit.@id`
+`IDataspaceProtocolDistribution`.[`@type`](#type)
 ***
-### hasPolicy?
+### hasPolicy? {#haspolicy}
-> `optional` **hasPolicy**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md) \| [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)[]
+> `optional` **hasPolicy?**: `ObjectOrArray`\<[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)\>
 Array of ODRL policies (Offers) as required by DS Protocol.
@@ -77,29 +81,41 @@ 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}
-> **accessService**: `string` \| [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md)
+> **accessService**: `string` \| [`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)
 Access service.
-It can be a URI pointing to an access service or inline the access service itself
+It can be a URI pointing to an access service or inline the access service itself.
+#### Inherited from
+`IDataspaceProtocolDistribution`.[`accessService`](#accessservice)
 ***
-### format
+### format {#format}
 > **format**: `string`
 Distribution format.
 REQUIRED per Eclipse Data Space Protocol.
+#### Inherited from
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`format`](IDataspaceProtocolDistributionBase.md#format)
 ***
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
-> `optional` **dcterms:title**: `DcatLiteralType`
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 A name given to the distribution.
@@ -109,13 +125,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
 #### Inherited from
-`Omit.dcterms:title`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:title`](IDataspaceProtocolDistributionBase.md#dctermstitle)
 ***
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
-> `optional` **dcterms:description**: `DcatLiteralType`
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
 A free-text account of the distribution.
@@ -125,13 +141,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
 #### Inherited from
-`Omit.dcterms:description`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:description`](IDataspaceProtocolDistributionBase.md#dctermsdescription)
 ***
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 Date of formal issuance of the distribution.
@@ -141,13 +157,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
 #### Inherited from
-`Omit.dcterms:issued`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:issued`](IDataspaceProtocolDistributionBase.md#dctermsissued)
 ***
-### dcterms:modified?
+### dcterms:modified? {#dctermsmodified}
-> `optional` **dcterms:modified**: `string`
+> `optional` **dcterms:modified?**: `string`
 Most recent date on which the distribution was changed, updated or modified.
@@ -157,13 +173,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
 #### Inherited from
-`Omit.dcterms:modified`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:modified`](IDataspaceProtocolDistributionBase.md#dctermsmodified)
 ***
-### dcterms:license?
+### dcterms:license? {#dctermslicense}
-> `optional` **dcterms:license**: `string`
+> `optional` **dcterms:license?**: `string`
 A legal document under which the distribution is made available.
@@ -173,13 +189,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
 #### Inherited from
-`Omit.dcterms:license`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:license`](IDataspaceProtocolDistributionBase.md#dctermslicense)
 ***
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
-> `optional` **dcterms:accessRights**: `string`
+> `optional` **dcterms:accessRights?**: `string`
 Information about who can access the distribution.
@@ -189,13 +205,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
 #### Inherited from
-`Omit.dcterms:accessRights`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:accessRights`](IDataspaceProtocolDistributionBase.md#dctermsaccessrights)
 ***
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
-> `optional` **dcterms:rights**: `string`
+> `optional` **dcterms:rights?**: `string`
 Information about rights held in and over the distribution.
@@ -205,13 +221,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
 #### Inherited from
-`Omit.dcterms:rights`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:rights`](IDataspaceProtocolDistributionBase.md#dctermsrights)
 ***
-### dcat:accessURL?
+### dcat:accessURL? {#dcataccessurl}
-> `optional` **dcat:accessURL**: `string`
+> `optional` **dcat:accessURL?**: `string`
 A URL of the resource that gives access to a distribution of the dataset.
@@ -221,13 +237,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
 #### Inherited from
-`Omit.dcat:accessURL`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:accessURL`](IDataspaceProtocolDistributionBase.md#dcataccessurl)
 ***
-### dcat:accessService?
+### dcat:accessService? {#dcataccessservice}
-> `optional` **dcat:accessService**: `string`
+> `optional` **dcat:accessService?**: `string`
 A data service that gives access to the distribution.
@@ -237,13 +253,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
 #### Inherited from
-`Omit.dcat:accessService`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:accessService`](IDataspaceProtocolDistributionBase.md#dcataccessservice)
 ***
-### dcat:downloadURL?
+### dcat:downloadURL? {#dcatdownloadurl}
-> `optional` **dcat:downloadURL**: `string`
+> `optional` **dcat:downloadURL?**: `string`
 The URL of the downloadable file in a given format.
@@ -253,13 +269,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
 #### Inherited from
-`Omit.dcat:downloadURL`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:downloadURL`](IDataspaceProtocolDistributionBase.md#dcatdownloadurl)
 ***
-### dcat:byteSize?
+### dcat:byteSize? {#dcatbytesize}
-> `optional` **dcat:byteSize**: `number`
+> `optional` **dcat:byteSize?**: `number`
 The size of the distribution in bytes.
@@ -269,13 +285,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
 #### Inherited from
-`Omit.dcat:byteSize`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:byteSize`](IDataspaceProtocolDistributionBase.md#dcatbytesize)
 ***
-### dcat:spatialResolutionInMeters?
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
-> `optional` **dcat:spatialResolutionInMeters**: `number`
+> `optional` **dcat:spatialResolutionInMeters?**: `number`
 The minimum spatial separation resolvable in a distribution, measured in meters.
@@ -285,13 +301,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
 #### Inherited from
-`Omit.dcat:spatialResolutionInMeters`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:spatialResolutionInMeters`](IDataspaceProtocolDistributionBase.md#dcatspatialresolutioninmeters)
 ***
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
-> `optional` **dcat:temporalResolution**: `string`
+> `optional` **dcat:temporalResolution?**: `string`
 Minimum time period resolvable in the distribution.
@@ -301,13 +317,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
 #### Inherited from
-`Omit.dcat:temporalResolution`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:temporalResolution`](IDataspaceProtocolDistributionBase.md#dcattemporalresolution)
 ***
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
-> `optional` **dcterms:conformsTo**: `string` \| `string`[]
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 An established standard to which the distribution conforms.
@@ -317,13 +333,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
 #### Inherited from
-`Omit.dcterms:conformsTo`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcterms:conformsTo`](IDataspaceProtocolDistributionBase.md#dctermsconformsto)
 ***
-### dcat:mediaType?
+### dcat:mediaType? {#dcatmediatype}
-> `optional` **dcat:mediaType**: `string`
+> `optional` **dcat:mediaType?**: `string`
 The media type of the distribution as defined by IANA.
@@ -333,13 +349,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
 #### Inherited from
-`Omit.dcat:mediaType`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:mediaType`](IDataspaceProtocolDistributionBase.md#dcatmediatype)
 ***
-### dcat:compressFormat?
+### dcat:compressFormat? {#dcatcompressformat}
-> `optional` **dcat:compressFormat**: `string`
+> `optional` **dcat:compressFormat?**: `string`
 The compression format of the distribution.
@@ -349,13 +365,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
 #### Inherited from
-`Omit.dcat:compressFormat`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:compressFormat`](IDataspaceProtocolDistributionBase.md#dcatcompressformat)
 ***
-### dcat:packageFormat?
+### dcat:packageFormat? {#dcatpackageformat}
-> `optional` **dcat:packageFormat**: `string`
+> `optional` **dcat:packageFormat?**: `string`
 The package format of the distribution.
@@ -365,13 +381,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
 #### Inherited from
-`Omit.dcat:packageFormat`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`dcat:packageFormat`](IDataspaceProtocolDistributionBase.md#dcatpackageformat)
 ***
-### spdx:checksum?
+### spdx:checksum? {#spdxchecksum}
-> `optional` **spdx:checksum**: `string`
+> `optional` **spdx:checksum?**: `string`
 The checksum property provides a mechanism to verify the data integrity.
@@ -381,4 +397,4 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
 #### Inherited from
-`Omit.spdx:checksum`
+[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md).[`spdx:checksum`](IDataspaceProtocolDistributionBase.md#spdxchecksum)