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

package/dist/es/schemas/OdrlAgreement.json

@@ -0,0 +1,270 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlAgreement",
+    "description": "Interface representing an ODRL Agreement. An Agreement requires both an assigner and assignee (both agreeing parties). https://www.w3.org/TR/odrl-model/#policy-agreement",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "description": "The ODRL JSON-LD context type.",
+            "anyOf": [
+                {
+                    "type": "string",
+                    "const": "https://www.w3.org/ns/odrl/2/"
+                },
+                {
+                    "type": "array",
+                    "minItems": 2,
+                    "prefixItems": [
+                        {
+                            "type": "string",
+                            "const": "https://www.w3.org/ns/odrl/2/"
+                        },
+                        {
+                            "$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": "https://www.w3.org/ns/odrl/2/"
+                        }
+                    ],
+                    "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": "Agreement",
+            "description": "The type must be \"Agreement\"."
+        },
+        "@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 agreement. Required for Agreement policies."
+        },
+        "assignee": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlParty"
+                }
+            ],
+            "description": "The assignee of the agreement. Required for Agreement policies."
+        },
+        "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",
+        "assignee",
+        "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"
+            }
+        ]
+    }
+}

package/dist/es/schemas/OdrlAsset.json

@@ -0,0 +1,110 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlAsset",
+    "description": "Interface for ODRL Assets. https://www.w3.org/TR/odrl-model/#asset",
+    "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": {
+            "type": "string",
+            "description": "The type of the asset. Can be used to specify additional type information."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "uid": {
+            "type": "string",
+            "description": "The unique identifier for the asset. Should be an IRI."
+        },
+        "partOf": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                }
+            ],
+            "description": "Reference to the asset collection this asset is part of. Used to identify an AssetCollection that this Asset is a member of."
+        },
+        "hasPolicy": {
+            "type": "string",
+            "description": "Reference to the policy that governs this asset. Used to identify the Policy that governs this Asset."
+        }
+    },
+    "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/OdrlAssetCollection.json

@@ -0,0 +1,124 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection",
+    "description": "Interface for ODRL Asset Collections. An AssetCollection is a single resource representing a set of member resources, where all members of the set will be the subject of the Rule. https://www.w3.org/TR/odrl-model/#asset",
+    "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": {
+            "type": "string",
+            "description": "The type of the asset. Can be used to specify additional type information."
+        },
+        "@reverse": {
+            "type": "object",
+            "additionalProperties": {
+                "type": "string"
+            }
+        },
+        "@index": {
+            "type": "string"
+        },
+        "uid": {
+            "type": "string",
+            "description": "The unique identifier for the asset. Should be an IRI."
+        },
+        "partOf": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/OdrlAssetCollection"
+                }
+            ],
+            "description": "Reference to the asset collection this asset is part of. Used to identify an AssetCollection that this Asset is a member of."
+        },
+        "hasPolicy": {
+            "type": "string",
+            "description": "Reference to the policy that governs this asset. Used to identify the Policy that governs this Asset."
+        },
+        "source": {
+            "type": "string",
+            "description": "Reference to the source of the asset collection. Must be an IRI that references the AssetCollection."
+        },
+        "refinement": {
+            "type": "array",
+            "items": {
+                "$ref": "https://schema.twindev.org/w3c-odrl/OdrlConstraint"
+            },
+            "description": "Refinements applied to the asset collection. Used to specify the refinement context under which to identify individual Asset(s) of the complete collection. The refinement applies to the characteristics of each member of the collection (not the resource as a whole)."
+        }
+    },
+    "required": [
+        "source"
+    ],
+    "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/OdrlConstraint.json

@@ -0,0 +1,174 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/w3c-odrl/OdrlConstraint",
+    "description": "Interface for ODRL Constraints. https://www.w3.org/TR/odrl-model/#constraint",
+    "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 constraint."
+        },
+        "leftOperand": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "$ref": "https://schema.twindev.org/w3c-odrl/LeftOperandType"
+                }
+            ],
+            "description": "The left operand of the constraint."
+        },
+        "operator": {
+            "$ref": "https://schema.twindev.org/w3c-odrl/OperatorType",
+            "description": "The operator of the constraint."
+        },
+        "rightOperand": {
+            "anyOf": [
+                {
+                    "type": "string"
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "@value": {
+                            "type": "string"
+                        },
+                        "@type": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "@value"
+                    ],
+                    "additionalProperties": false
+                },
+                {
+                    "type": "object",
+                    "properties": {
+                        "@id": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "@id"
+                    ],
+                    "additionalProperties": false
+                }
+            ],
+            "description": "The right operand of the constraint. value with optional"
+        },
+        "rightOperandReference": {
+            "type": "string",
+            "description": "Reference to the right operand."
+        },
+        "dataType": {
+            "type": "string",
+            "description": "The data type of the right operand."
+        },
+        "unit": {
+            "type": "string",
+            "description": "The unit for the right operand value."
+        },
+        "status": {
+            "$ref": "https://schema.twindev.org/w3c-odrl/StatusType",
+            "description": "The status value for comparison."
+        }
+    },
+    "required": [
+        "leftOperand",
+        "operator"
+    ],
+    "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"
+            }
+        ]
+    }
+}