@twin.org/standards-w3c-dcat 0.0.3-next.9 → 0.9.0

package/docs/reference/interfaces/IDcatCatalogRecordBase.md

@@ -0,0 +1,101 @@
+# Interface: IDcatCatalogRecordBase
+
+Base interface for DCAT Catalog Record without JSON-LD context.
+This is the context-free variant of IDcatCatalogRecord, intended for embedding
+catalog record objects inline within catalogs where the context is provided by the enclosing document.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog_Record
+
+## Extended by
+
+- [`IDcatCatalogRecord`](IDcatCatalogRecord.md)
+
+## Properties
+
+### @type {#type}
+
+> **@type**: `"dcat:CatalogRecord"`
+
+The type identifier, typically "CatalogRecord".
+
+***
+
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+The unique identifier for the catalog record.
+
+***
+
+### dcterms:title? {#dctermstitle}
+
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
+
+A name given to the catalog record.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_title
+
+***
+
+### dcterms:description? {#dctermsdescription}
+
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
+
+A free-text account of the catalog record.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_description
+
+***
+
+### dcterms:issued? {#dctermsissued}
+
+> `optional` **dcterms:issued?**: `string`
+
+The date of listing of the catalog record in the catalog.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_listing_date
+
+***
+
+### dcterms:modified? {#dctermsmodified}
+
+> `optional` **dcterms:modified?**: `string`
+
+Most recent date on which the catalog record entry was changed or modified.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_update_date
+
+***
+
+### dcterms:conformsTo? {#dctermsconformsto}
+
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
+
+An established standard to which the catalog record conforms.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_conforms_to
+
+***
+
+### foaf:primaryTopic? {#foafprimarytopic}
+
+> `optional` **foaf:primaryTopic?**: [`IDcatResource`](IDcatResource.md)
+
+The dataset or data service described in the catalog record.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:record_primary_topic

package/docs/reference/interfaces/IDcatDataService.md

@@ -10,29 +10,33 @@ https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service
 
 ## Extends
 
-- [`IDcatResource`](IDcatResource.md)
+- [`IDcatDataServiceBase`](IDcatDataServiceBase.md)
 
-## Indexable
+## Properties
 
-\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
+### @context {#context}
 
-## Properties
+> **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+
+The JSON-LD context for the resource.
 
-### @type
+***
+
+### @type {#type}
 
 > **@type**: `"dcat:DataService"`
 
 The type identifier, typically "DataService".
 
-#### Overrides
+#### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`@type`](IDcatResource.md#type)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`@type`](IDcatDataServiceBase.md#type)
 
 ***
 
-### dcat:endpointURL?
+### dcat:endpointURL? {#dcatendpointurl}
 
-> `optional` **dcat:endpointURL**: `string`
+> `optional` **dcat:endpointURL?**: `string`
 
 The root location or primary endpoint of the service (a Web-resolvable IRI).
 
@@ -40,11 +44,15 @@ The root location or primary endpoint of the service (a Web-resolvable IRI).
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_url
 
+#### Inherited from
+
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:endpointURL`](IDcatDataServiceBase.md#dcatendpointurl)
+
 ***
 
-### dcat:endpointDescription?
+### dcat:endpointDescription? {#dcatendpointdescription}
 
-> `optional` **dcat:endpointDescription**: `string`
+> `optional` **dcat:endpointDescription?**: `string`
 
 A description of the services available via the end-points, including their
 operations, parameters, etc.
@@ -53,11 +61,15 @@ operations, parameters, etc.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_description
 
+#### Inherited from
+
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:endpointDescription`](IDcatDataServiceBase.md#dcatendpointdescription)
+
 ***
 
-### dcat:servesDataset?
+### dcat:servesDataset? {#dcatservesdataset}
 
-> `optional` **dcat:servesDataset**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:servesDataset?**: `ObjectOrArray`\<`string`\>
 
 A collection of data that this data service can distribute.
 
@@ -65,23 +77,27 @@ A collection of data that this data service can distribute.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_serves_dataset
 
+#### Inherited from
+
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:servesDataset`](IDcatDataServiceBase.md#dcatservesdataset)
+
 ***
 
-### @context
+### @id? {#id}
 
-> **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+> `optional` **@id?**: `string`
 
-The JSON-LD context for the resource.
+The unique identifier for the resource.
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`@context`](IDcatResource.md#context)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`@id`](IDcatDataServiceBase.md#id)
 
 ***
 
-### dcterms:title?
+### dcterms:title? {#dctermstitle}
 
-> `optional` **dcterms:title**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 
 A name given to the resource.
 
@@ -91,13 +107,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:title`](IDcatResource.md#dctermstitle)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:title`](IDcatDataServiceBase.md#dctermstitle)
 
 ***
 
-### dcterms:description?
+### dcterms:description? {#dctermsdescription}
 
-> `optional` **dcterms:description**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
 
 A free-text account of the resource.
 
@@ -107,13 +123,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:description`](IDcatResource.md#dctermsdescription)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:description`](IDcatDataServiceBase.md#dctermsdescription)
 
 ***
 
-### dcterms:identifier?
+### dcterms:identifier? {#dctermsidentifier}
 
-> `optional` **dcterms:identifier**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcterms:identifier?**: `ObjectOrArray`\<`string`\>
 
 A unique identifier of the resource.
 
@@ -123,13 +139,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:identifier`](IDcatResource.md#dctermsidentifier)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:identifier`](IDcatDataServiceBase.md#dctermsidentifier)
 
 ***
 
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
 
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 
 Date of formal issuance (publication) of the resource.
 
@@ -139,13 +155,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:issued`](IDcatResource.md#dctermsissued)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:issued`](IDcatDataServiceBase.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.
 
@@ -155,13 +171,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:modified`](IDcatResource.md#dctermsmodified)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:modified`](IDcatDataServiceBase.md#dctermsmodified)
 
 ***
 
-### dcterms:language?
+### dcterms:language? {#dctermslanguage}
 
-> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:language?**: `ObjectOrArray`\<`string`\>
 
 A language of the resource.
 
@@ -171,13 +187,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:language`](IDcatResource.md#dctermslanguage)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:language`](IDcatDataServiceBase.md#dctermslanguage)
 
 ***
 
-### dcterms:publisher?
+### dcterms:publisher? {#dctermspublisher}
 
-> `optional` **dcterms:publisher**: `string` \| `IFoafAgent`
+> `optional` **dcterms:publisher?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for making the resource available.
 
@@ -187,13 +203,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:publisher`](IDcatResource.md#dctermspublisher)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:publisher`](IDcatDataServiceBase.md#dctermspublisher)
 
 ***
 
-### dcterms:creator?
+### dcterms:creator? {#dctermscreator}
 
-> `optional` **dcterms:creator**: `IFoafAgent`
+> `optional` **dcterms:creator?**: `string` \| `JsonLdObjectWithAliases`\<`IFoafAgent`, `"foaf"`\>
 
 An entity responsible for producing the resource.
 
@@ -203,13 +219,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:creator`](IDcatResource.md#dctermscreator)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:creator`](IDcatDataServiceBase.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.
 
@@ -219,13 +235,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:accessRights`](IDcatResource.md#dctermsaccessrights)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:accessRights`](IDcatDataServiceBase.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.
 
@@ -235,13 +251,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:license`](IDcatResource.md#dctermslicense)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:license`](IDcatDataServiceBase.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.
 
@@ -251,13 +267,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:rights`](IDcatResource.md#dctermsrights)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:rights`](IDcatDataServiceBase.md#dctermsrights)
 
 ***
 
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
 
-> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 
 An established standard to which the resource conforms.
 
@@ -267,13 +283,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:conformsTo`](IDcatResource.md#dctermsconformsto)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:conformsTo`](IDcatDataServiceBase.md#dctermsconformsto)
 
 ***
 
-### dcterms:type?
+### dcterms:type? {#dctermstype}
 
-> `optional` **dcterms:type**: `string`
+> `optional` **dcterms:type?**: `string`
 
 The nature or genre of the resource.
 
@@ -283,13 +299,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcterms:type`](IDcatResource.md#dctermstype)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcterms:type`](IDcatDataServiceBase.md#dctermstype)
 
 ***
 
-### dcat:contactPoint?
+### dcat:contactPoint? {#dcatcontactpoint}
 
-> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+> `optional` **dcat:contactPoint?**: `string` \| `IJsonLdNodeObject`
 
 Relevant contact information for the catalogued resource.
 
@@ -299,13 +315,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:contactPoint`](IDcatResource.md#dcatcontactpoint)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:contactPoint`](IDcatDataServiceBase.md#dcatcontactpoint)
 
 ***
 
-### dcat:keyword?
+### dcat:keyword? {#dcatkeyword}
 
-> `optional` **dcat:keyword**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+> `optional` **dcat:keyword?**: `ObjectOrArray`\<`string`\>
 
 A keyword or tag describing the resource.
 
@@ -315,13 +331,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:keyword`](IDcatResource.md#dcatkeyword)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:keyword`](IDcatDataServiceBase.md#dcatkeyword)
 
 ***
 
-### dcat:theme?
+### dcat:theme? {#dcattheme}
 
-> `optional` **dcat:theme**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:theme?**: `ObjectOrArray`\<`string`\>
 
 A main category of the resource. A resource can have multiple themes.
 
@@ -331,13 +347,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:theme`](IDcatResource.md#dcattheme)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:theme`](IDcatDataServiceBase.md#dcattheme)
 
 ***
 
-### dcat:landingPage?
+### dcat:landingPage? {#dcatlandingpage}
 
-> `optional` **dcat:landingPage**: `ObjectOrArray`\<`string`\>
+> `optional` **dcat:landingPage?**: `ObjectOrArray`\<`string`\>
 
 A Web page that can be navigated to gain access to the resource.
 
@@ -347,13 +363,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:landingPage`](IDcatResource.md#dcatlandingpage)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:landingPage`](IDcatDataServiceBase.md#dcatlandingpage)
 
 ***
 
-### dcat:qualifiedRelation?
+### dcat:qualifiedRelation? {#dcatqualifiedrelation}
 
-> `optional` **dcat:qualifiedRelation**: `string` \| [`IDcatRelationship`](IDcatRelationship.md)
+> `optional` **dcat:qualifiedRelation?**: `string` \| [`IDcatRelationship`](IDcatRelationship.md)
 
 Link to a description of a relationship with another resource.
 
@@ -363,13 +379,13 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`dcat:qualifiedRelation`](IDcatResource.md#dcatqualifiedrelation)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`dcat:qualifiedRelation`](IDcatDataServiceBase.md#dcatqualifiedrelation)
 
 ***
 
-### odrl:hasPolicy?
+### odrl:hasPolicy? {#odrlhaspolicy}
 
-> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+> `optional` **odrl:hasPolicy?**: `JsonLdObjectWithOptionalContext`\<`IOdrlPolicy`\>
 
 An ODRL conformant policy expressing the rights associated with the resource.
 
@@ -379,4 +395,4 @@ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy
 
 #### Inherited from
 
-[`IDcatResource`](IDcatResource.md).[`odrl:hasPolicy`](IDcatResource.md#odrlhaspolicy)
+[`IDcatDataServiceBase`](IDcatDataServiceBase.md).[`odrl:hasPolicy`](IDcatDataServiceBase.md#odrlhaspolicy)