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

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

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

@@ -21,11 +21,11 @@ by overriding properties with more specific types and constraints.
 ## Extends
-- `Omit`\<`IDcatCatalog`, `"@type"` \| `"@context"` \| `"dcat:catalog"` \| `"dcat:dataset"` \| `"dcat:distribution"` \| `"dcat:service"`\>
+- [`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md)
 ## Properties
-### @context
+### @context {#context}
 > **@context**: [`DataspaceProtocolContextType`](../type-aliases/DataspaceProtocolContextType.md)
@@ -33,69 +33,93 @@ LD Context. Required per Eclipse Data Space Protocol.
 ***
-### @type
+### @type {#type}
 > **@type**: `"Catalog"`
 The type identifier for the Catalog.
 REQUIRED per Eclipse Data Space Protocol.
+#### Inherited from
+`IDataspaceProtocolCatalog`.[`@type`](#type)
 ***
-### @id
+### @id {#id}
 > **@id**: `string`
 Unique identifier for the dataset.
 REQUIRED per Eclipse Data Space Protocol.
-#### Overrides
+#### Inherited from
-`Omit.@id`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`@id`](IDataspaceProtocolCatalogBase.md#id)
 ***
-### participantId
+### participantId {#participantid}
 > **participantId**: `string`
 Participant Id
+#### Inherited from
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`participantId`](IDataspaceProtocolCatalogBase.md#participantid)
 ***
-### catalog?
+### catalog? {#catalog}
-> `optional` **catalog**: [`IDataspaceProtocolCatalogNoContext`](../type-aliases/IDataspaceProtocolCatalogNoContext.md) \| [`IDataspaceProtocolCatalogNoContext`](../type-aliases/IDataspaceProtocolCatalogNoContext.md)[]
+> `optional` **catalog**: `ObjectOrArray`\<[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md)\>
 Other concerned catalogs
+#### Inherited from
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`catalog`](IDataspaceProtocolCatalogBase.md#catalog)
 ***
-### dataset?
+### dataset? {#dataset}
-> `optional` **dataset**: [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md) \| [`IDataspaceProtocolDatasetNoContext`](../type-aliases/IDataspaceProtocolDatasetNoContext.md)[]
+> `optional` **dataset**: `ObjectOrArray`\<[`IDataspaceProtocolDatasetBase`](IDataspaceProtocolDatasetBase.md)\>
 Datasets registered
+#### Inherited from
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dataset`](IDataspaceProtocolCatalogBase.md#dataset)
 ***
-### distribution?
+### distribution? {#distribution}
-> `optional` **distribution**: [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md) \| [`IDataspaceProtocolDistributionNoContext`](../type-aliases/IDataspaceProtocolDistributionNoContext.md)[]
+> `optional` **distribution**: `ObjectOrArray`\<[`IDataspaceProtocolDistributionBase`](IDataspaceProtocolDistributionBase.md)\>
 Catalog's distributions
+#### Inherited from
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`distribution`](IDataspaceProtocolCatalogBase.md#distribution)
 ***
-### service?
+### service? {#service}
-> `optional` **service**: [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md) \| [`IDataspaceProtocolDataServiceNoContext`](../type-aliases/IDataspaceProtocolDataServiceNoContext.md)[]
+> `optional` **service**: `ObjectOrArray`\<[`IDataspaceProtocolDataServiceBase`](IDataspaceProtocolDataServiceBase.md)\>
 Data services registered-
+#### Inherited from
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`service`](IDataspaceProtocolCatalogBase.md#service)
 ***
-### foaf:homepage?
+### foaf:homepage? {#foafhomepage}
 > `optional` **foaf:homepage**: `string`
@@ -107,13 +131,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_homepage
 #### Inherited from
-`Omit.foaf:homepage`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`foaf:homepage`](IDataspaceProtocolCatalogBase.md#foafhomepage)
 ***
-### dcat:themeTaxonomy?
+### dcat:themeTaxonomy? {#dcatthemetaxonomy}
-> `optional` **dcat:themeTaxonomy**: `IDcatResource` \| `IDcatResource`[]
+> `optional` **dcat:themeTaxonomy**: `ObjectOrArray`\<`IDcatResource`\>
 A knowledge organization system (KOS) used to classify the resources in the catalog.
@@ -123,13 +147,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_themes
 #### Inherited from
-`Omit.dcat:themeTaxonomy`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:themeTaxonomy`](IDataspaceProtocolCatalogBase.md#dcatthemetaxonomy)
 ***
-### dcat:resource?
+### dcat:resource? {#dcatresource}
-> `optional` **dcat:resource**: `IDcatResource` \| `IDcatResource`[]
+> `optional` **dcat:resource**: `ObjectOrArray`\<`IDcatResource`\>
 A resource that is listed in the catalog.
@@ -139,13 +163,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_resource
 #### Inherited from
-`Omit.dcat:resource`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:resource`](IDataspaceProtocolCatalogBase.md#dcatresource)
 ***
-### dcat:record?
+### dcat:record? {#dcatrecord}
-> `optional` **dcat:record**: `CatalogRecordOptionalContext` \| `CatalogRecordOptionalContext`[]
+> `optional` **dcat:record**: `ObjectOrArray`\<`IDcatCatalogRecordBase`\>
 A record describing the registration of a single resource in the catalog.
@@ -155,11 +179,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:catalog_catalog_record
 #### Inherited from
-`Omit.dcat:record`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:record`](IDataspaceProtocolCatalogBase.md#dcatrecord)
 ***
-### dcterms:accrualPeriodicity?
+### dcterms:accrualPeriodicity? {#dctermsaccrualperiodicity}
 > `optional` **dcterms:accrualPeriodicity**: `string`
@@ -171,11 +195,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
 #### Inherited from
-`Omit.dcterms:accrualPeriodicity`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:accrualPeriodicity`](IDataspaceProtocolCatalogBase.md#dctermsaccrualperiodicity)
 ***
-### dcat:inSeries?
+### dcat:inSeries? {#dcatinseries}
 > `optional` **dcat:inSeries**: `string`
@@ -187,11 +211,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
 #### Inherited from
-`Omit.dcat:inSeries`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:inSeries`](IDataspaceProtocolCatalogBase.md#dcatinseries)
 ***
-### dcterms:spatial?
+### dcterms:spatial? {#dctermsspatial}
 > `optional` **dcterms:spatial**: `string` \| `string`[] \| `IJsonLdNodeObject`
@@ -203,11 +227,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
 #### Inherited from
-`Omit.dcterms:spatial`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:spatial`](IDataspaceProtocolCatalogBase.md#dctermsspatial)
 ***
-### dcat:spatialResolutionInMeters?
+### dcat:spatialResolutionInMeters? {#dcatspatialresolutioninmeters}
 > `optional` **dcat:spatialResolutionInMeters**: `number`
@@ -219,11 +243,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
 #### Inherited from
-`Omit.dcat:spatialResolutionInMeters`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:spatialResolutionInMeters`](IDataspaceProtocolCatalogBase.md#dcatspatialresolutioninmeters)
 ***
-### dcterms:temporal?
+### dcterms:temporal? {#dctermstemporal}
 > `optional` **dcterms:temporal**: `IDublinCorePeriodOfTime`
@@ -235,11 +259,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
 #### Inherited from
-`Omit.dcterms:temporal`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:temporal`](IDataspaceProtocolCatalogBase.md#dctermstemporal)
 ***
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
 > `optional` **dcat:temporalResolution**: `string`
@@ -251,11 +275,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
 #### Inherited from
-`Omit.dcat:temporalResolution`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:temporalResolution`](IDataspaceProtocolCatalogBase.md#dcattemporalresolution)
 ***
-### prov:wasGeneratedBy?
+### prov:wasGeneratedBy? {#provwasgeneratedby}
 > `optional` **prov:wasGeneratedBy**: `string` \| `IJsonLdNodeObject`
@@ -267,13 +291,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
 #### Inherited from
-`Omit.prov:wasGeneratedBy`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`prov:wasGeneratedBy`](IDataspaceProtocolCatalogBase.md#provwasgeneratedby)
 ***
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
-> `optional` **dcterms:title**: `DcatLiteralType`
+> `optional` **dcterms:title**: `ObjectOrArray`\<`string`\>
 A name given to the resource.
@@ -283,13 +307,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
 #### Inherited from
-`Omit.dcterms:title`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:title`](IDataspaceProtocolCatalogBase.md#dctermstitle)
 ***
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
-> `optional` **dcterms:description**: `DcatLiteralType`
+> `optional` **dcterms:description**: `ObjectOrArray`\<`string`\>
 A free-text account of the resource.
@@ -299,13 +323,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
 #### Inherited from
-`Omit.dcterms:description`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:description`](IDataspaceProtocolCatalogBase.md#dctermsdescription)
 ***
-### dcterms:identifier?
+### dcterms:identifier? {#dctermsidentifier}
-> `optional` **dcterms:identifier**: `DcatLiteralType`
+> `optional` **dcterms:identifier**: `ObjectOrArray`\<`string`\>
 A unique identifier of the resource.
@@ -315,11 +339,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
 #### Inherited from
-`Omit.dcterms:identifier`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:identifier`](IDataspaceProtocolCatalogBase.md#dctermsidentifier)
 ***
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
 > `optional` **dcterms:issued**: `string`
@@ -331,11 +355,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
 #### Inherited from
-`Omit.dcterms:issued`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:issued`](IDataspaceProtocolCatalogBase.md#dctermsissued)
 ***
-### dcterms:modified?
+### dcterms:modified? {#dctermsmodified}
 > `optional` **dcterms:modified**: `string`
@@ -347,13 +371,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
 #### Inherited from
-`Omit.dcterms:modified`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:modified`](IDataspaceProtocolCatalogBase.md#dctermsmodified)
 ***
-### dcterms:language?
+### dcterms:language? {#dctermslanguage}
-> `optional` **dcterms:language**: `string` \| `string`[]
+> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
 A language of the resource.
@@ -363,11 +387,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
 #### Inherited from
-`Omit.dcterms:language`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:language`](IDataspaceProtocolCatalogBase.md#dctermslanguage)
 ***
-### dcterms:publisher?
+### dcterms:publisher? {#dctermspublisher}
 > `optional` **dcterms:publisher**: `string` \| `IFoafAgentWithAliases`
@@ -379,11 +403,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
 #### Inherited from
-`Omit.dcterms:publisher`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:publisher`](IDataspaceProtocolCatalogBase.md#dctermspublisher)
 ***
-### dcterms:creator?
+### dcterms:creator? {#dctermscreator}
 > `optional` **dcterms:creator**: `string` \| `IFoafAgentWithAliases`
@@ -395,11 +419,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
 #### Inherited from
-`Omit.dcterms:creator`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:creator`](IDataspaceProtocolCatalogBase.md#dctermscreator)
 ***
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
 > `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
@@ -411,11 +435,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
 #### Inherited from
-`Omit.dcterms:accessRights`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:accessRights`](IDataspaceProtocolCatalogBase.md#dctermsaccessrights)
 ***
-### dcterms:license?
+### dcterms:license? {#dctermslicense}
 > `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
@@ -427,11 +451,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
 #### Inherited from
-`Omit.dcterms:license`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:license`](IDataspaceProtocolCatalogBase.md#dctermslicense)
 ***
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
 > `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
@@ -443,13 +467,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
 #### Inherited from
-`Omit.dcterms:rights`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:rights`](IDataspaceProtocolCatalogBase.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.
@@ -459,11 +483,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
 #### Inherited from
-`Omit.dcterms:conformsTo`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:conformsTo`](IDataspaceProtocolCatalogBase.md#dctermsconformsto)
 ***
-### dcterms:type?
+### dcterms:type? {#dctermstype}
 > `optional` **dcterms:type**: `string`
@@ -475,11 +499,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
 #### Inherited from
-`Omit.dcterms:type`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcterms:type`](IDataspaceProtocolCatalogBase.md#dctermstype)
 ***
-### dcat:contactPoint?
+### dcat:contactPoint? {#dcatcontactpoint}
 > `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
@@ -491,13 +515,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
 #### Inherited from
-`Omit.dcat:contactPoint`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:contactPoint`](IDataspaceProtocolCatalogBase.md#dcatcontactpoint)
 ***
-### dcat:keyword?
+### dcat:keyword? {#dcatkeyword}
-> `optional` **dcat:keyword**: `DcatLiteralType`
+> `optional` **dcat:keyword**: `ObjectOrArray`\<`string`\>
 A keyword or tag describing the resource.
@@ -507,13 +531,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
 #### Inherited from
-`Omit.dcat:keyword`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:keyword`](IDataspaceProtocolCatalogBase.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.
@@ -523,13 +547,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
 #### Inherited from
-`Omit.dcat:theme`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:theme`](IDataspaceProtocolCatalogBase.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.
@@ -539,11 +563,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
 #### Inherited from
-`Omit.dcat:landingPage`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:landingPage`](IDataspaceProtocolCatalogBase.md#dcatlandingpage)
 ***
-### dcat:qualifiedRelation?
+### dcat:qualifiedRelation? {#dcatqualifiedrelation}
 > `optional` **dcat:qualifiedRelation**: `string` \| `IDcatRelationship`
@@ -555,11 +579,11 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
 #### Inherited from
-`Omit.dcat:qualifiedRelation`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`dcat:qualifiedRelation`](IDataspaceProtocolCatalogBase.md#dcatqualifiedrelation)
 ***
-### odrl:hasPolicy?
+### odrl:hasPolicy? {#odrlhaspolicy}
 > `optional` **odrl:hasPolicy**: `IOdrlPolicy`
@@ -571,4 +595,4 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy
 #### Inherited from
-`Omit.odrl:hasPolicy`
+[`IDataspaceProtocolCatalogBase`](IDataspaceProtocolCatalogBase.md).[`odrl:hasPolicy`](IDataspaceProtocolCatalogBase.md#odrlhaspolicy)