@twin.org/standards-gaia-x 0.0.2-next.9 → 0.0.3-next.10
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.
- package/dist/es/dataTypes/gaiaXDataTypes.js +56 -0
- package/dist/es/dataTypes/gaiaXDataTypes.js.map +1 -0
- package/dist/es/index.js +14 -0
- package/dist/es/index.js.map +1 -0
- package/dist/es/models/IGaiaXAddress.js +2 -0
- package/dist/es/models/IGaiaXAddress.js.map +1 -0
- package/dist/es/models/IGaiaXDataExchangeComponent.js +2 -0
- package/dist/es/models/IGaiaXDataExchangeComponent.js.map +1 -0
- package/dist/es/models/IGaiaXDataResource.js +2 -0
- package/dist/es/models/IGaiaXDataResource.js.map +1 -0
- package/dist/es/models/IGaiaXEndpoint.js +2 -0
- package/dist/es/models/IGaiaXEndpoint.js.map +1 -0
- package/dist/es/models/IGaiaXEntity.js +2 -0
- package/dist/es/models/IGaiaXEntity.js.map +1 -0
- package/dist/es/models/IGaiaXLegalPerson.js +2 -0
- package/dist/es/models/IGaiaXLegalPerson.js.map +1 -0
- package/dist/es/models/IGaiaXRegistrationNumber.js +2 -0
- package/dist/es/models/IGaiaXRegistrationNumber.js.map +1 -0
- package/dist/es/models/IGaiaXServiceOffering.js +2 -0
- package/dist/es/models/IGaiaXServiceOffering.js.map +1 -0
- package/dist/es/models/gaiaXContextType.js +2 -0
- package/dist/es/models/gaiaXContextType.js.map +1 -0
- package/dist/es/models/gaiaXContexts.js +13 -0
- package/dist/es/models/gaiaXContexts.js.map +1 -0
- package/dist/es/models/gaiaXTypes.js +61 -0
- package/dist/es/models/gaiaXTypes.js.map +1 -0
- package/dist/es/schemas/Address.json +115 -0
- package/dist/es/schemas/DataExchangeComponent.json +164 -0
- package/dist/es/schemas/DataResource.json +325 -0
- package/dist/es/schemas/Endpoint.json +120 -0
- package/dist/es/schemas/LegalPerson.json +403 -0
- package/dist/es/schemas/RegistrationNumber.json +152 -0
- package/dist/es/schemas/ServiceOffering.json +425 -0
- package/dist/types/index.d.ts +11 -11
- package/dist/types/models/{IAddress.d.ts → IGaiaXAddress.d.ts} +2 -2
- package/dist/types/models/{IDataExchangeComponent.d.ts → IGaiaXDataExchangeComponent.d.ts} +3 -3
- package/dist/types/models/{IDataResource.d.ts → IGaiaXDataResource.d.ts} +11 -10
- package/dist/types/models/{IEndpoint.d.ts → IGaiaXEndpoint.d.ts} +2 -2
- package/dist/types/models/IGaiaXEntity.d.ts +1 -1
- package/dist/types/models/{ILegalPerson.d.ts → IGaiaXLegalPerson.d.ts} +8 -8
- package/dist/types/models/{IRegistrationNumber.d.ts → IGaiaXRegistrationNumber.d.ts} +2 -2
- package/dist/types/models/{IServiceOffering.d.ts → IGaiaXServiceOffering.d.ts} +11 -10
- package/dist/types/models/gaiaXContextType.d.ts +1 -1
- package/dist/types/models/gaiaXContexts.d.ts +1 -5
- package/docs/changelog.md +223 -0
- package/docs/reference/index.md +7 -7
- package/docs/reference/interfaces/IGaiaXAddress.md +28 -0
- package/docs/reference/interfaces/IGaiaXDataExchangeComponent.md +32 -0
- package/docs/reference/interfaces/{IDataResource.md → IGaiaXDataResource.md} +6 -6
- package/docs/reference/interfaces/IGaiaXEndpoint.md +44 -0
- package/docs/reference/interfaces/{ILegalPerson.md → IGaiaXLegalPerson.md} +5 -5
- package/docs/reference/interfaces/{IRegistrationNumber.md → IGaiaXRegistrationNumber.md} +2 -2
- package/docs/reference/interfaces/IGaiaXServiceOffering.md +101 -0
- package/docs/reference/variables/GaiaXContexts.md +1 -7
- package/package.json +22 -9
- package/dist/cjs/index.cjs +0 -1935
- package/dist/esm/index.mjs +0 -1931
- package/docs/reference/interfaces/IAddress.md +0 -28
- package/docs/reference/interfaces/IDataExchangeComponent.md +0 -32
- package/docs/reference/interfaces/IEndpoint.md +0 -44
- package/docs/reference/interfaces/IServiceOffering.md +0 -101
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
# Interface: IAddress
|
|
2
|
-
|
|
3
|
-
Address as defined by Gaia-X
|
|
4
|
-
https://docs.gaia-x.eu/ontology/development/classes/Address/
|
|
5
|
-
|
|
6
|
-
## Extends
|
|
7
|
-
|
|
8
|
-
- `IJsonLdNodeObject`
|
|
9
|
-
|
|
10
|
-
## Indexable
|
|
11
|
-
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \}
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### type
|
|
17
|
-
|
|
18
|
-
> **type**: `undefined` \| `"Address"`
|
|
19
|
-
|
|
20
|
-
JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### countryCode
|
|
25
|
-
|
|
26
|
-
> **countryCode**: `string` \| `number`
|
|
27
|
-
|
|
28
|
-
Country code in ISO 3166-1 alpha2, alpha-3 or numeric format
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
# Interface: IDataExchangeComponent
|
|
2
|
-
|
|
3
|
-
Data Exchange component as defined by Gaia-X
|
|
4
|
-
https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent
|
|
5
|
-
|
|
6
|
-
## Extends
|
|
7
|
-
|
|
8
|
-
- `IJsonLdNodeObject`
|
|
9
|
-
|
|
10
|
-
## Indexable
|
|
11
|
-
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \}
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### @context
|
|
17
|
-
|
|
18
|
-
> **@context**: [`GaiaXContextType`](../type-aliases/GaiaXContextType.md)
|
|
19
|
-
|
|
20
|
-
The LD Context
|
|
21
|
-
|
|
22
|
-
#### Overrides
|
|
23
|
-
|
|
24
|
-
`IJsonLdNodeObject.@context`
|
|
25
|
-
|
|
26
|
-
***
|
|
27
|
-
|
|
28
|
-
### type
|
|
29
|
-
|
|
30
|
-
> **type**: `"DataExchangeComponent"` \| \[`"DataExchangeComponent"`, `...string[]`\]
|
|
31
|
-
|
|
32
|
-
The type of JSON-LD node
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
# Interface: IEndpoint
|
|
2
|
-
|
|
3
|
-
Endpoint as defined by the Gaia-X ontology.
|
|
4
|
-
https://docs.gaia-x.eu/ontology/development/classes/Endpoint
|
|
5
|
-
|
|
6
|
-
## Extends
|
|
7
|
-
|
|
8
|
-
- `IJsonLdNodeObject`
|
|
9
|
-
|
|
10
|
-
## Indexable
|
|
11
|
-
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \}
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### type
|
|
17
|
-
|
|
18
|
-
> **type**: `undefined` \| `"Endpoint"`
|
|
19
|
-
|
|
20
|
-
The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### endpointURL
|
|
25
|
-
|
|
26
|
-
> **endpointURL**: `string`
|
|
27
|
-
|
|
28
|
-
The endpoint URL
|
|
29
|
-
|
|
30
|
-
***
|
|
31
|
-
|
|
32
|
-
### formalDescription?
|
|
33
|
-
|
|
34
|
-
> `optional` **formalDescription**: `string`
|
|
35
|
-
|
|
36
|
-
The formal description
|
|
37
|
-
|
|
38
|
-
***
|
|
39
|
-
|
|
40
|
-
### standardConformity?
|
|
41
|
-
|
|
42
|
-
> `optional` **standardConformity**: `IJsonLdNodeObject`
|
|
43
|
-
|
|
44
|
-
Standards conformity
|
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
# Interface: IServiceOffering
|
|
2
|
-
|
|
3
|
-
A Service offering
|
|
4
|
-
|
|
5
|
-
## Extends
|
|
6
|
-
|
|
7
|
-
- `IGaiaXEntity`
|
|
8
|
-
|
|
9
|
-
## Indexable
|
|
10
|
-
|
|
11
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `IJsonLdContextDefinition` \| `string`[] \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \}
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### @context
|
|
16
|
-
|
|
17
|
-
> **@context**: [`GaiaXContextType`](../type-aliases/GaiaXContextType.md)
|
|
18
|
-
|
|
19
|
-
The LD context.
|
|
20
|
-
|
|
21
|
-
#### Inherited from
|
|
22
|
-
|
|
23
|
-
`IGaiaXEntity.@context`
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### id
|
|
28
|
-
|
|
29
|
-
> **id**: `string`
|
|
30
|
-
|
|
31
|
-
The Id.
|
|
32
|
-
|
|
33
|
-
#### Inherited from
|
|
34
|
-
|
|
35
|
-
`IGaiaXEntity.id`
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
|
-
### description?
|
|
40
|
-
|
|
41
|
-
> `optional` **description**: `string`
|
|
42
|
-
|
|
43
|
-
Description of the Gaia-X entity.
|
|
44
|
-
|
|
45
|
-
#### Inherited from
|
|
46
|
-
|
|
47
|
-
`IGaiaXEntity.description`
|
|
48
|
-
|
|
49
|
-
***
|
|
50
|
-
|
|
51
|
-
### type
|
|
52
|
-
|
|
53
|
-
> **type**: `"ServiceOffering"`
|
|
54
|
-
|
|
55
|
-
Type
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### name
|
|
60
|
-
|
|
61
|
-
> **name**: `string`
|
|
62
|
-
|
|
63
|
-
Name of the Service Offering.
|
|
64
|
-
|
|
65
|
-
#### Overrides
|
|
66
|
-
|
|
67
|
-
`IGaiaXEntity.name`
|
|
68
|
-
|
|
69
|
-
***
|
|
70
|
-
|
|
71
|
-
### providedBy
|
|
72
|
-
|
|
73
|
-
> **providedBy**: `string` \| [`ILegalPerson`](ILegalPerson.md) \| `IJsonLdNodeObject` & `object`
|
|
74
|
-
|
|
75
|
-
Participant that provides the offering
|
|
76
|
-
|
|
77
|
-
***
|
|
78
|
-
|
|
79
|
-
### servicePolicy
|
|
80
|
-
|
|
81
|
-
> **servicePolicy**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
82
|
-
|
|
83
|
-
ODRL policy associated to the service offering
|
|
84
|
-
|
|
85
|
-
***
|
|
86
|
-
|
|
87
|
-
### aggregationOfResources?
|
|
88
|
-
|
|
89
|
-
> `optional` **aggregationOfResources**: `string`[] \| [`IDataResource`](IDataResource.md)[] \| `IJsonLdNodeObject` & `object`
|
|
90
|
-
|
|
91
|
-
Resources aggregated
|
|
92
|
-
It is supported different representations, inline,
|
|
93
|
-
by reference both providing the URI or a partial JSON-LD Node object
|
|
94
|
-
|
|
95
|
-
***
|
|
96
|
-
|
|
97
|
-
### endpoint
|
|
98
|
-
|
|
99
|
-
> **endpoint**: [`IEndpoint`](IEndpoint.md)
|
|
100
|
-
|
|
101
|
-
The endpoint
|