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

package/dist/es/schemas/DataspaceProtocolDistribution.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDistribution",
+    "title": "DataspaceProtocolDistribution",
+    "description": "Distribution interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends IDistribution 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- `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)\n- Array MUST contain at least one IOdrlOffer\n- Each Offer MUST have `@type`: \"Offer\"\n- `format` is REQUIRED.\n\n**Type System Design:**\n- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`\n- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`\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\n\n**Future Compatibility:**\n- Currently only one Offer per dataset is supported\n- Array structure allows future support for multiple offers",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolContextType",
+            "description": "LD Context. Required per Eclipse Data Space Protocol."
+        },
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the distribution.\nREQUIRED on standalone Distribution objects per Eclipse Data Space Protocol."
+        }
+    },
+    "required": [
+        "@context",
+        "@id"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDistributionBase"
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolDistributionBase.json

@@ -0,0 +1,164 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDistributionBase",
+    "title": "DataspaceProtocolDistributionBase",
+    "description": "Distribution interface compliant with Eclipse Data Space Protocol.\n\nThis interface extends IDistribution 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- `odrl:hasPolicy` MIGHT be present as an array of ODRL Offers (OPTIONAL)\n- Array MUST contain at least one IOdrlOffer\n- Each Offer MUST have `@type`: \"Offer\"\n- `format` is REQUIRED.\n\n**Type System Design:**\n- W3C DCAT spec defines `odrl:hasPolicy` as optional singular `IOdrlPolicy`\n- DS Protocol requires it as a REQUIRED array of `IOdrlOffer`\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\n\n**Future Compatibility:**\n- Currently only one Offer per dataset is supported\n- Array structure allows future support for multiple offers",
+    "type": "object",
+    "properties": {
+        "@type": {
+            "const": "Distribution",
+            "description": "The type identifier for the Distribution.\nREQUIRED per Eclipse Data Space Protocol."
+        },
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the distribution.\nOPTIONAL for embedded distributions (may use JSON-LD blank nodes).\nREQUIRED on standalone Distribution objects per Eclipse Data Space Protocol."
+        },
+        "hasPolicy": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOfferBase"
+            },
+            "description": "Array of ODRL policies (Offers) as required by DS Protocol.\n\nREQUIRED per Eclipse Data Space Protocol spec.\nMust contain at least one IOdrlOffer.\nCurrently only single offer is supported, but array structure\nallows for future multi-offer support.",
+            "minItems": 1
+        },
+        "accessService": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolDataServiceBase"
+                }
+            ],
+            "description": "Access service.\nIt can be a URI pointing to an access service or inline the access service itself."
+        },
+        "format": {
+            "type": "string",
+            "description": "Distribution format.\nREQUIRED per Eclipse Data Space Protocol."
+        }
+    },
+    "required": [
+        "@type",
+        "accessService",
+        "format"
+    ],
+    "allOf": [
+        {
+            "description": "Base interface for DCAT Distribution without JSON-LD context.\nThis is the context-free variant of IDcatDistribution, intended for embedding\ndistribution objects inline within datasets where the context is provided by the enclosing document.",
+            "type": "object",
+            "properties": {
+                "@id": {
+                    "type": "string",
+                    "description": "The unique identifier for the distribution object."
+                },
+                "dcterms:title": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A name given to the distribution."
+                },
+                "dcterms:description": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "A free-text account of the distribution."
+                },
+                "dcterms:issued": {
+                    "type": "string",
+                    "description": "Date of formal issuance of the distribution.",
+                    "format": "date-time"
+                },
+                "dcterms:modified": {
+                    "type": "string",
+                    "description": "Most recent date on which the distribution was changed, updated or modified.",
+                    "format": "date-time"
+                },
+                "dcterms:license": {
+                    "type": "string",
+                    "description": "A legal document under which the distribution is made available."
+                },
+                "dcterms:accessRights": {
+                    "type": "string",
+                    "description": "Information about who can access the distribution."
+                },
+                "dcterms:rights": {
+                    "type": "string",
+                    "description": "Information about rights held in and over the distribution."
+                },
+                "dcat:accessURL": {
+                    "type": "string",
+                    "description": "A URL of the resource that gives access to a distribution of the dataset."
+                },
+                "dcat:accessService": {
+                    "type": "string",
+                    "description": "A data service that gives access to the distribution."
+                },
+                "dcat:downloadURL": {
+                    "type": "string",
+                    "description": "The URL of the downloadable file in a given format."
+                },
+                "dcat:byteSize": {
+                    "type": "number",
+                    "description": "The size of the distribution in bytes.",
+                    "minimum": 0
+                },
+                "dcat:spatialResolutionInMeters": {
+                    "type": "number",
+                    "description": "The minimum spatial separation resolvable in a distribution, measured in meters."
+                },
+                "dcat:temporalResolution": {
+                    "type": "string",
+                    "description": "Minimum time period resolvable in the distribution.",
+                    "format": "duration"
+                },
+                "dcterms:conformsTo": {
+                    "anyOf": [
+                        {
+                            "type": "string"
+                        },
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    ],
+                    "description": "An established standard to which the distribution conforms."
+                },
+                "dcat:mediaType": {
+                    "type": "string",
+                    "description": "The media type of the distribution as defined by IANA."
+                },
+                "dcat:compressFormat": {
+                    "type": "string",
+                    "description": "The compression format of the distribution."
+                },
+                "dcat:packageFormat": {
+                    "type": "string",
+                    "description": "The package format of the distribution."
+                },
+                "spdx:checksum": {
+                    "type": "string",
+                    "description": "The checksum property provides a mechanism to verify the data integrity."
+                }
+            },
+            "$comment": "Inlined utility base type DcatDistributionBase so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}

package/dist/es/schemas/{EndpointProperty.json → DataspaceProtocolEndpointProperty.json}

@@ -1,11 +1,11 @@
 {
     "$schema": "https://json-schema.org/draft/2020-12/schema",
-    "$id": "https://schema.twindev.org/dataspace-protocol/EndpointProperty",
-    "description": "Interface for Dataspace Protocol Transfer Messages. https://eclipse-dataspace-protocol-base.github.io/DataspaceProtocol/#lower-level-types",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolEndpointProperty",
+    "title": "DataspaceProtocolEndpointProperty",
+    "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": "EndpointProperty",
             "description": "LD Type."
         },
@@ -22,6 +22,5 @@
         "@type",
         "name",
         "value"
-    ],
-    "additionalProperties": false
+    ]
 }

package/dist/es/schemas/DataspaceProtocolOffer.json

@@ -0,0 +1,26 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOffer",
+    "title": "DataspaceProtocolOffer",
+    "description": "Offer interface compliant with Eclipse Data Space Protocol.\n\nExtends IOdrlOffer with DS Protocol-specific constraints:\n- `@id` is REQUIRED (used as the primary offer 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 offer."
+        },
+        "@context": {
+            "$ref": "https://schema.twindev.org/w3c-odrl/OdrlContextType",
+            "description": "LD Context."
+        }
+    },
+    "required": [
+        "@id",
+        "@context"
+    ],
+    "allOf": [
+        {
+            "$ref": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOfferBase"
+        }
+    ]
+}

package/dist/es/schemas/DataspaceProtocolOfferBase.json

@@ -0,0 +1,219 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/dataspace-protocol/DataspaceProtocolOfferBase",
+    "title": "DataspaceProtocolOfferBase",
+    "description": "Offer interface compliant with Eclipse Data Space Protocol without JSON-LD context.\nThis is the context-free variant of IDataspaceProtocolOffer, intended for embedding\noffers inline within other objects where the context is provided by the enclosing document.\n\nExtends IOdrlOffer with DS Protocol-specific constraints:\n- '@id' is REQUIRED (used as the primary offer identifier in DS Protocol)\n- '@context' is omitted (context is inherited from the parent object)",
+    "type": "object",
+    "properties": {
+        "@id": {
+            "type": "string",
+            "description": "Unique identifier for the offer."
+        }
+    },
+    "required": [
+        "@id"
+    ],
+    "allOf": [
+        {
+            "description": "Interface representing an ODRL Offer.\nAn Offer requires an assigner (the party making the offer).\nhttps://www.w3.org/TR/odrl-model/#policy-offer",
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "const": "Offer",
+                    "description": "The type must be \"Offer\".",
+                    "$comment": "Inherited from OdrlOffer"
+                },
+                "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 offer.\nRequired for Offer policies.",
+                    "$comment": "Inherited from OdrlOffer"
+                },
+                "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": [
+                "@type",
+                "assigner"
+            ],
+            "$comment": "Inlined utility base type OdrlOffer so utility transformations can operate on concrete properties instead of a $ref."
+        }
+    ]
+}