@twin.org/standards-dataspace-protocol 0.0.3-next.6 → 0.0.3-next.60

package/dist/es/schemas/DataspaceProtocolPolicy.json

@@ -0,0 +1,231 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolPolicy",
+    "title": "DataspaceProtocolPolicy",
+    "description": "Policy interface compliant with Eclipse Data Space Protocol.\n\nExtends IOdrlPolicy with DS Protocol-specific constraints:\n- `@id` is REQUIRED (used as the primary policy identifier in DS Protocol)\n- `@context` is omitted (inherited from the parent Dataset/Distribution)",
+    "type": "object",
+    "properties": {
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the policy."
+        }
+    },
+    "required": [
+        "@id"
+    ],
+    "allOf": [
+        {
+            "description": "Interface representing an ODRL Policy.\nhttps://www.w3.org/TR/odrl-model/#policy",
+            "type": "object",
+            "properties": {
+                "@context": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType",
+                    "description": "The context for the policy.\nMust include \"https://www.w3.org/ns/odrl.jsonld\""
+                },
+                "@type": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPolicyType",
+                    "description": "The type of policy.\nMust be one of: \"Set\", \"Offer\", \"Agreement\""
+                },
+                "profile": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s)."
+                },
+                "assigner": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level."
+                },
+                "assignee": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level."
+                },
+                "target": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The target asset for the rule."
+                },
+                "action": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                                    },
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The action associated with the rule."
+                },
+                "inheritFrom": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies)."
+                },
+                "conflict": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType",
+                    "description": "The conflict resolution strategy.\n- perm: Permissions override Prohibitions\n- prohibit: Prohibitions override Permissions\n- invalid: Policy is void if conflicts exist (default)"
+                },
+                "permission": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                            }
+                        }
+                    ],
+                    "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
+                },
+                "prohibition": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                            }
+                        }
+                    ],
+                    "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present."
+                },
+                "obligation": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                            }
+                        }
+                    ],
+                    "description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present."
+                }
+            },
+            "required": [
+                "@context",
+                "@type"
+            ],
+            "$comment": "Inlined utility base type OdrlPolicy so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolSet.json

@@ -0,0 +1,243 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolSet",
+    "title": "DataspaceProtocolSet",
+    "description": "Set interface compliant with Eclipse Data Space Protocol.\n\nExtends IOdrlSet with DS Protocol-specific constraints:\n- `@id` is REQUIRED (used as the primary set identifier in DS Protocol)\n- `@context` is omitted (inherited from the parent Dataset/Distribution)",
+    "type": "object",
+    "properties": {
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the set."
+        }
+    },
+    "required": [
+        "@id"
+    ],
+    "allOf": [
+        {
+            "description": "Interface representing an ODRL Set.\nA Set is a basic policy type with no specific party requirements.\nhttps://www.w3.org/TR/odrl-model/#policy-set",
+            "type": "object",
+            "properties": {
+                "@context": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType",
+                    "description": "The context for the policy.\nMust include \"https://www.w3.org/ns/odrl.jsonld\"",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "@type": {
+                    "const": "Set",
+                    "description": "The type must be \"Set\".",
+                    "$comment": "Inherited from OdrlSet"
+                },
+                "profile": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The profile(s) this policy conforms to.\nIRIs identifying the ODRL Profile(s).",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "assigner": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The assigner of the policy.\nApplies to all rules unless overridden at rule level.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "assignee": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPartyCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The assignee of the policy.\nApplies to all rules unless overridden at rule level.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "target": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The target asset for the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "action": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlActionType"
+                                    },
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The action associated with the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "inheritFrom": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies).",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "conflict": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConflictStrategyType",
+                    "description": "The conflict resolution strategy.\n- perm: Permissions override Prohibitions\n- prohibit: Prohibitions override Permissions\n- invalid: Policy is void if conflicts exist (default)",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "permission": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
+                            }
+                        }
+                    ],
+                    "description": "The permissions in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "prohibition": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                            }
+                        }
+                    ],
+                    "description": "The prohibitions in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                },
+                "obligation": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                            }
+                        }
+                    ],
+                    "description": "The obligations in the policy.\nAt least one of permission, prohibition, or obligation must be present.",
+                    "$comment": "Inherited from OdrlPolicy"
+                }
+            },
+            "required": [
+                "@context",
+                "@type"
+            ],
+            "$comment": "Inlined utility base type OdrlSet so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolTransferCompletionMessage.json

@@ -0,0 +1,31 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferCompletionMessage",
+    "title": "DataspaceProtocolTransferCompletionMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-completion-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context"
+        },
+        "@type": {
+            "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"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolTransferError.json

@@ -0,0 +1,40 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferError",
+    "title": "DataspaceProtocolTransferError",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol#error-transfer-error",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context"
+        },
+        "@type": {
+            "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"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolTransferProcess.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferProcess",
+    "title": "DataspaceProtocolTransferProcess",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#ack-transfer-process",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context"
+        },
+        "@type": {
+            "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"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolTransferRequestMessage.json

@@ -0,0 +1,45 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferRequestMessage",
+    "title": "DataspaceProtocolTransferRequestMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context"
+        },
+        "@type": {
+            "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.\nThis 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.\nIt MAY include an endpoint, a temporary authorization via the endpointProperties property - depending on the endpointType."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "agreementId",
+        "callbackAddress",
+        "consumerPid",
+        "format"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolTransferStartMessage.json

@@ -0,0 +1,35 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolTransferStartMessage",
+    "title": "DataspaceProtocolTransferStartMessage",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#transfer-start-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context"
+        },
+        "@type": {
+            "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\ncontains a transport-specific endpoint address for obtaining the data."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "providerPid"
+    ]
+}