@twin.org/standards-gaia-x 0.0.1-next.47 → 0.0.1-next.49
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 +1535 -5
- package/dist/esm/index.mjs +1535 -6
- package/dist/types/dataTypes/gaiaXDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +2 -1
- package/dist/types/models/IDataExchangeComponent.d.ts +2 -2
- package/dist/types/models/IEndpoint.d.ts +0 -3
- package/dist/types/models/gaiaXContextType.d.ts +3 -3
- package/dist/types/models/gaiaXContexts.d.ts +1 -5
- package/docs/changelog.md +14 -0
- package/docs/reference/classes/GaiaXDataTypes.md +25 -0
- package/docs/reference/index.md +4 -0
- package/docs/reference/interfaces/IAddress.md +1 -1
- package/docs/reference/interfaces/IDataExchangeComponent.md +1 -1
- package/docs/reference/interfaces/IDataResource.md +1 -1
- package/docs/reference/interfaces/IEndpoint.md +1 -1
- package/docs/reference/interfaces/IParticipant.md +1 -1
- package/docs/reference/interfaces/IRegistrationNumber.md +1 -1
- package/docs/reference/interfaces/IServiceOffering.md +1 -1
- package/docs/reference/type-aliases/GaiaXContextType.md +1 -1
- package/docs/reference/variables/GaiaXContexts.md +2 -8
- package/package.json +2 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
export * from "./dataTypes/gaiaXDataTypes";
|
|
1
2
|
export * from "./models/gaiaXContexts";
|
|
3
|
+
export * from "./models/gaiaXContextType";
|
|
2
4
|
export * from "./models/gaiaXTypes";
|
|
3
5
|
export * from "./models/IAddress";
|
|
4
6
|
export * from "./models/IDataExchangeComponent";
|
|
@@ -7,4 +9,3 @@ export * from "./models/IEndpoint";
|
|
|
7
9
|
export * from "./models/IParticipant";
|
|
8
10
|
export * from "./models/IRegistrationNumber";
|
|
9
11
|
export * from "./models/IServiceOffering";
|
|
10
|
-
export * from "./models/gaiaXContextType";
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
2
2
|
import type { GaiaXContextType } from "./gaiaXContextType";
|
|
3
3
|
import type { GaiaXTypes } from "./gaiaXTypes";
|
|
4
4
|
/**
|
|
@@ -13,5 +13,5 @@ export interface IDataExchangeComponent extends IJsonLdNodeObject {
|
|
|
13
13
|
/**
|
|
14
14
|
* The type of JSON-LD node
|
|
15
15
|
*/
|
|
16
|
-
type: typeof GaiaXTypes.DataExchangeComponent | [typeof GaiaXTypes.DataExchangeComponent, ...
|
|
16
|
+
type: typeof GaiaXTypes.DataExchangeComponent | [typeof GaiaXTypes.DataExchangeComponent, ...string[]];
|
|
17
17
|
}
|
|
@@ -10,17 +10,14 @@ export interface IEndpoint extends IJsonLdNodeObject {
|
|
|
10
10
|
*/
|
|
11
11
|
type: typeof GaiaXTypes.Endpoint | undefined;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
13
|
* The endpoint URL
|
|
15
14
|
*/
|
|
16
15
|
endpointURL: string;
|
|
17
16
|
/**
|
|
18
|
-
*
|
|
19
17
|
* The formal description
|
|
20
18
|
*/
|
|
21
19
|
formalDescription?: string;
|
|
22
20
|
/**
|
|
23
|
-
*
|
|
24
21
|
* Standards conformity
|
|
25
22
|
*/
|
|
26
23
|
standardConformity?: IJsonLdNodeObject;
|
|
@@ -3,12 +3,12 @@ import type { GaiaXContexts } from "./gaiaXContexts";
|
|
|
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.ContextRoot | [
|
|
7
7
|
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof GaiaXContexts.
|
|
8
|
+
typeof GaiaXContexts.ContextRoot,
|
|
9
9
|
IJsonLdContextDefinitionElement
|
|
10
10
|
] | [
|
|
11
11
|
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof GaiaXContexts.
|
|
12
|
+
typeof GaiaXContexts.ContextRoot,
|
|
13
13
|
...IJsonLdContextDefinitionElement[]
|
|
14
14
|
];
|
|
@@ -5,11 +5,7 @@ export declare const GaiaXContexts: {
|
|
|
5
5
|
/**
|
|
6
6
|
* The Gaia-X LD Context
|
|
7
7
|
*/
|
|
8
|
-
readonly
|
|
9
|
-
/**
|
|
10
|
-
* The W3id security LD Context
|
|
11
|
-
*/
|
|
12
|
-
readonly W3IdSecurityJwsLdContext: "https://w3id.org/security/suites/jws-2020/v1";
|
|
8
|
+
readonly ContextRoot: "https://w3id.org/gaia-x/development";
|
|
13
9
|
};
|
|
14
10
|
/**
|
|
15
11
|
* The LD Contexts concerning Gaia-X.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @twin.org/standards-gaia-x - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.1-next.49](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.1-next.48...standards-gaia-x-v0.0.1-next.49) (2025-06-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add gaia-x schemas ([54c48df](https://github.com/twinfoundation/standards/commit/54c48df8c3eb0ce74d9b9a887ea81c10110fce76))
|
|
9
|
+
|
|
10
|
+
## [0.0.1-next.48](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.1-next.47...standards-gaia-x-v0.0.1-next.48) (2025-06-11)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* update to latest JSON schema spec ([7a23930](https://github.com/twinfoundation/standards/commit/7a2393032d7f48bfb20d3a484f981fb6dd83a92c))
|
|
16
|
+
|
|
3
17
|
## [0.0.1-next.47](https://github.com/twinfoundation/standards/compare/standards-gaia-x-v0.0.1-next.46...standards-gaia-x-v0.0.1-next.47) (2025-06-05)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Class: GaiaXDataTypes
|
|
2
|
+
|
|
3
|
+
Handle all the data types for Gaia-X.
|
|
4
|
+
|
|
5
|
+
## Constructors
|
|
6
|
+
|
|
7
|
+
### Constructor
|
|
8
|
+
|
|
9
|
+
> **new GaiaXDataTypes**(): `GaiaXDataTypes`
|
|
10
|
+
|
|
11
|
+
#### Returns
|
|
12
|
+
|
|
13
|
+
`GaiaXDataTypes`
|
|
14
|
+
|
|
15
|
+
## Methods
|
|
16
|
+
|
|
17
|
+
### registerTypes()
|
|
18
|
+
|
|
19
|
+
> `static` **registerTypes**(): `void`
|
|
20
|
+
|
|
21
|
+
Register all the data types.
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`void`
|
package/docs/reference/index.md
CHANGED
|
@@ -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` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
12
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
12
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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 @@ See also W3C DCAT Dataset https://www.w3.org/TR/vocab-dcat-3/.
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
12
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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/Endpoint
|
|
|
9
9
|
|
|
10
10
|
## Indexable
|
|
11
11
|
|
|
12
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
12
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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
|
|
|
@@ -8,7 +8,7 @@ A Legal Person participating in the ecosystem
|
|
|
8
8
|
|
|
9
9
|
## Indexable
|
|
10
10
|
|
|
11
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
11
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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
|
|
|
@@ -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` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
12
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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
|
|
|
@@ -8,7 +8,7 @@ A Service offering
|
|
|
8
8
|
|
|
9
9
|
## Indexable
|
|
10
10
|
|
|
11
|
-
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `
|
|
11
|
+
\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `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
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
# Type Alias: GaiaXContextType
|
|
2
2
|
|
|
3
|
-
> **GaiaXContextType** = *typeof* [`
|
|
3
|
+
> **GaiaXContextType** = *typeof* [`ContextRoot`](../variables/GaiaXContexts.md#contextroot) \| \[`...IJsonLdContextDefinitionElement[]`, *typeof* [`ContextRoot`](../variables/GaiaXContexts.md#contextroot), `IJsonLdContextDefinitionElement`\] \| \[`IJsonLdContextDefinitionElement`, *typeof* [`ContextRoot`](../variables/GaiaXContexts.md#contextroot), `...IJsonLdContextDefinitionElement[]`\]
|
|
4
4
|
|
|
5
5
|
The Gaia-X JSON-LD context type.
|
|
@@ -6,14 +6,8 @@ The LD Contexts concerning Gaia-X.
|
|
|
6
6
|
|
|
7
7
|
## Type declaration
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### ContextRoot
|
|
10
10
|
|
|
11
|
-
> `readonly` **
|
|
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
|
-
### W3IdSecurityJwsLdContext
|
|
16
|
-
|
|
17
|
-
> `readonly` **W3IdSecurityJwsLdContext**: `"https://w3id.org/security/suites/jws-2020/v1"` = `"https://w3id.org/security/suites/jws-2020/v1"`
|
|
18
|
-
|
|
19
|
-
The W3id security LD Context
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/standards-gaia-x",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.49",
|
|
4
4
|
"description": "Models which define the structure of Gaia-x",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/core": "next",
|
|
18
|
+
"@twin.org/data-core": "next",
|
|
18
19
|
"@twin.org/data-json-ld": "next"
|
|
19
20
|
},
|
|
20
21
|
"main": "./dist/cjs/index.cjs",
|