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

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 +170 -0
  29. package/dist/es/schemas/DataResource.json +329 -0
  30. package/dist/es/schemas/Endpoint.json +120 -0
  31. package/dist/es/schemas/LegalPerson.json +407 -0
  32. package/dist/es/schemas/RegistrationNumber.json +152 -0
  33. package/dist/es/schemas/ServiceOffering.json +429 -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 +97 -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,329 @@
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
+ "items": {
18
+ "anyOf": [
19
+ {
20
+ "type": "string",
21
+ "const": "https://schema.twindev.org/gaia-x-loire/"
22
+ },
23
+ {
24
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
25
+ }
26
+ ]
27
+ },
28
+ "additionalItems": {
29
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
30
+ }
31
+ },
32
+ {
33
+ "type": "array",
34
+ "minItems": 2,
35
+ "items": {
36
+ "anyOf": [
37
+ {
38
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
39
+ },
40
+ {
41
+ "type": "string",
42
+ "const": "https://schema.twindev.org/gaia-x-loire/"
43
+ }
44
+ ]
45
+ },
46
+ "additionalItems": {
47
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
48
+ }
49
+ }
50
+ ]
51
+ },
52
+ "@id": {
53
+ "anyOf": [
54
+ {
55
+ "type": "string"
56
+ },
57
+ {
58
+ "type": "array",
59
+ "items": {
60
+ "type": "string"
61
+ }
62
+ }
63
+ ]
64
+ },
65
+ "@included": {
66
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
67
+ },
68
+ "@graph": {
69
+ "anyOf": [
70
+ {
71
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
72
+ },
73
+ {
74
+ "type": "array",
75
+ "items": {
76
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
77
+ }
78
+ }
79
+ ]
80
+ },
81
+ "@nest": {
82
+ "anyOf": [
83
+ {
84
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
85
+ },
86
+ {
87
+ "type": "array",
88
+ "items": {
89
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
90
+ }
91
+ }
92
+ ]
93
+ },
94
+ "@type": {
95
+ "anyOf": [
96
+ {
97
+ "type": "string"
98
+ },
99
+ {
100
+ "type": "array",
101
+ "items": {
102
+ "type": "string"
103
+ }
104
+ }
105
+ ]
106
+ },
107
+ "@reverse": {
108
+ "type": "object",
109
+ "additionalProperties": {
110
+ "type": "string"
111
+ }
112
+ },
113
+ "@index": {
114
+ "type": "string"
115
+ },
116
+ "id": {
117
+ "type": "string",
118
+ "description": "Subject Id"
119
+ },
120
+ "name": {
121
+ "type": "string",
122
+ "description": "The Resource Name"
123
+ },
124
+ "description": {
125
+ "type": "string",
126
+ "description": "Description of the Gaia-X entity."
127
+ },
128
+ "type": {
129
+ "type": "string",
130
+ "const": "DataResource",
131
+ "description": "Subject type"
132
+ },
133
+ "exposedThrough": {
134
+ "anyOf": [
135
+ {
136
+ "$ref": "https://schema.twindev.org/gaia-x-loire/DataExchangeComponent"
137
+ },
138
+ {
139
+ "type": "string"
140
+ },
141
+ {
142
+ "type": "object",
143
+ "additionalProperties": {
144
+ "anyOf": [
145
+ {
146
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
147
+ },
148
+ {
149
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
150
+ },
151
+ {
152
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
153
+ },
154
+ {
155
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
156
+ },
157
+ {
158
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
159
+ },
160
+ {
161
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
162
+ },
163
+ {
164
+ "type": "array"
165
+ }
166
+ ]
167
+ },
168
+ "properties": {
169
+ "id": {
170
+ "type": "string"
171
+ },
172
+ "type": {
173
+ "type": "string",
174
+ "const": "DataExchangeComponent"
175
+ },
176
+ "@context": {
177
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
178
+ },
179
+ "@id": {
180
+ "anyOf": [
181
+ {
182
+ "type": "string"
183
+ },
184
+ {
185
+ "type": "array",
186
+ "items": {
187
+ "type": "string"
188
+ }
189
+ }
190
+ ]
191
+ },
192
+ "@included": {
193
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
194
+ },
195
+ "@graph": {
196
+ "anyOf": [
197
+ {
198
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
199
+ },
200
+ {
201
+ "type": "array",
202
+ "items": {
203
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
204
+ }
205
+ }
206
+ ]
207
+ },
208
+ "@nest": {
209
+ "anyOf": [
210
+ {
211
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
212
+ },
213
+ {
214
+ "type": "array",
215
+ "items": {
216
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
217
+ }
218
+ }
219
+ ]
220
+ },
221
+ "@type": {
222
+ "anyOf": [
223
+ {
224
+ "type": "string"
225
+ },
226
+ {
227
+ "type": "array",
228
+ "items": {
229
+ "type": "string"
230
+ }
231
+ }
232
+ ]
233
+ },
234
+ "@reverse": {
235
+ "type": "object",
236
+ "additionalProperties": {
237
+ "type": "string"
238
+ }
239
+ },
240
+ "@index": {
241
+ "type": "string"
242
+ }
243
+ },
244
+ "required": [
245
+ "id",
246
+ "type"
247
+ ]
248
+ }
249
+ ],
250
+ "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."
251
+ },
252
+ "producedBy": {
253
+ "anyOf": [
254
+ {
255
+ "$ref": "https://schema.twindev.org/gaia-x-loire/LegalPerson"
256
+ },
257
+ {
258
+ "type": "string"
259
+ }
260
+ ],
261
+ "description": "Who is the data producer"
262
+ },
263
+ "license": {
264
+ "type": "string",
265
+ "description": "Pointer (URL) to the license"
266
+ },
267
+ "copyrightOwnedBy": {
268
+ "anyOf": [
269
+ {
270
+ "$ref": "https://schema.twindev.org/gaia-x-loire/LegalPerson"
271
+ },
272
+ {
273
+ "type": "string"
274
+ }
275
+ ],
276
+ "description": "Copyright owner"
277
+ },
278
+ "resourcePolicy": {
279
+ "description": "Object or array data type",
280
+ "anyOf": [
281
+ {
282
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
283
+ },
284
+ {
285
+ "type": "array",
286
+ "items": {
287
+ "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicy"
288
+ }
289
+ }
290
+ ]
291
+ }
292
+ },
293
+ "required": [
294
+ "@context",
295
+ "copyrightOwnedBy",
296
+ "exposedThrough",
297
+ "id",
298
+ "license",
299
+ "name",
300
+ "producedBy",
301
+ "resourcePolicy",
302
+ "type"
303
+ ],
304
+ "additionalProperties": {
305
+ "anyOf": [
306
+ {
307
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
308
+ },
309
+ {
310
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
311
+ },
312
+ {
313
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
314
+ },
315
+ {
316
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
317
+ },
318
+ {
319
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
320
+ },
321
+ {
322
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
323
+ },
324
+ {
325
+ "type": "array"
326
+ }
327
+ ]
328
+ }
329
+ }
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
+ }