@twin.org/standards-gaia-x 0.0.2-next.9 → 0.0.3-next.2

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 (56) hide show
  1. package/dist/es/dataTypes/gaiaXDataTypes.js +56 -0
  2. package/dist/es/dataTypes/gaiaXDataTypes.js.map +1 -0
  3. package/dist/es/index.js +14 -0
  4. package/dist/es/index.js.map +1 -0
  5. package/dist/es/models/IAddress.js +2 -0
  6. package/dist/es/models/IAddress.js.map +1 -0
  7. package/dist/es/models/IDataExchangeComponent.js +2 -0
  8. package/dist/es/models/IDataExchangeComponent.js.map +1 -0
  9. package/dist/es/models/IDataResource.js +2 -0
  10. package/dist/es/models/IDataResource.js.map +1 -0
  11. package/dist/es/models/IEndpoint.js +2 -0
  12. package/dist/es/models/IEndpoint.js.map +1 -0
  13. package/dist/es/models/IGaiaXEntity.js +2 -0
  14. package/dist/es/models/IGaiaXEntity.js.map +1 -0
  15. package/dist/es/models/ILegalPerson.js +2 -0
  16. package/dist/es/models/ILegalPerson.js.map +1 -0
  17. package/dist/es/models/IRegistrationNumber.js +2 -0
  18. package/dist/es/models/IRegistrationNumber.js.map +1 -0
  19. package/dist/es/models/IServiceOffering.js +2 -0
  20. package/dist/es/models/IServiceOffering.js.map +1 -0
  21. package/dist/es/models/gaiaXContextType.js +2 -0
  22. package/dist/es/models/gaiaXContextType.js.map +1 -0
  23. package/dist/es/models/gaiaXContexts.js +13 -0
  24. package/dist/es/models/gaiaXContexts.js.map +1 -0
  25. package/dist/es/models/gaiaXTypes.js +61 -0
  26. package/dist/es/models/gaiaXTypes.js.map +1 -0
  27. package/dist/es/schemas/Address.json +115 -0
  28. package/dist/es/schemas/DataExchangeComponent.json +164 -0
  29. package/dist/es/schemas/DataResource.json +325 -0
  30. package/dist/es/schemas/Endpoint.json +120 -0
  31. package/dist/es/schemas/LegalPerson.json +403 -0
  32. package/dist/es/schemas/RegistrationNumber.json +152 -0
  33. package/dist/es/schemas/ServiceOffering.json +425 -0
  34. package/dist/types/index.d.ts +11 -11
  35. package/dist/types/models/IAddress.d.ts +1 -1
  36. package/dist/types/models/IDataExchangeComponent.d.ts +2 -2
  37. package/dist/types/models/IDataResource.d.ts +7 -6
  38. package/dist/types/models/IEndpoint.d.ts +1 -1
  39. package/dist/types/models/IGaiaXEntity.d.ts +1 -1
  40. package/dist/types/models/ILegalPerson.d.ts +4 -4
  41. package/dist/types/models/IRegistrationNumber.d.ts +1 -1
  42. package/dist/types/models/IServiceOffering.d.ts +8 -7
  43. package/dist/types/models/gaiaXContextType.d.ts +1 -1
  44. package/dist/types/models/gaiaXContexts.d.ts +1 -5
  45. package/docs/changelog.md +111 -0
  46. package/docs/reference/interfaces/IAddress.md +2 -2
  47. package/docs/reference/interfaces/IDataExchangeComponent.md +1 -1
  48. package/docs/reference/interfaces/IDataResource.md +2 -2
  49. package/docs/reference/interfaces/IEndpoint.md +2 -2
  50. package/docs/reference/interfaces/ILegalPerson.md +1 -1
  51. package/docs/reference/interfaces/IRegistrationNumber.md +1 -1
  52. package/docs/reference/interfaces/IServiceOffering.md +4 -4
  53. package/docs/reference/variables/GaiaXContexts.md +1 -7
  54. package/package.json +22 -9
  55. package/dist/cjs/index.cjs +0 -1935
  56. package/dist/esm/index.mjs +0 -1931
package/dist/es/schemas/DataResource.json ADDED
@@ -0,0 +1,325 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.twindev.org/gaia-x-loire/DataResource",
4
+ "description": "A Data Resource as defined by Gaia-X. See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.",
5
+ "type": "object",
6
+ "properties": {
7
+ "@context": {
8
+ "description": "The Gaia-X JSON-LD context type.",
9
+ "anyOf": [
10
+ {
11
+ "type": "string",
12
+ "const": "https://schema.twindev.org/gaia-x-loire/"
13
+ },
14
+ {
15
+ "type": "array",
16
+ "minItems": 2,
17
+ "prefixItems": [
18
+ {
19
+ "type": "string",
20
+ "const": "https://schema.twindev.org/gaia-x-loire/"
21
+ },
22
+ {
23
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
24
+ }
25
+ ],
26
+ "items": {
27
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
28
+ }
29
+ },
30
+ {
31
+ "type": "array",
32
+ "minItems": 2,
33
+ "prefixItems": [
34
+ {
35
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
36
+ },
37
+ {
38
+ "type": "string",
39
+ "const": "https://schema.twindev.org/gaia-x-loire/"
40
+ }
41
+ ],
42
+ "items": {
43
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
44
+ }
45
+ }
46
+ ]
47
+ },
48
+ "@id": {
49
+ "anyOf": [
50
+ {
51
+ "type": "string"
52
+ },
53
+ {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "string"
57
+ }
58
+ }
59
+ ]
60
+ },
61
+ "@included": {
62
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
63
+ },
64
+ "@graph": {
65
+ "anyOf": [
66
+ {
67
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
68
+ },
69
+ {
70
+ "type": "array",
71
+ "items": {
72
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
73
+ }
74
+ }
75
+ ]
76
+ },
77
+ "@nest": {
78
+ "anyOf": [
79
+ {
80
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
81
+ },
82
+ {
83
+ "type": "array",
84
+ "items": {
85
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
86
+ }
87
+ }
88
+ ]
89
+ },
90
+ "@type": {
91
+ "anyOf": [
92
+ {
93
+ "type": "string"
94
+ },
95
+ {
96
+ "type": "array",
97
+ "items": {
98
+ "type": "string"
99
+ }
100
+ }
101
+ ]
102
+ },
103
+ "@reverse": {
104
+ "type": "object",
105
+ "additionalProperties": {
106
+ "type": "string"
107
+ }
108
+ },
109
+ "@index": {
110
+ "type": "string"
111
+ },
112
+ "id": {
113
+ "type": "string",
114
+ "description": "Subject Id"
115
+ },
116
+ "name": {
117
+ "type": "string",
118
+ "description": "The Resource Name"
119
+ },
120
+ "description": {
121
+ "type": "string",
122
+ "description": "Description of the Gaia-X entity."
123
+ },
124
+ "type": {
125
+ "type": "string",
126
+ "const": "DataResource",
127
+ "description": "Subject type"
128
+ },
129
+ "exposedThrough": {
130
+ "anyOf": [
131
+ {
132
+ "$ref": "https://schema.twindev.org/gaia-x-loire/DataExchangeComponent"
133
+ },
134
+ {
135
+ "type": "string"
136
+ },
137
+ {
138
+ "type": "object",
139
+ "additionalProperties": {
140
+ "anyOf": [
141
+ {
142
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
143
+ },
144
+ {
145
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
146
+ },
147
+ {
148
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
149
+ },
150
+ {
151
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
152
+ },
153
+ {
154
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
155
+ },
156
+ {
157
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
158
+ },
159
+ {
160
+ "type": "array"
161
+ }
162
+ ]
163
+ },
164
+ "properties": {
165
+ "id": {
166
+ "type": "string"
167
+ },
168
+ "type": {
169
+ "type": "string",
170
+ "const": "DataExchangeComponent"
171
+ },
172
+ "@context": {
173
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
174
+ },
175
+ "@id": {
176
+ "anyOf": [
177
+ {
178
+ "type": "string"
179
+ },
180
+ {
181
+ "type": "array",
182
+ "items": {
183
+ "type": "string"
184
+ }
185
+ }
186
+ ]
187
+ },
188
+ "@included": {
189
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
190
+ },
191
+ "@graph": {
192
+ "anyOf": [
193
+ {
194
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
195
+ },
196
+ {
197
+ "type": "array",
198
+ "items": {
199
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
200
+ }
201
+ }
202
+ ]
203
+ },
204
+ "@nest": {
205
+ "anyOf": [
206
+ {
207
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
208
+ },
209
+ {
210
+ "type": "array",
211
+ "items": {
212
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
213
+ }
214
+ }
215
+ ]
216
+ },
217
+ "@type": {
218
+ "anyOf": [
219
+ {
220
+ "type": "string"
221
+ },
222
+ {
223
+ "type": "array",
224
+ "items": {
225
+ "type": "string"
226
+ }
227
+ }
228
+ ]
229
+ },
230
+ "@reverse": {
231
+ "type": "object",
232
+ "additionalProperties": {
233
+ "type": "string"
234
+ }
235
+ },
236
+ "@index": {
237
+ "type": "string"
238
+ }
239
+ },
240
+ "required": [
241
+ "id",
242
+ "type"
243
+ ]
244
+ }
245
+ ],
246
+ "description": "Exposed through a Data Exchange Component. 'string' in case just an Id pointing to the Data Exchange Component is supplied the third case covers the idiom where a JSON-LD Node is supplied with id and type."
247
+ },
248
+ "producedBy": {
249
+ "anyOf": [
250
+ {
251
+ "$ref": "https://schema.twindev.org/gaia-x-loire/LegalPerson"
252
+ },
253
+ {
254
+ "type": "string"
255
+ }
256
+ ],
257
+ "description": "Who is the data producer"
258
+ },
259
+ "license": {
260
+ "type": "string",
261
+ "description": "Pointer (URL) to the license"
262
+ },
263
+ "copyrightOwnedBy": {
264
+ "anyOf": [
265
+ {
266
+ "$ref": "https://schema.twindev.org/gaia-x-loire/LegalPerson"
267
+ },
268
+ {
269
+ "type": "string"
270
+ }
271
+ ],
272
+ "description": "Copyright owner"
273
+ },
274
+ "resourcePolicy": {
275
+ "description": "Object or array data type",
276
+ "anyOf": [
277
+ {
278
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
279
+ },
280
+ {
281
+ "type": "array",
282
+ "items": {
283
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
284
+ }
285
+ }
286
+ ]
287
+ }
288
+ },
289
+ "required": [
290
+ "@context",
291
+ "copyrightOwnedBy",
292
+ "exposedThrough",
293
+ "id",
294
+ "license",
295
+ "name",
296
+ "producedBy",
297
+ "resourcePolicy",
298
+ "type"
299
+ ],
300
+ "additionalProperties": {
301
+ "anyOf": [
302
+ {
303
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
304
+ },
305
+ {
306
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
307
+ },
308
+ {
309
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
310
+ },
311
+ {
312
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
313
+ },
314
+ {
315
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
316
+ },
317
+ {
318
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
319
+ },
320
+ {
321
+ "type": "array"
322
+ }
323
+ ]
324
+ }
325
+ }
package/dist/es/schemas/Endpoint.json ADDED
@@ -0,0 +1,120 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.twindev.org/gaia-x-loire/Endpoint",
4
+ "description": "Endpoint as defined by the Gaia-X ontology. https://docs.gaia-x.eu/ontology/development/classes/Endpoint",
5
+ "type": "object",
6
+ "properties": {
7
+ "@context": {
8
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
9
+ },
10
+ "@id": {
11
+ "anyOf": [
12
+ {
13
+ "type": "string"
14
+ },
15
+ {
16
+ "type": "array",
17
+ "items": {
18
+ "type": "string"
19
+ }
20
+ }
21
+ ]
22
+ },
23
+ "@included": {
24
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
25
+ },
26
+ "@graph": {
27
+ "anyOf": [
28
+ {
29
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
30
+ },
31
+ {
32
+ "type": "array",
33
+ "items": {
34
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
35
+ }
36
+ }
37
+ ]
38
+ },
39
+ "@nest": {
40
+ "anyOf": [
41
+ {
42
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
43
+ },
44
+ {
45
+ "type": "array",
46
+ "items": {
47
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
48
+ }
49
+ }
50
+ ]
51
+ },
52
+ "@type": {
53
+ "anyOf": [
54
+ {
55
+ "type": "string"
56
+ },
57
+ {
58
+ "type": "array",
59
+ "items": {
60
+ "type": "string"
61
+ }
62
+ }
63
+ ]
64
+ },
65
+ "@reverse": {
66
+ "type": "object",
67
+ "additionalProperties": {
68
+ "type": "string"
69
+ }
70
+ },
71
+ "@index": {
72
+ "type": "string"
73
+ },
74
+ "type": {
75
+ "type": "string",
76
+ "const": "Endpoint",
77
+ "description": "The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node."
78
+ },
79
+ "endpointURL": {
80
+ "type": "string",
81
+ "description": "The endpoint URL"
82
+ },
83
+ "formalDescription": {
84
+ "type": "string",
85
+ "description": "The formal description"
86
+ },
87
+ "standardConformity": {
88
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
89
+ "description": "Standards conformity"
90
+ }
91
+ },
92
+ "required": [
93
+ "endpointURL"
94
+ ],
95
+ "additionalProperties": {
96
+ "anyOf": [
97
+ {
98
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
99
+ },
100
+ {
101
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
102
+ },
103
+ {
104
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
105
+ },
106
+ {
107
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
108
+ },
109
+ {
110
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
111
+ },
112
+ {
113
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
114
+ },
115
+ {
116
+ "type": "array"
117
+ }
118
+ ]
119
+ }
120
+ }