@twin.org/standards-dataspace-protocol 0.0.3-next.53 → 0.0.3-next.55

package/dist/es/schemas/DataspaceProtocolAgreement.json

@@ -1,184 +1,207 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolAgreement",
+    "title": "DataspaceProtocolAgreement",
     "description": "Agreement interface compliant with Eclipse Data Space Protocol.\n\nExtends IOdrlAgreement with DS Protocol-specific constraints:\n- `@id` is REQUIRED (used as the primary agreement identifier in DS Protocol)\n- `@context` is omitted (inherited from the parent Dataset/Distribution)",
     "type": "object",
     "properties": {
-        "@type": {
+        "@id": {
             "type": "string",
-            "const": "Agreement",
-            "description": "The type must be \"Agreement\"."
-        },
-        "assigner": {
-            "anyOf": [
-                {
-                    "type": "string"
-                },
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-                }
-            ],
-            "description": "The assigner of the agreement. Required for Agreement policies."
-        },
-        "assignee": {
-            "anyOf": [
-                {
-                    "type": "string"
+            "description": "Unique identifier for the agreement."
+        }
+    },
+    "required": [
+        "@id"
+    ],
+    "allOf": [
+        {
+            "description": "Interface representing an ODRL Agreement.\nAn Agreement requires both an assigner and assignee (both agreeing parties).\nhttps://www.w3.org/TR/odrl-model/#policy-agreement",
+            "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"
                 },
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
-                }
-            ],
-            "description": "The assignee of the agreement. Required for Agreement policies."
-        },
-        "@context": {
-            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType",
-            "description": "The context for the policy. Must include \"https://www.w3.org/ns/odrl.jsonld\""
-        },
-        "profile": {
-            "anyOf": [
-                {
-                    "type": "string"
+                "@type": {
+                    "const": "Agreement",
+                    "description": "The type must be \"Agreement\".",
+                    "$comment": "Inherited from OdrlAgreement"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            ],
-            "description": "The profile(s) this policy conforms to. IRIs identifying the ODRL Profile(s)."
-        },
-        "target": {
-            "anyOf": [
-                {
-                    "type": "string"
+                "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"
                 },
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                "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"
                 },
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                "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"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "anyOf": [
-                            {
-                                "type": "string"
-                            },
-                            {
-                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
-                            },
-                            {
-                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                "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/ActionType"
-                },
-                {
-                    "type": "string"
+                        }
+                    ],
+                    "description": "The target asset for the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
                 },
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                "action": {
+                    "anyOf": [
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/ActionTypeActionType"
+                        },
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "anyOf": [
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/ActionTypeActionType"
+                                    },
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                                    }
+                                ]
+                            }
+                        }
+                    ],
+                    "description": "The action associated with the rule.",
+                    "$comment": "Inherited from OdrlPolicy"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "anyOf": [
-                            {
-                                "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
-                            },
-                            {
+                "inheritFrom": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
                                 "type": "string"
-                            },
-                            {
-                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
                             }
-                        ]
-                    }
-                }
-            ],
-            "description": "The action associated with the rule."
-        },
-        "inheritFrom": {
-            "anyOf": [
-                {
-                    "type": "string"
+                        }
+                    ],
+                    "description": "The parent policy(ies) this policy inherits from.\nIRIs identifying the parent Policy(ies).",
+                    "$comment": "Inherited from OdrlPolicy"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                }
-            ],
-            "description": "The parent policy(ies) this policy inherits from. IRIs identifying the parent Policy(ies)."
-        },
-        "conflict": {
-            "$ref": "https://schema.twindev.org/w3c-odrl/ConflictStrategyType",
-            "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"
+                "conflict": {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/ConflictStrategyTypeConflictStrategyType",
+                    "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"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlPermission"
-                    }
-                }
-            ],
-            "description": "The permissions in the policy. At least one of permission, prohibition, or obligation must be present."
-        },
-        "prohibition": {
-            "anyOf": [
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
+                "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"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlProhibition"
-                    }
-                }
-            ],
-            "description": "The prohibitions in the policy. At least one of permission, prohibition, or obligation must be present."
-        },
-        "obligation": {
-            "anyOf": [
-                {
-                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+                "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"
                 },
-                {
-                    "type": "array",
-                    "items": {
-                        "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
-                    }
+                "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",
+                "assigner",
+                "assignee"
             ],
-            "description": "The obligations in the policy. At least one of permission, prohibition, or obligation must be present."
-        },
-        "@id": {
-            "type": "string",
-            "description": "Unique identifier for the agreement."
+            "$comment": "Inlined utility base type OdrlAgreement so utility transformations can operate on concrete properties instead of a $ref."
         }
-    },
-    "required": [
-        "@context",
-        "@id",
-        "@type",
-        "assignee",
-        "assigner"
     ]
 }

package/dist/es/schemas/DataspaceProtocolCatalog.json

@@ -1,11 +1,21 @@
 {
-    "$schema": "https://json-schema.org/draft/2019-09/schema",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
     "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalog",
-    "description": "Catalog compliant with Eclipse Data Space Protocol. Validates only DS Protocol-specific requirements while allowing all optional DCAT properties.",
     "title": "DataspaceProtocolCatalog",
+    "description": "Catalog interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends ICatalog 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- participantId 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://w3id.org/dspace/2025/1/catalog/catalog-schema.json"
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolCatalogBase"
         }
     ]
 }