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

package/dist/es/schemas/DataspaceProtocolContractAgreementMessage.json

@@ -0,0 +1,225 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractAgreementMessage",
+    "title": "DataspaceProtocolContractAgreementMessage",
+    "description": "Interface for Dataspace Protocol Contract Agreement Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractAgreementMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "agreement": {
+            "description": "The agreement being sent.",
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "const": "Agreement",
+                    "description": "The type must be \"Agreement\".",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "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"
+                        }
+                    ],
+                    "description": "The assigner of the agreement.\nRequired for Agreement policies.",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "assignee": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                        }
+                    ],
+                    "description": "The assignee of the agreement.\nRequired for Agreement policies.",
+                    "$comment": "Inherited from OdrlAgreement"
+                },
+                "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"
+                },
+                "@id": {
+                    "type": "string",
+                    "description": "Unique identifier for the agreement.",
+                    "$comment": "Inherited from DataspaceProtocolAgreement"
+                }
+            },
+            "required": [
+                "@type",
+                "assigner",
+                "assignee",
+                "@id"
+            ],
+            "$comment": "Inlined utility base type DataspaceProtocolAgreement so utility transformations can operate on concrete properties instead of a $ref."
+        },
+        "callbackAddress": {
+            "type": "string",
+            "description": "The base callback address for the provider to update the consumer on the state of the negotiation."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid",
+        "agreement"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractAgreementVerificationMessage.json

@@ -0,0 +1,31 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractAgreementVerificationMessage",
+    "title": "DataspaceProtocolContractAgreementVerificationMessage",
+    "description": "Interface for Dataspace Protocol Contract Agreement Verification Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-agreement-verification-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractAgreementVerificationMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiation.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiation",
+    "title": "DataspaceProtocolContractNegotiation",
+    "description": "Interface for Dataspace Protocol Contract Agreement Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#ack-contract-negotiation",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractNegotiation",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "state": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationStateType",
+            "description": "The offer being requested."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid",
+        "state"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiationError.json

@@ -0,0 +1,40 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationError",
+    "title": "DataspaceProtocolContractNegotiationError",
+    "description": "Interface for Dataspace Protocol Contract Negotiation Error Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#error-contract-negotiation-error",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractNegotiationError",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "code": {
+            "type": "string",
+            "description": "The error code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The error reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiationEventMessage.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationEventMessage",
+    "title": "DataspaceProtocolContractNegotiationEventMessage",
+    "description": "Interface for Dataspace Protocol Contract Negotiation Event Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-event-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractNegotiationEventMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "event": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationEventType",
+            "description": "The event type."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid",
+        "event"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiationEventType.json

@@ -0,0 +1,16 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationEventType",
+    "title": "DataspaceProtocolContractNegotiationEventType",
+    "description": "The types for Dataspace Protocol Contract Negotiation Events.",
+    "oneOf": [
+        {
+            "const": "ACCEPTED",
+            "description": "Accepted."
+        },
+        {
+            "const": "FINALIZED",
+            "description": "Finalized."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiationStateType.json

@@ -0,0 +1,36 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationStateType",
+    "title": "DataspaceProtocolContractNegotiationStateType",
+    "description": "The types for Dataspace Protocol Contract Negotiation States.",
+    "oneOf": [
+        {
+            "const": "REQUESTED",
+            "description": "Requested."
+        },
+        {
+            "const": "OFFERED",
+            "description": "Offered."
+        },
+        {
+            "const": "ACCEPTED",
+            "description": "Accepted."
+        },
+        {
+            "const": "AGREED",
+            "description": "Agreed."
+        },
+        {
+            "const": "VERIFIED",
+            "description": "Verified."
+        },
+        {
+            "const": "FINALIZED",
+            "description": "Finalized."
+        },
+        {
+            "const": "TERMINATED",
+            "description": "Terminated."
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractNegotiationTerminationMessage.json

@@ -0,0 +1,40 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractNegotiationTerminationMessage",
+    "title": "DataspaceProtocolContractNegotiationTerminationMessage",
+    "description": "Interface for Dataspace Protocol Contract Negotiation Termination Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-negotiation-termination-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractNegotiationTerminationMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "code": {
+            "type": "string",
+            "description": "The termination code."
+        },
+        "reason": {
+            "type": "array",
+            "items": {},
+            "description": "The termination reason(s)."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "consumerPid"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractOfferMessage.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractOfferMessage",
+    "title": "DataspaceProtocolContractOfferMessage",
+    "description": "Interface for Dataspace Protocol Contract Offer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-offer-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractOfferMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "offer": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOfferBase",
+            "description": "The offer being requested."
+        },
+        "callbackAddress": {
+            "type": "string",
+            "description": "The base callback address for the provider to update the consumer on the state of the negotiation."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "providerPid",
+        "offer"
+    ]
+}

package/dist/es/schemas/DataspaceProtocolContractRequestMessage.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContractRequestMessage",
+    "title": "DataspaceProtocolContractRequestMessage",
+    "description": "Interface for Dataspace Protocol Contract Request Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/2025-1/#contract-request-message",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "The JSON-LD context."
+        },
+        "@type": {
+            "const": "ContractRequestMessage",
+            "description": "The type of the message."
+        },
+        "providerPid": {
+            "type": "string",
+            "description": "The provider id for the contract."
+        },
+        "consumerPid": {
+            "type": "string",
+            "description": "The consumer id for the contract."
+        },
+        "offer": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOfferBase",
+            "description": "The offer being requested."
+        },
+        "callbackAddress": {
+            "type": "string",
+            "description": "The base callback address for the provider to update the consumer on the state of the negotiation."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "consumerPid",
+        "offer"
+    ]
+}

package/dist/es/schemas/{DataAddress.json → DataspaceProtocolDataAddress.json}

@@ -1,11 +1,11 @@
 {
     "$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",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataAddress",
+    "title": "DataspaceProtocolDataAddress",
+    "description": "Interface for Dataspace Protocol Transfer Messages.\nhttps://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
     "type": "object",
     "properties": {
         "@type": {
-            "type": "string",
             "const": "DataAddress",
             "description": "LD Type"
         },
@@ -20,7 +20,7 @@
         "endpointProperties": {
             "type": "array",
             "items": {
-                "$ref": "https://schema.twindev.org/dataspace-protocol/EndpointProperty"
+                "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolEndpointProperty"
             },
             "description": "Properties associated to the endpoint which might depend on the endpoint type."
         }
@@ -28,6 +28,5 @@
     "required": [
         "@type",
         "endpointType"
-    ],
-    "additionalProperties": false
+    ]
 }

package/dist/es/schemas/DataspaceProtocolDataService.json

@@ -0,0 +1,21 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataService",
+    "title": "DataspaceProtocolDataService",
+    "description": "Data Service interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends IDataService and enforces DS Protocol-specific requirements\nby overriding properties with more specific types and constraints.\n\n**Requirements per DS Protocol:**\n- `@id` MUST be present for dataset identification (REQUIRED)\n- endpointURL MUST be present (REQUIRED)\n\n**Type System Design:**\n- Interface extension allows TypeScript to override inherited property types\n- Standards packages (@twin.org/standards-w3c-*) follow W3C specs exactly\n- DS Protocol-specific constraints are defined here",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context. Required per Eclipse Data Space Protocol."
+        }
+    },
+    "required": [
+        "@context"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataServiceBase"
+        }
+    ]
+}