@twin.org/standards-w3c-dcat 0.0.3-next.3

package/docs/reference/interfaces/IDistribution.md

@@ -0,0 +1,281 @@
+# Interface: IDistribution
+
+Interface for DCAT Distribution.
+A specific representation of a dataset. A dataset might be available in multiple
+serializations that may differ in various ways.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`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`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+
+The JSON-LD context for the resource.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### @type
+
+> **@type**: `"Distribution"`
+
+The type identifier, typically "Distribution".
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### dcterms:title?
+
+> `optional` **dcterms:title**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A name given to the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
+
+***
+
+### dcterms:description?
+
+> `optional` **dcterms:description**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A free-text account of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
+
+***
+
+### dcterms:issued?
+
+> `optional` **dcterms:issued**: `string`
+
+Date of formal issuance of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
+
+***
+
+### dcterms:modified?
+
+> `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
+
+***
+
+### dcterms:license?
+
+> `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
+
+***
+
+### dcterms:accessRights?
+
+> `optional` **dcterms:accessRights**: `string`
+
+Information about who can access the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
+
+***
+
+### dcterms:rights?
+
+> `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
+
+***
+
+### dcat:accessURL?
+
+> `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
+
+***
+
+### dcat:accessService?
+
+> `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
+
+***
+
+### dcat:downloadURL?
+
+> `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
+
+***
+
+### dcat:byteSize?
+
+> `optional` **dcat:byteSize**: `number`
+
+The size of the distribution in bytes.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
+
+***
+
+### dcat:spatialResolutionInMeters?
+
+> `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
+
+***
+
+### dcat:temporalResolution?
+
+> `optional` **dcat:temporalResolution**: `string`
+
+Minimum time period resolvable in the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
+
+***
+
+### dcterms:conformsTo?
+
+> `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
+
+***
+
+### dcat:mediaType?
+
+> `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
+
+***
+
+### dcterms:format?
+
+> `optional` **dcterms:format**: `string`
+
+The file format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
+
+***
+
+### dcat:compressFormat?
+
+> `optional` **dcat:compressFormat**: `string`
+
+The compression format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
+
+***
+
+### dcat:packageFormat?
+
+> `optional` **dcat:packageFormat**: `string`
+
+The package format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
+
+***
+
+### spdx:checksum?
+
+> `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
+
+***
+
+### odrl:hasPolicy?
+
+> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+
+An ODRL conformant policy expressing the rights associated with the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_has_policy

package/docs/reference/interfaces/IRelationship.md

@@ -0,0 +1,65 @@
+# Interface: IRelationship
+
+Interface for DCAT Relationship.
+An association class for attaching additional information to a relationship
+between DCAT Resources.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Relationship
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`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`
+
+## Properties
+
+### @context
+
+> **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+
+The JSON-LD context for the resource.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### @type
+
+> **@type**: `"Relationship"`
+
+The type identifier, typically "Relationship".
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### dcterms:relation?
+
+> `optional` **dcterms:relation**: `string`
+
+The link to a related resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_relation
+
+***
+
+### dcat:hadRole?
+
+> `optional` **dcat:hadRole**: [`IRole`](IRole.md)
+
+The function of an entity or agent with respect to another resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_hadRole

package/docs/reference/interfaces/IResource.md

@@ -0,0 +1,274 @@
+# Interface: IResource
+
+Base interface for DCAT catalogued resources.
+This is the parent class of dcat:Dataset, dcat:DataService, and dcat:Catalog.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Resource
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Extended by
+
+- [`IDataService`](IDataService.md)
+- [`IDataset`](IDataset.md)
+
+## Indexable
+
+\[`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`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+
+The JSON-LD context for the resource.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### @type
+
+> **@type**: `"Catalog"` \| `"Resource"` \| `"Dataset"` \| `"DataService"` \| `"DatasetSeries"`
+
+The type of the resource.
+Typically "Catalog", "Dataset", "DataService", "DatasetSeries", or the base "Resource".
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### dcterms:title?
+
+> `optional` **dcterms:title**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A name given to the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
+
+***
+
+### dcterms:description?
+
+> `optional` **dcterms:description**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A free-text account of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
+
+***
+
+### dcterms:identifier?
+
+> `optional` **dcterms:identifier**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A unique identifier of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
+
+***
+
+### dcterms:issued?
+
+> `optional` **dcterms:issued**: `string`
+
+Date of formal issuance (publication) of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
+
+***
+
+### dcterms:modified?
+
+> `optional` **dcterms:modified**: `string`
+
+Most recent date on which the resource was changed, updated or modified.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
+
+***
+
+### dcterms:language?
+
+> `optional` **dcterms:language**: `ObjectOrArray`\<`string`\>
+
+A language of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
+
+***
+
+### dcterms:publisher?
+
+> `optional` **dcterms:publisher**: `string` \| `IAgent`
+
+An entity responsible for making the resource available.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
+
+***
+
+### dcterms:creator?
+
+> `optional` **dcterms:creator**: `IAgent`
+
+An entity responsible for producing the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
+
+***
+
+### dcterms:accessRights?
+
+> `optional` **dcterms:accessRights**: `string` \| `IJsonLdNodeObject`
+
+Information about who can access the resource or an indication of its security status.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
+
+***
+
+### dcterms:license?
+
+> `optional` **dcterms:license**: `string` \| `IJsonLdNodeObject`
+
+A legal document under which the resource is made available.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
+
+***
+
+### dcterms:rights?
+
+> `optional` **dcterms:rights**: `string` \| `IJsonLdNodeObject`
+
+Information about rights held in and over the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
+
+***
+
+### dcterms:conformsTo?
+
+> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
+
+An established standard to which the resource conforms.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
+
+***
+
+### dcterms:type?
+
+> `optional` **dcterms:type**: `string`
+
+The nature or genre of the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
+
+***
+
+### dcat:contactPoint?
+
+> `optional` **dcat:contactPoint**: `string` \| `IJsonLdNodeObject`
+
+Relevant contact information for the catalogued resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
+
+***
+
+### dcat:keyword?
+
+> `optional` **dcat:keyword**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A keyword or tag describing the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
+
+***
+
+### dcat:theme?
+
+> `optional` **dcat:theme**: `ObjectOrArray`\<`string`\>
+
+A main category of the resource. A resource can have multiple themes.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
+
+***
+
+### dcat:landingPage?
+
+> `optional` **dcat:landingPage**: `ObjectOrArray`\<`string`\>
+
+A Web page that can be navigated to gain access to the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
+
+***
+
+### dcat:qualifiedRelation?
+
+> `optional` **dcat:qualifiedRelation**: `string` \| [`IRelationship`](IRelationship.md)
+
+Link to a description of a relationship with another resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
+
+***
+
+### odrl:hasPolicy?
+
+> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+
+An ODRL conformant policy expressing the rights associated with the resource.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy

package/docs/reference/interfaces/IRole.md

@@ -0,0 +1,53 @@
+# Interface: IRole
+
+Interface for DCAT Role.
+A role is the function of a resource or agent with respect to another resource,
+in the context of resource attribution or resource relationships.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Role
+
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`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`
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
+
+The JSON-LD context for the resource.
+
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
+***
+
+### @type
+
+> **@type**: `"Role"`
+
+The type identifier, typically "Role".
+
+#### Overrides
+
+`IJsonLdNodeObject.@type`
+
+***
+
+### dcterms:title?
+
+> `optional` **dcterms:title**: [`LiteralType`](../type-aliases/LiteralType.md)
+
+A name given to the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title

package/docs/reference/type-aliases/DateTimeType.md

@@ -0,0 +1,6 @@
+# Type Alias: DateTimeType
+
+> **DateTimeType** = `string`
+
+Date/time values in ISO 8601 format.
+Can be xsd:date, xsd:dateTime, or xsd:gYear.

package/docs/reference/type-aliases/DcatClasses.md

@@ -0,0 +1,5 @@
+# Type Alias: DcatClasses
+
+> **DcatClasses** = *typeof* [`DcatClasses`](../variables/DcatClasses.md)\[keyof *typeof* [`DcatClasses`](../variables/DcatClasses.md)\]
+
+The classes for DCAT.

package/docs/reference/type-aliases/DcatContextType.md

@@ -0,0 +1,16 @@
+# Type Alias: DcatContextType
+
+> **DcatContextType** = `object` & `IJsonLdContextDefinition`
+
+The DCAT JSON-LD context type.
+Supports the DCAT context URL or arrays with additional context definitions.
+
+## Type Declaration
+
+### dcat
+
+> **dcat**: *typeof* [`ContextRoot`](../variables/DcatContexts.md#contextroot)
+
+### dcterms
+
+> **dcterms**: *typeof* `DublinCoreContexts.ContextTerms`

package/docs/reference/type-aliases/DcatContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: DcatContexts
+
+> **DcatContexts** = *typeof* [`DcatContexts`](../variables/DcatContexts.md)\[keyof *typeof* [`DcatContexts`](../variables/DcatContexts.md)\]
+
+The contexts for DCAT.

package/docs/reference/type-aliases/DcatRelationshipType.md

@@ -0,0 +1,5 @@
+# Type Alias: DcatRelationshipType
+
+> **DcatRelationshipType** = *typeof* [`DcatRelationshipType`](../variables/DcatRelationshipType.md)\[keyof *typeof* [`DcatRelationshipType`](../variables/DcatRelationshipType.md)\]
+
+The relationship types for DCAT.