@twin.org/standards-dataspace-protocol 0.0.3-next.2 → 0.0.3-next.4
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/dataspaceProtolDataTypes.js +100 -0
- package/dist/es/dataTypes/dataspaceProtolDataTypes.js.map +1 -0
- package/dist/es/index.js +10 -4
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/catalog/ICatalogError.js +2 -0
- package/dist/es/models/catalog/ICatalogError.js.map +1 -0
- package/dist/es/models/catalog/ICatalogRequestMessage.js +2 -0
- package/dist/es/models/catalog/ICatalogRequestMessage.js.map +1 -0
- package/dist/es/models/catalog/IDatasetRequestMessage.js +2 -0
- package/dist/es/models/catalog/IDatasetRequestMessage.js.map +1 -0
- package/dist/es/models/catalog/catalogTypes.js +22 -0
- package/dist/es/models/catalog/catalogTypes.js.map +1 -0
- package/dist/es/models/contractNegotiation/IContractAgreementMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractAgreementVerificationMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractNegotiation.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationError.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationEventMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractNegotiationTerminationMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractOfferMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IContractRequestMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/contractNegotiationTypes.js +1 -1
- package/dist/es/models/contractNegotiation/contractNegotiationTypes.js.map +1 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js +1 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationEventType.js.map +1 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js +1 -1
- package/dist/es/models/contractNegotiation/types/contractNegotiationStateType.js.map +1 -1
- package/dist/es/models/dataspaceProtocolContextType.js +2 -0
- package/dist/es/models/dataspaceProtocolContextType.js.map +1 -0
- package/dist/es/models/dataspaceProtocolContexts.js +17 -0
- package/dist/es/models/dataspaceProtocolContexts.js.map +1 -0
- package/dist/es/schemas/CatalogError.json +71 -0
- package/dist/es/schemas/CatalogRequestMessage.json +62 -0
- package/dist/es/schemas/ContractAgreementMessage.json +4 -4
- package/dist/es/schemas/ContractAgreementVerificationMessage.json +4 -4
- package/dist/es/schemas/ContractNegotiation.json +4 -4
- package/dist/es/schemas/ContractNegotiationError.json +4 -4
- package/dist/es/schemas/ContractNegotiationEventMessage.json +4 -4
- package/dist/es/schemas/ContractNegotiationTerminationMessage.json +4 -4
- package/dist/es/schemas/ContractOfferMessage.json +4 -4
- package/dist/es/schemas/ContractRequestMessage.json +4 -4
- package/dist/es/schemas/DatasetRequestMessage.json +64 -0
- package/dist/types/dataTypes/{contractNegotiationDataTypes.d.ts → dataspaceProtolDataTypes.d.ts} +2 -2
- package/dist/types/index.d.ts +7 -3
- package/dist/types/models/catalog/ICatalogError.d.ts +24 -0
- package/dist/types/models/catalog/ICatalogRequestMessage.d.ts +20 -0
- package/dist/types/models/catalog/IDatasetRequestMessage.d.ts +20 -0
- package/dist/types/models/catalog/catalogTypes.d.ts +22 -0
- package/dist/types/models/contractNegotiation/IContractAgreementMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractAgreementVerificationMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractNegotiation.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractNegotiationError.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractNegotiationEventMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractNegotiationTerminationMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractOfferMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IContractRequestMessage.d.ts +2 -2
- package/dist/types/models/dataspaceProtocolContextType.d.ts +14 -0
- package/dist/types/models/dataspaceProtocolContexts.d.ts +17 -0
- package/docs/changelog.md +29 -0
- package/docs/reference/classes/{ContractNegotiationDataTypes.md → DataspaceProtocolDataTypes.md} +4 -4
- package/docs/reference/index.md +9 -4
- package/docs/reference/interfaces/ICatalogError.md +36 -0
- package/docs/reference/interfaces/ICatalogRequestMessage.md +28 -0
- package/docs/reference/interfaces/IContractAgreementMessage.md +1 -1
- package/docs/reference/interfaces/IContractAgreementVerificationMessage.md +1 -1
- package/docs/reference/interfaces/IContractNegotiation.md +1 -1
- package/docs/reference/interfaces/IContractNegotiationError.md +1 -1
- package/docs/reference/interfaces/IContractNegotiationEventMessage.md +1 -1
- package/docs/reference/interfaces/IContractNegotiationTerminationMessage.md +1 -1
- package/docs/reference/interfaces/IContractOfferMessage.md +1 -1
- package/docs/reference/interfaces/IContractRequestMessage.md +1 -1
- package/docs/reference/interfaces/IDatasetRequestMessage.md +28 -0
- package/docs/reference/type-aliases/CatalogTypes.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +5 -0
- package/docs/reference/type-aliases/DataspaceProtocolContexts.md +5 -0
- package/docs/reference/variables/CatalogTypes.md +26 -0
- package/docs/reference/variables/DataspaceProtocolContexts.md +19 -0
- package/package.json +3 -2
- package/dist/es/dataTypes/contractNegotiationDataTypes.js +0 -81
- package/dist/es/dataTypes/contractNegotiationDataTypes.js.map +0 -1
- package/dist/es/models/contractNegotiation/contractNegotiationContextType.js +0 -2
- package/dist/es/models/contractNegotiation/contractNegotiationContextType.js.map +0 -1
- package/dist/es/models/contractNegotiation/contractNegotiationContexts.js +0 -17
- package/dist/es/models/contractNegotiation/contractNegotiationContexts.js.map +0 -1
- package/dist/types/models/contractNegotiation/contractNegotiationContextType.d.ts +0 -14
- package/dist/types/models/contractNegotiation/contractNegotiationContexts.d.ts +0 -17
- package/docs/reference/type-aliases/ContractNegotiationContextType.md +0 -5
- package/docs/reference/type-aliases/ContractNegotiationContexts.md +0 -5
- package/docs/reference/variables/ContractNegotiationContexts.md +0 -19
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -5,11 +5,11 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"@context": {
|
|
8
|
-
"description": "The Dataspace Protocol
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
9
|
"anyOf": [
|
|
10
10
|
{
|
|
11
11
|
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
"type": "array",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"prefixItems": [
|
|
18
18
|
{
|
|
19
19
|
"type": "string",
|
|
20
|
-
"const": "https://w3id.org/dspace/
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
21
|
},
|
|
22
22
|
{
|
|
23
23
|
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"type": "string",
|
|
39
|
-
"const": "https://w3id.org/dspace/
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
40
|
}
|
|
41
41
|
],
|
|
42
42
|
"items": {
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "https://schema.twindev.org/dataspace-protocol/DatasetRequestMessage",
|
|
4
|
+
"description": "Interface for Dataspace Protocol Dataset Request Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"properties": {
|
|
7
|
+
"@context": {
|
|
8
|
+
"description": "The Dataspace Protocol Protocol JSON-LD context type.",
|
|
9
|
+
"anyOf": [
|
|
10
|
+
{
|
|
11
|
+
"type": "string",
|
|
12
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"type": "array",
|
|
16
|
+
"minItems": 2,
|
|
17
|
+
"prefixItems": [
|
|
18
|
+
{
|
|
19
|
+
"type": "string",
|
|
20
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
24
|
+
}
|
|
25
|
+
],
|
|
26
|
+
"items": {
|
|
27
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
28
|
+
}
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"type": "array",
|
|
32
|
+
"minItems": 2,
|
|
33
|
+
"prefixItems": [
|
|
34
|
+
{
|
|
35
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
36
|
+
},
|
|
37
|
+
{
|
|
38
|
+
"type": "string",
|
|
39
|
+
"const": "https://w3id.org/dspace/2025/1/context.json"
|
|
40
|
+
}
|
|
41
|
+
],
|
|
42
|
+
"items": {
|
|
43
|
+
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
]
|
|
47
|
+
},
|
|
48
|
+
"@type": {
|
|
49
|
+
"type": "string",
|
|
50
|
+
"const": "DatasetRequestMessage",
|
|
51
|
+
"description": "The type of the message."
|
|
52
|
+
},
|
|
53
|
+
"dataset": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"description": "The identifier of the dataset."
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"required": [
|
|
59
|
+
"@context",
|
|
60
|
+
"@type",
|
|
61
|
+
"dataset"
|
|
62
|
+
],
|
|
63
|
+
"additionalProperties": false
|
|
64
|
+
}
|
package/dist/types/dataTypes/{contractNegotiationDataTypes.d.ts → dataspaceProtolDataTypes.d.ts}
RENAMED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Handle all the data types for Dataspace Protocol
|
|
2
|
+
* Handle all the data types for Dataspace Protocol.
|
|
3
3
|
*/
|
|
4
|
-
export declare class
|
|
4
|
+
export declare class DataspaceProtocolDataTypes {
|
|
5
5
|
/**
|
|
6
6
|
* Register the JSON-LD Redirects.
|
|
7
7
|
*/
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
export * from "./
|
|
2
|
-
export * from "./models/
|
|
3
|
-
export * from "./
|
|
1
|
+
export * from "./models/dataspaceProtocolContexts.js";
|
|
2
|
+
export * from "./models/dataspaceProtocolContextType.js";
|
|
3
|
+
export * from "./dataTypes/dataspaceProtolDataTypes.js";
|
|
4
|
+
export * from "./models/catalog/catalogTypes.js";
|
|
5
|
+
export * from "./models/catalog/ICatalogError.js";
|
|
6
|
+
export * from "./models/catalog/ICatalogRequestMessage.js";
|
|
7
|
+
export * from "./models/catalog/IDatasetRequestMessage.js";
|
|
4
8
|
export * from "./models/contractNegotiation/contractNegotiationTypes.js";
|
|
5
9
|
export * from "./models/contractNegotiation/IContractAgreementMessage.js";
|
|
6
10
|
export * from "./models/contractNegotiation/IContractAgreementVerificationMessage.js";
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { CatalogTypes } from "./catalogTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Catalog Error.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
|
|
6
|
+
*/
|
|
7
|
+
export interface ICatalogError {
|
|
8
|
+
/**
|
|
9
|
+
* The JSON-LD context.
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* The type of the message.
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof CatalogTypes.CatalogError;
|
|
16
|
+
/**
|
|
17
|
+
* The error code.
|
|
18
|
+
*/
|
|
19
|
+
code: string;
|
|
20
|
+
/**
|
|
21
|
+
* An optional array of error reasons.
|
|
22
|
+
*/
|
|
23
|
+
reasons?: string[];
|
|
24
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { CatalogTypes } from "./catalogTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Catalog Request Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
|
|
6
|
+
*/
|
|
7
|
+
export interface ICatalogRequestMessage {
|
|
8
|
+
/**
|
|
9
|
+
* The JSON-LD context.
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* The type of the message.
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof CatalogTypes.CatalogRequestMessage;
|
|
16
|
+
/**
|
|
17
|
+
* An implementation-specific query or filter expression.
|
|
18
|
+
*/
|
|
19
|
+
filter?: unknown;
|
|
20
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
|
+
import type { CatalogTypes } from "./catalogTypes.js";
|
|
3
|
+
/**
|
|
4
|
+
* Interface for Dataspace Protocol Dataset Request Messages.
|
|
5
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
|
|
6
|
+
*/
|
|
7
|
+
export interface IDatasetRequestMessage {
|
|
8
|
+
/**
|
|
9
|
+
* The JSON-LD context.
|
|
10
|
+
*/
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
|
+
/**
|
|
13
|
+
* The type of the message.
|
|
14
|
+
*/
|
|
15
|
+
"@type": typeof CatalogTypes.DatasetRequestMessage;
|
|
16
|
+
/**
|
|
17
|
+
* The identifier of the dataset.
|
|
18
|
+
*/
|
|
19
|
+
dataset: string;
|
|
20
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The types for Dataspace Protocol Catalog Protocol.
|
|
3
|
+
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
|
|
4
|
+
*/
|
|
5
|
+
export declare const CatalogTypes: {
|
|
6
|
+
/**
|
|
7
|
+
* Catalog Request Message.
|
|
8
|
+
*/
|
|
9
|
+
readonly CatalogRequestMessage: "CatalogRequestMessage";
|
|
10
|
+
/**
|
|
11
|
+
* Dataset Request Message.
|
|
12
|
+
*/
|
|
13
|
+
readonly DatasetRequestMessage: "DatasetRequestMessage";
|
|
14
|
+
/**
|
|
15
|
+
* Catalog Error.
|
|
16
|
+
*/
|
|
17
|
+
readonly CatalogError: "CatalogError";
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* The types for Dataspace Protocol Catalog Protocol.
|
|
21
|
+
*/
|
|
22
|
+
export type CatalogTypes = (typeof CatalogTypes)[keyof typeof CatalogTypes];
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { IOdrlAgreement } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type { ContractNegotiationContextType } from "./contractNegotiationContextType.js";
|
|
3
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Agreement Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
@@ -9,7 +9,7 @@ export interface IContractAgreementMessage {
|
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Agreement Verification Messages.
|
|
@@ -8,7 +8,7 @@ export interface IContractAgreementVerificationMessage {
|
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
11
|
-
"@context":
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
3
|
import type { ContractNegotiationStateType } from "./types/contractNegotiationStateType.js";
|
|
4
4
|
/**
|
|
@@ -9,7 +9,7 @@ export interface IContractNegotiation {
|
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Error Messages.
|
|
@@ -8,7 +8,7 @@ export interface IContractNegotiationError {
|
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
11
|
-
"@context":
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
3
|
import type { ContractNegotiationEventType } from "./types/contractNegotiationEventType.js";
|
|
4
4
|
/**
|
|
@@ -9,7 +9,7 @@ export interface IContractNegotiationEventMessage {
|
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
4
|
* Interface for Dataspace Protocol Contract Negotiation Termination Messages.
|
|
@@ -8,7 +8,7 @@ export interface IContractNegotiationTerminationMessage {
|
|
|
8
8
|
/**
|
|
9
9
|
* The JSON-LD context.
|
|
10
10
|
*/
|
|
11
|
-
"@context":
|
|
11
|
+
"@context": DataspaceProtocolContextType;
|
|
12
12
|
/**
|
|
13
13
|
* The type of the message.
|
|
14
14
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
3
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Offer Messages.
|
|
@@ -9,7 +9,7 @@ export interface IContractOfferMessage {
|
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IOdrlOffer } from "@twin.org/standards-w3c-odrl";
|
|
2
|
-
import type {
|
|
2
|
+
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
3
3
|
import type { ContractNegotiationTypes } from "./contractNegotiationTypes.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Request Messages.
|
|
@@ -9,7 +9,7 @@ export interface IContractRequestMessage {
|
|
|
9
9
|
/**
|
|
10
10
|
* The JSON-LD context.
|
|
11
11
|
*/
|
|
12
|
-
"@context":
|
|
12
|
+
"@context": DataspaceProtocolContextType;
|
|
13
13
|
/**
|
|
14
14
|
* The type of the message.
|
|
15
15
|
*/
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
|
+
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
|
+
/**
|
|
4
|
+
* The Dataspace Protocol Protocol JSON-LD context type.
|
|
5
|
+
*/
|
|
6
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.ContextRoot | [
|
|
7
|
+
...IJsonLdContextDefinitionElement[],
|
|
8
|
+
typeof DataspaceProtocolContexts.ContextRoot,
|
|
9
|
+
IJsonLdContextDefinitionElement
|
|
10
|
+
] | [
|
|
11
|
+
IJsonLdContextDefinitionElement,
|
|
12
|
+
typeof DataspaceProtocolContexts.ContextRoot,
|
|
13
|
+
...IJsonLdContextDefinitionElement[]
|
|
14
|
+
];
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The contexts for Dataspace Protocol Protocol.
|
|
3
|
+
*/
|
|
4
|
+
export declare const DataspaceProtocolContexts: {
|
|
5
|
+
/**
|
|
6
|
+
* The context root for Dataspace Protocol Protocol.
|
|
7
|
+
*/
|
|
8
|
+
readonly ContextRoot: "https://w3id.org/dspace/2025/1/context.json";
|
|
9
|
+
/**
|
|
10
|
+
* The context redirect for Dataspace Protocol Protocol.
|
|
11
|
+
*/
|
|
12
|
+
readonly ContextRedirect: "https://w3id.org/dspace/2025/1/context.jsonld";
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* The contexts for Dataspace Protocol Protocol.
|
|
16
|
+
*/
|
|
17
|
+
export type DataspaceProtocolContexts = (typeof DataspaceProtocolContexts)[keyof typeof DataspaceProtocolContexts];
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.4](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.3...standards-dataspace-protocol-v0.0.3-next.4) (2025-11-18)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* implement Dataspace Protocol Objects ([#73](https://github.com/twinfoundation/standards/issues/73)) ([2505495](https://github.com/twinfoundation/standards/commit/2505495c03b54a6606a775d7f2211308372c7cc6))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/standards-w3c-dcat bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
16
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.3 to 0.0.3-next.4
|
|
17
|
+
|
|
18
|
+
## [0.0.3-next.3](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.2...standards-dataspace-protocol-v0.0.3-next.3) (2025-11-18)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Miscellaneous Chores
|
|
22
|
+
|
|
23
|
+
* **standards-dataspace-protocol:** Synchronize repo versions
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/standards-w3c-odrl bumped from 0.0.3-next.2 to 0.0.3-next.3
|
|
31
|
+
|
|
3
32
|
## [0.0.3-next.2](https://github.com/twinfoundation/standards/compare/standards-dataspace-protocol-v0.0.3-next.1...standards-dataspace-protocol-v0.0.3-next.2) (2025-11-11)
|
|
4
33
|
|
|
5
34
|
|
package/docs/reference/classes/{ContractNegotiationDataTypes.md → DataspaceProtocolDataTypes.md}
RENAMED
|
@@ -1,16 +1,16 @@
|
|
|
1
|
-
# Class:
|
|
1
|
+
# Class: DataspaceProtocolDataTypes
|
|
2
2
|
|
|
3
|
-
Handle all the data types for Dataspace Protocol
|
|
3
|
+
Handle all the data types for Dataspace Protocol.
|
|
4
4
|
|
|
5
5
|
## Constructors
|
|
6
6
|
|
|
7
7
|
### Constructor
|
|
8
8
|
|
|
9
|
-
> **new
|
|
9
|
+
> **new DataspaceProtocolDataTypes**(): `DataspaceProtocolDataTypes`
|
|
10
10
|
|
|
11
11
|
#### Returns
|
|
12
12
|
|
|
13
|
-
`
|
|
13
|
+
`DataspaceProtocolDataTypes`
|
|
14
14
|
|
|
15
15
|
## Methods
|
|
16
16
|
|
package/docs/reference/index.md
CHANGED
|
@@ -2,10 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
## Classes
|
|
4
4
|
|
|
5
|
-
- [
|
|
5
|
+
- [DataspaceProtocolDataTypes](classes/DataspaceProtocolDataTypes.md)
|
|
6
6
|
|
|
7
7
|
## Interfaces
|
|
8
8
|
|
|
9
|
+
- [ICatalogError](interfaces/ICatalogError.md)
|
|
10
|
+
- [ICatalogRequestMessage](interfaces/ICatalogRequestMessage.md)
|
|
11
|
+
- [IDatasetRequestMessage](interfaces/IDatasetRequestMessage.md)
|
|
9
12
|
- [IContractAgreementMessage](interfaces/IContractAgreementMessage.md)
|
|
10
13
|
- [IContractAgreementVerificationMessage](interfaces/IContractAgreementVerificationMessage.md)
|
|
11
14
|
- [IContractNegotiation](interfaces/IContractNegotiation.md)
|
|
@@ -17,15 +20,17 @@
|
|
|
17
20
|
|
|
18
21
|
## Type Aliases
|
|
19
22
|
|
|
20
|
-
- [
|
|
21
|
-
- [ContractNegotiationContexts](type-aliases/ContractNegotiationContexts.md)
|
|
23
|
+
- [CatalogTypes](type-aliases/CatalogTypes.md)
|
|
22
24
|
- [ContractNegotiationTypes](type-aliases/ContractNegotiationTypes.md)
|
|
23
25
|
- [ContractNegotiationEventType](type-aliases/ContractNegotiationEventType.md)
|
|
24
26
|
- [ContractNegotiationStateType](type-aliases/ContractNegotiationStateType.md)
|
|
27
|
+
- [DataspaceProtocolContextType](type-aliases/DataspaceProtocolContextType.md)
|
|
28
|
+
- [DataspaceProtocolContexts](type-aliases/DataspaceProtocolContexts.md)
|
|
25
29
|
|
|
26
30
|
## Variables
|
|
27
31
|
|
|
28
|
-
- [
|
|
32
|
+
- [CatalogTypes](variables/CatalogTypes.md)
|
|
29
33
|
- [ContractNegotiationTypes](variables/ContractNegotiationTypes.md)
|
|
30
34
|
- [ContractNegotiationEventType](variables/ContractNegotiationEventType.md)
|
|
31
35
|
- [ContractNegotiationStateType](variables/ContractNegotiationStateType.md)
|
|
36
|
+
- [DataspaceProtocolContexts](variables/DataspaceProtocolContexts.md)
|