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

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 (105) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/dcatDataTypes.js +80 -49
  3. package/dist/es/dataTypes/dcatDataTypes.js.map +1 -1
  4. package/dist/es/index.js +6 -2
  5. package/dist/es/index.js.map +1 -1
  6. package/dist/es/models/IDcatCatalog.js.map +1 -1
  7. package/dist/es/models/IDcatCatalogBase.js +2 -0
  8. package/dist/es/models/IDcatCatalogBase.js.map +1 -0
  9. package/dist/es/models/IDcatCatalogRecord.js.map +1 -1
  10. package/dist/es/models/IDcatCatalogRecordBase.js +2 -0
  11. package/dist/es/models/IDcatCatalogRecordBase.js.map +1 -0
  12. package/dist/es/models/IDcatDataService.js.map +1 -1
  13. package/dist/es/models/IDcatDataServiceBase.js +2 -0
  14. package/dist/es/models/IDcatDataServiceBase.js.map +1 -0
  15. package/dist/es/models/IDcatDataset.js.map +1 -1
  16. package/dist/es/models/IDcatDatasetBase.js +2 -0
  17. package/dist/es/models/IDcatDatasetBase.js.map +1 -0
  18. package/dist/es/models/IDcatDatasetSeries.js.map +1 -1
  19. package/dist/es/models/IDcatDistribution.js.map +1 -1
  20. package/dist/es/models/IDcatDistributionBase.js +2 -0
  21. package/dist/es/models/IDcatDistributionBase.js.map +1 -0
  22. package/dist/es/models/IDcatRelationship.js.map +1 -1
  23. package/dist/es/models/IDcatResource.js.map +1 -1
  24. package/dist/es/models/IDcatResourceBase.js +2 -0
  25. package/dist/es/models/IDcatResourceBase.js.map +1 -0
  26. package/dist/es/models/IDcatRole.js.map +1 -1
  27. package/dist/es/models/dcatContextType.js.map +1 -1
  28. package/dist/es/models/dcatContexts.js +15 -19
  29. package/dist/es/models/dcatContexts.js.map +1 -1
  30. package/dist/es/schemas/DcatCatalog.json +10 -489
  31. package/dist/es/schemas/DcatCatalogBase.json +109 -0
  32. package/dist/es/schemas/DcatCatalogRecord.json +10 -210
  33. package/dist/es/schemas/DcatCatalogRecordBase.json +76 -0
  34. package/dist/es/schemas/DcatContextType.json +30 -0
  35. package/dist/es/schemas/DcatDataService.json +10 -356
  36. package/dist/es/schemas/DcatDataServiceBase.json +43 -0
  37. package/dist/es/schemas/DcatDataset.json +10 -405
  38. package/dist/es/schemas/DcatDatasetBase.json +94 -0
  39. package/dist/es/schemas/DcatDatasetSeries.json +17 -394
  40. package/dist/es/schemas/DcatDistribution.json +10 -266
  41. package/dist/es/schemas/DcatDistributionBase.json +134 -0
  42. package/dist/es/schemas/DcatRelationship.json +11 -170
  43. package/dist/es/schemas/DcatResource.json +10 -340
  44. package/dist/es/schemas/DcatResourceBase.json +663 -0
  45. package/dist/es/schemas/DcatRole.json +15 -167
  46. package/dist/types/dataTypes/dcatDataTypes.d.ts +0 -1
  47. package/dist/types/index.d.ts +6 -2
  48. package/dist/types/models/IDcatCatalog.d.ts +5 -43
  49. package/dist/types/models/IDcatCatalogBase.d.ts +54 -0
  50. package/dist/types/models/IDcatCatalogRecord.d.ts +2 -40
  51. package/dist/types/models/IDcatCatalogRecordBase.d.ts +51 -0
  52. package/dist/types/models/IDcatDataService.d.ts +5 -22
  53. package/dist/types/models/IDcatDataServiceBase.d.ts +31 -0
  54. package/dist/types/models/IDcatDataset.d.ts +5 -51
  55. package/dist/types/models/IDcatDatasetBase.d.ts +60 -0
  56. package/dist/types/models/IDcatDatasetSeries.d.ts +6 -0
  57. package/dist/types/models/IDcatDistribution.d.ts +2 -110
  58. package/dist/types/models/IDcatDistributionBase.d.ts +123 -0
  59. package/dist/types/models/IDcatRelationship.d.ts +2 -2
  60. package/dist/types/models/IDcatResource.d.ts +3 -109
  61. package/dist/types/models/IDcatResourceBase.d.ts +120 -0
  62. package/dist/types/models/IDcatRole.d.ts +8 -5
  63. package/dist/types/models/dcatContextType.d.ts +4 -4
  64. package/dist/types/models/dcatContexts.d.ts +15 -19
  65. package/docs/changelog.md +1125 -11
  66. package/docs/examples.md +25 -1
  67. package/docs/reference/classes/DcatDataTypes.md +2 -3
  68. package/docs/reference/index.md +6 -11
  69. package/docs/reference/interfaces/IDcatCatalog.md +138 -106
  70. package/docs/reference/interfaces/IDcatCatalogBase.md +558 -0
  71. package/docs/reference/interfaces/IDcatCatalogRecord.md +53 -25
  72. package/docs/reference/interfaces/IDcatCatalogRecordBase.md +101 -0
  73. package/docs/reference/interfaces/IDcatDataService.md +90 -74
  74. package/docs/reference/interfaces/IDcatDataServiceBase.md +382 -0
  75. package/docs/reference/interfaces/IDcatDataset.md +120 -85
  76. package/docs/reference/interfaces/IDcatDatasetBase.md +443 -0
  77. package/docs/reference/interfaces/IDcatDatasetSeries.md +88 -68
  78. package/docs/reference/interfaces/IDcatDistribution.md +137 -53
  79. package/docs/reference/interfaces/IDcatDistributionBase.md +269 -0
  80. package/docs/reference/interfaces/IDcatRelationship.md +6 -22
  81. package/docs/reference/interfaces/IDcatResource.md +132 -57
  82. package/docs/reference/interfaces/IDcatResourceBase.md +260 -0
  83. package/docs/reference/interfaces/IDcatRole.md +11 -19
  84. package/docs/reference/type-aliases/DcatContextType.md +4 -4
  85. package/docs/reference/variables/DcatClasses.md +9 -9
  86. package/docs/reference/variables/DcatContexts.md +21 -33
  87. package/docs/reference/variables/DcatRelationshipType.md +9 -9
  88. package/package.json +10 -10
  89. package/dist/es/models/types/dcatContextFreeTypes.js +0 -4
  90. package/dist/es/models/types/dcatContextFreeTypes.js.map +0 -1
  91. package/dist/es/models/types/dcatPropertyTypes.js +0 -4
  92. package/dist/es/models/types/dcatPropertyTypes.js.map +0 -1
  93. package/dist/types/models/types/dcatContextFreeTypes.d.ts +0 -40
  94. package/dist/types/models/types/dcatPropertyTypes.d.ts +0 -29
  95. package/docs/reference/type-aliases/CatalogOptionalContext.md +0 -11
  96. package/docs/reference/type-aliases/CatalogRecordOptionalContext.md +0 -11
  97. package/docs/reference/type-aliases/DataServiceOptionalContext.md +0 -11
  98. package/docs/reference/type-aliases/DatasetOptionalContext.md +0 -11
  99. package/docs/reference/type-aliases/DcatDateTimeType.md +0 -6
  100. package/docs/reference/type-aliases/DcatDecimalType.md +0 -5
  101. package/docs/reference/type-aliases/DcatDurationType.md +0 -5
  102. package/docs/reference/type-aliases/DcatIriType.md +0 -5
  103. package/docs/reference/type-aliases/DcatLiteralType.md +0 -5
  104. package/docs/reference/type-aliases/DcatNonNegativeIntegerType.md +0 -5
  105. package/docs/reference/type-aliases/DistributionOptionalContext.md +0 -11
package/docs/examples.md CHANGED
@@ -1 +1,25 @@
1
- # @twin.org/standards-w3c-dcat - Examples
1
+ # Standards W3C DCAT Examples
2
+
3
+ These snippets register DCAT schemas and model a catalogue record for publication workflows.
4
+
5
+ ## DcatDataTypes
6
+
7
+ ```typescript
8
+ import {
9
+ DcatClasses,
10
+ DcatContexts,
11
+ DcatDataTypes,
12
+ type IDcatCatalog
13
+ } from '@twin.org/standards-w3c-dcat';
14
+
15
+ DcatDataTypes.registerRedirects();
16
+ DcatDataTypes.registerTypes();
17
+
18
+ const catalog: IDcatCatalog = {
19
+ '@context': DcatContexts.Context,
20
+ type: DcatClasses.Catalog,
21
+ title: 'Operational Data Catalogue'
22
+ };
23
+
24
+ console.log(catalog.type); // dcat:Catalog
25
+ ```
@@ -14,12 +14,11 @@ Class providing DCAT data type utilities and JSON-LD redirect registration.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### registerRedirects()
17
+ ### registerRedirects() {#registerredirects}
18
18
 
19
19
  > `static` **registerRedirects**(): `void`
20
20
 
21
21
  Register redirects for DCAT namespace to enable offline JSON-LD processing.
22
- This maps the W3C DCAT namespace to a local redirect URL for faster resolution.
23
22
 
24
23
  #### Returns
25
24
 
@@ -27,7 +26,7 @@ This maps the W3C DCAT namespace to a local redirect URL for faster resolution.
27
26
 
28
27
  ***
29
28
 
30
- ### registerTypes()
29
+ ### registerTypes() {#registertypes}
31
30
 
32
31
  > `static` **registerTypes**(): `void`
33
32
 
@@ -7,13 +7,19 @@
7
7
  ## Interfaces
8
8
 
9
9
  - [IDcatCatalog](interfaces/IDcatCatalog.md)
10
+ - [IDcatCatalogBase](interfaces/IDcatCatalogBase.md)
10
11
  - [IDcatCatalogRecord](interfaces/IDcatCatalogRecord.md)
12
+ - [IDcatCatalogRecordBase](interfaces/IDcatCatalogRecordBase.md)
11
13
  - [IDcatDataService](interfaces/IDcatDataService.md)
14
+ - [IDcatDataServiceBase](interfaces/IDcatDataServiceBase.md)
12
15
  - [IDcatDataset](interfaces/IDcatDataset.md)
16
+ - [IDcatDatasetBase](interfaces/IDcatDatasetBase.md)
13
17
  - [IDcatDatasetSeries](interfaces/IDcatDatasetSeries.md)
14
18
  - [IDcatDistribution](interfaces/IDcatDistribution.md)
19
+ - [IDcatDistributionBase](interfaces/IDcatDistributionBase.md)
15
20
  - [IDcatRelationship](interfaces/IDcatRelationship.md)
16
21
  - [IDcatResource](interfaces/IDcatResource.md)
22
+ - [IDcatResourceBase](interfaces/IDcatResourceBase.md)
17
23
  - [IDcatRole](interfaces/IDcatRole.md)
18
24
 
19
25
  ## Type Aliases
@@ -22,17 +28,6 @@
22
28
  - [DcatContextType](type-aliases/DcatContextType.md)
23
29
  - [DcatContexts](type-aliases/DcatContexts.md)
24
30
  - [DcatRelationshipType](type-aliases/DcatRelationshipType.md)
25
- - [DatasetOptionalContext](type-aliases/DatasetOptionalContext.md)
26
- - [DataServiceOptionalContext](type-aliases/DataServiceOptionalContext.md)
27
- - [CatalogOptionalContext](type-aliases/CatalogOptionalContext.md)
28
- - [CatalogRecordOptionalContext](type-aliases/CatalogRecordOptionalContext.md)
29
- - [DistributionOptionalContext](type-aliases/DistributionOptionalContext.md)
30
- - [DcatLiteralType](type-aliases/DcatLiteralType.md)
31
- - [DcatIriType](type-aliases/DcatIriType.md)
32
- - [DcatDateTimeType](type-aliases/DcatDateTimeType.md)
33
- - [DcatDurationType](type-aliases/DcatDurationType.md)
34
- - [DcatDecimalType](type-aliases/DcatDecimalType.md)
35
- - [DcatNonNegativeIntegerType](type-aliases/DcatNonNegativeIntegerType.md)
36
31
 
37
32
  ## Variables
38
33