@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/LegalPerson.json ADDED
@@ -0,0 +1,407 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.twindev.org/gaia-x-loire/LegalPerson",
4
+ "description": "A Legal Person as defined by Gaia-X.",
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": "The Id."
119
+ },
120
+ "name": {
121
+ "type": "string",
122
+ "description": "Human readable Name."
123
+ },
124
+ "description": {
125
+ "type": "string",
126
+ "description": "Description of the Gaia-X entity."
127
+ },
128
+ "type": {
129
+ "type": "string",
130
+ "const": "LegalPerson",
131
+ "description": "JSON-LD type."
132
+ },
133
+ "registrationNumber": {
134
+ "$ref": "https://schema.twindev.org/gaia-x-loire/RegistrationNumber",
135
+ "description": "The legal registration number."
136
+ },
137
+ "legalName": {
138
+ "type": "string",
139
+ "description": "The legal name."
140
+ },
141
+ "legalAddress": {
142
+ "$ref": "https://schema.twindev.org/gaia-x-loire/Address",
143
+ "description": "Legal Address"
144
+ },
145
+ "headquartersAddress": {
146
+ "$ref": "https://schema.twindev.org/gaia-x-loire/Address",
147
+ "description": "Headquarters address."
148
+ },
149
+ "parentOrganizationOf": {
150
+ "type": "array",
151
+ "items": {
152
+ "type": "object",
153
+ "additionalProperties": {
154
+ "anyOf": [
155
+ {
156
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
157
+ },
158
+ {
159
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
160
+ },
161
+ {
162
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
163
+ },
164
+ {
165
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
166
+ },
167
+ {
168
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
169
+ },
170
+ {
171
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
172
+ },
173
+ {
174
+ "type": "array"
175
+ }
176
+ ]
177
+ },
178
+ "properties": {
179
+ "id": {
180
+ "type": "string"
181
+ },
182
+ "type": {
183
+ "type": "string",
184
+ "const": "LegalPerson"
185
+ },
186
+ "@context": {
187
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
188
+ },
189
+ "@id": {
190
+ "anyOf": [
191
+ {
192
+ "type": "string"
193
+ },
194
+ {
195
+ "type": "array",
196
+ "items": {
197
+ "type": "string"
198
+ }
199
+ }
200
+ ]
201
+ },
202
+ "@included": {
203
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
204
+ },
205
+ "@graph": {
206
+ "anyOf": [
207
+ {
208
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
209
+ },
210
+ {
211
+ "type": "array",
212
+ "items": {
213
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
214
+ }
215
+ }
216
+ ]
217
+ },
218
+ "@nest": {
219
+ "anyOf": [
220
+ {
221
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
222
+ },
223
+ {
224
+ "type": "array",
225
+ "items": {
226
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
227
+ }
228
+ }
229
+ ]
230
+ },
231
+ "@type": {
232
+ "anyOf": [
233
+ {
234
+ "type": "string"
235
+ },
236
+ {
237
+ "type": "array",
238
+ "items": {
239
+ "type": "string"
240
+ }
241
+ }
242
+ ]
243
+ },
244
+ "@reverse": {
245
+ "type": "object",
246
+ "additionalProperties": {
247
+ "type": "string"
248
+ }
249
+ },
250
+ "@index": {
251
+ "type": "string"
252
+ }
253
+ },
254
+ "required": [
255
+ "id",
256
+ "type"
257
+ ]
258
+ },
259
+ "description": "Parent organization."
260
+ },
261
+ "subOrganizationOf": {
262
+ "type": "array",
263
+ "items": {
264
+ "type": "object",
265
+ "additionalProperties": {
266
+ "anyOf": [
267
+ {
268
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
269
+ },
270
+ {
271
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
272
+ },
273
+ {
274
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
275
+ },
276
+ {
277
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
278
+ },
279
+ {
280
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
281
+ },
282
+ {
283
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
284
+ },
285
+ {
286
+ "type": "array"
287
+ }
288
+ ]
289
+ },
290
+ "properties": {
291
+ "id": {
292
+ "type": "string"
293
+ },
294
+ "type": {
295
+ "type": "string",
296
+ "const": "LegalPerson"
297
+ },
298
+ "@context": {
299
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
300
+ },
301
+ "@id": {
302
+ "anyOf": [
303
+ {
304
+ "type": "string"
305
+ },
306
+ {
307
+ "type": "array",
308
+ "items": {
309
+ "type": "string"
310
+ }
311
+ }
312
+ ]
313
+ },
314
+ "@included": {
315
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
316
+ },
317
+ "@graph": {
318
+ "anyOf": [
319
+ {
320
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
321
+ },
322
+ {
323
+ "type": "array",
324
+ "items": {
325
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
326
+ }
327
+ }
328
+ ]
329
+ },
330
+ "@nest": {
331
+ "anyOf": [
332
+ {
333
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
334
+ },
335
+ {
336
+ "type": "array",
337
+ "items": {
338
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
339
+ }
340
+ }
341
+ ]
342
+ },
343
+ "@type": {
344
+ "anyOf": [
345
+ {
346
+ "type": "string"
347
+ },
348
+ {
349
+ "type": "array",
350
+ "items": {
351
+ "type": "string"
352
+ }
353
+ }
354
+ ]
355
+ },
356
+ "@reverse": {
357
+ "type": "object",
358
+ "additionalProperties": {
359
+ "type": "string"
360
+ }
361
+ },
362
+ "@index": {
363
+ "type": "string"
364
+ }
365
+ },
366
+ "required": [
367
+ "id",
368
+ "type"
369
+ ]
370
+ },
371
+ "description": "Sub organization of."
372
+ }
373
+ },
374
+ "required": [
375
+ "@context",
376
+ "id",
377
+ "legalAddress",
378
+ "legalName",
379
+ "registrationNumber",
380
+ "type"
381
+ ],
382
+ "additionalProperties": {
383
+ "anyOf": [
384
+ {
385
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
386
+ },
387
+ {
388
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
389
+ },
390
+ {
391
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
392
+ },
393
+ {
394
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
395
+ },
396
+ {
397
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
398
+ },
399
+ {
400
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
401
+ },
402
+ {
403
+ "type": "array"
404
+ }
405
+ ]
406
+ }
407
+ }
package/dist/es/schemas/RegistrationNumber.json ADDED
@@ -0,0 +1,152 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.twindev.org/gaia-x-loire/RegistrationNumber",
4
+ "description": "Registration Number as defined by the Gaia-X ontology. https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/",
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
+ "enum": [
77
+ "RegistrationNumber",
78
+ "LocalRegistrationNumber",
79
+ "EORI",
80
+ "EUID",
81
+ "LeiCode",
82
+ "TaxID",
83
+ "VatID"
84
+ ],
85
+ "description": "JSON-LD Type."
86
+ },
87
+ "local": {
88
+ "type": "string",
89
+ "description": "Local Registration."
90
+ },
91
+ "countryCode": {
92
+ "type": "string",
93
+ "description": "Country code. See https://docs.gaia-x.eu/ontology/development/enums/CountryNameAlpha2/"
94
+ },
95
+ "subdivisionCountryCode": {
96
+ "type": "string",
97
+ "description": "Subdivision country code. See https://docs.gaia-x.eu/ontology/development/enums/RegionCode/"
98
+ },
99
+ "vatID": {
100
+ "type": "string",
101
+ "description": "The VAT identification number."
102
+ },
103
+ "leiCode": {
104
+ "type": "string",
105
+ "description": "Unique LEI number as defined by GLEIF."
106
+ },
107
+ "eori": {
108
+ "type": "string",
109
+ "description": "The Economic Operators Registration and Identification number (EORI)."
110
+ },
111
+ "country": {
112
+ "type": "string",
113
+ "description": "The country where the EORI is registered written in plain english"
114
+ },
115
+ "euid": {
116
+ "type": "string",
117
+ "description": "The European Unique Identifier (EUID) for business located in the European Ec."
118
+ },
119
+ "taxId": {
120
+ "type": "string",
121
+ "description": "The company tax ID."
122
+ }
123
+ },
124
+ "required": [
125
+ "type"
126
+ ],
127
+ "additionalProperties": {
128
+ "anyOf": [
129
+ {
130
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
131
+ },
132
+ {
133
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
134
+ },
135
+ {
136
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
137
+ },
138
+ {
139
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
140
+ },
141
+ {
142
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
143
+ },
144
+ {
145
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
146
+ },
147
+ {
148
+ "type": "array"
149
+ }
150
+ ]
151
+ }
152
+ }