@twin.org/standards-gaia-x 0.0.3-next.1 → 0.0.3-next.11
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 +34 -36
- package/dist/es/dataTypes/gaiaXDataTypes.js.map +1 -1
- package/dist/es/index.js +7 -7
- package/dist/es/index.js.map +1 -1
- 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/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.map +1 -1
- package/dist/es/models/gaiaXContexts.js +3 -3
- package/dist/es/models/gaiaXContexts.js.map +1 -1
- package/dist/es/schemas/DataExchangeComponent.json +24 -30
- package/dist/es/schemas/DataResource.json +18 -22
- package/dist/es/schemas/LegalPerson.json +18 -22
- package/dist/es/schemas/ServiceOffering.json +18 -22
- package/dist/types/index.d.ts +7 -7
- package/dist/types/models/{IAddress.d.ts → IGaiaXAddress.d.ts} +1 -1
- package/dist/types/models/{IDataExchangeComponent.d.ts → IGaiaXDataExchangeComponent.d.ts} +1 -1
- package/dist/types/models/{IDataResource.d.ts → IGaiaXDataResource.d.ts} +6 -6
- package/dist/types/models/{IEndpoint.d.ts → IGaiaXEndpoint.d.ts} +1 -1
- package/dist/types/models/{ILegalPerson.d.ts → IGaiaXLegalPerson.d.ts} +6 -6
- package/dist/types/models/{IRegistrationNumber.d.ts → IGaiaXRegistrationNumber.d.ts} +1 -1
- package/dist/types/models/{IServiceOffering.d.ts → IGaiaXServiceOffering.d.ts} +7 -7
- package/dist/types/models/gaiaXContextType.d.ts +3 -3
- package/dist/types/models/gaiaXContexts.d.ts +4 -4
- package/docs/changelog.md +140 -0
- package/docs/reference/index.md +7 -7
- package/docs/reference/interfaces/{IAddress.md → IGaiaXAddress.md} +1 -1
- package/docs/reference/interfaces/{IDataExchangeComponent.md → IGaiaXDataExchangeComponent.md} +1 -1
- package/docs/reference/interfaces/{IDataResource.md → IGaiaXDataResource.md} +4 -4
- package/docs/reference/interfaces/{IEndpoint.md → IGaiaXEndpoint.md} +1 -1
- package/docs/reference/interfaces/{ILegalPerson.md → IGaiaXLegalPerson.md} +4 -4
- package/docs/reference/interfaces/{IRegistrationNumber.md → IGaiaXRegistrationNumber.md} +1 -1
- package/docs/reference/interfaces/{IServiceOffering.md → IGaiaXServiceOffering.md} +4 -4
- package/docs/reference/type-aliases/GaiaXContextType.md +1 -1
- package/docs/reference/type-aliases/GaiaXContexts.md +1 -1
- package/docs/reference/variables/GaiaXContexts.md +4 -4
- package/package.json +2 -2
- package/dist/es/models/IAddress.js +0 -2
- package/dist/es/models/IAddress.js.map +0 -1
- package/dist/es/models/IDataExchangeComponent.js +0 -2
- package/dist/es/models/IDataExchangeComponent.js.map +0 -1
- package/dist/es/models/IDataResource.js +0 -2
- package/dist/es/models/IDataResource.js.map +0 -1
- package/dist/es/models/IEndpoint.js +0 -2
- package/dist/es/models/IEndpoint.js.map +0 -1
- package/dist/es/models/ILegalPerson.js +0 -2
- package/dist/es/models/ILegalPerson.js.map +0 -1
- package/dist/es/models/IRegistrationNumber.js +0 -2
- package/dist/es/models/IRegistrationNumber.js.map +0 -1
- package/dist/es/models/IServiceOffering.js +0 -2
- package/dist/es/models/IServiceOffering.js.map +0 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
// Copyright 2024 IOTA Stiftung.
|
|
2
|
+
// SPDX-License-Identifier: Apache-2.0.
|
|
3
|
+
import { DataTypeHelper } from "@twin.org/data-core";
|
|
2
4
|
import { GaiaXContexts } from "../models/gaiaXContexts.js";
|
|
3
5
|
import { GaiaXTypes } from "../models/gaiaXTypes.js";
|
|
4
6
|
import AddressSchema from "../schemas/Address.json" with { type: "json" };
|
|
@@ -16,41 +18,37 @@ export class GaiaXDataTypes {
|
|
|
16
18
|
* Register all the data types.
|
|
17
19
|
*/
|
|
18
20
|
static registerTypes() {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
context: GaiaXContexts.ContextRoot,
|
|
51
|
-
type: GaiaXTypes.RegistrationNumber,
|
|
52
|
-
jsonSchema: async () => RegistrationNumberSchema
|
|
53
|
-
}));
|
|
21
|
+
const types = [
|
|
22
|
+
{
|
|
23
|
+
type: GaiaXTypes.DataExchangeComponent,
|
|
24
|
+
schema: DataExchangeComponentSchema
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
type: GaiaXTypes.DataResource,
|
|
28
|
+
schema: DataResourceSchema
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
type: GaiaXTypes.Endpoint,
|
|
32
|
+
schema: EndpointSchema
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
type: GaiaXTypes.Address,
|
|
36
|
+
schema: AddressSchema
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
type: GaiaXTypes.ServiceOffering,
|
|
40
|
+
schema: ServiceOfferingSchema
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
type: GaiaXTypes.LegalPerson,
|
|
44
|
+
schema: LegalPersonSchema
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
type: GaiaXTypes.RegistrationNumber,
|
|
48
|
+
schema: RegistrationNumberSchema
|
|
49
|
+
}
|
|
50
|
+
];
|
|
51
|
+
DataTypeHelper.registerTypes(GaiaXContexts.Namespace, undefined, types);
|
|
54
52
|
}
|
|
55
53
|
}
|
|
56
54
|
//# sourceMappingURL=gaiaXDataTypes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gaiaXDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/gaiaXDataTypes.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"gaiaXDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/gaiaXDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,aAAa,MAAM,yBAAyB,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC1E,OAAO,2BAA2B,MAAM,uCAAuC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACtG,OAAO,kBAAkB,MAAM,8BAA8B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACpF,OAAO,cAAc,MAAM,0BAA0B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAC5E,OAAO,iBAAiB,MAAM,6BAA6B,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAClF,OAAO,wBAAwB,MAAM,oCAAoC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAChG,OAAO,qBAAqB,MAAM,iCAAiC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE1F;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,MAAM,KAAK,GAAG;YACb;gBACC,IAAI,EAAE,UAAU,CAAC,qBAAqB;gBACtC,MAAM,EAAE,2BAA2B;aACnC;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,YAAY;gBAC7B,MAAM,EAAE,kBAAkB;aAC1B;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,QAAQ;gBACzB,MAAM,EAAE,cAAc;aACtB;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,OAAO;gBACxB,MAAM,EAAE,aAAa;aACrB;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,eAAe;gBAChC,MAAM,EAAE,qBAAqB;aAC7B;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,WAAW;gBAC5B,MAAM,EAAE,iBAAiB;aACzB;YACD;gBACC,IAAI,EAAE,UAAU,CAAC,kBAAkB;gBACnC,MAAM,EAAE,wBAAwB;aAChC;SACD,CAAC;QAEF,cAAc,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHelper } from \"@twin.org/data-core\";\nimport { GaiaXContexts } from \"../models/gaiaXContexts.js\";\nimport { GaiaXTypes } from \"../models/gaiaXTypes.js\";\nimport AddressSchema from \"../schemas/Address.json\" with { type: \"json\" };\nimport DataExchangeComponentSchema from \"../schemas/DataExchangeComponent.json\" with { type: \"json\" };\nimport DataResourceSchema from \"../schemas/DataResource.json\" with { type: \"json\" };\nimport EndpointSchema from \"../schemas/Endpoint.json\" with { type: \"json\" };\nimport LegalPersonSchema from \"../schemas/LegalPerson.json\" with { type: \"json\" };\nimport RegistrationNumberSchema from \"../schemas/RegistrationNumber.json\" with { type: \"json\" };\nimport ServiceOfferingSchema from \"../schemas/ServiceOffering.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for Gaia-X.\n */\nexport class GaiaXDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tconst types = [\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.DataExchangeComponent,\n\t\t\t\tschema: DataExchangeComponentSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.DataResource,\n\t\t\t\tschema: DataResourceSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.Endpoint,\n\t\t\t\tschema: EndpointSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.Address,\n\t\t\t\tschema: AddressSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.ServiceOffering,\n\t\t\t\tschema: ServiceOfferingSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.LegalPerson,\n\t\t\t\tschema: LegalPersonSchema\n\t\t\t},\n\t\t\t{\n\t\t\t\ttype: GaiaXTypes.RegistrationNumber,\n\t\t\t\tschema: RegistrationNumberSchema\n\t\t\t}\n\t\t];\n\n\t\tDataTypeHelper.registerTypes(GaiaXContexts.Namespace, undefined, types);\n\t}\n}\n"]}
|
package/dist/es/index.js
CHANGED
|
@@ -4,11 +4,11 @@ export * from "./dataTypes/gaiaXDataTypes.js";
|
|
|
4
4
|
export * from "./models/gaiaXContexts.js";
|
|
5
5
|
export * from "./models/gaiaXContextType.js";
|
|
6
6
|
export * from "./models/gaiaXTypes.js";
|
|
7
|
-
export * from "./models/
|
|
8
|
-
export * from "./models/
|
|
9
|
-
export * from "./models/
|
|
10
|
-
export * from "./models/
|
|
11
|
-
export * from "./models/
|
|
12
|
-
export * from "./models/
|
|
13
|
-
export * from "./models/
|
|
7
|
+
export * from "./models/IGaiaXAddress.js";
|
|
8
|
+
export * from "./models/IGaiaXDataExchangeComponent.js";
|
|
9
|
+
export * from "./models/IGaiaXDataResource.js";
|
|
10
|
+
export * from "./models/IGaiaXEndpoint.js";
|
|
11
|
+
export * from "./models/IGaiaXLegalPerson.js";
|
|
12
|
+
export * from "./models/IGaiaXRegistrationNumber.js";
|
|
13
|
+
export * from "./models/IGaiaXServiceOffering.js";
|
|
14
14
|
//# sourceMappingURL=index.js.map
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yCAAyC,CAAC;AACxD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/gaiaXDataTypes.js\";\nexport * from \"./models/gaiaXContexts.js\";\nexport * from \"./models/gaiaXContextType.js\";\nexport * from \"./models/gaiaXTypes.js\";\nexport * from \"./models/IGaiaXAddress.js\";\nexport * from \"./models/IGaiaXDataExchangeComponent.js\";\nexport * from \"./models/IGaiaXDataResource.js\";\nexport * from \"./models/IGaiaXEndpoint.js\";\nexport * from \"./models/IGaiaXLegalPerson.js\";\nexport * from \"./models/IGaiaXRegistrationNumber.js\";\nexport * from \"./models/IGaiaXServiceOffering.js\";\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXAddress.js","sourceRoot":"","sources":["../../../src/models/IGaiaXAddress.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Address as defined by Gaia-X\n * https://docs.gaia-x.eu/ontology/development/classes/Address/\n */\nexport interface IGaiaXAddress extends IJsonLdNodeObject {\n\t/**\n\t * JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.\n\t */\n\ttype: typeof GaiaXTypes.Address | undefined;\n\n\t/**\n\t * Country code in ISO 3166-1 alpha2, alpha-3 or numeric format\n\t */\n\tcountryCode: string | number;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXDataExchangeComponent.js","sourceRoot":"","sources":["../../../src/models/IGaiaXDataExchangeComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXContextType } from \"./gaiaXContextType.js\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Data Exchange component as defined by Gaia-X\n * https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent\n */\nexport interface IGaiaXDataExchangeComponent extends IJsonLdNodeObject {\n\t/**\n\t * The LD Context\n\t */\n\t\"@context\": GaiaXContextType;\n\n\t/**\n\t * The type of JSON-LD node\n\t */\n\ttype:\n\t\t| typeof GaiaXTypes.DataExchangeComponent\n\t\t| [typeof GaiaXTypes.DataExchangeComponent, ...string[]];\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXDataResource.js","sourceRoot":"","sources":["../../../src/models/IGaiaXDataResource.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ObjectOrArray } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { GaiaXContextType } from \"./gaiaXContextType.js\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IGaiaXDataExchangeComponent } from \"./IGaiaXDataExchangeComponent.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { IGaiaXLegalPerson } from \"./IGaiaXLegalPerson.js\";\n\n/**\n * A Data Resource as defined by Gaia-X.\n * See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.\n */\nexport interface IGaiaXDataResource extends IGaiaXEntity {\n\t/**\n\t * The LD Context\n\t */\n\t\"@context\": GaiaXContextType;\n\n\t/**\n\t * Subject Id\n\t */\n\tid: string;\n\n\t/**\n\t * Subject type\n\t */\n\ttype: typeof GaiaXTypes.DataResource;\n\n\t/**\n\t * The Resource Name\n\t */\n\tname: string;\n\n\t/**\n\t * Exposed through a Data Exchange Component.\n\t * 'string' in case just an Id pointing to the Data Exchange Component is supplied\n\t * the third case covers the idiom where a JSON-LD Node is supplied with id and type.\n\t */\n\texposedThrough:\n\t\t| IGaiaXDataExchangeComponent\n\t\t| string\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.DataExchangeComponent });\n\n\t/**\n\t * Who is the data producer\n\t */\n\tproducedBy: IGaiaXLegalPerson | string;\n\n\t/**\n\t * Pointer (URL) to the license\n\t */\n\tlicense: string;\n\n\t/**\n\t * Copyright owner\n\t */\n\tcopyrightOwnedBy: IGaiaXLegalPerson | string;\n\n\t/**\n\t * ODRL Policy\n\t */\n\tresourcePolicy: ObjectOrArray<IOdrlPolicy>;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXEndpoint.js","sourceRoot":"","sources":["../../../src/models/IGaiaXEndpoint.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Endpoint as defined by the Gaia-X ontology.\n * https://docs.gaia-x.eu/ontology/development/classes/Endpoint\n */\nexport interface IGaiaXEndpoint extends IJsonLdNodeObject {\n\t/**\n\t * The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.\n\t */\n\ttype: typeof GaiaXTypes.Endpoint | undefined;\n\n\t/**\n\t * The endpoint URL\n\t */\n\tendpointURL: string;\n\n\t/**\n\t * The formal description\n\t */\n\tformalDescription?: string;\n\n\t/**\n\t * Standards conformity\n\t */\n\tstandardConformity?: IJsonLdNodeObject;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXLegalPerson.js","sourceRoot":"","sources":["../../../src/models/IGaiaXLegalPerson.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IGaiaXAddress } from \"./IGaiaXAddress.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { IGaiaXRegistrationNumber } from \"./IGaiaXRegistrationNumber.js\";\n\n/**\n * A Legal Person as defined by Gaia-X.\n * @see https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.\n */\nexport interface IGaiaXLegalPerson extends IGaiaXEntity {\n\t/**\n\t * JSON-LD type.\n\t */\n\ttype: typeof GaiaXTypes.LegalPerson;\n\n\t/**\n\t * The legal registration number.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/\n\t */\n\tregistrationNumber: IGaiaXRegistrationNumber;\n\n\t/**\n\t * The legal name.\n\t */\n\tlegalName: string;\n\n\t/**\n\t * Legal Address\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/legalAddress/\n\t */\n\tlegalAddress: IGaiaXAddress;\n\n\t/**\n\t * Headquarters address.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/\n\t */\n\theadquartersAddress?: IGaiaXAddress;\n\n\t/**\n\t * Parent organization.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/\n\t */\n\tparentOrganizationOf?: (IJsonLdNodeObject & {\n\t\tid: string;\n\t\ttype: typeof GaiaXTypes.LegalPerson;\n\t})[];\n\n\t/**\n\t * Sub organization of.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/parentSubOrganizationOf\n\t */\n\tsubOrganizationOf?: (IJsonLdNodeObject & {\n\t\tid: string;\n\t\ttype: typeof GaiaXTypes.LegalPerson;\n\t})[];\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXRegistrationNumber.js","sourceRoot":"","sources":["../../../src/models/IGaiaXRegistrationNumber.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Registration Number as defined by the Gaia-X ontology.\n * https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/\n */\nexport interface IGaiaXRegistrationNumber extends IJsonLdNodeObject {\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype:\n\t\t| typeof GaiaXTypes.RegistrationNumber\n\t\t| typeof GaiaXTypes.LocalRegistrationNumber\n\t\t| typeof GaiaXTypes.EORI\n\t\t| typeof GaiaXTypes.EUID\n\t\t| typeof GaiaXTypes.LeiCode\n\t\t| typeof GaiaXTypes.TaxID\n\t\t| typeof GaiaXTypes.VatID;\n\n\t/**\n\t * Local Registration.\n\t */\n\tlocal?: string;\n\n\t/**\n\t * Country code. See https://docs.gaia-x.eu/ontology/development/enums/CountryNameAlpha2/\n\t */\n\tcountryCode?: string;\n\n\t/**\n\t * Subdivision country code.\n\t * See https://docs.gaia-x.eu/ontology/development/enums/RegionCode/\n\t */\n\tsubdivisionCountryCode?: string;\n\n\t/**\n\t * The VAT identification number.\n\t */\n\tvatID?: string;\n\n\t/**\n\t * Unique LEI number as defined by GLEIF.\n\t */\n\tleiCode?: string;\n\n\t/**\n\t * The Economic Operators Registration and Identification number (EORI).\n\t */\n\teori?: string;\n\n\t/**\n\t * The country where the EORI is registered written in plain english\n\t */\n\tcountry?: string;\n\n\t/**\n\t * The European Unique Identifier (EUID) for business located in the European Ec.\n\t */\n\teuid?: string;\n\n\t/**\n\t * The company tax ID.\n\t */\n\ttaxId?: string;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IGaiaXServiceOffering.js","sourceRoot":"","sources":["../../../src/models/IGaiaXServiceOffering.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ObjectOrArray } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IGaiaXDataResource } from \"./IGaiaXDataResource.js\";\nimport type { IGaiaXEndpoint } from \"./IGaiaXEndpoint.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { IGaiaXLegalPerson } from \"./IGaiaXLegalPerson.js\";\n\n/**\n * A Service offering\n */\nexport interface IGaiaXServiceOffering extends IGaiaXEntity {\n\t/**\n\t * Type\n\t */\n\ttype: typeof GaiaXTypes.ServiceOffering;\n\n\t/**\n\t * Name of the Service Offering.\n\t */\n\tname: string;\n\n\t/**\n\t * Participant that provides the offering\n\t */\n\tprovidedBy:\n\t\t| string\n\t\t| IGaiaXLegalPerson\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.LegalPerson });\n\n\t/**\n\t * ODRL policy associated to the service offering\n\t */\n\tservicePolicy: ObjectOrArray<IOdrlPolicy>;\n\n\t/**\n\t * Resources aggregated\n\t * It is supported different representations, inline,\n\t * by reference both providing the URI or a partial JSON-LD Node object\n\t */\n\taggregationOfResources?:\n\t\t| string[]\n\t\t| IGaiaXDataResource[]\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.DataResource });\n\n\t/**\n\t * The endpoint\n\t */\n\tendpoint?: IGaiaXEndpoint;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gaiaXContextType.js","sourceRoot":"","sources":["../../../src/models/gaiaXContextType.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { GaiaXContexts } from \"./gaiaXContexts.js\";\n\n/**\n * The Gaia-X JSON-LD context type.\n */\nexport type GaiaXContextType =\n\t| typeof GaiaXContexts.
|
|
1
|
+
{"version":3,"file":"gaiaXContextType.js","sourceRoot":"","sources":["../../../src/models/gaiaXContextType.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { GaiaXContexts } from \"./gaiaXContexts.js\";\n\n/**\n * The Gaia-X JSON-LD context type.\n */\nexport type GaiaXContextType =\n\t| typeof GaiaXContexts.Namespace\n\t| [\n\t\t\t...IJsonLdContextDefinitionElement[],\n\t\t\ttypeof GaiaXContexts.Namespace,\n\t\t\tIJsonLdContextDefinitionElement\n\t ]\n\t| [\n\t\t\tIJsonLdContextDefinitionElement,\n\t\t\ttypeof GaiaXContexts.Namespace,\n\t\t\t...IJsonLdContextDefinitionElement[]\n\t ];\n"]}
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
// Copyright 2024 IOTA Stiftung.
|
|
2
2
|
// SPDX-License-Identifier: Apache-2.0.
|
|
3
3
|
/**
|
|
4
|
-
* The
|
|
4
|
+
* The Contexts concerning Gaia-X.
|
|
5
5
|
*/
|
|
6
6
|
// eslint-disable-next-line @typescript-eslint/naming-convention
|
|
7
7
|
export const GaiaXContexts = {
|
|
8
8
|
/**
|
|
9
|
-
* The Gaia-X
|
|
9
|
+
* The Gaia-X Namespace
|
|
10
10
|
*/
|
|
11
|
-
|
|
11
|
+
Namespace: "https://schema.twindev.org/gaia-x-loire/"
|
|
12
12
|
};
|
|
13
13
|
//# sourceMappingURL=gaiaXContexts.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"gaiaXContexts.js","sourceRoot":"","sources":["../../../src/models/gaiaXContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,
|
|
1
|
+
{"version":3,"file":"gaiaXContexts.js","sourceRoot":"","sources":["../../../src/models/gaiaXContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,0CAA0C;CAC5C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The Contexts concerning Gaia-X.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const GaiaXContexts = {\n\t/**\n\t * The Gaia-X Namespace\n\t */\n\tNamespace: \"https://schema.twindev.org/gaia-x-loire/\"\n} as const;\n\n/**\n * The Contexts concerning Gaia-X.\n */\nexport type GaiaXContexts = (typeof GaiaXContexts)[keyof typeof GaiaXContexts];\n"]}
|
|
@@ -14,36 +14,32 @@
|
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
16
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
|
+
],
|
|
17
26
|
"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
27
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
30
28
|
}
|
|
31
29
|
},
|
|
32
30
|
{
|
|
33
31
|
"type": "array",
|
|
34
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
|
+
],
|
|
35
42
|
"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
43
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
48
44
|
}
|
|
49
45
|
}
|
|
@@ -122,15 +118,13 @@
|
|
|
122
118
|
{
|
|
123
119
|
"type": "array",
|
|
124
120
|
"minItems": 1,
|
|
121
|
+
"prefixItems": [
|
|
122
|
+
{
|
|
123
|
+
"type": "string",
|
|
124
|
+
"const": "DataExchangeComponent"
|
|
125
|
+
}
|
|
126
|
+
],
|
|
125
127
|
"items": {
|
|
126
|
-
"anyOf": [
|
|
127
|
-
{
|
|
128
|
-
"type": "string",
|
|
129
|
-
"const": "DataExchangeComponent"
|
|
130
|
-
}
|
|
131
|
-
]
|
|
132
|
-
},
|
|
133
|
-
"additionalItems": {
|
|
134
128
|
"type": "string"
|
|
135
129
|
}
|
|
136
130
|
}
|
|
@@ -14,36 +14,32 @@
|
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
16
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
|
+
],
|
|
17
26
|
"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
27
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
30
28
|
}
|
|
31
29
|
},
|
|
32
30
|
{
|
|
33
31
|
"type": "array",
|
|
34
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
|
+
],
|
|
35
42
|
"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
43
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
48
44
|
}
|
|
49
45
|
}
|
|
@@ -14,36 +14,32 @@
|
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
16
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
|
+
],
|
|
17
26
|
"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
27
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
30
28
|
}
|
|
31
29
|
},
|
|
32
30
|
{
|
|
33
31
|
"type": "array",
|
|
34
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
|
+
],
|
|
35
42
|
"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
43
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
48
44
|
}
|
|
49
45
|
}
|
|
@@ -14,36 +14,32 @@
|
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
16
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
|
+
],
|
|
17
26
|
"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
27
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
30
28
|
}
|
|
31
29
|
},
|
|
32
30
|
{
|
|
33
31
|
"type": "array",
|
|
34
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
|
+
],
|
|
35
42
|
"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
43
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
48
44
|
}
|
|
49
45
|
}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -2,10 +2,10 @@ export * from "./dataTypes/gaiaXDataTypes.js";
|
|
|
2
2
|
export * from "./models/gaiaXContexts.js";
|
|
3
3
|
export * from "./models/gaiaXContextType.js";
|
|
4
4
|
export * from "./models/gaiaXTypes.js";
|
|
5
|
-
export * from "./models/
|
|
6
|
-
export * from "./models/
|
|
7
|
-
export * from "./models/
|
|
8
|
-
export * from "./models/
|
|
9
|
-
export * from "./models/
|
|
10
|
-
export * from "./models/
|
|
11
|
-
export * from "./models/
|
|
5
|
+
export * from "./models/IGaiaXAddress.js";
|
|
6
|
+
export * from "./models/IGaiaXDataExchangeComponent.js";
|
|
7
|
+
export * from "./models/IGaiaXDataResource.js";
|
|
8
|
+
export * from "./models/IGaiaXEndpoint.js";
|
|
9
|
+
export * from "./models/IGaiaXLegalPerson.js";
|
|
10
|
+
export * from "./models/IGaiaXRegistrationNumber.js";
|
|
11
|
+
export * from "./models/IGaiaXServiceOffering.js";
|
|
@@ -4,7 +4,7 @@ import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
|
4
4
|
* Address as defined by Gaia-X
|
|
5
5
|
* https://docs.gaia-x.eu/ontology/development/classes/Address/
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IGaiaXAddress extends IJsonLdNodeObject {
|
|
8
8
|
/**
|
|
9
9
|
* JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.
|
|
10
10
|
*/
|
|
@@ -5,7 +5,7 @@ import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
|
5
5
|
* Data Exchange component as defined by Gaia-X
|
|
6
6
|
* https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
8
|
+
export interface IGaiaXDataExchangeComponent extends IJsonLdNodeObject {
|
|
9
9
|
/**
|
|
10
10
|
* The LD Context
|
|
11
11
|
*/
|
|
@@ -3,14 +3,14 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
|
3
3
|
import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
|
|
4
4
|
import type { GaiaXContextType } from "./gaiaXContextType.js";
|
|
5
5
|
import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
6
|
-
import type {
|
|
6
|
+
import type { IGaiaXDataExchangeComponent } from "./IGaiaXDataExchangeComponent.js";
|
|
7
7
|
import type { IGaiaXEntity } from "./IGaiaXEntity.js";
|
|
8
|
-
import type {
|
|
8
|
+
import type { IGaiaXLegalPerson } from "./IGaiaXLegalPerson.js";
|
|
9
9
|
/**
|
|
10
10
|
* A Data Resource as defined by Gaia-X.
|
|
11
11
|
* See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
|
|
12
12
|
*/
|
|
13
|
-
export interface
|
|
13
|
+
export interface IGaiaXDataResource extends IGaiaXEntity {
|
|
14
14
|
/**
|
|
15
15
|
* The LD Context
|
|
16
16
|
*/
|
|
@@ -32,14 +32,14 @@ export interface IDataResource extends IGaiaXEntity {
|
|
|
32
32
|
* 'string' in case just an Id pointing to the Data Exchange Component is supplied
|
|
33
33
|
* the third case covers the idiom where a JSON-LD Node is supplied with id and type.
|
|
34
34
|
*/
|
|
35
|
-
exposedThrough:
|
|
35
|
+
exposedThrough: IGaiaXDataExchangeComponent | string | (IJsonLdNodeObject & {
|
|
36
36
|
id: string;
|
|
37
37
|
type: typeof GaiaXTypes.DataExchangeComponent;
|
|
38
38
|
});
|
|
39
39
|
/**
|
|
40
40
|
* Who is the data producer
|
|
41
41
|
*/
|
|
42
|
-
producedBy:
|
|
42
|
+
producedBy: IGaiaXLegalPerson | string;
|
|
43
43
|
/**
|
|
44
44
|
* Pointer (URL) to the license
|
|
45
45
|
*/
|
|
@@ -47,7 +47,7 @@ export interface IDataResource extends IGaiaXEntity {
|
|
|
47
47
|
/**
|
|
48
48
|
* Copyright owner
|
|
49
49
|
*/
|
|
50
|
-
copyrightOwnedBy:
|
|
50
|
+
copyrightOwnedBy: IGaiaXLegalPerson | string;
|
|
51
51
|
/**
|
|
52
52
|
* ODRL Policy
|
|
53
53
|
*/
|
|
@@ -4,7 +4,7 @@ import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
|
4
4
|
* Endpoint as defined by the Gaia-X ontology.
|
|
5
5
|
* https://docs.gaia-x.eu/ontology/development/classes/Endpoint
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IGaiaXEndpoint extends IJsonLdNodeObject {
|
|
8
8
|
/**
|
|
9
9
|
* The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.
|
|
10
10
|
*/
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
2
|
import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { IGaiaXAddress } from "./IGaiaXAddress.js";
|
|
4
4
|
import type { IGaiaXEntity } from "./IGaiaXEntity.js";
|
|
5
|
-
import type {
|
|
5
|
+
import type { IGaiaXRegistrationNumber } from "./IGaiaXRegistrationNumber.js";
|
|
6
6
|
/**
|
|
7
7
|
* A Legal Person as defined by Gaia-X.
|
|
8
8
|
* @see https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.
|
|
9
9
|
*/
|
|
10
|
-
export interface
|
|
10
|
+
export interface IGaiaXLegalPerson extends IGaiaXEntity {
|
|
11
11
|
/**
|
|
12
12
|
* JSON-LD type.
|
|
13
13
|
*/
|
|
@@ -16,7 +16,7 @@ export interface ILegalPerson extends IGaiaXEntity {
|
|
|
16
16
|
* The legal registration number.
|
|
17
17
|
* @see https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/
|
|
18
18
|
*/
|
|
19
|
-
registrationNumber:
|
|
19
|
+
registrationNumber: IGaiaXRegistrationNumber;
|
|
20
20
|
/**
|
|
21
21
|
* The legal name.
|
|
22
22
|
*/
|
|
@@ -25,12 +25,12 @@ export interface ILegalPerson extends IGaiaXEntity {
|
|
|
25
25
|
* Legal Address
|
|
26
26
|
* @see https://docs.gaia-x.eu/ontology/development/slots/legalAddress/
|
|
27
27
|
*/
|
|
28
|
-
legalAddress:
|
|
28
|
+
legalAddress: IGaiaXAddress;
|
|
29
29
|
/**
|
|
30
30
|
* Headquarters address.
|
|
31
31
|
* @see https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/
|
|
32
32
|
*/
|
|
33
|
-
headquartersAddress?:
|
|
33
|
+
headquartersAddress?: IGaiaXAddress;
|
|
34
34
|
/**
|
|
35
35
|
* Parent organization.
|
|
36
36
|
* @see https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/
|
|
@@ -4,7 +4,7 @@ import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
|
4
4
|
* Registration Number as defined by the Gaia-X ontology.
|
|
5
5
|
* https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface IGaiaXRegistrationNumber extends IJsonLdNodeObject {
|
|
8
8
|
/**
|
|
9
9
|
* JSON-LD Type.
|
|
10
10
|
*/
|
|
@@ -2,14 +2,14 @@ import type { ObjectOrArray } from "@twin.org/core";
|
|
|
2
2
|
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
3
3
|
import type { IOdrlPolicy } from "@twin.org/standards-w3c-odrl";
|
|
4
4
|
import type { GaiaXTypes } from "./gaiaXTypes.js";
|
|
5
|
-
import type {
|
|
6
|
-
import type {
|
|
5
|
+
import type { IGaiaXDataResource } from "./IGaiaXDataResource.js";
|
|
6
|
+
import type { IGaiaXEndpoint } from "./IGaiaXEndpoint.js";
|
|
7
7
|
import type { IGaiaXEntity } from "./IGaiaXEntity.js";
|
|
8
|
-
import type {
|
|
8
|
+
import type { IGaiaXLegalPerson } from "./IGaiaXLegalPerson.js";
|
|
9
9
|
/**
|
|
10
10
|
* A Service offering
|
|
11
11
|
*/
|
|
12
|
-
export interface
|
|
12
|
+
export interface IGaiaXServiceOffering extends IGaiaXEntity {
|
|
13
13
|
/**
|
|
14
14
|
* Type
|
|
15
15
|
*/
|
|
@@ -21,7 +21,7 @@ export interface IServiceOffering extends IGaiaXEntity {
|
|
|
21
21
|
/**
|
|
22
22
|
* Participant that provides the offering
|
|
23
23
|
*/
|
|
24
|
-
providedBy: string |
|
|
24
|
+
providedBy: string | IGaiaXLegalPerson | (IJsonLdNodeObject & {
|
|
25
25
|
id: string;
|
|
26
26
|
type: typeof GaiaXTypes.LegalPerson;
|
|
27
27
|
});
|
|
@@ -34,12 +34,12 @@ export interface IServiceOffering extends IGaiaXEntity {
|
|
|
34
34
|
* It is supported different representations, inline,
|
|
35
35
|
* by reference both providing the URI or a partial JSON-LD Node object
|
|
36
36
|
*/
|
|
37
|
-
aggregationOfResources?: string[] |
|
|
37
|
+
aggregationOfResources?: string[] | IGaiaXDataResource[] | (IJsonLdNodeObject & {
|
|
38
38
|
id: string;
|
|
39
39
|
type: typeof GaiaXTypes.DataResource;
|
|
40
40
|
});
|
|
41
41
|
/**
|
|
42
42
|
* The endpoint
|
|
43
43
|
*/
|
|
44
|
-
endpoint?:
|
|
44
|
+
endpoint?: IGaiaXEndpoint;
|
|
45
45
|
}
|
|
@@ -3,12 +3,12 @@ import type { GaiaXContexts } from "./gaiaXContexts.js";
|
|
|
3
3
|
/**
|
|
4
4
|
* The Gaia-X JSON-LD context type.
|
|
5
5
|
*/
|
|
6
|
-
export type GaiaXContextType = typeof GaiaXContexts.
|
|
6
|
+
export type GaiaXContextType = typeof GaiaXContexts.Namespace | [
|
|
7
7
|
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof GaiaXContexts.
|
|
8
|
+
typeof GaiaXContexts.Namespace,
|
|
9
9
|
IJsonLdContextDefinitionElement
|
|
10
10
|
] | [
|
|
11
11
|
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof GaiaXContexts.
|
|
12
|
+
typeof GaiaXContexts.Namespace,
|
|
13
13
|
...IJsonLdContextDefinitionElement[]
|
|
14
14
|
];
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* The
|
|
2
|
+
* The Contexts concerning Gaia-X.
|
|
3
3
|
*/
|
|
4
4
|
export declare const GaiaXContexts: {
|
|
5
5
|
/**
|
|
6
|
-
* The Gaia-X
|
|
6
|
+
* The Gaia-X Namespace
|
|
7
7
|
*/
|
|
8
|
-
readonly
|
|
8
|
+
readonly Namespace: "https://schema.twindev.org/gaia-x-loire/";
|
|
9
9
|
};
|
|
10
10
|
/**
|
|
11
|
-
* The
|
|
11
|
+
* The Contexts concerning Gaia-X.
|
|
12
12
|
*/
|
|
13
13
|
export type GaiaXContexts = (typeof GaiaXContexts)[keyof typeof GaiaXContexts];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,145 @@
|
|
|
1
1
|
# @twin.org/standards-gaia-x - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.11](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.10...standards-gaia-x-v0.0.3-next.11) (2026-01-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* improved namespaces and contexts ([#102](https://github.com/twinfoundation/standards/issues/102)) ([c74c370](https://github.com/twinfoundation/standards/commit/c74c370cd8145d6166ca4454353f3774c302ac3b))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.10 to 0.0.3-next.11
|
|
16
|
+
|
|
17
|
+
## [0.0.3-next.10](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.9...standards-gaia-x-v0.0.3-next.10) (2026-01-13)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Miscellaneous Chores
|
|
21
|
+
|
|
22
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Dependencies
|
|
26
|
+
|
|
27
|
+
* The following workspace dependencies were updated
|
|
28
|
+
* dependencies
|
|
29
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.9 to 0.0.3-next.10
|
|
30
|
+
|
|
31
|
+
## [0.0.3-next.9](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.8...standards-gaia-x-v0.0.3-next.9) (2026-01-09)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Miscellaneous Chores
|
|
35
|
+
|
|
36
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
### Dependencies
|
|
40
|
+
|
|
41
|
+
* The following workspace dependencies were updated
|
|
42
|
+
* dependencies
|
|
43
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.8 to 0.0.3-next.9
|
|
44
|
+
|
|
45
|
+
## [0.0.3-next.8](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.7...standards-gaia-x-v0.0.3-next.8) (2026-01-08)
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Miscellaneous Chores
|
|
49
|
+
|
|
50
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### Dependencies
|
|
54
|
+
|
|
55
|
+
* The following workspace dependencies were updated
|
|
56
|
+
* dependencies
|
|
57
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.7 to 0.0.3-next.8
|
|
58
|
+
|
|
59
|
+
## [0.0.3-next.7](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.6...standards-gaia-x-v0.0.3-next.7) (2026-01-06)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Features
|
|
63
|
+
|
|
64
|
+
* update type names ([#89](https://github.com/twinfoundation/standards/issues/89)) ([6fdef47](https://github.com/twinfoundation/standards/commit/6fdef4792151f89d1a95a07da8309d05a7b6de3d))
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
### Dependencies
|
|
68
|
+
|
|
69
|
+
* The following workspace dependencies were updated
|
|
70
|
+
* dependencies
|
|
71
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.6 to 0.0.3-next.7
|
|
72
|
+
|
|
73
|
+
## [0.0.3-next.6](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.5...standards-gaia-x-v0.0.3-next.6) (2025-12-03)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
### Miscellaneous Chores
|
|
77
|
+
|
|
78
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
### Dependencies
|
|
82
|
+
|
|
83
|
+
* The following workspace dependencies were updated
|
|
84
|
+
* dependencies
|
|
85
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.5 to 0.0.3-next.6
|
|
86
|
+
|
|
87
|
+
## [0.0.3-next.5](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.4...standards-gaia-x-v0.0.3-next.5) (2025-11-28)
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
### Miscellaneous Chores
|
|
91
|
+
|
|
92
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
### Dependencies
|
|
96
|
+
|
|
97
|
+
* The following workspace dependencies were updated
|
|
98
|
+
* dependencies
|
|
99
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.4 to 0.0.3-next.5
|
|
100
|
+
|
|
101
|
+
## [0.0.3-next.4](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.3...standards-gaia-x-v0.0.3-next.4) (2025-11-18)
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### Miscellaneous Chores
|
|
105
|
+
|
|
106
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
### Dependencies
|
|
110
|
+
|
|
111
|
+
* The following workspace dependencies were updated
|
|
112
|
+
* dependencies
|
|
113
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
114
|
+
|
|
115
|
+
## [0.0.3-next.3](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.2...standards-gaia-x-v0.0.3-next.3) (2025-11-18)
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### Miscellaneous Chores
|
|
119
|
+
|
|
120
|
+
* **standards-gaia-x:** Synchronize repo versions
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
### Dependencies
|
|
124
|
+
|
|
125
|
+
* The following workspace dependencies were updated
|
|
126
|
+
* dependencies
|
|
127
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.2 to 0.0.3-next.3
|
|
128
|
+
|
|
129
|
+
## [0.0.3-next.2](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.1...standards-gaia-x-v0.0.3-next.2) (2025-11-11)
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
### Features
|
|
133
|
+
|
|
134
|
+
* update schemas ([c3c11e0](https://github.com/twinfoundation/standards/commit/c3c11e07da6c0d3eac5ea4a68e3ad57f022b2351))
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
### Dependencies
|
|
138
|
+
|
|
139
|
+
* The following workspace dependencies were updated
|
|
140
|
+
* dependencies
|
|
141
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.1 to 0.0.3-next.2
|
|
142
|
+
|
|
3
143
|
## [0.0.3-next.1](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.3-next.0...standards-gaia-x-v0.0.3-next.1) (2025-11-10)
|
|
4
144
|
|
|
5
145
|
|
package/docs/reference/index.md
CHANGED
|
@@ -6,13 +6,13 @@
|
|
|
6
6
|
|
|
7
7
|
## Interfaces
|
|
8
8
|
|
|
9
|
-
- [
|
|
10
|
-
- [
|
|
11
|
-
- [
|
|
12
|
-
- [
|
|
13
|
-
- [
|
|
14
|
-
- [
|
|
15
|
-
- [
|
|
9
|
+
- [IGaiaXAddress](interfaces/IGaiaXAddress.md)
|
|
10
|
+
- [IGaiaXDataExchangeComponent](interfaces/IGaiaXDataExchangeComponent.md)
|
|
11
|
+
- [IGaiaXDataResource](interfaces/IGaiaXDataResource.md)
|
|
12
|
+
- [IGaiaXEndpoint](interfaces/IGaiaXEndpoint.md)
|
|
13
|
+
- [IGaiaXLegalPerson](interfaces/IGaiaXLegalPerson.md)
|
|
14
|
+
- [IGaiaXRegistrationNumber](interfaces/IGaiaXRegistrationNumber.md)
|
|
15
|
+
- [IGaiaXServiceOffering](interfaces/IGaiaXServiceOffering.md)
|
|
16
16
|
|
|
17
17
|
## Type Aliases
|
|
18
18
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IGaiaXDataResource
|
|
2
2
|
|
|
3
3
|
A Data Resource as defined by Gaia-X.
|
|
4
4
|
See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
|
|
@@ -59,7 +59,7 @@ The Resource Name
|
|
|
59
59
|
|
|
60
60
|
### exposedThrough
|
|
61
61
|
|
|
62
|
-
> **exposedThrough**: `string` \| [`
|
|
62
|
+
> **exposedThrough**: `string` \| [`IGaiaXDataExchangeComponent`](IGaiaXDataExchangeComponent.md) \| `IJsonLdNodeObject` & `object`
|
|
63
63
|
|
|
64
64
|
Exposed through a Data Exchange Component.
|
|
65
65
|
'string' in case just an Id pointing to the Data Exchange Component is supplied
|
|
@@ -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` \| [`IGaiaXLegalPerson`](IGaiaXLegalPerson.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` \| [`IGaiaXLegalPerson`](IGaiaXLegalPerson.md)
|
|
89
89
|
|
|
90
90
|
Copyright owner
|
|
91
91
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IGaiaXLegalPerson
|
|
2
2
|
|
|
3
3
|
A Legal Person as defined by Gaia-X.
|
|
4
4
|
|
|
@@ -74,7 +74,7 @@ JSON-LD type.
|
|
|
74
74
|
|
|
75
75
|
### registrationNumber
|
|
76
76
|
|
|
77
|
-
> **registrationNumber**: [`
|
|
77
|
+
> **registrationNumber**: [`IGaiaXRegistrationNumber`](IGaiaXRegistrationNumber.md)
|
|
78
78
|
|
|
79
79
|
The legal registration number.
|
|
80
80
|
|
|
@@ -94,7 +94,7 @@ The legal name.
|
|
|
94
94
|
|
|
95
95
|
### legalAddress
|
|
96
96
|
|
|
97
|
-
> **legalAddress**: [`
|
|
97
|
+
> **legalAddress**: [`IGaiaXAddress`](IGaiaXAddress.md)
|
|
98
98
|
|
|
99
99
|
Legal Address
|
|
100
100
|
|
|
@@ -106,7 +106,7 @@ https://docs.gaia-x.eu/ontology/development/slots/legalAddress/
|
|
|
106
106
|
|
|
107
107
|
### headquartersAddress?
|
|
108
108
|
|
|
109
|
-
> `optional` **headquartersAddress**: [`
|
|
109
|
+
> `optional` **headquartersAddress**: [`IGaiaXAddress`](IGaiaXAddress.md)
|
|
110
110
|
|
|
111
111
|
Headquarters address.
|
|
112
112
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Interface:
|
|
1
|
+
# Interface: IGaiaXServiceOffering
|
|
2
2
|
|
|
3
3
|
A Service offering
|
|
4
4
|
|
|
@@ -70,7 +70,7 @@ Name of the Service Offering.
|
|
|
70
70
|
|
|
71
71
|
### providedBy
|
|
72
72
|
|
|
73
|
-
> **providedBy**: `string` \| [`
|
|
73
|
+
> **providedBy**: `string` \| [`IGaiaXLegalPerson`](IGaiaXLegalPerson.md) \| `IJsonLdNodeObject` & `object`
|
|
74
74
|
|
|
75
75
|
Participant that provides the offering
|
|
76
76
|
|
|
@@ -86,7 +86,7 @@ ODRL policy associated to the service offering
|
|
|
86
86
|
|
|
87
87
|
### aggregationOfResources?
|
|
88
88
|
|
|
89
|
-
> `optional` **aggregationOfResources**: `string`[] \| [`
|
|
89
|
+
> `optional` **aggregationOfResources**: `string`[] \| [`IGaiaXDataResource`](IGaiaXDataResource.md)[] \| `IJsonLdNodeObject` & `object`
|
|
90
90
|
|
|
91
91
|
Resources aggregated
|
|
92
92
|
It is supported different representations, inline,
|
|
@@ -96,6 +96,6 @@ by reference both providing the URI or a partial JSON-LD Node object
|
|
|
96
96
|
|
|
97
97
|
### endpoint?
|
|
98
98
|
|
|
99
|
-
> `optional` **endpoint**: [`
|
|
99
|
+
> `optional` **endpoint**: [`IGaiaXEndpoint`](IGaiaXEndpoint.md)
|
|
100
100
|
|
|
101
101
|
The endpoint
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: GaiaXContextType
|
|
2
2
|
|
|
3
|
-
> **GaiaXContextType** = *typeof* [`
|
|
3
|
+
> **GaiaXContextType** = *typeof* [`Namespace`](../variables/GaiaXContexts.md#namespace) \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`Namespace`](../variables/GaiaXContexts.md#namespace), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`Namespace`](../variables/GaiaXContexts.md#namespace), `...IJsonLdContextDefinitionElement[]`\]
|
|
4
4
|
|
|
5
5
|
The Gaia-X JSON-LD context type.
|
|
@@ -2,12 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
> `const` **GaiaXContexts**: `object`
|
|
4
4
|
|
|
5
|
-
The
|
|
5
|
+
The Contexts concerning Gaia-X.
|
|
6
6
|
|
|
7
7
|
## Type Declaration
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### Namespace
|
|
10
10
|
|
|
11
|
-
> `readonly` **
|
|
11
|
+
> `readonly` **Namespace**: `"https://schema.twindev.org/gaia-x-loire/"` = `"https://schema.twindev.org/gaia-x-loire/"`
|
|
12
12
|
|
|
13
|
-
The Gaia-X
|
|
13
|
+
The Gaia-X Namespace
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/standards-gaia-x",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.11",
|
|
4
4
|
"description": "Models which define the structure of Gaia-x",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@twin.org/core": "next",
|
|
18
18
|
"@twin.org/data-core": "next",
|
|
19
19
|
"@twin.org/data-json-ld": "next",
|
|
20
|
-
"@twin.org/standards-w3c-odrl": "0.0.3-next.
|
|
20
|
+
"@twin.org/standards-w3c-odrl": "0.0.3-next.11"
|
|
21
21
|
},
|
|
22
22
|
"main": "./dist/es/index.js",
|
|
23
23
|
"types": "./dist/types/index.d.ts",
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IAddress.js","sourceRoot":"","sources":["../../../src/models/IAddress.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Address as defined by Gaia-X\n * https://docs.gaia-x.eu/ontology/development/classes/Address/\n */\nexport interface IAddress extends IJsonLdNodeObject {\n\t/**\n\t * JSON-LD @ type. In this case it is allowed to be omitted as it is usually a child node.\n\t */\n\ttype: typeof GaiaXTypes.Address | undefined;\n\n\t/**\n\t * Country code in ISO 3166-1 alpha2, alpha-3 or numeric format\n\t */\n\tcountryCode: string | number;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IDataExchangeComponent.js","sourceRoot":"","sources":["../../../src/models/IDataExchangeComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXContextType } from \"./gaiaXContextType.js\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Data Exchange component as defined by Gaia-X\n * https://docs.gaia-x.eu/ontology/development/classes/DataExchangeComponent\n */\nexport interface IDataExchangeComponent extends IJsonLdNodeObject {\n\t/**\n\t * The LD Context\n\t */\n\t\"@context\": GaiaXContextType;\n\n\t/**\n\t * The type of JSON-LD node\n\t */\n\ttype:\n\t\t| typeof GaiaXTypes.DataExchangeComponent\n\t\t| [typeof GaiaXTypes.DataExchangeComponent, ...string[]];\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IDataResource.js","sourceRoot":"","sources":["../../../src/models/IDataResource.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ObjectOrArray } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { GaiaXContextType } from \"./gaiaXContextType.js\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IDataExchangeComponent } from \"./IDataExchangeComponent.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { ILegalPerson } from \"./ILegalPerson.js\";\n\n/**\n * A Data Resource as defined by Gaia-X.\n * See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.\n */\nexport interface IDataResource extends IGaiaXEntity {\n\t/**\n\t * The LD Context\n\t */\n\t\"@context\": GaiaXContextType;\n\n\t/**\n\t * Subject Id\n\t */\n\tid: string;\n\n\t/**\n\t * Subject type\n\t */\n\ttype: typeof GaiaXTypes.DataResource;\n\n\t/**\n\t * The Resource Name\n\t */\n\tname: string;\n\n\t/**\n\t * Exposed through a Data Exchange Component.\n\t * 'string' in case just an Id pointing to the Data Exchange Component is supplied\n\t * the third case covers the idiom where a JSON-LD Node is supplied with id and type.\n\t */\n\texposedThrough:\n\t\t| IDataExchangeComponent\n\t\t| string\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.DataExchangeComponent });\n\n\t/**\n\t * Who is the data producer\n\t */\n\tproducedBy: ILegalPerson | string;\n\n\t/**\n\t * Pointer (URL) to the license\n\t */\n\tlicense: string;\n\n\t/**\n\t * Copyright owner\n\t */\n\tcopyrightOwnedBy: ILegalPerson | string;\n\n\t/**\n\t * ODRL Policy\n\t */\n\tresourcePolicy: ObjectOrArray<IOdrlPolicy>;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IEndpoint.js","sourceRoot":"","sources":["../../../src/models/IEndpoint.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Endpoint as defined by the Gaia-X ontology.\n * https://docs.gaia-x.eu/ontology/development/classes/Endpoint\n */\nexport interface IEndpoint extends IJsonLdNodeObject {\n\t/**\n\t * The type of JSON-LD node. In this case it is allowed to be omitted as it is usually a child node.\n\t */\n\ttype: typeof GaiaXTypes.Endpoint | undefined;\n\n\t/**\n\t * The endpoint URL\n\t */\n\tendpointURL: string;\n\n\t/**\n\t * The formal description\n\t */\n\tformalDescription?: string;\n\n\t/**\n\t * Standards conformity\n\t */\n\tstandardConformity?: IJsonLdNodeObject;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"ILegalPerson.js","sourceRoot":"","sources":["../../../src/models/ILegalPerson.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IAddress } from \"./IAddress.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { IRegistrationNumber } from \"./IRegistrationNumber.js\";\n\n/**\n * A Legal Person as defined by Gaia-X.\n * @see https://docs.gaia-x.eu/ontology/development/classes/LegalPerson/.\n */\nexport interface ILegalPerson extends IGaiaXEntity {\n\t/**\n\t * JSON-LD type.\n\t */\n\ttype: typeof GaiaXTypes.LegalPerson;\n\n\t/**\n\t * The legal registration number.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/registrationNumber/\n\t */\n\tregistrationNumber: IRegistrationNumber;\n\n\t/**\n\t * The legal name.\n\t */\n\tlegalName: string;\n\n\t/**\n\t * Legal Address\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/legalAddress/\n\t */\n\tlegalAddress: IAddress;\n\n\t/**\n\t * Headquarters address.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/headquartersAddress/\n\t */\n\theadquartersAddress?: IAddress;\n\n\t/**\n\t * Parent organization.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/parentOrganizationOf/\n\t */\n\tparentOrganizationOf?: (IJsonLdNodeObject & {\n\t\tid: string;\n\t\ttype: typeof GaiaXTypes.LegalPerson;\n\t})[];\n\n\t/**\n\t * Sub organization of.\n\t * @see https://docs.gaia-x.eu/ontology/development/slots/parentSubOrganizationOf\n\t */\n\tsubOrganizationOf?: (IJsonLdNodeObject & {\n\t\tid: string;\n\t\ttype: typeof GaiaXTypes.LegalPerson;\n\t})[];\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IRegistrationNumber.js","sourceRoot":"","sources":["../../../src/models/IRegistrationNumber.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\n\n/**\n * Registration Number as defined by the Gaia-X ontology.\n * https://docs.gaia-x.eu/ontology/development/classes/RegistrationNumber/\n */\nexport interface IRegistrationNumber extends IJsonLdNodeObject {\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype:\n\t\t| typeof GaiaXTypes.RegistrationNumber\n\t\t| typeof GaiaXTypes.LocalRegistrationNumber\n\t\t| typeof GaiaXTypes.EORI\n\t\t| typeof GaiaXTypes.EUID\n\t\t| typeof GaiaXTypes.LeiCode\n\t\t| typeof GaiaXTypes.TaxID\n\t\t| typeof GaiaXTypes.VatID;\n\n\t/**\n\t * Local Registration.\n\t */\n\tlocal?: string;\n\n\t/**\n\t * Country code. See https://docs.gaia-x.eu/ontology/development/enums/CountryNameAlpha2/\n\t */\n\tcountryCode?: string;\n\n\t/**\n\t * Subdivision country code.\n\t * See https://docs.gaia-x.eu/ontology/development/enums/RegionCode/\n\t */\n\tsubdivisionCountryCode?: string;\n\n\t/**\n\t * The VAT identification number.\n\t */\n\tvatID?: string;\n\n\t/**\n\t * Unique LEI number as defined by GLEIF.\n\t */\n\tleiCode?: string;\n\n\t/**\n\t * The Economic Operators Registration and Identification number (EORI).\n\t */\n\teori?: string;\n\n\t/**\n\t * The country where the EORI is registered written in plain english\n\t */\n\tcountry?: string;\n\n\t/**\n\t * The European Unique Identifier (EUID) for business located in the European Ec.\n\t */\n\teuid?: string;\n\n\t/**\n\t * The company tax ID.\n\t */\n\ttaxId?: string;\n}\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IServiceOffering.js","sourceRoot":"","sources":["../../../src/models/IServiceOffering.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ObjectOrArray } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IOdrlPolicy } from \"@twin.org/standards-w3c-odrl\";\nimport type { GaiaXTypes } from \"./gaiaXTypes.js\";\nimport type { IDataResource } from \"./IDataResource.js\";\nimport type { IEndpoint } from \"./IEndpoint.js\";\nimport type { IGaiaXEntity } from \"./IGaiaXEntity.js\";\nimport type { ILegalPerson } from \"./ILegalPerson.js\";\n\n/**\n * A Service offering\n */\nexport interface IServiceOffering extends IGaiaXEntity {\n\t/**\n\t * Type\n\t */\n\ttype: typeof GaiaXTypes.ServiceOffering;\n\n\t/**\n\t * Name of the Service Offering.\n\t */\n\tname: string;\n\n\t/**\n\t * Participant that provides the offering\n\t */\n\tprovidedBy:\n\t\t| string\n\t\t| ILegalPerson\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.LegalPerson });\n\n\t/**\n\t * ODRL policy associated to the service offering\n\t */\n\tservicePolicy: ObjectOrArray<IOdrlPolicy>;\n\n\t/**\n\t * Resources aggregated\n\t * It is supported different representations, inline,\n\t * by reference both providing the URI or a partial JSON-LD Node object\n\t */\n\taggregationOfResources?:\n\t\t| string[]\n\t\t| IDataResource[]\n\t\t| (IJsonLdNodeObject & { id: string; type: typeof GaiaXTypes.DataResource });\n\n\t/**\n\t * The endpoint\n\t */\n\tendpoint?: IEndpoint;\n}\n"]}
|