@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/LegalPerson.json ADDED
@@ -0,0 +1,403 @@
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
+ "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": "The Id."
115
+ },
116
+ "name": {
117
+ "type": "string",
118
+ "description": "Human readable Name."
119
+ },
120
+ "description": {
121
+ "type": "string",
122
+ "description": "Description of the Gaia-X entity."
123
+ },
124
+ "type": {
125
+ "type": "string",
126
+ "const": "LegalPerson",
127
+ "description": "JSON-LD type."
128
+ },
129
+ "registrationNumber": {
130
+ "$ref": "https://schema.twindev.org/gaia-x-loire/RegistrationNumber",
131
+ "description": "The legal registration number."
132
+ },
133
+ "legalName": {
134
+ "type": "string",
135
+ "description": "The legal name."
136
+ },
137
+ "legalAddress": {
138
+ "$ref": "https://schema.twindev.org/gaia-x-loire/Address",
139
+ "description": "Legal Address"
140
+ },
141
+ "headquartersAddress": {
142
+ "$ref": "https://schema.twindev.org/gaia-x-loire/Address",
143
+ "description": "Headquarters address."
144
+ },
145
+ "parentOrganizationOf": {
146
+ "type": "array",
147
+ "items": {
148
+ "type": "object",
149
+ "additionalProperties": {
150
+ "anyOf": [
151
+ {
152
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
153
+ },
154
+ {
155
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
156
+ },
157
+ {
158
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
159
+ },
160
+ {
161
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
162
+ },
163
+ {
164
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
165
+ },
166
+ {
167
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
168
+ },
169
+ {
170
+ "type": "array"
171
+ }
172
+ ]
173
+ },
174
+ "properties": {
175
+ "id": {
176
+ "type": "string"
177
+ },
178
+ "type": {
179
+ "type": "string",
180
+ "const": "LegalPerson"
181
+ },
182
+ "@context": {
183
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
184
+ },
185
+ "@id": {
186
+ "anyOf": [
187
+ {
188
+ "type": "string"
189
+ },
190
+ {
191
+ "type": "array",
192
+ "items": {
193
+ "type": "string"
194
+ }
195
+ }
196
+ ]
197
+ },
198
+ "@included": {
199
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
200
+ },
201
+ "@graph": {
202
+ "anyOf": [
203
+ {
204
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
205
+ },
206
+ {
207
+ "type": "array",
208
+ "items": {
209
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
210
+ }
211
+ }
212
+ ]
213
+ },
214
+ "@nest": {
215
+ "anyOf": [
216
+ {
217
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
218
+ },
219
+ {
220
+ "type": "array",
221
+ "items": {
222
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
223
+ }
224
+ }
225
+ ]
226
+ },
227
+ "@type": {
228
+ "anyOf": [
229
+ {
230
+ "type": "string"
231
+ },
232
+ {
233
+ "type": "array",
234
+ "items": {
235
+ "type": "string"
236
+ }
237
+ }
238
+ ]
239
+ },
240
+ "@reverse": {
241
+ "type": "object",
242
+ "additionalProperties": {
243
+ "type": "string"
244
+ }
245
+ },
246
+ "@index": {
247
+ "type": "string"
248
+ }
249
+ },
250
+ "required": [
251
+ "id",
252
+ "type"
253
+ ]
254
+ },
255
+ "description": "Parent organization."
256
+ },
257
+ "subOrganizationOf": {
258
+ "type": "array",
259
+ "items": {
260
+ "type": "object",
261
+ "additionalProperties": {
262
+ "anyOf": [
263
+ {
264
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
265
+ },
266
+ {
267
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
268
+ },
269
+ {
270
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
271
+ },
272
+ {
273
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
274
+ },
275
+ {
276
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
277
+ },
278
+ {
279
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
280
+ },
281
+ {
282
+ "type": "array"
283
+ }
284
+ ]
285
+ },
286
+ "properties": {
287
+ "id": {
288
+ "type": "string"
289
+ },
290
+ "type": {
291
+ "type": "string",
292
+ "const": "LegalPerson"
293
+ },
294
+ "@context": {
295
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
296
+ },
297
+ "@id": {
298
+ "anyOf": [
299
+ {
300
+ "type": "string"
301
+ },
302
+ {
303
+ "type": "array",
304
+ "items": {
305
+ "type": "string"
306
+ }
307
+ }
308
+ ]
309
+ },
310
+ "@included": {
311
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
312
+ },
313
+ "@graph": {
314
+ "anyOf": [
315
+ {
316
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
317
+ },
318
+ {
319
+ "type": "array",
320
+ "items": {
321
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
322
+ }
323
+ }
324
+ ]
325
+ },
326
+ "@nest": {
327
+ "anyOf": [
328
+ {
329
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
330
+ },
331
+ {
332
+ "type": "array",
333
+ "items": {
334
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
335
+ }
336
+ }
337
+ ]
338
+ },
339
+ "@type": {
340
+ "anyOf": [
341
+ {
342
+ "type": "string"
343
+ },
344
+ {
345
+ "type": "array",
346
+ "items": {
347
+ "type": "string"
348
+ }
349
+ }
350
+ ]
351
+ },
352
+ "@reverse": {
353
+ "type": "object",
354
+ "additionalProperties": {
355
+ "type": "string"
356
+ }
357
+ },
358
+ "@index": {
359
+ "type": "string"
360
+ }
361
+ },
362
+ "required": [
363
+ "id",
364
+ "type"
365
+ ]
366
+ },
367
+ "description": "Sub organization of."
368
+ }
369
+ },
370
+ "required": [
371
+ "@context",
372
+ "id",
373
+ "legalAddress",
374
+ "legalName",
375
+ "registrationNumber",
376
+ "type"
377
+ ],
378
+ "additionalProperties": {
379
+ "anyOf": [
380
+ {
381
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
382
+ },
383
+ {
384
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
385
+ },
386
+ {
387
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
388
+ },
389
+ {
390
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
391
+ },
392
+ {
393
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
394
+ },
395
+ {
396
+ "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
397
+ },
398
+ {
399
+ "type": "array"
400
+ }
401
+ ]
402
+ }
403
+ }
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
+ }