@twin.org/standards-dataspace-protocol 0.0.3-next.54 → 0.0.3-next.56
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/catalogDataTypes.js +18 -39
- package/dist/es/dataTypes/catalogDataTypes.js.map +1 -1
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js +6 -0
- package/dist/es/dataTypes/dataspaceProtocolDataTypes.js.map +1 -1
- package/dist/es/index.js +10 -13
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +1 -33
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.js.map +1 -1
- package/dist/es/models/dataspaceProtocolContextType.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataService.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDataset.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js +2 -0
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -0
- package/dist/es/models/odrl/IDataspaceProtocolOffer.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js +2 -0
- package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js.map +1 -0
- package/dist/es/schemas/DataspaceProtocolAgreement.json +181 -158
- package/dist/es/schemas/DataspaceProtocolCatalog.json +13 -3
- package/dist/es/schemas/DataspaceProtocolCatalogBase.json +428 -0
- package/dist/es/schemas/DataspaceProtocolCatalogError.json +4 -50
- package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContextType.json +30 -0
- package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +191 -52
- package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContractNegotiationEventType.json +11 -5
- package/dist/es/schemas/DataspaceProtocolContractNegotiationStateType.json +31 -10
- package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +5 -51
- package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +5 -51
- package/dist/es/schemas/DataspaceProtocolDataAddress.json +2 -2
- package/dist/es/schemas/DataspaceProtocolDataService.json +21 -0
- package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +285 -0
- package/dist/es/schemas/DataspaceProtocolDataset.json +13 -3
- package/dist/es/schemas/DataspaceProtocolDatasetBase.json +342 -0
- package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolDistribution.json +26 -0
- package/dist/es/schemas/DataspaceProtocolDistributionBase.json +170 -0
- package/dist/es/schemas/DataspaceProtocolEndpointProperty.json +2 -2
- package/dist/es/schemas/DataspaceProtocolOffer.json +10 -186
- package/dist/es/schemas/DataspaceProtocolOfferBase.json +219 -0
- package/dist/es/schemas/DataspaceProtocolPolicy.json +214 -202
- package/dist/es/schemas/DataspaceProtocolSet.json +225 -202
- package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolTransferError.json +4 -50
- package/dist/es/schemas/DataspaceProtocolTransferProcess.json +4 -50
- package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +6 -52
- package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +5 -51
- package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +4 -50
- package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +4 -50
- package/dist/types/index.d.ts +10 -13
- package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +0 -32
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.d.ts +3 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractOfferMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractRequestMessage.d.ts +2 -2
- package/dist/types/models/dataspaceProtocolContextType.d.ts +2 -9
- package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +2 -37
- package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +58 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +2 -22
- package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +44 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +2 -29
- package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +61 -0
- package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +4 -31
- package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +66 -0
- package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +7 -2
- package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +18 -0
- package/docs/changelog.md +35 -0
- package/docs/reference/classes/CatalogDataTypes.md +1 -1
- package/docs/reference/classes/ContractNegotiationDataTypes.md +1 -1
- package/docs/reference/classes/DataspaceProtocolDataTypes.md +2 -2
- package/docs/reference/classes/DataspaceProtocolHelper.md +2 -2
- package/docs/reference/classes/TransferProcessDataTypes.md +1 -1
- package/docs/reference/index.md +5 -8
- package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +21 -21
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +129 -105
- package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +570 -0
- package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +5 -5
- package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +4 -4
- package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md +4 -4
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiation.md +5 -5
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationEventMessage.md +5 -5
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md +9 -9
- package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md +9 -9
- package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +6 -6
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +82 -70
- package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +387 -0
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +97 -85
- package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +484 -0
- package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md +3 -3
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +87 -71
- package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +381 -0
- package/docs/reference/interfaces/IDataspaceProtocolEndpointProperty.md +3 -3
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +44 -45
- package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +171 -0
- package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +24 -24
- package/docs/reference/interfaces/IDataspaceProtocolSet.md +23 -23
- package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md +4 -4
- package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +5 -5
- package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +6 -6
- package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +8 -8
- package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +8 -8
- package/docs/reference/type-aliases/DataspaceProtocolContextType.md +1 -1
- package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +11 -59
- package/docs/reference/variables/DataspaceProtocolContexts.md +4 -4
- package/docs/reference/variables/DataspaceProtocolContractNegotiationEventType.md +2 -2
- package/docs/reference/variables/DataspaceProtocolContractNegotiationStateType.md +7 -7
- package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +10 -10
- package/docs/reference/variables/DataspaceProtocolEndpointType.md +4 -4
- package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +5 -5
- package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +9 -9
- package/package.json +3 -3
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogNoContext.js +0 -2
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogNoContext.js.map +0 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceNoContext.js +0 -2
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceNoContext.js.map +0 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetNoContext.js +0 -2
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetNoContext.js.map +0 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionNoContext.js +0 -2
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionNoContext.js.map +0 -1
- package/dist/es/models/odrl/IDataspaceProtocolAgreementNoContext.js +0 -2
- package/dist/es/models/odrl/IDataspaceProtocolAgreementNoContext.js.map +0 -1
- package/dist/es/models/odrl/IDataspaceProtocolOfferNoContext.js +0 -2
- package/dist/es/models/odrl/IDataspaceProtocolOfferNoContext.js.map +0 -1
- package/dist/es/models/odrl/IDataspaceProtocolPolicyNoContext.js +0 -2
- package/dist/es/models/odrl/IDataspaceProtocolPolicyNoContext.js.map +0 -1
- package/dist/es/models/odrl/IDataspaceProtocolSetNoContext.js +0 -2
- package/dist/es/models/odrl/IDataspaceProtocolSetNoContext.js.map +0 -1
- package/dist/es/schemas/DataspaceProtocolAgreementNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolCatalogNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolDataServiceNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolDatasetNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolDistributionNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolOfferNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolPolicyNoContext.json +0 -6
- package/dist/es/schemas/DataspaceProtocolSetNoContext.json +0 -6
- package/dist/es/schemas-src/DataspaceProtocolDataService.json +0 -11
- package/dist/es/schemas-src/DataspaceProtocolDistribution.json +0 -11
- package/dist/types/models/dcat3/IDataspaceProtocolCatalogNoContext.d.ts +0 -5
- package/dist/types/models/dcat3/IDataspaceProtocolDataServiceNoContext.d.ts +0 -5
- package/dist/types/models/dcat3/IDataspaceProtocolDatasetNoContext.d.ts +0 -5
- package/dist/types/models/dcat3/IDataspaceProtocolDistributionNoContext.d.ts +0 -5
- package/dist/types/models/odrl/IDataspaceProtocolAgreementNoContext.d.ts +0 -5
- package/dist/types/models/odrl/IDataspaceProtocolOfferNoContext.d.ts +0 -5
- package/dist/types/models/odrl/IDataspaceProtocolPolicyNoContext.d.ts +0 -5
- package/dist/types/models/odrl/IDataspaceProtocolSetNoContext.d.ts +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolAgreementNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolCatalogNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolDataServiceNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolDatasetNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolDistributionNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolOfferNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolPolicyNoContext.md +0 -5
- package/docs/reference/type-aliases/IDataspaceProtocolSetNoContext.md +0 -5
|
@@ -1,61 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess",
|
|
4
|
-
"
|
|
4
|
+
"title": "DataspaceProtocolTransferProcess",
|
|
5
|
+
"description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process",
|
|
5
6
|
"type": "object",
|
|
6
7
|
"properties": {
|
|
7
8
|
"@context": {
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
{
|
|
11
|
-
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"type": "array",
|
|
16
|
-
"items": {
|
|
17
|
-
"type": "string",
|
|
18
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
19
|
-
},
|
|
20
|
-
"minItems": 1,
|
|
21
|
-
"maxItems": 1
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"type": "array",
|
|
25
|
-
"minItems": 2,
|
|
26
|
-
"prefixItems": [
|
|
27
|
-
{
|
|
28
|
-
"type": "string",
|
|
29
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
-
}
|
|
34
|
-
],
|
|
35
|
-
"items": {
|
|
36
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"type": "array",
|
|
41
|
-
"minItems": 2,
|
|
42
|
-
"prefixItems": [
|
|
43
|
-
{
|
|
44
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"type": "string",
|
|
48
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
"items": {
|
|
52
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
]
|
|
9
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
+
"description": "LD Context"
|
|
56
11
|
},
|
|
57
12
|
"@type": {
|
|
58
|
-
"type": "string",
|
|
59
13
|
"const": "TransferProcess",
|
|
60
14
|
"description": "LD Type"
|
|
61
15
|
},
|
|
@@ -1,61 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferRequestMessage",
|
|
4
|
-
"
|
|
4
|
+
"title": "DataspaceProtocolTransferRequestMessage",
|
|
5
|
+
"description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message",
|
|
5
6
|
"type": "object",
|
|
6
7
|
"properties": {
|
|
7
8
|
"@context": {
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
{
|
|
11
|
-
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"type": "array",
|
|
16
|
-
"items": {
|
|
17
|
-
"type": "string",
|
|
18
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
19
|
-
},
|
|
20
|
-
"minItems": 1,
|
|
21
|
-
"maxItems": 1
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"type": "array",
|
|
25
|
-
"minItems": 2,
|
|
26
|
-
"prefixItems": [
|
|
27
|
-
{
|
|
28
|
-
"type": "string",
|
|
29
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
-
}
|
|
34
|
-
],
|
|
35
|
-
"items": {
|
|
36
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"type": "array",
|
|
41
|
-
"minItems": 2,
|
|
42
|
-
"prefixItems": [
|
|
43
|
-
{
|
|
44
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"type": "string",
|
|
48
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
"items": {
|
|
52
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
]
|
|
9
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
+
"description": "LD Context"
|
|
56
11
|
},
|
|
57
12
|
"@type": {
|
|
58
|
-
"type": "string",
|
|
59
13
|
"const": "TransferRequestMessage",
|
|
60
14
|
"description": "LD Type"
|
|
61
15
|
},
|
|
@@ -73,11 +27,11 @@
|
|
|
73
27
|
},
|
|
74
28
|
"format": {
|
|
75
29
|
"type": "string",
|
|
76
|
-
"description": "The format property is a format specified by a Distribution for the Dataset associated with the Agreement
|
|
30
|
+
"description": "The format property is a format specified by a Distribution for the Dataset associated with the Agreement.\nThis is generally obtained from the Provider's Catalog."
|
|
77
31
|
},
|
|
78
32
|
"dataAddress": {
|
|
79
33
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataAddress",
|
|
80
|
-
"description": "If defined MUST contain a transport-specific set of properties for pushing the data
|
|
34
|
+
"description": "If defined MUST contain a transport-specific set of properties for pushing the data.\nIt MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType."
|
|
81
35
|
}
|
|
82
36
|
},
|
|
83
37
|
"required": [
|
|
@@ -1,61 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage",
|
|
4
|
-
"
|
|
4
|
+
"title": "DataspaceProtocolTransferStartMessage",
|
|
5
|
+
"description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message",
|
|
5
6
|
"type": "object",
|
|
6
7
|
"properties": {
|
|
7
8
|
"@context": {
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
{
|
|
11
|
-
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"type": "array",
|
|
16
|
-
"items": {
|
|
17
|
-
"type": "string",
|
|
18
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
19
|
-
},
|
|
20
|
-
"minItems": 1,
|
|
21
|
-
"maxItems": 1
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"type": "array",
|
|
25
|
-
"minItems": 2,
|
|
26
|
-
"prefixItems": [
|
|
27
|
-
{
|
|
28
|
-
"type": "string",
|
|
29
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
-
}
|
|
34
|
-
],
|
|
35
|
-
"items": {
|
|
36
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"type": "array",
|
|
41
|
-
"minItems": 2,
|
|
42
|
-
"prefixItems": [
|
|
43
|
-
{
|
|
44
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"type": "string",
|
|
48
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
"items": {
|
|
52
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
]
|
|
9
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
+
"description": "LD Context"
|
|
56
11
|
},
|
|
57
12
|
"@type": {
|
|
58
|
-
"type": "string",
|
|
59
13
|
"const": "TransferStartMessage",
|
|
60
14
|
"description": "LD Type"
|
|
61
15
|
},
|
|
@@ -69,7 +23,7 @@
|
|
|
69
23
|
},
|
|
70
24
|
"dataAddress": {
|
|
71
25
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataAddress",
|
|
72
|
-
"description": "MUST be provided if the current transfer is a pull transfer and
|
|
26
|
+
"description": "MUST be provided if the current transfer is a pull transfer and\ncontains a transport-specific endpoint address for obtaining the data."
|
|
73
27
|
}
|
|
74
28
|
},
|
|
75
29
|
"required": [
|
|
@@ -1,61 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferSuspensionMessage",
|
|
4
|
-
"
|
|
4
|
+
"title": "DataspaceProtocolTransferSuspensionMessage",
|
|
5
|
+
"description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message",
|
|
5
6
|
"type": "object",
|
|
6
7
|
"properties": {
|
|
7
8
|
"@context": {
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
{
|
|
11
|
-
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"type": "array",
|
|
16
|
-
"items": {
|
|
17
|
-
"type": "string",
|
|
18
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
19
|
-
},
|
|
20
|
-
"minItems": 1,
|
|
21
|
-
"maxItems": 1
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"type": "array",
|
|
25
|
-
"minItems": 2,
|
|
26
|
-
"prefixItems": [
|
|
27
|
-
{
|
|
28
|
-
"type": "string",
|
|
29
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
-
}
|
|
34
|
-
],
|
|
35
|
-
"items": {
|
|
36
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"type": "array",
|
|
41
|
-
"minItems": 2,
|
|
42
|
-
"prefixItems": [
|
|
43
|
-
{
|
|
44
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"type": "string",
|
|
48
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
"items": {
|
|
52
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
]
|
|
9
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
+
"description": "LD Context"
|
|
56
11
|
},
|
|
57
12
|
"@type": {
|
|
58
|
-
"type": "string",
|
|
59
13
|
"const": "TransferSuspensionMessage",
|
|
60
14
|
"description": "LD Type"
|
|
61
15
|
},
|
|
@@ -1,61 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferTerminationMessage",
|
|
4
|
-
"
|
|
4
|
+
"title": "DataspaceProtocolTransferTerminationMessage",
|
|
5
|
+
"description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message",
|
|
5
6
|
"type": "object",
|
|
6
7
|
"properties": {
|
|
7
8
|
"@context": {
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
{
|
|
11
|
-
"type": "string",
|
|
12
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"type": "array",
|
|
16
|
-
"items": {
|
|
17
|
-
"type": "string",
|
|
18
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
19
|
-
},
|
|
20
|
-
"minItems": 1,
|
|
21
|
-
"maxItems": 1
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
"type": "array",
|
|
25
|
-
"minItems": 2,
|
|
26
|
-
"prefixItems": [
|
|
27
|
-
{
|
|
28
|
-
"type": "string",
|
|
29
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
30
|
-
},
|
|
31
|
-
{
|
|
32
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
33
|
-
}
|
|
34
|
-
],
|
|
35
|
-
"items": {
|
|
36
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
37
|
-
}
|
|
38
|
-
},
|
|
39
|
-
{
|
|
40
|
-
"type": "array",
|
|
41
|
-
"minItems": 2,
|
|
42
|
-
"prefixItems": [
|
|
43
|
-
{
|
|
44
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
"type": "string",
|
|
48
|
-
"const": "https://w3id.org/dspace/2025/1/context.jsonld"
|
|
49
|
-
}
|
|
50
|
-
],
|
|
51
|
-
"items": {
|
|
52
|
-
"$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
|
|
53
|
-
}
|
|
54
|
-
}
|
|
55
|
-
]
|
|
9
|
+
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
+
"description": "LD Context"
|
|
56
11
|
},
|
|
57
12
|
"@type": {
|
|
58
|
-
"type": "string",
|
|
59
13
|
"const": "TransferTerminationMessage",
|
|
60
14
|
"description": "LD Type"
|
|
61
15
|
},
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,27 +1,24 @@
|
|
|
1
|
+
export * from "./dataTypes/catalogDataTypes.js";
|
|
2
|
+
export * from "./dataTypes/dataspaceProtocolDataTypes.js";
|
|
1
3
|
export * from "./models/dataspaceProtocolContexts.js";
|
|
2
4
|
export * from "./models/dataspaceProtocolContextType.js";
|
|
3
|
-
export * from "./dataTypes/dataspaceProtocolDataTypes.js";
|
|
4
|
-
export * from "./dataTypes/catalogDataTypes.js";
|
|
5
5
|
export * from "./models/catalog/dataspaceProtocolCatalogTypes.js";
|
|
6
6
|
export * from "./models/catalog/IDataspaceProtocolCatalogError.js";
|
|
7
7
|
export * from "./models/catalog/IDataspaceProtocolCatalogRequestMessage.js";
|
|
8
8
|
export * from "./models/catalog/IDataspaceProtocolDatasetRequestMessage.js";
|
|
9
|
-
export * from "./models/dcat3/IDataspaceProtocolDataset.js";
|
|
10
|
-
export * from "./models/dcat3/IDataspaceProtocolDatasetNoContext.js";
|
|
11
9
|
export * from "./models/dcat3/IDataspaceProtocolCatalog.js";
|
|
12
|
-
export * from "./models/dcat3/
|
|
13
|
-
export * from "./models/dcat3/IDataspaceProtocolDistribution.js";
|
|
14
|
-
export * from "./models/dcat3/IDataspaceProtocolDistributionNoContext.js";
|
|
10
|
+
export * from "./models/dcat3/IDataspaceProtocolCatalogBase.js";
|
|
15
11
|
export * from "./models/dcat3/IDataspaceProtocolDataService.js";
|
|
16
|
-
export * from "./models/dcat3/
|
|
12
|
+
export * from "./models/dcat3/IDataspaceProtocolDataServiceBase.js";
|
|
13
|
+
export * from "./models/dcat3/IDataspaceProtocolDataset.js";
|
|
14
|
+
export * from "./models/dcat3/IDataspaceProtocolDatasetBase.js";
|
|
15
|
+
export * from "./models/dcat3/IDataspaceProtocolDistribution.js";
|
|
16
|
+
export * from "./models/dcat3/IDataspaceProtocolDistributionBase.js";
|
|
17
17
|
export * from "./models/odrl/IDataspaceProtocolAgreement.js";
|
|
18
|
-
export * from "./models/odrl/IDataspaceProtocolAgreementNoContext.js";
|
|
19
18
|
export * from "./models/odrl/IDataspaceProtocolOffer.js";
|
|
20
|
-
export * from "./models/odrl/
|
|
19
|
+
export * from "./models/odrl/IDataspaceProtocolOfferBase.js";
|
|
21
20
|
export * from "./models/odrl/IDataspaceProtocolPolicy.js";
|
|
22
|
-
export * from "./models/odrl/IDataspaceProtocolPolicyNoContext.js";
|
|
23
21
|
export * from "./models/odrl/IDataspaceProtocolSet.js";
|
|
24
|
-
export * from "./models/odrl/IDataspaceProtocolSetNoContext.js";
|
|
25
22
|
export * from "./models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js";
|
|
26
23
|
export * from "./models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.js";
|
|
27
24
|
export * from "./models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.js";
|
|
@@ -44,7 +41,7 @@ export * from "./models/transferProcess/IDataspaceProtocolTransferRequestMessage
|
|
|
44
41
|
export * from "./models/transferProcess/IDataspaceProtocolTransferStartMessage.js";
|
|
45
42
|
export * from "./models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js";
|
|
46
43
|
export * from "./models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js";
|
|
47
|
-
export * from "./models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js";
|
|
48
44
|
export * from "./models/transferProcess/types/dataspaceProtocolEndpointType.js";
|
|
45
|
+
export * from "./models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js";
|
|
49
46
|
export * from "./dataTypes/transferProcessDataTypes.js";
|
|
50
47
|
export * from "./utils/dataspaceProtocolHelper.js";
|
|
@@ -19,66 +19,34 @@ export declare const DataspaceProtocolCatalogTypes: {
|
|
|
19
19
|
* Dataset.
|
|
20
20
|
*/
|
|
21
21
|
readonly Dataset: "Dataset";
|
|
22
|
-
/**
|
|
23
|
-
* Dataset without JSON-LD context.
|
|
24
|
-
*/
|
|
25
|
-
readonly DatasetNoContext: "DatasetNoContext";
|
|
26
22
|
/**
|
|
27
23
|
* Data Service.
|
|
28
24
|
*/
|
|
29
25
|
readonly DataService: "DataService";
|
|
30
|
-
/**
|
|
31
|
-
* Data Service without JSON-LD context.
|
|
32
|
-
*/
|
|
33
|
-
readonly DataServiceNoContext: "DataServiceNoContext";
|
|
34
26
|
/**
|
|
35
27
|
* Distribution.
|
|
36
28
|
*/
|
|
37
29
|
readonly Distribution: "Distribution";
|
|
38
|
-
/**
|
|
39
|
-
* Distribution without JSON-LD context.
|
|
40
|
-
*/
|
|
41
|
-
readonly DistributionNoContext: "DistributionNoContext";
|
|
42
30
|
/**
|
|
43
31
|
* Catalog.
|
|
44
32
|
*/
|
|
45
33
|
readonly Catalog: "Catalog";
|
|
46
|
-
/**
|
|
47
|
-
* Catalog without JSON-LD context.
|
|
48
|
-
*/
|
|
49
|
-
readonly CatalogNoContext: "CatalogNoContext";
|
|
50
34
|
/**
|
|
51
35
|
* Policy.
|
|
52
36
|
*/
|
|
53
37
|
readonly Policy: "Policy";
|
|
54
|
-
/**
|
|
55
|
-
* Policy without JSON-LD context.
|
|
56
|
-
*/
|
|
57
|
-
readonly PolicyNoContext: "PolicyNoContext";
|
|
58
38
|
/**
|
|
59
39
|
* Offer.
|
|
60
40
|
*/
|
|
61
41
|
readonly Offer: "Offer";
|
|
62
|
-
/**
|
|
63
|
-
* Offer without JSON-LD context.
|
|
64
|
-
*/
|
|
65
|
-
readonly OfferNoContext: "OfferNoContext";
|
|
66
42
|
/**
|
|
67
43
|
* Agreement.
|
|
68
44
|
*/
|
|
69
45
|
readonly Agreement: "Agreement";
|
|
70
|
-
/**
|
|
71
|
-
* Agreement without JSON-LD context.
|
|
72
|
-
*/
|
|
73
|
-
readonly AgreementNoContext: "AgreementNoContext";
|
|
74
46
|
/**
|
|
75
47
|
* Set.
|
|
76
48
|
*/
|
|
77
49
|
readonly Set: "Set";
|
|
78
|
-
/**
|
|
79
|
-
* Set without JSON-LD context.
|
|
80
|
-
*/
|
|
81
|
-
readonly SetNoContext: "SetNoContext";
|
|
82
50
|
};
|
|
83
51
|
/**
|
|
84
52
|
* The types for Dataspace Protocol Catalog Protocol.
|
package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import type { JsonLdObjectWithNoContext } from "@twin.org/data-json-ld";
|
|
1
2
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
3
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
-
import type {
|
|
4
|
+
import type { IDataspaceProtocolAgreement } from "../odrl/IDataspaceProtocolAgreement.js";
|
|
4
5
|
/**
|
|
5
6
|
* Interface for Dataspace Protocol Contract Agreement Messages.
|
|
6
7
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
@@ -25,7 +26,7 @@ export interface IDataspaceProtocolContractAgreementMessage {
|
|
|
25
26
|
/**
|
|
26
27
|
* The agreement being sent.
|
|
27
28
|
*/
|
|
28
|
-
agreement:
|
|
29
|
+
agreement: JsonLdObjectWithNoContext<IDataspaceProtocolAgreement>;
|
|
29
30
|
/**
|
|
30
31
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
32
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Offer Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
@@ -25,7 +25,7 @@ export interface IDataspaceProtocolContractOfferMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The offer being requested.
|
|
27
27
|
*/
|
|
28
|
-
offer:
|
|
28
|
+
offer: IDataspaceProtocolOfferBase;
|
|
29
29
|
/**
|
|
30
30
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
31
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
|
-
import type {
|
|
3
|
+
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
4
4
|
/**
|
|
5
5
|
* Interface for Dataspace Protocol Contract Request Messages.
|
|
6
6
|
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
@@ -25,7 +25,7 @@ export interface IDataspaceProtocolContractRequestMessage {
|
|
|
25
25
|
/**
|
|
26
26
|
* The offer being requested.
|
|
27
27
|
*/
|
|
28
|
-
offer:
|
|
28
|
+
offer: IDataspaceProtocolOfferBase;
|
|
29
29
|
/**
|
|
30
30
|
* The base callback address for the provider to update the consumer on the state of the negotiation.
|
|
31
31
|
*/
|
|
@@ -1,14 +1,7 @@
|
|
|
1
|
+
import type { SingleOccurrenceArray } from "@twin.org/core";
|
|
1
2
|
import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
|
|
2
3
|
import type { DataspaceProtocolContexts } from "./dataspaceProtocolContexts.js";
|
|
3
4
|
/**
|
|
4
5
|
* The Dataspace Protocol JSON-LD context type.
|
|
5
6
|
*/
|
|
6
|
-
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context |
|
|
7
|
-
...IJsonLdContextDefinitionElement[],
|
|
8
|
-
typeof DataspaceProtocolContexts.Context,
|
|
9
|
-
IJsonLdContextDefinitionElement
|
|
10
|
-
] | [
|
|
11
|
-
IJsonLdContextDefinitionElement,
|
|
12
|
-
typeof DataspaceProtocolContexts.Context,
|
|
13
|
-
...IJsonLdContextDefinitionElement[]
|
|
14
|
-
];
|
|
7
|
+
export type DataspaceProtocolContextType = typeof DataspaceProtocolContexts.Context | SingleOccurrenceArray<IJsonLdContextDefinitionElement, typeof DataspaceProtocolContexts.Context>;
|
|
@@ -1,10 +1,5 @@
|
|
|
1
|
-
import type { IDcatCatalog } from "@twin.org/standards-w3c-dcat";
|
|
2
|
-
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
3
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
4
|
-
import type {
|
|
5
|
-
import type { IDataspaceProtocolDataServiceNoContext } from "./IDataspaceProtocolDataServiceNoContext.js";
|
|
6
|
-
import type { IDataspaceProtocolDatasetNoContext } from "./IDataspaceProtocolDatasetNoContext.js";
|
|
7
|
-
import type { IDataspaceProtocolDistributionNoContext } from "./IDataspaceProtocolDistributionNoContext.js";
|
|
2
|
+
import type { IDataspaceProtocolCatalogBase } from "./IDataspaceProtocolCatalogBase.js";
|
|
8
3
|
/**
|
|
9
4
|
* Catalog interface compliant with Eclipse Data Space Protocol.
|
|
10
5
|
*
|
|
@@ -25,39 +20,9 @@ import type { IDataspaceProtocolDistributionNoContext } from "./IDataspaceProtoc
|
|
|
25
20
|
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
26
21
|
*
|
|
27
22
|
*/
|
|
28
|
-
export interface IDataspaceProtocolCatalog extends
|
|
23
|
+
export interface IDataspaceProtocolCatalog extends IDataspaceProtocolCatalogBase {
|
|
29
24
|
/**
|
|
30
25
|
* LD Context. Required per Eclipse Data Space Protocol.
|
|
31
26
|
*/
|
|
32
27
|
"@context": DataspaceProtocolContextType;
|
|
33
|
-
/**
|
|
34
|
-
* The type identifier for the Catalog.
|
|
35
|
-
* REQUIRED per Eclipse Data Space Protocol.
|
|
36
|
-
*/
|
|
37
|
-
"@type": typeof DataspaceProtocolCatalogTypes.Catalog;
|
|
38
|
-
/**
|
|
39
|
-
* Unique identifier for the dataset.
|
|
40
|
-
* REQUIRED per Eclipse Data Space Protocol.
|
|
41
|
-
*/
|
|
42
|
-
"@id": string;
|
|
43
|
-
/**
|
|
44
|
-
* Participant Id
|
|
45
|
-
*/
|
|
46
|
-
participantId: string;
|
|
47
|
-
/**
|
|
48
|
-
* Other concerned catalogs
|
|
49
|
-
*/
|
|
50
|
-
catalog?: IDataspaceProtocolCatalogNoContext | IDataspaceProtocolCatalogNoContext[];
|
|
51
|
-
/**
|
|
52
|
-
* Datasets registered
|
|
53
|
-
*/
|
|
54
|
-
dataset?: IDataspaceProtocolDatasetNoContext | IDataspaceProtocolDatasetNoContext[];
|
|
55
|
-
/**
|
|
56
|
-
* Catalog's distributions
|
|
57
|
-
*/
|
|
58
|
-
distribution?: IDataspaceProtocolDistributionNoContext | IDataspaceProtocolDistributionNoContext[];
|
|
59
|
-
/**
|
|
60
|
-
* Data services registered-
|
|
61
|
-
*/
|
|
62
|
-
service?: IDataspaceProtocolDataServiceNoContext | IDataspaceProtocolDataServiceNoContext[];
|
|
63
28
|
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import type { ObjectOrArray } from "@twin.org/core";
|
|
2
|
+
import type { IDcatCatalogBase } from "@twin.org/standards-w3c-dcat";
|
|
3
|
+
import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolDataServiceBase.js";
|
|
4
|
+
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
5
|
+
import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
|
|
6
|
+
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
7
|
+
/**
|
|
8
|
+
* Catalog interface compliant with Eclipse Data Space Protocol.
|
|
9
|
+
*
|
|
10
|
+
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
11
|
+
* by overriding properties with more specific types and constraints.
|
|
12
|
+
*
|
|
13
|
+
* **Requirements per DS Protocol:**
|
|
14
|
+
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
15
|
+
* - participantId MUST be present (REQUIRED)
|
|
16
|
+
*
|
|
17
|
+
* **Type System Design:**
|
|
18
|
+
* - Interface extension allows TypeScript to override inherited property types
|
|
19
|
+
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
20
|
+
* - DS Protocol-specific constraints are defined here
|
|
21
|
+
*
|
|
22
|
+
*
|
|
23
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
24
|
+
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export interface IDataspaceProtocolCatalogBase extends Omit<IDcatCatalogBase, "@type" | "dcat:catalog" | "dcat:dataset" | "dcat:distribution" | "dcat:service"> {
|
|
28
|
+
/**
|
|
29
|
+
* The type identifier for the Catalog.
|
|
30
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
31
|
+
*/
|
|
32
|
+
"@type": typeof DataspaceProtocolCatalogTypes.Catalog;
|
|
33
|
+
/**
|
|
34
|
+
* Unique identifier for the dataset.
|
|
35
|
+
* REQUIRED per Eclipse Data Space Protocol.
|
|
36
|
+
*/
|
|
37
|
+
"@id": string;
|
|
38
|
+
/**
|
|
39
|
+
* Participant Id
|
|
40
|
+
*/
|
|
41
|
+
participantId: string;
|
|
42
|
+
/**
|
|
43
|
+
* Other concerned catalogs
|
|
44
|
+
*/
|
|
45
|
+
catalog?: ObjectOrArray<IDataspaceProtocolCatalogBase>;
|
|
46
|
+
/**
|
|
47
|
+
* Datasets registered
|
|
48
|
+
*/
|
|
49
|
+
dataset?: ObjectOrArray<IDataspaceProtocolDatasetBase>;
|
|
50
|
+
/**
|
|
51
|
+
* Catalog's distributions
|
|
52
|
+
*/
|
|
53
|
+
distribution?: ObjectOrArray<IDataspaceProtocolDistributionBase>;
|
|
54
|
+
/**
|
|
55
|
+
* Data services registered-
|
|
56
|
+
*/
|
|
57
|
+
service?: ObjectOrArray<IDataspaceProtocolDataServiceBase>;
|
|
58
|
+
}
|