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

package/dist/es/schemas/DataspaceProtocolEndpointProperty.json

@@ -0,0 +1,27 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolEndpointProperty",
+    "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/DataspaceProtocolTransferCompletionMessage.json

@@ -0,0 +1,78 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferCompletionMessage",
+    "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 JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "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/DataspaceProtocolTransferError.json

@@ -0,0 +1,87 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError",
+    "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 JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "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/DataspaceProtocolTransferProcess.json

@@ -0,0 +1,83 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess",
+    "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 JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "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": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcessStateType",
+            "description": "The transfer process state."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid",
+        "state"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json

@@ -0,0 +1,92 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferRequestMessage",
+    "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 JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "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/DataspaceProtocolDataAddress",
+            "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/DataspaceProtocolTransferStartMessage.json

@@ -0,0 +1,82 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage",
+    "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 JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "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/DataspaceProtocolDataAddress",
+            "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
+}

package/dist/es/schemas/DataspaceProtocolTransferSuspensionMessage.json

@@ -0,0 +1,87 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferSuspensionMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-suspension-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferSuspensionMessage",
+            "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 suspension code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The suspension reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas/DataspaceProtocolTransferTerminationMessage.json

@@ -0,0 +1,87 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferTerminationMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-termination-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The Dataspace Protocol JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://w3id.org/dspace/2025/1/context.jsonld"
+                        },
+                        {
+                            "$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.jsonld"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "TransferTerminationMessage",
+            "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 termination code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The termination reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ],
+    "additionalProperties": false
+}

package/dist/es/schemas-src/DataspaceProtocolDataService.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DsProtocolDataService",
+    "description": "DataService compliant with Eclipse Data Space Protocol. Validates only DS Protocol-specific requirements while allowing all optional DCAT properties.",
+    "title": "DataspaceProtocolDataService",
+    "allOf": [
+        {
+            "$ref": "https://w3id.org/dspace/2025/1/catalog/dataset-schema.json#/definitions/DataService"
+        }
+    ]
+}

package/dist/es/schemas-src/DataspaceProtocolDistribution.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DsProtocolDistribution",
+    "description": "Distribution compliant with Eclipse Data Space Protocol. Validates only DS Protocol-specific requirements while allowing all optional DCAT properties.",
+    "title": "DataspaceProtocolDistribution",
+    "allOf": [
+        {
+            "$ref": "https://w3id.org/dspace/2025/1/catalog/dataset-schema.json#/definitions/Distribution"
+        }
+    ]
+}