@twin.org/standards-gaia-x 0.0.1 → 0.0.2-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.
- package/dist/cjs/index.cjs +391 -68
- package/dist/esm/index.mjs +391 -68
- package/dist/types/index.d.ts +1 -1
- package/dist/types/models/IDataResource.d.ts +5 -8
- package/dist/types/models/IGaiaXEntity.d.ts +24 -0
- package/dist/types/models/ILegalPerson.d.ts +50 -0
- package/dist/types/models/IServiceOffering.d.ts +6 -18
- package/dist/types/models/gaiaXContexts.d.ts +4 -0
- package/dist/types/models/gaiaXTypes.d.ts +2 -2
- package/docs/changelog.md +25 -0
- package/docs/reference/index.md +1 -1
- package/docs/reference/interfaces/IAddress.md +1 -1
- package/docs/reference/interfaces/IDataExchangeComponent.md +1 -1
- package/docs/reference/interfaces/IDataResource.md +25 -13
- package/docs/reference/interfaces/IEndpoint.md +1 -1
- package/docs/reference/interfaces/ILegalPerson.md +139 -0
- package/docs/reference/interfaces/IRegistrationNumber.md +1 -1
- package/docs/reference/interfaces/IServiceOffering.md +26 -14
- package/docs/reference/variables/GaiaXContexts.md +6 -0
- package/docs/reference/variables/GaiaXTypes.md +3 -3
- package/package.json +4 -4
- package/dist/types/models/IParticipant.d.ts +0 -35
- package/docs/reference/interfaces/IParticipant.md +0 -63
|
@@ -3,12 +3,13 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
|
3
3
|
import type { GaiaXContextType } from "./gaiaXContextType";
|
|
4
4
|
import type { GaiaXTypes } from "./gaiaXTypes";
|
|
5
5
|
import type { IDataExchangeComponent } from "./IDataExchangeComponent";
|
|
6
|
-
import type {
|
|
6
|
+
import type { IGaiaXEntity } from "./IGaiaXEntity";
|
|
7
|
+
import type { ILegalPerson } from "./ILegalPerson";
|
|
7
8
|
/**
|
|
8
9
|
* A Data Resource as defined by Gaia-X.
|
|
9
10
|
* See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
|
|
10
11
|
*/
|
|
11
|
-
export interface IDataResource extends
|
|
12
|
+
export interface IDataResource extends IGaiaXEntity {
|
|
12
13
|
/**
|
|
13
14
|
* The LD Context
|
|
14
15
|
*/
|
|
@@ -21,10 +22,6 @@ export interface IDataResource extends IJsonLdNodeObject {
|
|
|
21
22
|
* Subject type
|
|
22
23
|
*/
|
|
23
24
|
type: typeof GaiaXTypes.DataResource;
|
|
24
|
-
/**
|
|
25
|
-
* Description
|
|
26
|
-
*/
|
|
27
|
-
description?: string;
|
|
28
25
|
/**
|
|
29
26
|
* The Resource Name
|
|
30
27
|
*/
|
|
@@ -41,7 +38,7 @@ export interface IDataResource extends IJsonLdNodeObject {
|
|
|
41
38
|
/**
|
|
42
39
|
* Who is the data producer
|
|
43
40
|
*/
|
|
44
|
-
producedBy:
|
|
41
|
+
producedBy: ILegalPerson | string;
|
|
45
42
|
/**
|
|
46
43
|
* Pointer (URL) to the license
|
|
47
44
|
*/
|
|
@@ -49,7 +46,7 @@ export interface IDataResource extends IJsonLdNodeObject {
|
|
|
49
46
|
/**
|
|
50
47
|
* Copyright owner
|
|
51
48
|
*/
|
|
52
|
-
copyrightOwnedBy:
|
|
49
|
+
copyrightOwnedBy: ILegalPerson | string;
|
|
53
50
|
/**
|
|
54
51
|
* ODRL Policy
|
|
55
52
|
*/
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
|
+
import type { GaiaXContextType } from "./gaiaXContextType";
|
|
3
|
+
/**
|
|
4
|
+
* GaiaX Entity.
|
|
5
|
+
* @see https://docs.gaia-x.eu/ontology/development/classes/GaiaXEntity/
|
|
6
|
+
*/
|
|
7
|
+
export interface IGaiaXEntity extends IJsonLdNodeObject {
|
|
8
|
+
/**
|
|
9
|
+
* The LD context.
|
|
10
|
+
*/
|
|
11
|
+
"@context": GaiaXContextType;
|
|
12
|
+
/**
|
|
13
|
+
* The Id.
|
|
14
|
+
*/
|
|
15
|
+
id: string;
|
|
16
|
+
/**
|
|
17
|
+
* Human readable Name.
|
|
18
|
+
*/
|
|
19
|
+
name?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Description of the Gaia-X entity.
|
|
22
|
+
*/
|
|
23
|
+
description?: string;
|
|
24
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
|
+
import type { GaiaXTypes } from "./gaiaXTypes";
|
|
3
|
+
import type { IAddress } from "./IAddress";
|
|
4
|
+
import type { IGaiaXEntity } from "./IGaiaXEntity";
|
|
5
|
+
import type { IRegistrationNumber } from "./IRegistrationNumber";
|
|
6
|
+
/**
|
|
7
|
+
* A Legal Person as defined by Gaia-X.
|
|
8
|
+
* @see https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.
|
|
9
|
+
*/
|
|
10
|
+
export interface ILegalPerson extends IGaiaXEntity {
|
|
11
|
+
/**
|
|
12
|
+
* JSON-LD type.
|
|
13
|
+
*/
|
|
14
|
+
type: typeof GaiaXTypes.LegalPerson;
|
|
15
|
+
/**
|
|
16
|
+
* The legal registration number.
|
|
17
|
+
* @see https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/
|
|
18
|
+
*/
|
|
19
|
+
registrationNumber: IRegistrationNumber;
|
|
20
|
+
/**
|
|
21
|
+
* The legal name.
|
|
22
|
+
*/
|
|
23
|
+
legalName: string;
|
|
24
|
+
/**
|
|
25
|
+
* Legal Address
|
|
26
|
+
* @see https://docs.gaia-x.eu/ontology/development/slots/legalAddress/
|
|
27
|
+
*/
|
|
28
|
+
legalAddress: IAddress;
|
|
29
|
+
/**
|
|
30
|
+
* Headquarters address.
|
|
31
|
+
* @see https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/
|
|
32
|
+
*/
|
|
33
|
+
headquartersAddress?: IAddress;
|
|
34
|
+
/**
|
|
35
|
+
* Parent organization.
|
|
36
|
+
* @see https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/
|
|
37
|
+
*/
|
|
38
|
+
parentOrganizationOf?: (IJsonLdNodeObject & {
|
|
39
|
+
id: string;
|
|
40
|
+
type: typeof GaiaXTypes.LegalPerson;
|
|
41
|
+
})[];
|
|
42
|
+
/**
|
|
43
|
+
* Sub organization of.
|
|
44
|
+
* @see https://docs.gaia-x.eu/ontology/development/slots/parentSubOrganizationOf
|
|
45
|
+
*/
|
|
46
|
+
subOrganizationOf?: (IJsonLdNodeObject & {
|
|
47
|
+
id: string;
|
|
48
|
+
type: typeof GaiaXTypes.LegalPerson;
|
|
49
|
+
})[];
|
|
50
|
+
}
|
|
@@ -1,40 +1,28 @@
|
|
|
1
1
|
import type { ObjectOrArray } from "@twin.org/core";
|
|
2
2
|
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
3
|
-
import type { GaiaXContextType } from "./gaiaXContextType";
|
|
4
3
|
import type { GaiaXTypes } from "./gaiaXTypes";
|
|
5
4
|
import type { IDataResource } from "./IDataResource";
|
|
6
5
|
import type { IEndpoint } from "./IEndpoint";
|
|
7
|
-
import type {
|
|
6
|
+
import type { IGaiaXEntity } from "./IGaiaXEntity";
|
|
7
|
+
import type { ILegalPerson } from "./ILegalPerson";
|
|
8
8
|
/**
|
|
9
9
|
* A Service offering
|
|
10
10
|
*/
|
|
11
|
-
export interface IServiceOffering extends
|
|
12
|
-
/**
|
|
13
|
-
* The LD context
|
|
14
|
-
*/
|
|
15
|
-
"@context": GaiaXContextType;
|
|
16
|
-
/**
|
|
17
|
-
* Id
|
|
18
|
-
*/
|
|
19
|
-
id: string;
|
|
11
|
+
export interface IServiceOffering extends IGaiaXEntity {
|
|
20
12
|
/**
|
|
21
13
|
* Type
|
|
22
14
|
*/
|
|
23
15
|
type: typeof GaiaXTypes.ServiceOffering;
|
|
24
16
|
/**
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
27
|
-
description?: string;
|
|
28
|
-
/**
|
|
29
|
-
* Name
|
|
17
|
+
* Name of the Service Offering.
|
|
30
18
|
*/
|
|
31
19
|
name: string;
|
|
32
20
|
/**
|
|
33
21
|
* Participant that provides the offering
|
|
34
22
|
*/
|
|
35
|
-
providedBy: string |
|
|
23
|
+
providedBy: string | ILegalPerson | (IJsonLdNodeObject & {
|
|
36
24
|
id: string;
|
|
37
|
-
type: typeof GaiaXTypes.
|
|
25
|
+
type: typeof GaiaXTypes.LegalPerson;
|
|
38
26
|
});
|
|
39
27
|
/**
|
|
40
28
|
* ODRL policy associated to the service offering
|
|
@@ -6,6 +6,10 @@ export declare const GaiaXContexts: {
|
|
|
6
6
|
* The Gaia-X LD Context
|
|
7
7
|
*/
|
|
8
8
|
readonly ContextRoot: "https://w3id.org/gaia-x/development";
|
|
9
|
+
/**
|
|
10
|
+
* The Gaia-X custom context.
|
|
11
|
+
*/
|
|
12
|
+
readonly TwinContext: "https://schema.twindev.org/gaia-x";
|
|
9
13
|
};
|
|
10
14
|
/**
|
|
11
15
|
* The LD Contexts concerning Gaia-X.
|
|
@@ -11,9 +11,9 @@ export declare const GaiaXTypes: {
|
|
|
11
11
|
*/
|
|
12
12
|
readonly ServiceOffering: "ServiceOffering";
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Legal Person
|
|
15
15
|
*/
|
|
16
|
-
readonly
|
|
16
|
+
readonly LegalPerson: "LegalPerson";
|
|
17
17
|
/**
|
|
18
18
|
* Data Exchange Component
|
|
19
19
|
*/
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
# @twin.org/standards-gaia-x - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.2-next.2](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.2-next.1...standards-gaia-x-v0.0.2-next.2) (2025-08-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update framework core ([58c0c3d](https://github.com/twinfoundation/standards/commit/58c0c3dd6cea0e4c2393dc0e3e1eb33a6d06f617))
|
|
9
|
+
|
|
10
|
+
## [0.0.2-next.1](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.2-next.0...standards-gaia-x-v0.0.2-next.1) (2025-07-14)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* add gaia-x schemas ([54c48df](https://github.com/twinfoundation/standards/commit/54c48df8c3eb0ce74d9b9a887ea81c10110fce76))
|
|
16
|
+
* align Data Resource and Service Offering definition (ODRL polic… ([#27](https://github.com/twinfoundation/standards/issues/27)) ([20797be](https://github.com/twinfoundation/standards/commit/20797beff059c6fb253401d49b654cd7a57762d5))
|
|
17
|
+
* Extend Gaia-X types to support Participant specification variants ([#9](https://github.com/twinfoundation/standards/issues/9)) ([2df9641](https://github.com/twinfoundation/standards/commit/2df9641946fe27f916721978ca807002398c4199))
|
|
18
|
+
* normalise type outputs ([0b3aed7](https://github.com/twinfoundation/standards/commit/0b3aed7df0802cd609423bbd7fda6bde601d3ceb))
|
|
19
|
+
* update to latest JSON schema spec ([7a23930](https://github.com/twinfoundation/standards/commit/7a2393032d7f48bfb20d3a484f981fb6dd83a92c))
|
|
20
|
+
* use shared store mechanism ([#11](https://github.com/twinfoundation/standards/issues/11)) ([96fa237](https://github.com/twinfoundation/standards/commit/96fa23735f69c1fc7e3d0019b527634fa0a042d9))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Bug Fixes
|
|
24
|
+
|
|
25
|
+
* gaia-X Legal Person. Removal of Participant ([#42](https://github.com/twinfoundation/standards/issues/42)) ([71e3b48](https://github.com/twinfoundation/standards/commit/71e3b48be2917ad58b55eb25c86cdcfa17d1291f))
|
|
26
|
+
* refine the LD Context of Gaia-X entities ([#24](https://github.com/twinfoundation/standards/issues/24)) ([151c7f9](https://github.com/twinfoundation/standards/commit/151c7f940c900daac6c98a6f89ea5f708b25a1bd))
|
|
27
|
+
|
|
3
28
|
## 0.0.1 (2025-07-03)
|
|
4
29
|
|
|
5
30
|
|
package/docs/reference/index.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
- [IDataExchangeComponent](interfaces/IDataExchangeComponent.md)
|
|
11
11
|
- [IDataResource](interfaces/IDataResource.md)
|
|
12
12
|
- [IEndpoint](interfaces/IEndpoint.md)
|
|
13
|
-
- [
|
|
13
|
+
- [ILegalPerson](interfaces/ILegalPerson.md)
|
|
14
14
|
- [IRegistrationNumber](interfaces/IRegistrationNumber.md)
|
|
15
15
|
- [IServiceOffering](interfaces/IServiceOffering.md)
|
|
16
16
|
|
|
@@ -9,7 +9,7 @@ https://docs.gaia-x.eu/ontology/development/classes/Address/
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
@@ -5,11 +5,11 @@ See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
|
|
|
5
5
|
|
|
6
6
|
## Extends
|
|
7
7
|
|
|
8
|
-
- `
|
|
8
|
+
- `IGaiaXEntity`
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
@@ -21,7 +21,7 @@ The LD Context
|
|
|
21
21
|
|
|
22
22
|
#### Overrides
|
|
23
23
|
|
|
24
|
-
`
|
|
24
|
+
`IGaiaXEntity.@context`
|
|
25
25
|
|
|
26
26
|
***
|
|
27
27
|
|
|
@@ -31,6 +31,10 @@ The LD Context
|
|
|
31
31
|
|
|
32
32
|
Subject Id
|
|
33
33
|
|
|
34
|
+
#### Overrides
|
|
35
|
+
|
|
36
|
+
`IGaiaXEntity.id`
|
|
37
|
+
|
|
34
38
|
***
|
|
35
39
|
|
|
36
40
|
### type
|
|
@@ -41,20 +45,16 @@ Subject type
|
|
|
41
45
|
|
|
42
46
|
***
|
|
43
47
|
|
|
44
|
-
### description?
|
|
45
|
-
|
|
46
|
-
> `optional` **description**: `string`
|
|
47
|
-
|
|
48
|
-
Description
|
|
49
|
-
|
|
50
|
-
***
|
|
51
|
-
|
|
52
48
|
### name
|
|
53
49
|
|
|
54
50
|
> **name**: `string`
|
|
55
51
|
|
|
56
52
|
The Resource Name
|
|
57
53
|
|
|
54
|
+
#### Overrides
|
|
55
|
+
|
|
56
|
+
`IGaiaXEntity.name`
|
|
57
|
+
|
|
58
58
|
***
|
|
59
59
|
|
|
60
60
|
### exposedThrough
|
|
@@ -69,7 +69,7 @@ the third case covers the idiom where a JSON-LD Node is supplied with id and typ
|
|
|
69
69
|
|
|
70
70
|
### producedBy
|
|
71
71
|
|
|
72
|
-
> **producedBy**: `string` \| [`
|
|
72
|
+
> **producedBy**: `string` \| [`ILegalPerson`](ILegalPerson.md)
|
|
73
73
|
|
|
74
74
|
Who is the data producer
|
|
75
75
|
|
|
@@ -85,7 +85,7 @@ Pointer (URL) to the license
|
|
|
85
85
|
|
|
86
86
|
### copyrightOwnedBy
|
|
87
87
|
|
|
88
|
-
> **copyrightOwnedBy**: `string` \| [`
|
|
88
|
+
> **copyrightOwnedBy**: `string` \| [`ILegalPerson`](ILegalPerson.md)
|
|
89
89
|
|
|
90
90
|
Copyright owner
|
|
91
91
|
|
|
@@ -96,3 +96,15 @@ Copyright owner
|
|
|
96
96
|
> **resourcePolicy**: `ObjectOrArray`\<`IJsonLdNodeObject`\>
|
|
97
97
|
|
|
98
98
|
ODRL Policy
|
|
99
|
+
|
|
100
|
+
***
|
|
101
|
+
|
|
102
|
+
### description?
|
|
103
|
+
|
|
104
|
+
> `optional` **description**: `string`
|
|
105
|
+
|
|
106
|
+
Description of the Gaia-X entity.
|
|
107
|
+
|
|
108
|
+
#### Inherited from
|
|
109
|
+
|
|
110
|
+
`IGaiaXEntity.description`
|
|
@@ -9,7 +9,7 @@ https://docs.gaia-x.eu/ontology/development/classes/Endpoint
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
# Interface: ILegalPerson
|
|
2
|
+
|
|
3
|
+
A Legal Person as defined by Gaia-X.
|
|
4
|
+
|
|
5
|
+
## See
|
|
6
|
+
|
|
7
|
+
https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.
|
|
8
|
+
|
|
9
|
+
## Extends
|
|
10
|
+
|
|
11
|
+
- `IGaiaXEntity`
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`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`; \}
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### @context
|
|
20
|
+
|
|
21
|
+
> **@context**: [`GaiaXContextType`](../type-aliases/GaiaXContextType.md)
|
|
22
|
+
|
|
23
|
+
The LD context.
|
|
24
|
+
|
|
25
|
+
#### Inherited from
|
|
26
|
+
|
|
27
|
+
`IGaiaXEntity.@context`
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### id
|
|
32
|
+
|
|
33
|
+
> **id**: `string`
|
|
34
|
+
|
|
35
|
+
The Id.
|
|
36
|
+
|
|
37
|
+
#### Inherited from
|
|
38
|
+
|
|
39
|
+
`IGaiaXEntity.id`
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### name?
|
|
44
|
+
|
|
45
|
+
> `optional` **name**: `string`
|
|
46
|
+
|
|
47
|
+
Human readable Name.
|
|
48
|
+
|
|
49
|
+
#### Inherited from
|
|
50
|
+
|
|
51
|
+
`IGaiaXEntity.name`
|
|
52
|
+
|
|
53
|
+
***
|
|
54
|
+
|
|
55
|
+
### description?
|
|
56
|
+
|
|
57
|
+
> `optional` **description**: `string`
|
|
58
|
+
|
|
59
|
+
Description of the Gaia-X entity.
|
|
60
|
+
|
|
61
|
+
#### Inherited from
|
|
62
|
+
|
|
63
|
+
`IGaiaXEntity.description`
|
|
64
|
+
|
|
65
|
+
***
|
|
66
|
+
|
|
67
|
+
### type
|
|
68
|
+
|
|
69
|
+
> **type**: `"LegalPerson"`
|
|
70
|
+
|
|
71
|
+
JSON-LD type.
|
|
72
|
+
|
|
73
|
+
***
|
|
74
|
+
|
|
75
|
+
### registrationNumber
|
|
76
|
+
|
|
77
|
+
> **registrationNumber**: [`IRegistrationNumber`](IRegistrationNumber.md)
|
|
78
|
+
|
|
79
|
+
The legal registration number.
|
|
80
|
+
|
|
81
|
+
#### See
|
|
82
|
+
|
|
83
|
+
https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/
|
|
84
|
+
|
|
85
|
+
***
|
|
86
|
+
|
|
87
|
+
### legalName
|
|
88
|
+
|
|
89
|
+
> **legalName**: `string`
|
|
90
|
+
|
|
91
|
+
The legal name.
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### legalAddress
|
|
96
|
+
|
|
97
|
+
> **legalAddress**: [`IAddress`](IAddress.md)
|
|
98
|
+
|
|
99
|
+
Legal Address
|
|
100
|
+
|
|
101
|
+
#### See
|
|
102
|
+
|
|
103
|
+
https://docs.gaia-x.eu/ontology/development/slots/legalAddress/
|
|
104
|
+
|
|
105
|
+
***
|
|
106
|
+
|
|
107
|
+
### headquartersAddress?
|
|
108
|
+
|
|
109
|
+
> `optional` **headquartersAddress**: [`IAddress`](IAddress.md)
|
|
110
|
+
|
|
111
|
+
Headquarters address.
|
|
112
|
+
|
|
113
|
+
#### See
|
|
114
|
+
|
|
115
|
+
https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/
|
|
116
|
+
|
|
117
|
+
***
|
|
118
|
+
|
|
119
|
+
### parentOrganizationOf?
|
|
120
|
+
|
|
121
|
+
> `optional` **parentOrganizationOf**: `IJsonLdNodeObject` & `object`[]
|
|
122
|
+
|
|
123
|
+
Parent organization.
|
|
124
|
+
|
|
125
|
+
#### See
|
|
126
|
+
|
|
127
|
+
https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/
|
|
128
|
+
|
|
129
|
+
***
|
|
130
|
+
|
|
131
|
+
### subOrganizationOf?
|
|
132
|
+
|
|
133
|
+
> `optional` **subOrganizationOf**: `IJsonLdNodeObject` & `object`[]
|
|
134
|
+
|
|
135
|
+
Sub organization of.
|
|
136
|
+
|
|
137
|
+
#### See
|
|
138
|
+
|
|
139
|
+
https://docs.gaia-x.eu/ontology/development/slots/parentSubOrganizationOf
|
|
@@ -9,7 +9,7 @@ https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
@@ -4,11 +4,11 @@ A Service offering
|
|
|
4
4
|
|
|
5
5
|
## Extends
|
|
6
6
|
|
|
7
|
-
- `
|
|
7
|
+
- `IGaiaXEntity`
|
|
8
8
|
|
|
9
9
|
## Indexable
|
|
10
10
|
|
|
11
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `
|
|
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
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
@@ -16,11 +16,11 @@ A Service offering
|
|
|
16
16
|
|
|
17
17
|
> **@context**: [`GaiaXContextType`](../type-aliases/GaiaXContextType.md)
|
|
18
18
|
|
|
19
|
-
The LD context
|
|
19
|
+
The LD context.
|
|
20
20
|
|
|
21
|
-
####
|
|
21
|
+
#### Inherited from
|
|
22
22
|
|
|
23
|
-
`
|
|
23
|
+
`IGaiaXEntity.@context`
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,23 +28,31 @@ The LD context
|
|
|
28
28
|
|
|
29
29
|
> **id**: `string`
|
|
30
30
|
|
|
31
|
-
Id
|
|
31
|
+
The Id.
|
|
32
|
+
|
|
33
|
+
#### Inherited from
|
|
34
|
+
|
|
35
|
+
`IGaiaXEntity.id`
|
|
32
36
|
|
|
33
37
|
***
|
|
34
38
|
|
|
35
|
-
###
|
|
39
|
+
### description?
|
|
36
40
|
|
|
37
|
-
> **
|
|
41
|
+
> `optional` **description**: `string`
|
|
38
42
|
|
|
39
|
-
|
|
43
|
+
Description of the Gaia-X entity.
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
`IGaiaXEntity.description`
|
|
40
48
|
|
|
41
49
|
***
|
|
42
50
|
|
|
43
|
-
###
|
|
51
|
+
### type
|
|
44
52
|
|
|
45
|
-
>
|
|
53
|
+
> **type**: `"ServiceOffering"`
|
|
46
54
|
|
|
47
|
-
|
|
55
|
+
Type
|
|
48
56
|
|
|
49
57
|
***
|
|
50
58
|
|
|
@@ -52,13 +60,17 @@ Description
|
|
|
52
60
|
|
|
53
61
|
> **name**: `string`
|
|
54
62
|
|
|
55
|
-
Name
|
|
63
|
+
Name of the Service Offering.
|
|
64
|
+
|
|
65
|
+
#### Overrides
|
|
66
|
+
|
|
67
|
+
`IGaiaXEntity.name`
|
|
56
68
|
|
|
57
69
|
***
|
|
58
70
|
|
|
59
71
|
### providedBy
|
|
60
72
|
|
|
61
|
-
> **providedBy**: `string` \| [`
|
|
73
|
+
> **providedBy**: `string` \| [`ILegalPerson`](ILegalPerson.md) \| `IJsonLdNodeObject` & `object`
|
|
62
74
|
|
|
63
75
|
Participant that provides the offering
|
|
64
76
|
|
|
@@ -11,3 +11,9 @@ The LD Contexts concerning Gaia-X.
|
|
|
11
11
|
> `readonly` **ContextRoot**: `"https://w3id.org/gaia-x/development"` = `"https://w3id.org/gaia-x/development"`
|
|
12
12
|
|
|
13
13
|
The Gaia-X LD Context
|
|
14
|
+
|
|
15
|
+
### TwinContext
|
|
16
|
+
|
|
17
|
+
> `readonly` **TwinContext**: `"https://schema.twindev.org/gaia-x"` = `"https://schema.twindev.org/gaia-x"`
|
|
18
|
+
|
|
19
|
+
The Gaia-X custom context.
|
|
@@ -18,11 +18,11 @@ Data Resource
|
|
|
18
18
|
|
|
19
19
|
Service Offering Type
|
|
20
20
|
|
|
21
|
-
###
|
|
21
|
+
### LegalPerson
|
|
22
22
|
|
|
23
|
-
> `readonly` **
|
|
23
|
+
> `readonly` **LegalPerson**: `"LegalPerson"` = `"LegalPerson"`
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Legal Person
|
|
26
26
|
|
|
27
27
|
### DataExchangeComponent
|
|
28
28
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/standards-gaia-x",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2-next.2",
|
|
4
4
|
"description": "Models which define the structure of Gaia-x",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/core": "
|
|
18
|
-
"@twin.org/data-core": "
|
|
19
|
-
"@twin.org/data-json-ld": "
|
|
17
|
+
"@twin.org/core": "next",
|
|
18
|
+
"@twin.org/data-core": "next",
|
|
19
|
+
"@twin.org/data-json-ld": "next"
|
|
20
20
|
},
|
|
21
21
|
"main": "./dist/cjs/index.cjs",
|
|
22
22
|
"module": "./dist/esm/index.mjs",
|