@twin.org/standards-dataspace-protocol 0.0.3-next.67 → 0.0.3-next.69
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/models/catalog/IDataspaceProtocolCatalogError.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolCatalogRequestMessage.js.map +1 -1
- package/dist/es/models/catalog/IDataspaceProtocolDatasetRequestMessage.js.map +1 -1
- package/dist/es/models/catalog/dataspaceProtocolCatalogTypes.js +2 -2
- 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/IDataspaceProtocolContractAgreementVerificationMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiation.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.js.map +1 -1
- package/dist/es/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.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/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js +2 -2
- package/dist/es/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.js.map +1 -1
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js +2 -2
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.js.map +1 -1
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js +2 -2
- package/dist/es/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.js.map +1 -1
- package/dist/es/models/dataspaceProtocolContexts.js +1 -1
- package/dist/es/models/dataspaceProtocolContexts.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolCatalog.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolCatalogBase.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDataService.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDataServiceBase.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDataset.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDatasetBase.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDistribution.js.map +1 -1
- package/dist/es/models/dcat3/IDataspaceProtocolDistributionBase.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolAgreement.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolOffer.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolOfferBase.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolPolicy.js.map +1 -1
- package/dist/es/models/odrl/IDataspaceProtocolSet.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolDataAddress.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolEndpointProperty.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferError.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferProcess.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferRequestMessage.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferStartMessage.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.js.map +1 -1
- package/dist/es/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.js.map +1 -1
- package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js +2 -2
- package/dist/es/models/transferProcess/dataspaceProtocolTransferProcessTypes.js.map +1 -1
- package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js +5 -59
- package/dist/es/models/transferProcess/types/dataspaceProtocolEndpointType.js.map +1 -1
- package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js +2 -2
- package/dist/es/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.js.map +1 -1
- package/dist/es/schemas/DataspaceProtocolAgreement.json +1 -1
- package/dist/es/schemas/DataspaceProtocolCatalog.json +2 -2
- package/dist/es/schemas/DataspaceProtocolCatalogBase.json +6 -6
- package/dist/es/schemas/DataspaceProtocolCatalogError.json +1 -1
- package/dist/es/schemas/DataspaceProtocolCatalogRequestMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractNegotiation.json +2 -2
- package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolDataAddress.json +5 -5
- package/dist/es/schemas/DataspaceProtocolDataService.json +2 -2
- package/dist/es/schemas/DataspaceProtocolDataServiceBase.json +1 -1
- package/dist/es/schemas/DataspaceProtocolDataset.json +2 -2
- package/dist/es/schemas/DataspaceProtocolDatasetBase.json +3 -3
- package/dist/es/schemas/DataspaceProtocolDatasetRequestMessage.json +1 -1
- package/dist/es/schemas/DataspaceProtocolDistribution.json +3 -3
- package/dist/es/schemas/DataspaceProtocolDistributionBase.json +5 -5
- package/dist/es/schemas/DataspaceProtocolEndpointProperty.json +4 -4
- package/dist/es/schemas/DataspaceProtocolOffer.json +2 -2
- package/dist/es/schemas/DataspaceProtocolOfferBase.json +1 -1
- package/dist/es/schemas/DataspaceProtocolPolicy.json +1 -1
- package/dist/es/schemas/DataspaceProtocolSet.json +1 -1
- package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferError.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferProcess.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json +3 -3
- package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json +3 -3
- package/dist/types/models/catalog/IDataspaceProtocolCatalogError.d.ts +2 -2
- package/dist/types/models/catalog/IDataspaceProtocolCatalogRequestMessage.d.ts +2 -2
- package/dist/types/models/catalog/IDataspaceProtocolDatasetRequestMessage.d.ts +2 -2
- package/dist/types/models/catalog/dataspaceProtocolCatalogTypes.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementVerificationMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiation.d.ts +3 -3
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts +2 -2
- package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationTerminationMessage.d.ts +2 -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/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts +2 -2
- package/dist/types/models/contractNegotiation/types/dataspaceProtocolContractNegotiationEventType.d.ts +2 -2
- package/dist/types/models/contractNegotiation/types/dataspaceProtocolContractNegotiationStateType.d.ts +2 -2
- package/dist/types/models/dataspaceProtocolContexts.d.ts +1 -1
- package/dist/types/models/dcat3/IDataspaceProtocolCatalog.d.ts +2 -17
- package/dist/types/models/dcat3/IDataspaceProtocolCatalogBase.d.ts +6 -21
- package/dist/types/models/dcat3/IDataspaceProtocolDataService.d.ts +2 -17
- package/dist/types/models/dcat3/IDataspaceProtocolDataServiceBase.d.ts +1 -16
- package/dist/types/models/dcat3/IDataspaceProtocolDataset.d.ts +2 -27
- package/dist/types/models/dcat3/IDataspaceProtocolDatasetBase.d.ts +3 -34
- package/dist/types/models/dcat3/IDataspaceProtocolDistribution.d.ts +3 -28
- package/dist/types/models/dcat3/IDataspaceProtocolDistributionBase.d.ts +5 -38
- package/dist/types/models/odrl/IDataspaceProtocolAgreement.d.ts +1 -6
- package/dist/types/models/odrl/IDataspaceProtocolOffer.d.ts +2 -7
- package/dist/types/models/odrl/IDataspaceProtocolOfferBase.d.ts +1 -7
- package/dist/types/models/odrl/IDataspaceProtocolPolicy.d.ts +1 -6
- package/dist/types/models/odrl/IDataspaceProtocolSet.d.ts +1 -6
- package/dist/types/models/transferProcess/IDataspaceProtocolDataAddress.d.ts +6 -6
- package/dist/types/models/transferProcess/IDataspaceProtocolEndpointProperty.d.ts +5 -5
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferCompletionMessage.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferError.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferProcess.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferRequestMessage.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferStartMessage.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferSuspensionMessage.d.ts +4 -4
- package/dist/types/models/transferProcess/IDataspaceProtocolTransferTerminationMessage.d.ts +4 -4
- package/dist/types/models/transferProcess/dataspaceProtocolTransferProcessTypes.d.ts +2 -2
- package/dist/types/models/transferProcess/types/dataspaceProtocolEndpointType.d.ts +6 -60
- package/dist/types/models/transferProcess/types/dataspaceProtocolTransferProcessStateType.d.ts +2 -2
- package/docs/changelog.md +34 -0
- package/docs/reference/interfaces/IDataspaceProtocolAgreement.md +2 -7
- package/docs/reference/interfaces/IDataspaceProtocolCatalog.md +8 -21
- package/docs/reference/interfaces/IDataspaceProtocolCatalogBase.md +7 -20
- package/docs/reference/interfaces/IDataspaceProtocolCatalogError.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolCatalogRequestMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractAgreementMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractAgreementVerificationMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiation.md +5 -2
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationError.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationEventMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractNegotiationTerminationMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractOfferMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolContractRequestMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolDataAddress.md +8 -5
- package/docs/reference/interfaces/IDataspaceProtocolDataService.md +3 -16
- package/docs/reference/interfaces/IDataspaceProtocolDataServiceBase.md +2 -15
- package/docs/reference/interfaces/IDataspaceProtocolDataset.md +5 -36
- package/docs/reference/interfaces/IDataspaceProtocolDatasetBase.md +4 -35
- package/docs/reference/interfaces/IDataspaceProtocolDatasetRequestMessage.md +4 -1
- package/docs/reference/interfaces/IDataspaceProtocolDistribution.md +7 -39
- package/docs/reference/interfaces/IDataspaceProtocolDistributionBase.md +6 -39
- package/docs/reference/interfaces/IDataspaceProtocolEndpointProperty.md +7 -4
- package/docs/reference/interfaces/IDataspaceProtocolOffer.md +3 -8
- package/docs/reference/interfaces/IDataspaceProtocolOfferBase.md +1 -7
- package/docs/reference/interfaces/IDataspaceProtocolPolicy.md +2 -7
- package/docs/reference/interfaces/IDataspaceProtocolSet.md +2 -7
- package/docs/reference/interfaces/IDataspaceProtocolTransferCompletionMessage.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferError.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferProcess.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferRequestMessage.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferStartMessage.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferSuspensionMessage.md +6 -3
- package/docs/reference/interfaces/IDataspaceProtocolTransferTerminationMessage.md +6 -3
- package/docs/reference/type-aliases/DataspaceProtocolEndpointType.md +1 -8
- package/docs/reference/variables/DataspaceProtocolCatalogTypes.md +5 -2
- package/docs/reference/variables/DataspaceProtocolContexts.md +1 -1
- package/docs/reference/variables/DataspaceProtocolContractNegotiationEventType.md +5 -2
- package/docs/reference/variables/DataspaceProtocolContractNegotiationStateType.md +5 -2
- package/docs/reference/variables/DataspaceProtocolContractNegotiationTypes.md +5 -2
- package/docs/reference/variables/DataspaceProtocolEndpointType.md +11 -56
- package/docs/reference/variables/DataspaceProtocolTransferProcessStateType.md +5 -2
- package/docs/reference/variables/DataspaceProtocolTransferProcessTypes.md +5 -2
- package/package.json +3 -3
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferCompletionMessage",
|
|
4
4
|
"title": "DataspaceProtocolTransferCompletionMessage",
|
|
5
|
-
"description": "Interface for Dataspace Protocol
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer completion message.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferCompletionMessage",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
3
|
"$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError",
|
|
4
4
|
"title": "DataspaceProtocolTransferError",
|
|
5
|
-
"description": "Interface for Dataspace Protocol
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer error response.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferError",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
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
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer process acknowledgment.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferProcess",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
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
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer request message.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferRequestMessage",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"agreementId": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
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
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer start message.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferStartMessage",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
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
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer suspension message.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferSuspensionMessage",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -2,16 +2,16 @@
|
|
|
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
|
|
5
|
+
"description": "Interface for the Dataspace Protocol transfer termination message.",
|
|
6
6
|
"type": "object",
|
|
7
7
|
"properties": {
|
|
8
8
|
"@context": {
|
|
9
9
|
"$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
|
|
10
|
-
"description": "LD
|
|
10
|
+
"description": "The JSON-LD context."
|
|
11
11
|
},
|
|
12
12
|
"@type": {
|
|
13
13
|
"const": "TransferTerminationMessage",
|
|
14
|
-
"description": "LD
|
|
14
|
+
"description": "The JSON-LD type."
|
|
15
15
|
},
|
|
16
16
|
"consumerPid": {
|
|
17
17
|
"type": "string",
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
|
|
4
|
+
* Interface for the Dataspace Protocol catalog error response.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-catalog-error
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolCatalogError {
|
|
8
8
|
/**
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
|
|
4
|
+
* Interface for the Dataspace Protocol catalog request message.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-request-message
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolCatalogRequestMessage {
|
|
8
8
|
/**
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolCatalogTypes } from "./dataspaceProtocolCatalogTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
|
|
4
|
+
* Interface for the Dataspace Protocol dataset request message.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolDatasetRequestMessage {
|
|
8
8
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
|
|
2
|
+
* Type identifiers for the Dataspace Protocol Catalog Protocol.
|
|
3
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#catalog-protocol
|
|
4
4
|
*/
|
|
5
5
|
export declare const DataspaceProtocolCatalogTypes: {
|
|
6
6
|
/**
|
package/dist/types/models/contractNegotiation/IDataspaceProtocolContractAgreementMessage.d.ts
CHANGED
|
@@ -3,8 +3,8 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
|
|
|
3
3
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
4
4
|
import type { IDataspaceProtocolAgreement } from "../odrl/IDataspaceProtocolAgreement.js";
|
|
5
5
|
/**
|
|
6
|
-
* Interface for Dataspace Protocol
|
|
7
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
6
|
+
* Interface for the Dataspace Protocol contract agreement message.
|
|
7
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message
|
|
8
8
|
*/
|
|
9
9
|
export interface IDataspaceProtocolContractAgreementMessage {
|
|
10
10
|
/**
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
|
|
4
|
+
* Interface for the Dataspace Protocol contract agreement verification message.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolContractAgreementVerificationMessage {
|
|
8
8
|
/**
|
|
@@ -2,8 +2,8 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
|
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
import type { DataspaceProtocolContractNegotiationStateType } from "./types/dataspaceProtocolContractNegotiationStateType.js";
|
|
4
4
|
/**
|
|
5
|
-
* Interface for Dataspace Protocol
|
|
6
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
|
|
5
|
+
* Interface for the Dataspace Protocol contract negotiation acknowledgment.
|
|
6
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation
|
|
7
7
|
*/
|
|
8
8
|
export interface IDataspaceProtocolContractNegotiation {
|
|
9
9
|
/**
|
|
@@ -23,7 +23,7 @@ export interface IDataspaceProtocolContractNegotiation {
|
|
|
23
23
|
*/
|
|
24
24
|
consumerPid: string;
|
|
25
25
|
/**
|
|
26
|
-
* The
|
|
26
|
+
* The current state of the contract negotiation.
|
|
27
27
|
*/
|
|
28
28
|
state: DataspaceProtocolContractNegotiationStateType;
|
|
29
29
|
}
|
package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationError.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
|
|
4
|
+
* Interface for the Dataspace Protocol contract negotiation error response.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolContractNegotiationError {
|
|
8
8
|
/**
|
package/dist/types/models/contractNegotiation/IDataspaceProtocolContractNegotiationEventMessage.d.ts
CHANGED
|
@@ -2,8 +2,8 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
|
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
import type { DataspaceProtocolContractNegotiationEventType } from "./types/dataspaceProtocolContractNegotiationEventType.js";
|
|
4
4
|
/**
|
|
5
|
-
* Interface for Dataspace Protocol
|
|
6
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
5
|
+
* Interface for the Dataspace Protocol contract negotiation event message.
|
|
6
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
7
7
|
*/
|
|
8
8
|
export interface IDataspaceProtocolContractNegotiationEventMessage {
|
|
9
9
|
/**
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
/**
|
|
4
|
-
* Interface for Dataspace Protocol
|
|
5
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
|
|
4
|
+
* Interface for the Dataspace Protocol contract negotiation termination message.
|
|
5
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message
|
|
6
6
|
*/
|
|
7
7
|
export interface IDataspaceProtocolContractNegotiationTerminationMessage {
|
|
8
8
|
/**
|
|
@@ -2,8 +2,8 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
|
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
4
4
|
/**
|
|
5
|
-
* Interface for Dataspace Protocol
|
|
6
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
5
|
+
* Interface for the Dataspace Protocol contract offer message.
|
|
6
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message
|
|
7
7
|
*/
|
|
8
8
|
export interface IDataspaceProtocolContractOfferMessage {
|
|
9
9
|
/**
|
|
@@ -2,8 +2,8 @@ import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextTy
|
|
|
2
2
|
import type { DataspaceProtocolContractNegotiationTypes } from "./dataspaceProtocolContractNegotiationTypes.js";
|
|
3
3
|
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
4
4
|
/**
|
|
5
|
-
* Interface for Dataspace Protocol
|
|
6
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
5
|
+
* Interface for the Dataspace Protocol contract request message.
|
|
6
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message
|
|
7
7
|
*/
|
|
8
8
|
export interface IDataspaceProtocolContractRequestMessage {
|
|
9
9
|
/**
|
package/dist/types/models/contractNegotiation/dataspaceProtocolContractNegotiationTypes.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
|
|
2
|
+
* Type identifiers for the Dataspace Protocol Contract Negotiation.
|
|
3
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#message-types-0
|
|
4
4
|
*/
|
|
5
5
|
export declare const DataspaceProtocolContractNegotiationTypes: {
|
|
6
6
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
2
|
+
* Event type identifiers for the Dataspace Protocol Contract Negotiation.
|
|
3
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message
|
|
4
4
|
*/
|
|
5
5
|
export declare const DataspaceProtocolContractNegotiationEventType: {
|
|
6
6
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
* https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
|
|
2
|
+
* State type identifiers for the Dataspace Protocol Contract Negotiation.
|
|
3
|
+
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-states
|
|
4
4
|
*/
|
|
5
5
|
export declare const DataspaceProtocolContractNegotiationStateType: {
|
|
6
6
|
/**
|
|
@@ -1,28 +1,13 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { IDataspaceProtocolCatalogBase } from "./IDataspaceProtocolCatalogBase.js";
|
|
3
3
|
/**
|
|
4
|
-
* Catalog
|
|
5
|
-
*
|
|
6
|
-
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
7
|
-
* by overriding properties with more specific types and constraints.
|
|
8
|
-
*
|
|
9
|
-
* **Requirements per DS Protocol:**
|
|
10
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
-
* - participantId MUST be present (REQUIRED)
|
|
12
|
-
*
|
|
13
|
-
* **Type System Design:**
|
|
14
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
15
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
16
|
-
* - DS Protocol-specific constraints are defined here
|
|
17
|
-
*
|
|
4
|
+
* Catalog compliant with Eclipse Data Space Protocol, requiring a context, id, and participantId.
|
|
18
5
|
*
|
|
19
6
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
20
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
21
|
-
*
|
|
22
7
|
*/
|
|
23
8
|
export interface IDataspaceProtocolCatalog extends IDataspaceProtocolCatalogBase {
|
|
24
9
|
/**
|
|
25
|
-
* LD
|
|
10
|
+
* The JSON-LD context.
|
|
26
11
|
*/
|
|
27
12
|
"@context": DataspaceProtocolContextType;
|
|
28
13
|
}
|
|
@@ -4,24 +4,9 @@ import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetB
|
|
|
4
4
|
import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDistributionBase.js";
|
|
5
5
|
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* This interface extends ICatalog and enforces DS Protocol-specific requirements
|
|
10
|
-
* by overriding properties with more specific types and constraints.
|
|
11
|
-
*
|
|
12
|
-
* **Requirements per DS Protocol:**
|
|
13
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
14
|
-
* - participantId MUST be present (REQUIRED)
|
|
15
|
-
*
|
|
16
|
-
* **Type System Design:**
|
|
17
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
18
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
19
|
-
* - DS Protocol-specific constraints are defined here
|
|
20
|
-
*
|
|
7
|
+
* Base catalog interface compliant with Eclipse Data Space Protocol, requiring an id and participantId.
|
|
21
8
|
*
|
|
22
9
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
23
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
24
|
-
*
|
|
25
10
|
*/
|
|
26
11
|
export interface IDataspaceProtocolCatalogBase extends Omit<IDcatCatalogBase, "@type" | "dcat:catalog" | "dcat:dataset" | "dcat:distribution" | "dcat:service"> {
|
|
27
12
|
/**
|
|
@@ -35,23 +20,23 @@ export interface IDataspaceProtocolCatalogBase extends Omit<IDcatCatalogBase, "@
|
|
|
35
20
|
*/
|
|
36
21
|
"@id": string;
|
|
37
22
|
/**
|
|
38
|
-
*
|
|
23
|
+
* The participant identifier.
|
|
39
24
|
*/
|
|
40
25
|
participantId: string;
|
|
41
26
|
/**
|
|
42
|
-
*
|
|
27
|
+
* Nested catalogs.
|
|
43
28
|
*/
|
|
44
29
|
catalog?: IDataspaceProtocolCatalogBase[];
|
|
45
30
|
/**
|
|
46
|
-
* Datasets registered
|
|
31
|
+
* Datasets registered in this catalog.
|
|
47
32
|
*/
|
|
48
33
|
dataset?: IDataspaceProtocolDatasetBase[];
|
|
49
34
|
/**
|
|
50
|
-
*
|
|
35
|
+
* Distributions for this catalog.
|
|
51
36
|
*/
|
|
52
37
|
distribution?: IDataspaceProtocolDistributionBase[];
|
|
53
38
|
/**
|
|
54
|
-
* Data services registered
|
|
39
|
+
* Data services registered in this catalog.
|
|
55
40
|
*/
|
|
56
41
|
service?: IDataspaceProtocolDataServiceBase[];
|
|
57
42
|
}
|
|
@@ -1,28 +1,13 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { IDataspaceProtocolDataServiceBase } from "./IDataspaceProtocolDataServiceBase.js";
|
|
3
3
|
/**
|
|
4
|
-
* Data
|
|
5
|
-
*
|
|
6
|
-
* This interface extends IDataService and enforces DS Protocol-specific requirements
|
|
7
|
-
* by overriding properties with more specific types and constraints.
|
|
8
|
-
*
|
|
9
|
-
* **Requirements per DS Protocol:**
|
|
10
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
-
* - endpointURL MUST be present (REQUIRED)
|
|
12
|
-
*
|
|
13
|
-
* **Type System Design:**
|
|
14
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
15
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
16
|
-
* - DS Protocol-specific constraints are defined here
|
|
17
|
-
*
|
|
4
|
+
* Data service compliant with Eclipse Data Space Protocol, requiring an id and endpointURL.
|
|
18
5
|
*
|
|
19
6
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
20
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
21
|
-
*
|
|
22
7
|
*/
|
|
23
8
|
export interface IDataspaceProtocolDataService extends IDataspaceProtocolDataServiceBase {
|
|
24
9
|
/**
|
|
25
|
-
* LD
|
|
10
|
+
* The JSON-LD context.
|
|
26
11
|
*/
|
|
27
12
|
"@context": DataspaceProtocolContextType;
|
|
28
13
|
}
|
|
@@ -2,24 +2,9 @@ import type { IDcatDataServiceBase } from "@twin.org/standards-w3c-dcat";
|
|
|
2
2
|
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
3
3
|
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
* This interface extends IDataService and enforces DS Protocol-specific requirements
|
|
8
|
-
* by overriding properties with more specific types and constraints.
|
|
9
|
-
*
|
|
10
|
-
* **Requirements per DS Protocol:**
|
|
11
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
12
|
-
* - endpointURL MUST be present (REQUIRED)
|
|
13
|
-
*
|
|
14
|
-
* **Type System Design:**
|
|
15
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
16
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
17
|
-
* - DS Protocol-specific constraints are defined here
|
|
18
|
-
*
|
|
5
|
+
* Base data service interface compliant with Eclipse Data Space Protocol, requiring an id and endpointURL.
|
|
19
6
|
*
|
|
20
7
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
21
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
22
|
-
*
|
|
23
8
|
*/
|
|
24
9
|
export interface IDataspaceProtocolDataServiceBase extends Omit<IDcatDataServiceBase, "@type" | "dcat:servesDataset" | "dcat:endpointURL"> {
|
|
25
10
|
/**
|
|
@@ -1,38 +1,13 @@
|
|
|
1
1
|
import type { DataspaceProtocolContextType } from "../dataspaceProtocolContextType.js";
|
|
2
2
|
import type { IDataspaceProtocolDatasetBase } from "./IDataspaceProtocolDatasetBase.js";
|
|
3
3
|
/**
|
|
4
|
-
* Dataset
|
|
5
|
-
*
|
|
6
|
-
* This interface extends IDataset and enforces DS Protocol-specific requirements
|
|
7
|
-
* by overriding properties with more specific types and constraints.
|
|
8
|
-
*
|
|
9
|
-
* **Requirements per DS Protocol:**
|
|
10
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
11
|
-
* - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
|
|
12
|
-
* - Array MUST contain at least one IOdrlOffer
|
|
13
|
-
* - Each Offer MUST have `@type`: "Offer"
|
|
14
|
-
* - Each Offer MUST have `@id`
|
|
15
|
-
* - `dcat:distribution` MUST be present (REQUIRED)
|
|
16
|
-
*
|
|
17
|
-
* **Type System Design:**
|
|
18
|
-
* - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
19
|
-
* - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
20
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
21
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
22
|
-
* - DS Protocol-specific constraints are defined here
|
|
23
|
-
*
|
|
24
|
-
* **Future Compatibility:**
|
|
25
|
-
* - Currently only one Offer per dataset is supported
|
|
26
|
-
* - Array structure allows future support for multiple offers
|
|
4
|
+
* Dataset compliant with Eclipse Data Space Protocol, requiring an id, hasPolicy, and distribution.
|
|
27
5
|
*
|
|
28
6
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
29
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
30
|
-
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
31
|
-
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
32
7
|
*/
|
|
33
8
|
export interface IDataspaceProtocolDataset extends IDataspaceProtocolDatasetBase {
|
|
34
9
|
/**
|
|
35
|
-
* LD
|
|
10
|
+
* The JSON-LD context.
|
|
36
11
|
*/
|
|
37
12
|
"@context": DataspaceProtocolContextType;
|
|
38
13
|
}
|
|
@@ -3,34 +3,9 @@ import type { IDataspaceProtocolDistributionBase } from "./IDataspaceProtocolDis
|
|
|
3
3
|
import type { DataspaceProtocolCatalogTypes } from "../catalog/dataspaceProtocolCatalogTypes.js";
|
|
4
4
|
import type { IDataspaceProtocolOfferBase } from "../odrl/IDataspaceProtocolOfferBase.js";
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* This interface extends IDataset and enforces DS Protocol-specific requirements
|
|
9
|
-
* by overriding properties with more specific types and constraints.
|
|
10
|
-
*
|
|
11
|
-
* **Requirements per DS Protocol:**
|
|
12
|
-
* - `@id` MUST be present for dataset identification (REQUIRED)
|
|
13
|
-
* - `odrl:hasPolicy` MUST be present as an array of ODRL Offers (REQUIRED)
|
|
14
|
-
* - Array MUST contain at least one IOdrlOffer
|
|
15
|
-
* - Each Offer MUST have `@type`: "Offer"
|
|
16
|
-
* - Each Offer MUST have `@id`
|
|
17
|
-
* - `dcat:distribution` MUST be present (REQUIRED)
|
|
18
|
-
*
|
|
19
|
-
* **Type System Design:**
|
|
20
|
-
* - W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`
|
|
21
|
-
* - DS Protocol requires it as a REQUIRED array of `IOdrlOffer`
|
|
22
|
-
* - Interface extension allows TypeScript to override inherited property types
|
|
23
|
-
* - Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly
|
|
24
|
-
* - DS Protocol-specific constraints are defined here
|
|
25
|
-
*
|
|
26
|
-
* **Future Compatibility:**
|
|
27
|
-
* - Currently only one Offer per dataset is supported
|
|
28
|
-
* - Array structure allows future support for multiple offers
|
|
6
|
+
* Base dataset interface compliant with Eclipse Data Space Protocol, requiring an id, hasPolicy, and distribution.
|
|
29
7
|
*
|
|
30
8
|
* @see https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1-err1/#lower-level-types
|
|
31
|
-
* @see https://www.w3.org/TR/vocab-dcat-3/ - W3C DCAT v3 spec
|
|
32
|
-
* @see IOdrlOffer from @twin.org/standards-w3c-odrl
|
|
33
|
-
* @see IResource.odrl:hasPolicy from @twin.org/standards-w3c-dcat
|
|
34
9
|
*/
|
|
35
10
|
export interface IDataspaceProtocolDatasetBase extends Omit<IDcatDatasetBase, "odrl:hasPolicy" | "dcat:distribution" | "@type"> {
|
|
36
11
|
/**
|
|
@@ -44,18 +19,12 @@ export interface IDataspaceProtocolDatasetBase extends Omit<IDcatDatasetBase, "o
|
|
|
44
19
|
*/
|
|
45
20
|
"@id": string;
|
|
46
21
|
/**
|
|
47
|
-
* Array of ODRL
|
|
48
|
-
*
|
|
49
|
-
* REQUIRED per Eclipse Data Space Protocol spec.
|
|
50
|
-
* Must contain at least one IOdrlOffer.
|
|
51
|
-
* Currently only single offer is supported, but array structure
|
|
52
|
-
* allows for future multi-offer support.
|
|
22
|
+
* Array of ODRL offers; must contain at least one entry.
|
|
53
23
|
* @json-schema minItems:1
|
|
54
24
|
*/
|
|
55
25
|
hasPolicy: IDataspaceProtocolOfferBase[];
|
|
56
26
|
/**
|
|
57
|
-
*
|
|
58
|
-
* REQUIRED per Eclipse Data Space Protocol.
|
|
27
|
+
* Distributions of this dataset; must contain at least one entry.
|
|
59
28
|
* @json-schema minItems:1
|
|
60
29
|
*/
|
|
61
30
|
distribution: IDataspaceProtocolDistributionBase[];
|