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/IDataspaceProtocolDataset.md CHANGED Viewed

@@ -33,11 +33,11 @@ by overriding properties with more specific types and constraints.
 ## Extends
-- `Omit`\<`IDcatDataset`, `"odrl:hasPolicy"` \| `"dcat:distribution"` \| `"@type"` \| `"@context"`\>
+- [`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md)
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -45,31 +45,35 @@ LD Context. Required per Eclipse Data Space Protocol.
 ***
-### @type
+### @type {#type}
 > **@type**: `"Dataset"`
 The type identifier for the dataset.
 REQUIRED per Eclipse Data Space Protocol.
+#### Inherited from
+`IDataspaceProtocolDataset`.[`@type`](#type)
 ***
-### @id
+### @id {#id}
 > **@id**: `string`
 Unique identifier for the dataset.
 REQUIRED per Eclipse Data Space Protocol.
-#### Overrides
+#### Inherited from
-`Omit.@id`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`@id`](IDataspaceProtocolDatasetBase.md#id)
 ***
-### hasPolicy
+### hasPolicy {#haspolicy}
-> **hasPolicy**: [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md) \| [`IDataspaceProtocolOfferNoContext`](../type-aliases/IDataspaceProtocolOfferNoContext.md)[]
+> **hasPolicy**: `ObjectOrArray`\<[`IDataspaceProtocolOfferBase`](IDataspaceProtocolOfferBase.md)\>
 Array of ODRL policies (Offers) as required by DS Protocol.
@@ -78,20 +82,28 @@ Must contain at least one IOdrlOffer.
 Currently only single offer is supported, but array structure
 allows for future multi-offer support.
+#### Inherited from
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`hasPolicy`](IDataspaceProtocolDatasetBase.md#haspolicy)
 ***
-### distribution
+### distribution {#distribution}
-> **distribution**: [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md) \| [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md)[]
+> **distribution**: `ObjectOrArray`\<[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)\>
 Distribution of the dataset.
 REQUIRED per Eclipse Data Space Protocol.
+#### Inherited from
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`distribution`](IDataspaceProtocolDatasetBase.md#distribution)
 ***
-### dcterms:accrualPeriodicity?
+### dcterms:accrualPeriodicity? {#dctermsaccrualperiodicity}
-> `optional` **dcterms:accrualPeriodicity**: `string`
+> `optional` **dcterms:accrualPeriodicity?**: `string`
 The frequency at which the dataset is published.
@@ -101,13 +113,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
 #### Inherited from
-`Omit.dcterms:accrualPeriodicity`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:accrualPeriodicity`](IDataspaceProtocolDatasetBase.md#dctermsaccrualperiodicity)
 ***
-### dcat:inSeries?
+### dcat:inSeries? {#dcatinseries}
-> `optional` **dcat:inSeries**: `string`
+> `optional` **dcat:inSeries?**: `string`
 A dataset series of which the dataset is part.
@@ -117,13 +129,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
 #### Inherited from
-`Omit.dcat:inSeries`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:inSeries`](IDataspaceProtocolDatasetBase.md#dcatinseries)
 ***
-### dcterms:spatial?
+### dcterms:spatial? {#dctermsspatial}
-> `optional` **dcterms:spatial**: `string` \| `string`[] \| `IJsonLdNodeObject`
+> `optional` **dcterms:spatial?**: `string` \| `string`[] \| `IJsonLdNodeObject`
 The geographical area covered by the dataset.
@@ -133,13 +145,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
 #### Inherited from
-`Omit.dcterms:spatial`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:spatial`](IDataspaceProtocolDatasetBase.md#dctermsspatial)
 ***
-### dcat:spatialResolutionInMeters?
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
-> `optional` **dcat:spatialResolutionInMeters**: `number`
+> `optional` **dcat:spatialResolutionInMeters?**: `number`
 Minimum spatial separation resolvable in a dataset, measured in meters.
@@ -149,13 +161,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
 #### Inherited from
-`Omit.dcat:spatialResolutionInMeters`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:spatialResolutionInMeters`](IDataspaceProtocolDatasetBase.md#dcatspatialresolutioninmeters)
 ***
-### dcterms:temporal?
+### dcterms:temporal? {#dctermstemporal}
-> `optional` **dcterms:temporal**: `IDublinCorePeriodOfTime`
+> `optional` **dcterms:temporal?**: `IDublinCorePeriodOfTime`
 The temporal period that the dataset covers.
@@ -165,13 +177,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
 #### Inherited from
-`Omit.dcterms:temporal`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:temporal`](IDataspaceProtocolDatasetBase.md#dctermstemporal)
 ***
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
-> `optional` **dcat:temporalResolution**: `string`
+> `optional` **dcat:temporalResolution?**: `string`
 Minimum time period resolvable in the dataset.
@@ -181,13 +193,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
 #### Inherited from
-`Omit.dcat:temporalResolution`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:temporalResolution`](IDataspaceProtocolDatasetBase.md#dcattemporalresolution)
 ***
-### prov:wasGeneratedBy?
+### prov:wasGeneratedBy? {#provwasgeneratedby}
-> `optional` **prov:wasGeneratedBy**: `string` \| `IJsonLdNodeObject`
+> `optional` **prov:wasGeneratedBy?**: `string` \| `IJsonLdNodeObject`
 An activity that generated, or provides the business context for, the creation of the dataset.
@@ -197,13 +209,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
 #### Inherited from
-`Omit.prov:wasGeneratedBy`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`prov:wasGeneratedBy`](IDataspaceProtocolDatasetBase.md#provwasgeneratedby)
 ***
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
-> `optional` **dcterms:title**: `DcatLiteralType`
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 A name given to the resource.
@@ -213,13 +225,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
 #### Inherited from
-`Omit.dcterms:title`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:title`](IDataspaceProtocolDatasetBase.md#dctermstitle)
 ***
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
-> `optional` **dcterms:description**: `DcatLiteralType`
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
 A free-text account of the resource.
@@ -229,13 +241,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
 #### Inherited from
-`Omit.dcterms:description`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:description`](IDataspaceProtocolDatasetBase.md#dctermsdescription)
 ***
-### dcterms:identifier?
+### dcterms:identifier? {#dctermsidentifier}
-> `optional` **dcterms:identifier**: `DcatLiteralType`
+> `optional` **dcterms:identifier?**: `ObjectOrArray`\<`string`\>
 A unique identifier of the resource.
@@ -245,13 +257,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
 #### Inherited from
-`Omit.dcterms:identifier`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:identifier`](IDataspaceProtocolDatasetBase.md#dctermsidentifier)
 ***
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 Date of formal issuance (publication) of the resource.
@@ -261,13 +273,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
 #### Inherited from
-`Omit.dcterms:issued`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:issued`](IDataspaceProtocolDatasetBase.md#dctermsissued)
 ***
-### dcterms:modified?
+### dcterms:modified? {#dctermsmodified}
-> `optional` **dcterms:modified**: `string`
+> `optional` **dcterms:modified?**: `string`
 Most recent date on which the resource was changed, updated or modified.
@@ -277,13 +289,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
 #### Inherited from
-`Omit.dcterms:modified`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:modified`](IDataspaceProtocolDatasetBase.md#dctermsmodified)
 ***
-### dcterms:language?
+### dcterms:language? {#dctermslanguage}
-> `optional` **dcterms:language**: `string` \| `string`[]
+> `optional` **dcterms:language?**: `ObjectOrArray`\<`string`\>
 A language of the resource.
@@ -293,13 +305,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
 #### Inherited from
-`Omit.dcterms:language`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:language`](IDataspaceProtocolDatasetBase.md#dctermslanguage)
 ***
-### dcterms:publisher?
+### dcterms:publisher? {#dctermspublisher}
-> `optional` **dcterms:publisher**: `string` \| `IFoafAgentWithAliases`
+> `optional` **dcterms:publisher?**: `string` \| `IFoafAgentWithAliases`
 An entity responsible for making the resource available.
@@ -309,13 +321,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
 #### Inherited from
-`Omit.dcterms:publisher`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:publisher`](IDataspaceProtocolDatasetBase.md#dctermspublisher)
 ***
-### dcterms:creator?
+### dcterms:creator? {#dctermscreator}
-> `optional` **dcterms:creator**: `string` \| `IFoafAgentWithAliases`
+> `optional` **dcterms:creator?**: `string` \| `IFoafAgentWithAliases`
 An entity responsible for producing the resource.
@@ -325,13 +337,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
 #### Inherited from
-`Omit.dcterms:creator`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:creator`](IDataspaceProtocolDatasetBase.md#dctermscreator)
 ***
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
-> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:accessRights?**: `string` \| `IJsonLdNodeObject`
 Information about who can access the resource or an indication of its security status.
@@ -341,13 +353,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
 #### Inherited from
-`Omit.dcterms:accessRights`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:accessRights`](IDataspaceProtocolDatasetBase.md#dctermsaccessrights)
 ***
-### dcterms:license?
+### dcterms:license? {#dctermslicense}
-> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:license?**: `string` \| `IJsonLdNodeObject`
 A legal document under which the resource is made available.
@@ -357,13 +369,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
 #### Inherited from
-`Omit.dcterms:license`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:license`](IDataspaceProtocolDatasetBase.md#dctermslicense)
 ***
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
-> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcterms:rights?**: `string` \| `IJsonLdNodeObject`
 Information about rights held in and over the resource.
@@ -373,13 +385,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
 #### Inherited from
-`Omit.dcterms:rights`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:rights`](IDataspaceProtocolDatasetBase.md#dctermsrights)
 ***
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
-> `optional` **dcterms:conformsTo**: `string` \| `string`[]
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 An established standard to which the resource conforms.
@@ -389,13 +401,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
 #### Inherited from
-`Omit.dcterms:conformsTo`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:conformsTo`](IDataspaceProtocolDatasetBase.md#dctermsconformsto)
 ***
-### dcterms:type?
+### dcterms:type? {#dctermstype}
-> `optional` **dcterms:type**: `string`
+> `optional` **dcterms:type?**: `string`
 The nature or genre of the resource.
@@ -405,13 +417,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
 #### Inherited from
-`Omit.dcterms:type`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcterms:type`](IDataspaceProtocolDatasetBase.md#dctermstype)
 ***
-### dcat:contactPoint?
+### dcat:contactPoint? {#dcatcontactpoint}
-> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcat:contactPoint?**: `string` \| `IJsonLdNodeObject`
 Relevant contact information for the catalogued resource.
@@ -421,13 +433,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
 #### Inherited from
-`Omit.dcat:contactPoint`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:contactPoint`](IDataspaceProtocolDatasetBase.md#dcatcontactpoint)
 ***
-### dcat:keyword?
+### dcat:keyword? {#dcatkeyword}
-> `optional` **dcat:keyword**: `DcatLiteralType`
+> `optional` **dcat:keyword?**: `ObjectOrArray`\<`string`\>
 A keyword or tag describing the resource.
@@ -437,13 +449,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
 #### Inherited from
-`Omit.dcat:keyword`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:keyword`](IDataspaceProtocolDatasetBase.md#dcatkeyword)
 ***
-### dcat:theme?
+### dcat:theme? {#dcattheme}
-> `optional` **dcat:theme**: `string` \| `string`[]
+> `optional` **dcat:theme?**: `ObjectOrArray`\<`string`\>
 A main category of the resource. A resource can have multiple themes.
@@ -453,13 +465,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
 #### Inherited from
-`Omit.dcat:theme`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:theme`](IDataspaceProtocolDatasetBase.md#dcattheme)
 ***
-### dcat:landingPage?
+### dcat:landingPage? {#dcatlandingpage}
-> `optional` **dcat:landingPage**: `string` \| `string`[]
+> `optional` **dcat:landingPage?**: `ObjectOrArray`\<`string`\>
 A Web page that can be navigated to gain access to the resource.
@@ -469,13 +481,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
 #### Inherited from
-`Omit.dcat:landingPage`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:landingPage`](IDataspaceProtocolDatasetBase.md#dcatlandingpage)
 ***
-### dcat:qualifiedRelation?
+### dcat:qualifiedRelation? {#dcatqualifiedrelation}
-> `optional` **dcat:qualifiedRelation**: `string` \| `IDcatRelationship`
+> `optional` **dcat:qualifiedRelation?**: `string` \| `IDcatRelationship`
 Link to a description of a relationship with another resource.
@@ -485,4 +497,4 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
 #### Inherited from
-`Omit.dcat:qualifiedRelation`
+[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md).[`dcat:qualifiedRelation`](IDataspaceProtocolDatasetBase.md#dcatqualifiedrelation)