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

package/docs/reference/interfaces/IDcatDistribution.md

@@ -10,41 +10,45 @@ 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`
+- [`IDcatDistributionBase`](IDcatDistributionBase.md)
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
 
 The JSON-LD context for the resource.
 
-#### Overrides
-
-`IJsonLdNodeObject.@context`
-
 ***
 
-### @type
+### @type {#type}
 
 > **@type**: `"dcat:Distribution"`
 
 The type identifier, typically "Distribution".
 
-#### Overrides
+#### Inherited from
 
-`IJsonLdNodeObject.@type`
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`@type`](IDcatDistributionBase.md#type)
 
 ***
 
-### dcterms:title?
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+The unique identifier for the distribution object.
+
+#### Inherited from
 
-> `optional` **dcterms:title**: [`DcatLiteralType`](../type-aliases/DcatLiteralType.md)
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`@id`](IDcatDistributionBase.md#id)
+
+***
+
+### dcterms:title? {#dctermstitle}
+
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
 
 A name given to the distribution.
 
@@ -52,11 +56,15 @@ A name given to the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:title`](IDcatDistributionBase.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 distribution.
 
@@ -64,11 +72,15 @@ A free-text account of the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:description`](IDcatDistributionBase.md#dctermsdescription)
+
 ***
 
-### dcterms:issued?
+### dcterms:issued? {#dctermsissued}
 
-> `optional` **dcterms:issued**: `string`
+> `optional` **dcterms:issued?**: `string`
 
 Date of formal issuance of the distribution.
 
@@ -76,11 +88,15 @@ Date of formal issuance of the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:issued`](IDcatDistributionBase.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.
 
@@ -88,11 +104,15 @@ Most recent date on which the distribution was changed, updated or modified.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:modified`](IDcatDistributionBase.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.
 
@@ -100,11 +120,15 @@ A legal document under which the distribution is made available.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:license`](IDcatDistributionBase.md#dctermslicense)
+
 ***
 
-### dcterms:accessRights?
+### dcterms:accessRights? {#dctermsaccessrights}
 
-> `optional` **dcterms:accessRights**: `string`
+> `optional` **dcterms:accessRights?**: `string`
 
 Information about who can access the distribution.
 
@@ -112,11 +136,15 @@ Information about who can access the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:accessRights`](IDcatDistributionBase.md#dctermsaccessrights)
+
 ***
 
-### dcterms:rights?
+### dcterms:rights? {#dctermsrights}
 
-> `optional` **dcterms:rights**: `string`
+> `optional` **dcterms:rights?**: `string`
 
 Information about rights held in and over the distribution.
 
@@ -124,11 +152,15 @@ Information about rights held in and over the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:rights`](IDcatDistributionBase.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.
 
@@ -136,11 +168,15 @@ A URL of the resource that gives access to a distribution of the dataset.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:accessURL`](IDcatDistributionBase.md#dcataccessurl)
+
 ***
 
-### dcat:accessService?
+### dcat:accessService? {#dcataccessservice}
 
-> `optional` **dcat:accessService**: `string`
+> `optional` **dcat:accessService?**: `string`
 
 A data service that gives access to the distribution.
 
@@ -148,11 +184,15 @@ A data service that gives access to the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:accessService`](IDcatDistributionBase.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.
 
@@ -160,11 +200,15 @@ The URL of the downloadable file in a given format.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:downloadURL`](IDcatDistributionBase.md#dcatdownloadurl)
+
 ***
 
-### dcat:byteSize?
+### dcat:byteSize? {#dcatbytesize}
 
-> `optional` **dcat:byteSize**: `number`
+> `optional` **dcat:byteSize?**: `number`
 
 The size of the distribution in bytes.
 
@@ -172,11 +216,15 @@ The size of the distribution in bytes.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:byteSize`](IDcatDistributionBase.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.
 
@@ -184,11 +232,15 @@ The minimum spatial separation resolvable in a distribution, measured in meters.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:spatialResolutionInMeters`](IDcatDistributionBase.md#dcatspatialresolutioninmeters)
+
 ***
 
-### dcat:temporalResolution?
+### dcat:temporalResolution? {#dcattemporalresolution}
 
-> `optional` **dcat:temporalResolution**: `string`
+> `optional` **dcat:temporalResolution?**: `string`
 
 Minimum time period resolvable in the distribution.
 
@@ -196,11 +248,15 @@ Minimum time period resolvable in the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:temporalResolution`](IDcatDistributionBase.md#dcattemporalresolution)
+
 ***
 
-### dcterms:conformsTo?
+### dcterms:conformsTo? {#dctermsconformsto}
 
-> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
+> `optional` **dcterms:conformsTo?**: `ObjectOrArray`\<`string`\>
 
 An established standard to which the distribution conforms.
 
@@ -208,11 +264,15 @@ An established standard to which the distribution conforms.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:conformsTo`](IDcatDistributionBase.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.
 
@@ -220,11 +280,15 @@ The media type of the distribution as defined by IANA.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:mediaType`](IDcatDistributionBase.md#dcatmediatype)
+
 ***
 
-### dcterms:format?
+### dcterms:format? {#dctermsformat}
 
-> `optional` **dcterms:format**: `string`
+> `optional` **dcterms:format?**: `string`
 
 The file format of the distribution.
 
@@ -232,11 +296,15 @@ The file format of the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcterms:format`](IDcatDistributionBase.md#dctermsformat)
+
 ***
 
-### dcat:compressFormat?
+### dcat:compressFormat? {#dcatcompressformat}
 
-> `optional` **dcat:compressFormat**: `string`
+> `optional` **dcat:compressFormat?**: `string`
 
 The compression format of the distribution.
 
@@ -244,11 +312,15 @@ The compression format of the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:compressFormat`](IDcatDistributionBase.md#dcatcompressformat)
+
 ***
 
-### dcat:packageFormat?
+### dcat:packageFormat? {#dcatpackageformat}
 
-> `optional` **dcat:packageFormat**: `string`
+> `optional` **dcat:packageFormat?**: `string`
 
 The package format of the distribution.
 
@@ -256,11 +328,15 @@ The package format of the distribution.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`dcat:packageFormat`](IDcatDistributionBase.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.
 
@@ -268,14 +344,22 @@ The checksum property provides a mechanism to verify the data integrity.
 
 https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
 
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`spdx:checksum`](IDcatDistributionBase.md#spdxchecksum)
+
 ***
 
-### odrl:hasPolicy?
+### odrl:hasPolicy? {#odrlhaspolicy}
 
-> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
+> `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
+
+#### Inherited from
+
+[`IDcatDistributionBase`](IDcatDistributionBase.md).[`odrl:hasPolicy`](IDcatDistributionBase.md#odrlhaspolicy)

package/docs/reference/interfaces/IDcatDistributionBase.md

@@ -0,0 +1,269 @@
+# Interface: IDcatDistributionBase
+
+Base interface for DCAT Distribution without JSON-LD context.
+This is the context-free variant of IDcatDistribution, intended for embedding
+distribution objects inline within datasets where the context is provided by the enclosing document.
+
+## See
+
+https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
+
+## Extended by
+
+- [`IDcatDistribution`](IDcatDistribution.md)
+
+## Properties
+
+### @type {#type}
+
+> **@type**: `"dcat:Distribution"`
+
+The type identifier, typically "Distribution".
+
+***
+
+### @id? {#id}
+
+> `optional` **@id?**: `string`
+
+The unique identifier for the distribution object.
+
+***
+
+### dcterms:title? {#dctermstitle}
+
+> `optional` **dcterms:title?**: `ObjectOrArray`\<`string`\>
+
+A name given to the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
+
+***
+
+### dcterms:description? {#dctermsdescription}
+
+> `optional` **dcterms:description?**: `ObjectOrArray`\<`string`\>
+
+A free-text account of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
+
+***
+
+### dcterms:issued? {#dctermsissued}
+
+> `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? {#dctermsmodified}
+
+> `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? {#dctermslicense}
+
+> `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? {#dctermsaccessrights}
+
+> `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? {#dctermsrights}
+
+> `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? {#dcataccessurl}
+
+> `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? {#dcataccessservice}
+
+> `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? {#dcatdownloadurl}
+
+> `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? {#dcatbytesize}
+
+> `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? {#dcatspatialresolutioninmeters}
+
+> `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? {#dcattemporalresolution}
+
+> `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? {#dctermsconformsto}
+
+> `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? {#dcatmediatype}
+
+> `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? {#dctermsformat}
+
+> `optional` **dcterms:format?**: `string`
+
+The file format of the distribution.
+
+#### See
+
+https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
+
+***
+
+### dcat:compressFormat? {#dcatcompressformat}
+
+> `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? {#dcatpackageformat}
+
+> `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? {#spdxchecksum}
+
+> `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? {#odrlhaspolicy}
+
+> `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