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

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 (95) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +21 -0
  3. package/dist/es/dataTypes/dcatDataTypes.js +77 -0
  4. package/dist/es/dataTypes/dcatDataTypes.js.map +1 -0
  5. package/dist/es/index.js +19 -0
  6. package/dist/es/index.js.map +1 -0
  7. package/dist/es/models/IDcatCatalog.js +2 -0
  8. package/dist/es/models/IDcatCatalog.js.map +1 -0
  9. package/dist/es/models/IDcatCatalogRecord.js +2 -0
  10. package/dist/es/models/IDcatCatalogRecord.js.map +1 -0
  11. package/dist/es/models/IDcatDataService.js +2 -0
  12. package/dist/es/models/IDcatDataService.js.map +1 -0
  13. package/dist/es/models/IDcatDataset.js +2 -0
  14. package/dist/es/models/IDcatDataset.js.map +1 -0
  15. package/dist/es/models/IDcatDatasetSeries.js +2 -0
  16. package/dist/es/models/IDcatDatasetSeries.js.map +1 -0
  17. package/dist/es/models/IDcatDistribution.js +2 -0
  18. package/dist/es/models/IDcatDistribution.js.map +1 -0
  19. package/dist/es/models/IDcatRelationship.js +2 -0
  20. package/dist/es/models/IDcatRelationship.js.map +1 -0
  21. package/dist/es/models/IDcatResource.js +2 -0
  22. package/dist/es/models/IDcatResource.js.map +1 -0
  23. package/dist/es/models/IDcatRole.js +2 -0
  24. package/dist/es/models/IDcatRole.js.map +1 -0
  25. package/dist/es/models/dcatClasses.js +56 -0
  26. package/dist/es/models/dcatClasses.js.map +1 -0
  27. package/dist/es/models/dcatContextType.js +2 -0
  28. package/dist/es/models/dcatContextType.js.map +1 -0
  29. package/dist/es/models/dcatContexts.js +42 -0
  30. package/dist/es/models/dcatContexts.js.map +1 -0
  31. package/dist/es/models/dcatRelationshipTypes.js +57 -0
  32. package/dist/es/models/dcatRelationshipTypes.js.map +1 -0
  33. package/dist/es/models/types/dcatContextFreeTypes.js +4 -0
  34. package/dist/es/models/types/dcatContextFreeTypes.js.map +1 -0
  35. package/dist/es/models/types/dcatPropertyTypes.js +4 -0
  36. package/dist/es/models/types/dcatPropertyTypes.js.map +1 -0
  37. package/dist/es/schemas/DcatCatalog.json +500 -0
  38. package/dist/es/schemas/DcatCatalogRecord.json +221 -0
  39. package/dist/es/schemas/DcatDataService.json +367 -0
  40. package/dist/es/schemas/DcatDataset.json +416 -0
  41. package/dist/es/schemas/DcatDatasetSeries.json +434 -0
  42. package/dist/es/schemas/DcatDistribution.json +277 -0
  43. package/dist/es/schemas/DcatRelationship.json +195 -0
  44. package/dist/es/schemas/DcatResource.json +351 -0
  45. package/dist/es/schemas/DcatRole.json +191 -0
  46. package/dist/types/dataTypes/dcatDataTypes.d.ts +14 -0
  47. package/dist/types/index.d.ts +16 -0
  48. package/dist/types/models/IDcatCatalog.d.ts +52 -0
  49. package/dist/types/models/IDcatCatalogRecord.d.ts +52 -0
  50. package/dist/types/models/IDcatDataService.d.ts +31 -0
  51. package/dist/types/models/IDcatDataset.d.ts +60 -0
  52. package/dist/types/models/IDcatDatasetSeries.d.ts +30 -0
  53. package/dist/types/models/IDcatDistribution.d.ts +122 -0
  54. package/dist/types/models/IDcatRelationship.d.ts +30 -0
  55. package/dist/types/models/IDcatResource.d.ts +119 -0
  56. package/dist/types/models/IDcatRole.d.ts +25 -0
  57. package/dist/types/models/dcatClasses.d.ts +56 -0
  58. package/dist/types/models/dcatContextType.d.ts +15 -0
  59. package/dist/types/models/dcatContexts.d.ts +42 -0
  60. package/dist/types/models/dcatRelationshipTypes.d.ts +57 -0
  61. package/dist/types/models/types/dcatContextFreeTypes.d.ts +40 -0
  62. package/dist/types/models/types/dcatPropertyTypes.d.ts +29 -0
  63. package/docs/changelog.md +146 -0
  64. package/docs/examples.md +1 -0
  65. package/docs/reference/classes/DcatDataTypes.md +38 -0
  66. package/docs/reference/index.md +41 -0
  67. package/docs/reference/interfaces/IDcatCatalog.md +557 -0
  68. package/docs/reference/interfaces/IDcatCatalogRecord.md +113 -0
  69. package/docs/reference/interfaces/IDcatDataService.md +382 -0
  70. package/docs/reference/interfaces/IDcatDataset.md +447 -0
  71. package/docs/reference/interfaces/IDcatDatasetSeries.md +509 -0
  72. package/docs/reference/interfaces/IDcatDistribution.md +281 -0
  73. package/docs/reference/interfaces/IDcatRelationship.md +65 -0
  74. package/docs/reference/interfaces/IDcatResource.md +274 -0
  75. package/docs/reference/interfaces/IDcatRole.md +53 -0
  76. package/docs/reference/type-aliases/CatalogOptionalContext.md +11 -0
  77. package/docs/reference/type-aliases/CatalogRecordOptionalContext.md +11 -0
  78. package/docs/reference/type-aliases/DataServiceOptionalContext.md +11 -0
  79. package/docs/reference/type-aliases/DatasetOptionalContext.md +11 -0
  80. package/docs/reference/type-aliases/DcatClasses.md +5 -0
  81. package/docs/reference/type-aliases/DcatContextType.md +24 -0
  82. package/docs/reference/type-aliases/DcatContexts.md +5 -0
  83. package/docs/reference/type-aliases/DcatDateTimeType.md +6 -0
  84. package/docs/reference/type-aliases/DcatDecimalType.md +5 -0
  85. package/docs/reference/type-aliases/DcatDurationType.md +5 -0
  86. package/docs/reference/type-aliases/DcatIriType.md +5 -0
  87. package/docs/reference/type-aliases/DcatLiteralType.md +5 -0
  88. package/docs/reference/type-aliases/DcatNonNegativeIntegerType.md +5 -0
  89. package/docs/reference/type-aliases/DcatRelationshipType.md +5 -0
  90. package/docs/reference/type-aliases/DistributionOptionalContext.md +11 -0
  91. package/docs/reference/variables/DcatClasses.md +102 -0
  92. package/docs/reference/variables/DcatContexts.md +69 -0
  93. package/docs/reference/variables/DcatRelationshipType.md +103 -0
  94. package/locales/en.json +1 -0
  95. package/package.json +57 -0
@@ -0,0 +1,31 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { DcatClasses } from "./dcatClasses.js";
3
+ import type { IDcatResource } from "./IDcatResource.js";
4
+ /**
5
+ * Interface for DCAT Data Service.
6
+ * A collection of operations that provides access to one or more datasets or data
7
+ * processing functions.
8
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service
9
+ */
10
+ export interface IDcatDataService extends IDcatResource {
11
+ /**
12
+ * The type identifier, typically "DataService".
13
+ */
14
+ "@type": typeof DcatClasses.DataService;
15
+ /**
16
+ * The root location or primary endpoint of the service (a Web-resolvable IRI).
17
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_url
18
+ */
19
+ "dcat:endpointURL"?: string;
20
+ /**
21
+ * A description of the services available via the end-points, including their
22
+ * operations, parameters, etc.
23
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_endpoint_description
24
+ */
25
+ "dcat:endpointDescription"?: string;
26
+ /**
27
+ * A collection of data that this data service can distribute.
28
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:data_service_serves_dataset
29
+ */
30
+ "dcat:servesDataset"?: ObjectOrArray<string>;
31
+ }
@@ -0,0 +1,60 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { IDublinCorePeriodOfTime } from "@twin.org/standards-dublin-core";
4
+ import type { DcatClasses } from "./dcatClasses.js";
5
+ import type { IDcatResource } from "./IDcatResource.js";
6
+ import type { DistributionOptionalContext } from "./types/dcatContextFreeTypes.js";
7
+ import type { DcatDecimalType, DcatDurationType } from "./types/dcatPropertyTypes.js";
8
+ /**
9
+ * Interface for DCAT Dataset.
10
+ * A collection of data, published or curated by a single agent, and available
11
+ * for access or download in one or more representations.
12
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
13
+ */
14
+ export interface IDcatDataset extends IDcatResource {
15
+ /**
16
+ * The type identifier, typically "Dataset".
17
+ * Can also be "Catalog" or "DatasetSeries" for subclasses.
18
+ */
19
+ "@type": typeof DcatClasses.Dataset | typeof DcatClasses.Catalog | typeof DcatClasses.DatasetSeries;
20
+ /**
21
+ * An available distribution of the dataset.
22
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_distribution
23
+ */
24
+ "dcat:distribution"?: ObjectOrArray<DistributionOptionalContext>;
25
+ /**
26
+ * The frequency at which the dataset is published.
27
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_frequency
28
+ */
29
+ "dcterms:accrualPeriodicity"?: string;
30
+ /**
31
+ * A dataset series of which the dataset is part.
32
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_in_series
33
+ */
34
+ "dcat:inSeries"?: string;
35
+ /**
36
+ * The geographical area covered by the dataset.
37
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial
38
+ */
39
+ "dcterms:spatial"?: IJsonLdNodeObject | ObjectOrArray<string>;
40
+ /**
41
+ * Minimum spatial separation resolvable in a dataset, measured in meters.
42
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_spatial_resolution
43
+ */
44
+ "dcat:spatialResolutionInMeters"?: DcatDecimalType;
45
+ /**
46
+ * The temporal period that the dataset covers.
47
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal
48
+ */
49
+ "dcterms:temporal"?: IDublinCorePeriodOfTime;
50
+ /**
51
+ * Minimum time period resolvable in the dataset.
52
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_temporal_resolution
53
+ */
54
+ "dcat:temporalResolution"?: DcatDurationType;
55
+ /**
56
+ * An activity that generated, or provides the business context for, the creation of the dataset.
57
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_was_generated_by
58
+ */
59
+ "prov:wasGeneratedBy"?: IJsonLdNodeObject | string;
60
+ }
@@ -0,0 +1,30 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { DcatClasses } from "./dcatClasses.js";
3
+ import type { IDcatDataset } from "./IDcatDataset.js";
4
+ /**
5
+ * Interface for DCAT Dataset Series.
6
+ * A collection of datasets that are published separately, but share some common
7
+ * characteristics that enable them to be grouped together.
8
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset_Series
9
+ */
10
+ export interface IDcatDatasetSeries extends IDcatDataset {
11
+ /**
12
+ * The type identifier, typically "DatasetSeries".
13
+ */
14
+ "@type": typeof DcatClasses.DatasetSeries;
15
+ /**
16
+ * A dataset that is part of this dataset series.
17
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_first
18
+ */
19
+ "dcat:first"?: string;
20
+ /**
21
+ * A dataset that is part of this dataset series.
22
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_last
23
+ */
24
+ "dcat:last"?: string;
25
+ /**
26
+ * A dataset that is part of this dataset series.
27
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:dataset_series_member
28
+ */
29
+ "dcat:seriesMember"?: ObjectOrArray<string>;
30
+ }
@@ -0,0 +1,122 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
4
+ import type { DcatClasses } from "./dcatClasses.js";
5
+ import type { DcatContextType } from "./dcatContextType.js";
6
+ import type { DcatDateTimeType, DcatDecimalType, DcatDurationType, DcatLiteralType, DcatNonNegativeIntegerType } from "./types/dcatPropertyTypes.js";
7
+ /**
8
+ * Interface for DCAT Distribution.
9
+ * A specific representation of a dataset. A dataset might be available in multiple
10
+ * serializations that may differ in various ways.
11
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
12
+ */
13
+ export interface IDcatDistribution extends IJsonLdNodeObject {
14
+ /**
15
+ * The JSON-LD context for the resource.
16
+ */
17
+ "@context": DcatContextType;
18
+ /**
19
+ * The type identifier, typically "Distribution".
20
+ */
21
+ "@type": typeof DcatClasses.Distribution;
22
+ /**
23
+ * A name given to the distribution.
24
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
25
+ */
26
+ "dcterms:title"?: DcatLiteralType;
27
+ /**
28
+ * A free-text account of the distribution.
29
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
30
+ */
31
+ "dcterms:description"?: DcatLiteralType;
32
+ /**
33
+ * Date of formal issuance of the distribution.
34
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
35
+ */
36
+ "dcterms:issued"?: DcatDateTimeType;
37
+ /**
38
+ * Most recent date on which the distribution was changed, updated or modified.
39
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
40
+ */
41
+ "dcterms:modified"?: DcatDateTimeType;
42
+ /**
43
+ * A legal document under which the distribution is made available.
44
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
45
+ */
46
+ "dcterms:license"?: string;
47
+ /**
48
+ * Information about who can access the distribution.
49
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
50
+ */
51
+ "dcterms:accessRights"?: string;
52
+ /**
53
+ * Information about rights held in and over the distribution.
54
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
55
+ */
56
+ "dcterms:rights"?: string;
57
+ /**
58
+ * A URL of the resource that gives access to a distribution of the dataset.
59
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
60
+ */
61
+ "dcat:accessURL"?: string;
62
+ /**
63
+ * A data service that gives access to the distribution.
64
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
65
+ */
66
+ "dcat:accessService"?: string;
67
+ /**
68
+ * The URL of the downloadable file in a given format.
69
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
70
+ */
71
+ "dcat:downloadURL"?: string;
72
+ /**
73
+ * The size of the distribution in bytes.
74
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
75
+ */
76
+ "dcat:byteSize"?: DcatNonNegativeIntegerType;
77
+ /**
78
+ * The minimum spatial separation resolvable in a distribution, measured in meters.
79
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
80
+ */
81
+ "dcat:spatialResolutionInMeters"?: DcatDecimalType;
82
+ /**
83
+ * Minimum time period resolvable in the distribution.
84
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
85
+ */
86
+ "dcat:temporalResolution"?: DcatDurationType;
87
+ /**
88
+ * An established standard to which the distribution conforms.
89
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
90
+ */
91
+ "dcterms:conformsTo"?: ObjectOrArray<string>;
92
+ /**
93
+ * The media type of the distribution as defined by IANA.
94
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
95
+ */
96
+ "dcat:mediaType"?: string;
97
+ /**
98
+ * The file format of the distribution.
99
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
100
+ */
101
+ "dcterms:format"?: string;
102
+ /**
103
+ * The compression format of the distribution.
104
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
105
+ */
106
+ "dcat:compressFormat"?: string;
107
+ /**
108
+ * The package format of the distribution.
109
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
110
+ */
111
+ "dcat:packageFormat"?: string;
112
+ /**
113
+ * The checksum property provides a mechanism to verify the data integrity.
114
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
115
+ */
116
+ "spdx:checksum"?: string;
117
+ /**
118
+ * An ODRL conformant policy expressing the rights associated with the distribution.
119
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_has_policy
120
+ */
121
+ "odrl:hasPolicy"?: IOdrlPolicy;
122
+ }
@@ -0,0 +1,30 @@
1
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
+ import type { DcatClasses } from "./dcatClasses.js";
3
+ import type { DcatContextType } from "./dcatContextType.js";
4
+ import type { IDcatRole } from "./IDcatRole.js";
5
+ /**
6
+ * Interface for DCAT Relationship.
7
+ * An association class for attaching additional information to a relationship
8
+ * between DCAT Resources.
9
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Relationship
10
+ */
11
+ export interface IDcatRelationship extends IJsonLdNodeObject {
12
+ /**
13
+ * The JSON-LD context for the resource.
14
+ */
15
+ "@context": DcatContextType;
16
+ /**
17
+ * The type identifier, typically "Relationship".
18
+ */
19
+ "@type": typeof DcatClasses.Relationship;
20
+ /**
21
+ * The link to a related resource.
22
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_relation
23
+ */
24
+ "dcterms:relation"?: string;
25
+ /**
26
+ * The function of an entity or agent with respect to another resource.
27
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_hadRole
28
+ */
29
+ "dcat:hadRole"?: IDcatRole;
30
+ }
@@ -0,0 +1,119 @@
1
+ import type { ObjectOrArray } from "@twin.org/core";
2
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
3
+ import type { IFoafAgent } from "@twin.org/standards-foaf";
4
+ import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
5
+ import type { DcatClasses } from "./dcatClasses.js";
6
+ import type { DcatContextType } from "./dcatContextType.js";
7
+ import type { IDcatRelationship } from "./IDcatRelationship.js";
8
+ import type { DcatDateTimeType, DcatLiteralType } from "./types/dcatPropertyTypes.js";
9
+ /**
10
+ * Base interface for DCAT catalogued resources.
11
+ * This is the parent class of dcat:Dataset, dcat:DataService, and dcat:Catalog.
12
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Resource
13
+ */
14
+ export interface IDcatResource extends IJsonLdNodeObject {
15
+ /**
16
+ * The JSON-LD context for the resource.
17
+ */
18
+ "@context": DcatContextType;
19
+ /**
20
+ * The type of the resource.
21
+ * Typically "Catalog", "Dataset", "DataService", "DatasetSeries", or the base "Resource".
22
+ */
23
+ "@type": typeof DcatClasses.Resource | typeof DcatClasses.Dataset | typeof DcatClasses.DataService | typeof DcatClasses.Catalog | typeof DcatClasses.DatasetSeries;
24
+ /**
25
+ * A name given to the resource.
26
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_title
27
+ */
28
+ "dcterms:title"?: DcatLiteralType;
29
+ /**
30
+ * A free-text account of the resource.
31
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_description
32
+ */
33
+ "dcterms:description"?: DcatLiteralType;
34
+ /**
35
+ * A unique identifier of the resource.
36
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_identifier
37
+ */
38
+ "dcterms:identifier"?: DcatLiteralType;
39
+ /**
40
+ * Date of formal issuance (publication) of the resource.
41
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_release_date
42
+ */
43
+ "dcterms:issued"?: DcatDateTimeType;
44
+ /**
45
+ * Most recent date on which the resource was changed, updated or modified.
46
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_update_date
47
+ */
48
+ "dcterms:modified"?: DcatDateTimeType;
49
+ /**
50
+ * A language of the resource.
51
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_language
52
+ */
53
+ "dcterms:language"?: ObjectOrArray<string>;
54
+ /**
55
+ * An entity responsible for making the resource available.
56
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_publisher
57
+ */
58
+ "dcterms:publisher"?: IFoafAgent | string;
59
+ /**
60
+ * An entity responsible for producing the resource.
61
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_creator
62
+ */
63
+ "dcterms:creator"?: IFoafAgent;
64
+ /**
65
+ * Information about who can access the resource or an indication of its security status.
66
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_access_rights
67
+ */
68
+ "dcterms:accessRights"?: IJsonLdNodeObject | string;
69
+ /**
70
+ * A legal document under which the resource is made available.
71
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_license
72
+ */
73
+ "dcterms:license"?: IJsonLdNodeObject | string;
74
+ /**
75
+ * Information about rights held in and over the resource.
76
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_rights
77
+ */
78
+ "dcterms:rights"?: IJsonLdNodeObject | string;
79
+ /**
80
+ * An established standard to which the resource conforms.
81
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_conforms_to
82
+ */
83
+ "dcterms:conformsTo"?: ObjectOrArray<string>;
84
+ /**
85
+ * The nature or genre of the resource.
86
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_type
87
+ */
88
+ "dcterms:type"?: string;
89
+ /**
90
+ * Relevant contact information for the catalogued resource.
91
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_contact_point
92
+ */
93
+ "dcat:contactPoint"?: IJsonLdNodeObject | string;
94
+ /**
95
+ * A keyword or tag describing the resource.
96
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_keyword
97
+ */
98
+ "dcat:keyword"?: DcatLiteralType;
99
+ /**
100
+ * A main category of the resource. A resource can have multiple themes.
101
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_theme
102
+ */
103
+ "dcat:theme"?: ObjectOrArray<string>;
104
+ /**
105
+ * A Web page that can be navigated to gain access to the resource.
106
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_landing_page
107
+ */
108
+ "dcat:landingPage"?: ObjectOrArray<string>;
109
+ /**
110
+ * Link to a description of a relationship with another resource.
111
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_qualified_relation
112
+ */
113
+ "dcat:qualifiedRelation"?: IDcatRelationship | string;
114
+ /**
115
+ * An ODRL conformant policy expressing the rights associated with the resource.
116
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_policy
117
+ */
118
+ "odrl:hasPolicy"?: IOdrlPolicy;
119
+ }
@@ -0,0 +1,25 @@
1
+ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
+ import type { DcatClasses } from "./dcatClasses.js";
3
+ import type { DcatContextType } from "./dcatContextType.js";
4
+ import type { DcatLiteralType } from "./types/dcatPropertyTypes.js";
5
+ /**
6
+ * Interface for DCAT Role.
7
+ * A role is the function of a resource or agent with respect to another resource,
8
+ * in the context of resource attribution or resource relationships.
9
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Role
10
+ */
11
+ export interface IDcatRole extends IJsonLdNodeObject {
12
+ /**
13
+ * The JSON-LD context for the resource.
14
+ */
15
+ "@context": DcatContextType;
16
+ /**
17
+ * The type identifier, typically "Role".
18
+ */
19
+ "@type": typeof DcatClasses.Role;
20
+ /**
21
+ * A name given to the distribution.
22
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
23
+ */
24
+ "dcterms:title"?: DcatLiteralType;
25
+ }
@@ -0,0 +1,56 @@
1
+ /**
2
+ * DCAT core classes representing the main entities in the Data Catalog Vocabulary.
3
+ * @see https://www.w3.org/TR/vocab-dcat-3/#classes
4
+ */
5
+ export declare const DcatClasses: {
6
+ /**
7
+ * A curated collection of metadata about resources (e.g., datasets and data services in the context of a data catalog).
8
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog
9
+ */
10
+ readonly Catalog: "dcat:Catalog";
11
+ /**
12
+ * Resource published or curated by a single agent.
13
+ * This is an abstract class and should not be used directly.
14
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Resource
15
+ */
16
+ readonly Resource: "dcat:Resource";
17
+ /**
18
+ * A collection of data, published or curated by a single agent, and available for access or download in one or more representations.
19
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
20
+ */
21
+ readonly Dataset: "dcat:Dataset";
22
+ /**
23
+ * A specific representation of a dataset. A dataset might be available in multiple serializations that may differ in various ways.
24
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
25
+ */
26
+ readonly Distribution: "dcat:Distribution";
27
+ /**
28
+ * A collection of operations that provides access to one or more datasets or data processing functions.
29
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service
30
+ */
31
+ readonly DataService: "dcat:DataService";
32
+ /**
33
+ * A collection of datasets that are published separately, but share some common characteristics.
34
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset_Series
35
+ */
36
+ readonly DatasetSeries: "dcat:DatasetSeries";
37
+ /**
38
+ * A record in a data catalog, describing the registration of a single dataset or data service.
39
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog_Record
40
+ */
41
+ readonly CatalogRecord: "dcat:CatalogRecord";
42
+ /**
43
+ * An association class for attaching additional information to a relationship between DCAT Resources.
44
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Relationship
45
+ */
46
+ readonly Relationship: "dcat:Relationship";
47
+ /**
48
+ * A role is the function of a resource or agent with respect to another resource, in the context of resource attribution or resource relationships..
49
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Class:Role
50
+ */
51
+ readonly Role: "dcat:Role";
52
+ };
53
+ /**
54
+ * The classes for DCAT.
55
+ */
56
+ export type DcatClasses = (typeof DcatClasses)[keyof typeof DcatClasses];
@@ -0,0 +1,15 @@
1
+ import type { IJsonLdContextDefinition } from "@twin.org/data-json-ld";
2
+ import type { DublinCoreContexts } from "@twin.org/standards-dublin-core";
3
+ import type { FoafContexts } from "@twin.org/standards-foaf";
4
+ import type { OdrlContexts } from "@twin.org/standards-w3c-odrl";
5
+ import type { DcatContexts } from "./dcatContexts.js";
6
+ /**
7
+ * The DCAT JSON-LD context type.
8
+ * Supports the DCAT context URL or arrays with additional context definitions.
9
+ */
10
+ export type DcatContextType = {
11
+ dcat: typeof DcatContexts.ContextRoot;
12
+ dcterms: typeof DublinCoreContexts.ContextTerms;
13
+ odrl?: typeof OdrlContexts.Namespace;
14
+ foaf?: typeof FoafContexts.ContextRoot;
15
+ } & IJsonLdContextDefinition;
@@ -0,0 +1,42 @@
1
+ /**
2
+ * DCAT (Data Catalog Vocabulary) namespace contexts.
3
+ * @see https://www.w3.org/TR/vocab-dcat-3/
4
+ */
5
+ export declare const DcatContexts: {
6
+ /**
7
+ * The context root for DCAT vocabulary.
8
+ */
9
+ readonly ContextRoot: "http://www.w3.org/ns/dcat#";
10
+ /**
11
+ * The namespace for DCAT terms
12
+ */
13
+ readonly Namespace: "http://www.w3.org/ns/dcat#";
14
+ /**
15
+ * The redirect URL for the DCAT context, used for JSON-LD processing.
16
+ */
17
+ readonly ContextRedirect: "https://www.w3.org/ns/dcat.jsonld";
18
+ /**
19
+ * The context for RDF vocabulary.
20
+ * @see https://www.w3.org/TR/rdf-schema/
21
+ */
22
+ readonly ContextRdf: "http://www.w3.org/2000/01/rdf-schema#";
23
+ /**
24
+ * The context for RDF vocabulary Json-LD.
25
+ * @see https://www.w3.org/TR/rdf-schema/
26
+ */
27
+ readonly ContextRdfRedirect: "https://schema.twindev.org/w3c-rdf/types.jsonld";
28
+ /**
29
+ * The context for SPDX (Software Package Data Exchange) vocabulary.
30
+ * @see https://spdx.org/rdf/terms
31
+ */
32
+ readonly ContextSpdx: "http://spdx.org/rdf/terms#";
33
+ /**
34
+ * The context for PROV (Provenance) vocabulary.
35
+ * @see https://www.w3.org/ns/prov
36
+ */
37
+ readonly ContextProv: "http://www.w3.org/ns/prov#";
38
+ };
39
+ /**
40
+ * The contexts for DCAT.
41
+ */
42
+ export type DcatContexts = (typeof DcatContexts)[keyof typeof DcatContexts];
@@ -0,0 +1,57 @@
1
+ /**
2
+ * DCAT relationship types for describing qualified relationships between resources.
3
+ * These are used with the dcat:qualifiedRelation property.
4
+ * @see https://www.w3.org/TR/vocab-dcat-3/#qualified-forms
5
+ */
6
+ export declare const DcatRelationshipType: {
7
+ /**
8
+ * The function of an entity with respect to another resource.
9
+ * Used in qualified relationships to specify the role.
10
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_had_role
11
+ */
12
+ readonly HadRole: "hadRole";
13
+ /**
14
+ * A related resource that is supplanted, displaced, or superseded by the described resource.
15
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_replaces
16
+ */
17
+ readonly Replaces: "replaces";
18
+ /**
19
+ * A related resource that supplants, displaces, or supersedes the described resource.
20
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_replaced_by
21
+ */
22
+ readonly IsReplacedBy: "isReplacedBy";
23
+ /**
24
+ * A related resource that is a version, edition, or adaptation of the described resource.
25
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_version
26
+ */
27
+ readonly HasVersion: "hasVersion";
28
+ /**
29
+ * A related resource of which the described resource is a version, edition, or adaptation.
30
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_version_of
31
+ */
32
+ readonly IsVersionOf: "isVersionOf";
33
+ /**
34
+ * A related resource that references, cites, or otherwise points to the described resource.
35
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_referenced_by
36
+ */
37
+ readonly IsReferencedBy: "isReferencedBy";
38
+ /**
39
+ * A related resource that is referenced, cited, or otherwise pointed to by the described resource.
40
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_references
41
+ */
42
+ readonly References: "references";
43
+ /**
44
+ * A related resource that requires the described resource to support its function, delivery, or coherence.
45
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_requires
46
+ */
47
+ readonly Requires: "requires";
48
+ /**
49
+ * A related resource that is required by the described resource to support its function, delivery, or coherence.
50
+ * @see https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_required_by
51
+ */
52
+ readonly IsRequiredBy: "isRequiredBy";
53
+ };
54
+ /**
55
+ * The relationship types for DCAT.
56
+ */
57
+ export type DcatRelationshipType = (typeof DcatRelationshipType)[keyof typeof DcatRelationshipType];
@@ -0,0 +1,40 @@
1
+ import type { DcatContextType } from "../dcatContextType.js";
2
+ import type { IDcatCatalog } from "../IDcatCatalog.js";
3
+ import type { IDcatCatalogRecord } from "../IDcatCatalogRecord.js";
4
+ import type { IDcatDataService } from "../IDcatDataService.js";
5
+ import type { IDcatDataset } from "../IDcatDataset.js";
6
+ import type { IDcatDistribution } from "../IDcatDistribution.js";
7
+ /**
8
+ * Type aliases for DCAT entities when LD Context is omitted
9
+ * These provide type safety while maintaining flexibility for JSON-LD data.
10
+ */
11
+ /**
12
+ * Dataset omitting LD Context
13
+ */
14
+ export type DatasetOptionalContext = Omit<IDcatDataset, "@context"> & {
15
+ "@context"?: DcatContextType;
16
+ };
17
+ /**
18
+ * DataService omitting LD Context
19
+ */
20
+ export type DataServiceOptionalContext = Omit<IDcatDataService, "@context"> & {
21
+ "@context"?: DcatContextType;
22
+ };
23
+ /**
24
+ * Catalog omitting LD Context
25
+ */
26
+ export type CatalogOptionalContext = Omit<IDcatCatalog, "@context"> & {
27
+ "@context"?: DcatContextType;
28
+ };
29
+ /**
30
+ * Record omitting LD Context
31
+ */
32
+ export type CatalogRecordOptionalContext = Omit<IDcatCatalogRecord, "@context"> & {
33
+ "@context"?: DcatContextType;
34
+ };
35
+ /**
36
+ * Distribution omitting LD Context
37
+ */
38
+ export type DistributionOptionalContext = Omit<IDcatDistribution, "@context"> & {
39
+ "@context"?: DcatContextType;
40
+ };
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Common type aliases for DCAT properties.
3
+ * These provide type safety while maintaining flexibility for JSON-LD data.
4
+ */
5
+ /**
6
+ * Literal values can be strings or arrays of strings (for multi-valued properties).
7
+ */
8
+ export type DcatLiteralType = string | string[];
9
+ /**
10
+ * IRI references - can be a single IRI or array of IRIs.
11
+ */
12
+ export type DcatIriType = string | string[];
13
+ /**
14
+ * Date/time values in ISO 8601 format.
15
+ * Can be xsd:date, xsd:dateTime, or xsd:gYear.
16
+ */
17
+ export type DcatDateTimeType = string;
18
+ /**
19
+ * Duration values in ISO 8601 duration format (xsd:duration).
20
+ */
21
+ export type DcatDurationType = string;
22
+ /**
23
+ * Decimal number values (xsd:decimal).
24
+ */
25
+ export type DcatDecimalType = number;
26
+ /**
27
+ * Non-negative integer values (xsd:nonNegativeInteger).
28
+ */
29
+ export type DcatNonNegativeIntegerType = number;