@twin.org/standards-w3c-odrl 0.0.2-next.9 → 0.0.3-next.10

package/dist/es/schemas/OdrlDuty.json

@@ -0,0 +1,217 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlDuty",
+    "description": "Interface for Duty Rules. A Duty is the obligation to exercise an action, with all refinements satisfied. A Duty is fulfilled if all constraints are satisfied and if its action has been exercised. https://www.w3.org/TR/odrl-model/#duty",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "uid": {
+            "type": "string",
+            "description": "Optional unique identifier for the rule."
+        },
+        "action": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
+                },
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
+                            },
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                            }
+                        ]
+                    }
+                }
+            ],
+            "description": "The action associated with the rule."
+        },
+        "target": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                            }
+                        ]
+                    }
+                }
+            ],
+            "description": "The target asset for the rule."
+        },
+        "assigner": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                }
+            ],
+            "description": "The assigner of the rule."
+        },
+        "assignee": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                }
+            ],
+            "description": "The assignee of the rule."
+        },
+        "constraint": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConstraint"
+            },
+            "description": "Constraints applied to the rule."
+        },
+        "summary": {
+            "type": "string",
+            "description": "Additional relation sub-properties as defined in ODRL profiles. For example, 'summary' in profile \"http://example.com/odrl:profile:03\" indicates where the output should be stored."
+        },
+        "attributedParty": {
+            "type": "string",
+            "description": "The party to be attributed Used when the duty involves attribution"
+        },
+        "trackingParty": {
+            "type": "string",
+            "description": "The party performing the tracking Used when the duty involves tracking"
+        },
+        "consequence": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+            },
+            "description": "The consequences if the duty is not fulfilled. Only applicable when the Duty is referenced by a Rule with duty or obligation properties."
+        },
+        "remedy": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+            },
+            "description": "The remedies that may be fulfilled to cure the violation."
+        },
+        "compensatedParty": {
+            "type": "string",
+            "description": "The party to be compensated Used when the duty involves compensation"
+        }
+    },
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/OdrlLogicalConstraint.json

@@ -0,0 +1,204 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlLogicalConstraint",
+    "description": "Interface for ODRL Logical Constraints. A Logical Constraint compares two or more existing Constraints by one logical operator. If the comparison returns a logical match, then the Logical Constraint is satisfied. https://www.w3.org/TR/odrl-model/#constraint-logical",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionRoot"
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "uid": {
+            "type": "string",
+            "description": "Optional unique identifier for the logical constraint. Must be an IRI."
+        },
+        "and": {
+            "type": "object",
+            "properties": {
+                "@list": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "@id": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "@id"
+                        ],
+                        "additionalProperties": false
+                    }
+                }
+            },
+            "required": [
+                "@list"
+            ],
+            "additionalProperties": false,
+            "description": "AND operator - all constraints must be satisfied."
+        },
+        "or": {
+            "type": "object",
+            "properties": {
+                "@list": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "@id": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "@id"
+                        ],
+                        "additionalProperties": false
+                    }
+                }
+            },
+            "required": [
+                "@list"
+            ],
+            "additionalProperties": false,
+            "description": "OR operator - at least one constraint must be satisfied."
+        },
+        "xone": {
+            "type": "object",
+            "properties": {
+                "@list": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "@id": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "@id"
+                        ],
+                        "additionalProperties": false
+                    }
+                }
+            },
+            "required": [
+                "@list"
+            ],
+            "additionalProperties": false,
+            "description": "XOR operator - exactly one constraint must be satisfied."
+        },
+        "andSequence": {
+            "type": "object",
+            "properties": {
+                "@list": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "@id": {
+                                "type": "string"
+                            }
+                        },
+                        "required": [
+                            "@id"
+                        ],
+                        "additionalProperties": false
+                    }
+                }
+            },
+            "required": [
+                "@list"
+            ],
+            "additionalProperties": false,
+            "description": "AND Sequence operator - all constraints must be satisfied in order."
+        }
+    },
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}

package/dist/es/schemas/OdrlOffer.json

@@ -0,0 +1,278 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlOffer",
+    "description": "Interface representing an ODRL Offer. An Offer requires an assigner (the party making the offer). https://www.w3.org/TR/odrl-model/#policy-offer",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The ODRL JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "http://www.w3.org/ns/odrl.jsonld"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "const": "http://www.w3.org/ns/odrl.jsonld"
+                    },
+                    "minItems": 1,
+                    "maxItems": 1
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "http://www.w3.org/ns/odrl.jsonld"
+                        },
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                        },
+                        {
+                            "type": "string",
+                            "const": "http://www.w3.org/ns/odrl.jsonld"
+                        }
+                    ],
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+                    }
+                }
+            ]
+        },
+        "@id": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ]
+        },
+        "@included": {
+            "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+        },
+        "@graph": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject"
+                    }
+                }
+            ]
+        },
+        "@nest": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "$ref": "https://schema.twindev.org/json-ld/JsonLdJsonObject"
+                    }
+                }
+            ]
+        },
+        "@type": {
+            "type": "string",
+            "const": "Offer",
+            "description": "The type must be \"Offer\"."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "uid": {
+            "type": "string",
+            "description": "The unique identifier for the policy. Must be an IRI."
+        },
+        "profile": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            ],
+            "description": "The profile(s) this policy conforms to. IRIs identifying the ODRL Profile(s)."
+        },
+        "assigner": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                }
+            ],
+            "description": "The assigner of the offer. Required for Offer policies."
+        },
+        "assignee": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                }
+            ],
+            "description": "The assignee of the policy. Applies to all rules unless overridden at rule level."
+        },
+        "target": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "type": "string"
+                            },
+                            {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAsset"
+                            }
+                        ]
+                    }
+                }
+            ],
+            "description": "The target asset for the rule."
+        },
+        "action": {
+            "anyOf": [
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
+                },
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAction"
+                },
+                {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "https://schema.twindev.org/w3c-odrl/ActionType"
+                            },
+                            {
+                                "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. 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": {
+            "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": {
+            "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": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlDuty"
+            },
+            "description": "The obligations in the policy. At least one of permission, prohibition, or obligation must be present."
+        }
+    },
+    "required": [
+        "@context",
+        "@type",
+        "assigner",
+        "uid"
+    ],
+    "additionalProperties": {
+        "anyOf": [
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdNodePrimitive"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdLanguageMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIndexMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIncludedBlock"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdIdMap"
+            },
+            {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdTypeMap"
+            },
+            {
+                "type": "array"
+            }
+        ]
+    }
+}