@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,5 @@
1
+ # Type Alias: DcatClasses
2
+
3
+ > **DcatClasses** = *typeof* [`DcatClasses`](../variables/DcatClasses.md)\[keyof *typeof* [`DcatClasses`](../variables/DcatClasses.md)\]
4
+
5
+ The classes for DCAT.
@@ -0,0 +1,24 @@
1
+ # Type Alias: DcatContextType
2
+
3
+ > **DcatContextType** = `object` & `IJsonLdContextDefinition`
4
+
5
+ The DCAT JSON-LD context type.
6
+ Supports the DCAT context URL or arrays with additional context definitions.
7
+
8
+ ## Type Declaration
9
+
10
+ ### dcat
11
+
12
+ > **dcat**: *typeof* [`ContextRoot`](../variables/DcatContexts.md#contextroot)
13
+
14
+ ### dcterms
15
+
16
+ > **dcterms**: *typeof* `DublinCoreContexts.ContextTerms`
17
+
18
+ ### odrl?
19
+
20
+ > `optional` **odrl**: *typeof* `OdrlContexts.Namespace`
21
+
22
+ ### foaf?
23
+
24
+ > `optional` **foaf**: *typeof* `FoafContexts.ContextRoot`
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatContexts
2
+
3
+ > **DcatContexts** = *typeof* [`DcatContexts`](../variables/DcatContexts.md)\[keyof *typeof* [`DcatContexts`](../variables/DcatContexts.md)\]
4
+
5
+ The contexts for DCAT.
@@ -0,0 +1,6 @@
1
+ # Type Alias: DcatDateTimeType
2
+
3
+ > **DcatDateTimeType** = `string`
4
+
5
+ Date/time values in ISO 8601 format.
6
+ Can be xsd:date, xsd:dateTime, or xsd:gYear.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatDecimalType
2
+
3
+ > **DcatDecimalType** = `number`
4
+
5
+ Decimal number values (xsd:decimal).
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatDurationType
2
+
3
+ > **DcatDurationType** = `string`
4
+
5
+ Duration values in ISO 8601 duration format (xsd:duration).
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatIriType
2
+
3
+ > **DcatIriType** = `string` \| `string`[]
4
+
5
+ IRI references - can be a single IRI or array of IRIs.
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatLiteralType
2
+
3
+ > **DcatLiteralType** = `string` \| `string`[]
4
+
5
+ Literal values can be strings or arrays of strings (for multi-valued properties).
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatNonNegativeIntegerType
2
+
3
+ > **DcatNonNegativeIntegerType** = `number`
4
+
5
+ Non-negative integer values (xsd:nonNegativeInteger).
@@ -0,0 +1,5 @@
1
+ # Type Alias: DcatRelationshipType
2
+
3
+ > **DcatRelationshipType** = *typeof* [`DcatRelationshipType`](../variables/DcatRelationshipType.md)\[keyof *typeof* [`DcatRelationshipType`](../variables/DcatRelationshipType.md)\]
4
+
5
+ The relationship types for DCAT.
@@ -0,0 +1,11 @@
1
+ # Type Alias: DistributionOptionalContext
2
+
3
+ > **DistributionOptionalContext** = `Omit`\<[`IDcatDistribution`](../interfaces/IDcatDistribution.md), `"@context"`\> & `object`
4
+
5
+ Distribution omitting LD Context
6
+
7
+ ## Type Declaration
8
+
9
+ ### @context?
10
+
11
+ > `optional` **@context**: [`DcatContextType`](DcatContextType.md)
@@ -0,0 +1,102 @@
1
+ # Variable: DcatClasses
2
+
3
+ > `const` **DcatClasses**: `object`
4
+
5
+ DCAT core classes representing the main entities in the Data Catalog Vocabulary.
6
+
7
+ ## Type Declaration
8
+
9
+ ### Catalog
10
+
11
+ > `readonly` **Catalog**: `"dcat:Catalog"` = `"dcat:Catalog"`
12
+
13
+ A curated collection of metadata about resources (e.g., datasets and data services in the context of a data catalog).
14
+
15
+ #### See
16
+
17
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog
18
+
19
+ ### Resource
20
+
21
+ > `readonly` **Resource**: `"dcat:Resource"` = `"dcat:Resource"`
22
+
23
+ Resource published or curated by a single agent.
24
+ This is an abstract class and should not be used directly.
25
+
26
+ #### See
27
+
28
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Resource
29
+
30
+ ### Dataset
31
+
32
+ > `readonly` **Dataset**: `"dcat:Dataset"` = `"dcat:Dataset"`
33
+
34
+ A collection of data, published or curated by a single agent, and available for access or download in one or more representations.
35
+
36
+ #### See
37
+
38
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset
39
+
40
+ ### Distribution
41
+
42
+ > `readonly` **Distribution**: `"dcat:Distribution"` = `"dcat:Distribution"`
43
+
44
+ A specific representation of a dataset. A dataset might be available in multiple serializations that may differ in various ways.
45
+
46
+ #### See
47
+
48
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
49
+
50
+ ### DataService
51
+
52
+ > `readonly` **DataService**: `"dcat:DataService"` = `"dcat:DataService"`
53
+
54
+ A collection of operations that provides access to one or more datasets or data processing functions.
55
+
56
+ #### See
57
+
58
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Data_Service
59
+
60
+ ### DatasetSeries
61
+
62
+ > `readonly` **DatasetSeries**: `"dcat:DatasetSeries"` = `"dcat:DatasetSeries"`
63
+
64
+ A collection of datasets that are published separately, but share some common characteristics.
65
+
66
+ #### See
67
+
68
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Dataset_Series
69
+
70
+ ### CatalogRecord
71
+
72
+ > `readonly` **CatalogRecord**: `"dcat:CatalogRecord"` = `"dcat:CatalogRecord"`
73
+
74
+ A record in a data catalog, describing the registration of a single dataset or data service.
75
+
76
+ #### See
77
+
78
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Catalog_Record
79
+
80
+ ### Relationship
81
+
82
+ > `readonly` **Relationship**: `"dcat:Relationship"` = `"dcat:Relationship"`
83
+
84
+ An association class for attaching additional information to a relationship between DCAT Resources.
85
+
86
+ #### See
87
+
88
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Relationship
89
+
90
+ ### Role
91
+
92
+ > `readonly` **Role**: `"dcat:Role"` = `"dcat:Role"`
93
+
94
+ A role is the function of a resource or agent with respect to another resource, in the context of resource attribution or resource relationships..
95
+
96
+ #### See
97
+
98
+ https://www.w3.org/TR/vocab-dcat-3/#Class:Role
99
+
100
+ ## See
101
+
102
+ https://www.w3.org/TR/vocab-dcat-3/#classes
@@ -0,0 +1,69 @@
1
+ # Variable: DcatContexts
2
+
3
+ > `const` **DcatContexts**: `object`
4
+
5
+ DCAT (Data Catalog Vocabulary) namespace contexts.
6
+
7
+ ## Type Declaration
8
+
9
+ ### ContextRoot
10
+
11
+ > `readonly` **ContextRoot**: `"http://www.w3.org/ns/dcat#"` = `"http://www.w3.org/ns/dcat#"`
12
+
13
+ The context root for DCAT vocabulary.
14
+
15
+ ### Namespace
16
+
17
+ > `readonly` **Namespace**: `"http://www.w3.org/ns/dcat#"` = `"http://www.w3.org/ns/dcat#"`
18
+
19
+ The namespace for DCAT terms
20
+
21
+ ### ContextRedirect
22
+
23
+ > `readonly` **ContextRedirect**: `"https://www.w3.org/ns/dcat.jsonld"` = `"https://www.w3.org/ns/dcat.jsonld"`
24
+
25
+ The redirect URL for the DCAT context, used for JSON-LD processing.
26
+
27
+ ### ContextRdf
28
+
29
+ > `readonly` **ContextRdf**: `"http://www.w3.org/2000/01/rdf-schema#"` = `"http://www.w3.org/2000/01/rdf-schema#"`
30
+
31
+ The context for RDF vocabulary.
32
+
33
+ #### See
34
+
35
+ https://www.w3.org/TR/rdf-schema/
36
+
37
+ ### ContextRdfRedirect
38
+
39
+ > `readonly` **ContextRdfRedirect**: `"https://schema.twindev.org/w3c-rdf/types.jsonld"` = `"https://schema.twindev.org/w3c-rdf/types.jsonld"`
40
+
41
+ The context for RDF vocabulary Json-LD.
42
+
43
+ #### See
44
+
45
+ https://www.w3.org/TR/rdf-schema/
46
+
47
+ ### ContextSpdx
48
+
49
+ > `readonly` **ContextSpdx**: `"http://spdx.org/rdf/terms#"` = `"http://spdx.org/rdf/terms#"`
50
+
51
+ The context for SPDX (Software Package Data Exchange) vocabulary.
52
+
53
+ #### See
54
+
55
+ https://spdx.org/rdf/terms
56
+
57
+ ### ContextProv
58
+
59
+ > `readonly` **ContextProv**: `"http://www.w3.org/ns/prov#"` = `"http://www.w3.org/ns/prov#"`
60
+
61
+ The context for PROV (Provenance) vocabulary.
62
+
63
+ #### See
64
+
65
+ https://www.w3.org/ns/prov
66
+
67
+ ## See
68
+
69
+ https://www.w3.org/TR/vocab-dcat-3/
@@ -0,0 +1,103 @@
1
+ # Variable: DcatRelationshipType
2
+
3
+ > `const` **DcatRelationshipType**: `object`
4
+
5
+ DCAT relationship types for describing qualified relationships between resources.
6
+ These are used with the dcat:qualifiedRelation property.
7
+
8
+ ## Type Declaration
9
+
10
+ ### HadRole
11
+
12
+ > `readonly` **HadRole**: `"hadRole"` = `"hadRole"`
13
+
14
+ The function of an entity with respect to another resource.
15
+ Used in qualified relationships to specify the role.
16
+
17
+ #### See
18
+
19
+ https://www.w3.org/TR/vocab-dcat-3/#Property:relationship_had_role
20
+
21
+ ### Replaces
22
+
23
+ > `readonly` **Replaces**: `"replaces"` = `"replaces"`
24
+
25
+ A related resource that is supplanted, displaced, or superseded by the described resource.
26
+
27
+ #### See
28
+
29
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_replaces
30
+
31
+ ### IsReplacedBy
32
+
33
+ > `readonly` **IsReplacedBy**: `"isReplacedBy"` = `"isReplacedBy"`
34
+
35
+ A related resource that supplants, displaces, or supersedes the described resource.
36
+
37
+ #### See
38
+
39
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_replaced_by
40
+
41
+ ### HasVersion
42
+
43
+ > `readonly` **HasVersion**: `"hasVersion"` = `"hasVersion"`
44
+
45
+ A related resource that is a version, edition, or adaptation of the described resource.
46
+
47
+ #### See
48
+
49
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_has_version
50
+
51
+ ### IsVersionOf
52
+
53
+ > `readonly` **IsVersionOf**: `"isVersionOf"` = `"isVersionOf"`
54
+
55
+ A related resource of which the described resource is a version, edition, or adaptation.
56
+
57
+ #### See
58
+
59
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_version_of
60
+
61
+ ### IsReferencedBy
62
+
63
+ > `readonly` **IsReferencedBy**: `"isReferencedBy"` = `"isReferencedBy"`
64
+
65
+ A related resource that references, cites, or otherwise points to the described resource.
66
+
67
+ #### See
68
+
69
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_referenced_by
70
+
71
+ ### References
72
+
73
+ > `readonly` **References**: `"references"` = `"references"`
74
+
75
+ A related resource that is referenced, cited, or otherwise pointed to by the described resource.
76
+
77
+ #### See
78
+
79
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_references
80
+
81
+ ### Requires
82
+
83
+ > `readonly` **Requires**: `"requires"` = `"requires"`
84
+
85
+ A related resource that requires the described resource to support its function, delivery, or coherence.
86
+
87
+ #### See
88
+
89
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_requires
90
+
91
+ ### IsRequiredBy
92
+
93
+ > `readonly` **IsRequiredBy**: `"isRequiredBy"` = `"isRequiredBy"`
94
+
95
+ A related resource that is required by the described resource to support its function, delivery, or coherence.
96
+
97
+ #### See
98
+
99
+ https://www.w3.org/TR/vocab-dcat-3/#Property:resource_is_required_by
100
+
101
+ ## See
102
+
103
+ https://www.w3.org/TR/vocab-dcat-3/#qualified-forms
@@ -0,0 +1 @@
1
+ {}
package/package.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "name": "@twin.org/standards-w3c-dcat",
3
+ "version": "0.0.3-next.10",
4
+ "description": "Models which define the structure of W3C DCAT Standard",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/twinfoundation/standards.git",
8
+ "directory": "packages/standards-w3c-dcat"
9
+ },
10
+ "author": "cornel.filip@iota.org",
11
+ "license": "Apache-2.0",
12
+ "type": "module",
13
+ "engines": {
14
+ "node": ">=20.0.0"
15
+ },
16
+ "dependencies": {
17
+ "@twin.org/data-json-ld": "next",
18
+ "@twin.org/standards-dublin-core": "0.0.3-next.10",
19
+ "@twin.org/standards-foaf": "0.0.3-next.10",
20
+ "@twin.org/standards-w3c-odrl": "0.0.3-next.10",
21
+ "@twin.org/standards-w3c-vcard": "0.0.3-next.10",
22
+ "@twin.org/web": "next"
23
+ },
24
+ "main": "./dist/es/index.js",
25
+ "types": "./dist/types/index.d.ts",
26
+ "exports": {
27
+ ".": {
28
+ "types": "./dist/types/index.d.ts",
29
+ "import": "./dist/es/index.js",
30
+ "default": "./dist/es/index.js"
31
+ },
32
+ "./locales/*.json": "./locales/*.json"
33
+ },
34
+ "files": [
35
+ "dist/es",
36
+ "dist/types",
37
+ "locales",
38
+ "docs"
39
+ ],
40
+ "keywords": [
41
+ "twin",
42
+ "trade",
43
+ "iota",
44
+ "framework",
45
+ "blockchain",
46
+ "standards",
47
+ "dcat",
48
+ "catalog",
49
+ "w3c",
50
+ "data-catalog",
51
+ "metadata"
52
+ ],
53
+ "bugs": {
54
+ "url": "git+https://github.com/twinfoundation/standards/issues"
55
+ },
56
+ "homepage": "https://twindev.org"
57
+ }