@twin.org/standards-dataspace-protocol 0.0.3-next.3 → 0.0.3-next.5

package/dist/es/schemas/ContractOfferMessage.json

@@ -5,11 +5,16 @@
     "type": "object",
     "properties": {
         "@context": {
-            "description": "The Dataspace Protocol Contract Negotiation JSON-LD context type.",
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
             "anyOf": [
                 {
-                    "type": "string",
-                    "const": "https://w3id.org/dspace/2024/1/context.json"
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
                 },
                 {
                     "type": "array",
@@ -17,7 +22,7 @@
                     "prefixItems": [
                         {
                             "type": "string",
-                            "const": "https://w3id.org/dspace/2024/1/context.json"
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
                         },
                         {
                             "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
@@ -36,7 +41,7 @@
                         },
                         {
                             "type": "string",
-                            "const": "https://w3id.org/dspace/2024/1/context.json"
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
                         }
                     ],
                     "items": {

package/dist/es/schemas/ContractRequestMessage.json

@@ -5,11 +5,16 @@
     "type": "object",
     "properties": {
         "@context": {
-            "description": "The Dataspace Protocol Contract Negotiation JSON-LD context type.",
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
             "anyOf": [
                 {
-                    "type": "string",
-                    "const": "https://w3id.org/dspace/2024/1/context.json"
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
                 },
                 {
                     "type": "array",
@@ -17,7 +22,7 @@
                     "prefixItems": [
                         {
                             "type": "string",
-                            "const": "https://w3id.org/dspace/2024/1/context.json"
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
                         },
                         {
                             "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
@@ -36,7 +41,7 @@
                         },
                         {
                             "type": "string",
-                            "const": "https://w3id.org/dspace/2024/1/context.json"
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
                         }
                     ],
                     "items": {

package/dist/es/schemas/DataAddress.json

@@ -0,0 +1,33 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataAddress",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
+    "type": "object",
+    "properties": {
+        "@type": {
+            "type": "string",
+            "const": "DataAddress",
+            "description": "LD Type"
+        },
+        "endpointType": {
+            "type": "string",
+            "description": "The type of endpoint of this data address."
+        },
+        "endpoint": {
+            "type": "string",
+            "description": "The endpoint of the data address"
+        },
+        "endpointProperties": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/dataspace-protocol/EndpointProperty"
+            },
+            "description": "Properties associated to the endpoint which might depend on the endpoint type."
+        }
+    },
+    "required": [
+        "@type",
+        "endpointType"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DatasetRequestMessage.json

@@ -0,0 +1,69 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DatasetRequestMessage",
+    "description": "Interface for Dataspace Protocol Dataset Request Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#dataset-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "DatasetRequestMessage",
+            "description": "The type of the message."
+        },
+        "dataset": {
+            "type": "string",
+            "description": "The identifier of the dataset."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "dataset"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/EndpointProperty.json

@@ -0,0 +1,27 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/EndpointProperty",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
+    "type": "object",
+    "properties": {
+        "@type": {
+            "type": "string",
+            "const": "EndpointProperty",
+            "description": "LD Type."
+        },
+        "name": {
+            "type": "string",
+            "description": "Property name."
+        },
+        "value": {
+            "type": "string",
+            "description": "Property value."
+        }
+    },
+    "required": [
+        "@type",
+        "name",
+        "value"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferCompletionMessage.json

@@ -0,0 +1,74 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferCompletionMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferCompletionMessage",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferError.json

@@ -0,0 +1,83 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferError",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferError",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "code": {
+            "type": "string",
+            "description": "The error code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The error reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferProcess.json

@@ -0,0 +1,109 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferProcess",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferProcess",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "state": {
+            "type": "object",
+            "properties": {
+                "COMPLETED": {
+                    "type": "string",
+                    "const": "COMPLETED"
+                },
+                "REQUESTED": {
+                    "type": "string",
+                    "const": "REQUESTED"
+                },
+                "STARTED": {
+                    "type": "string",
+                    "const": "STARTED"
+                },
+                "SUSPENDED": {
+                    "type": "string",
+                    "const": "SUSPENDED"
+                },
+                "TERMINATED": {
+                    "type": "string",
+                    "const": "TERMINATED"
+                }
+            },
+            "required": [
+                "COMPLETED",
+                "REQUESTED",
+                "STARTED",
+                "SUSPENDED",
+                "TERMINATED"
+            ],
+            "additionalProperties": false,
+            "description": "The transfer process state."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid",
+        "state"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferRequestMessage.json

@@ -0,0 +1,88 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferRequestMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferRequestMessage",
+            "description": "LD Type"
+        },
+        "agreementId": {
+            "type": "string",
+            "description": "MUST refer to an existing Agreement between the Consumer and Provider."
+        },
+        "callbackAddress": {
+            "type": "string",
+            "description": "MUST be a URI indicating where messages to the Consumer SHOULD be sent."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "format": {
+            "type": "string",
+            "description": "The format property is a format specified by a Distribution for the Dataset associated with the Agreement. This is generally obtained from the Provider's Catalog."
+        },
+        "dataAddress": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
+            "description": "If defined MUST contain a transport-specific set of properties for pushing the data. It MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "agreementId",
+        "callbackAddress",
+        "consumerPid",
+        "format"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/TransferStartMessage.json

@@ -0,0 +1,78 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/TransferStartMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.json"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.json"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferStartMessage",
+            "description": "LD Type"
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Consumer side."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "MUST refer to the transfer identifier of the Provider side."
+        },
+        "dataAddress": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataAddress",
+            "description": "MUST be provided if the current transfer is a pull transfer and contains a transport-specific endpoint address for obtaining the data."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}