coreason-manifest 0.9.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

coreason_manifest/__init__.py

@@ -1,17 +1,51 @@
-from .definitions.agent import AgentDefinition
-from .definitions.audit import AuditLog
-from .definitions.simulation import SimulationScenario, SimulationStep, SimulationTrace
-from .definitions.topology import Edge, Node, Topology
-from .recipes import RecipeManifest
+# Copyright (c) 2025 CoReason, Inc.
+#
+# This software is proprietary and dual-licensed.
+# Licensed under the Prosperity Public License 3.0 (the "License").
+# A copy of the license is available at https://prosperitylicense.com/versions/3.0.0
+# For details, see the LICENSE file.
+# Commercial use beyond a 30-day trial requires a separate license.
+#
+# Source Code: https://github.com/CoReason-AI/coreason-manifest
+
+from .v2.io import dump_to_yaml, load_from_yaml
+from .v2.spec.contracts import InterfaceDefinition, PolicyDefinition, StateDefinition
+from .v2.spec.definitions import (
+    AgentDefinition,
+    AgentStep,
+    CouncilStep,
+    LogicStep,
+    ManifestMetadata,
+    ManifestV2,
+    Step,
+    SwitchStep,
+    ToolDefinition,
+    Workflow,
+)
+
+__version__ = "0.12.0"
+
+Manifest = ManifestV2
+Recipe = ManifestV2
+load = load_from_yaml
+dump = dump_to_yaml
 
 __all__ = [
+    "Manifest",
+    "Recipe",
+    "load",
+    "dump",
+    "__version__",
+    "ManifestMetadata",
+    "AgentStep",
+    "Workflow",
     "AgentDefinition",
-    "Topology",
-    "Node",
-    "Edge",
-    "SimulationScenario",
-    "SimulationTrace",
-    "SimulationStep",
-    "AuditLog",
-    "RecipeManifest",
+    "ToolDefinition",
+    "Step",
+    "LogicStep",
+    "SwitchStep",
+    "CouncilStep",
+    "InterfaceDefinition",
+    "StateDefinition",
+    "PolicyDefinition",
 ]

coreason_manifest/common.py

@@ -0,0 +1,64 @@
+# Copyright (c) 2025 CoReason, Inc.
+#
+# This software is proprietary and dual-licensed.
+# Licensed under the Prosperity Public License 3.0 (the "License").
+# A copy of the license is available at https://prosperitylicense.com/versions/3.0.0
+# For details, see the LICENSE file.
+# Commercial use beyond a 30-day trial requires a separate license.
+#
+# Source Code: https://github.com/CoReason-AI/coreason-manifest
+
+from enum import Enum
+from typing import Any, Dict
+
+from pydantic import AnyUrl, BaseModel, ConfigDict, PlainSerializer
+from typing_extensions import Annotated
+
+
+class CoReasonBaseModel(BaseModel):
+    """Base model for all CoReason Pydantic models with enhanced serialization.
+
+    This base class addresses JSON serialization challenges in Pydantic v2 (e.g., UUID, datetime)
+    by providing standardized methods (`dump`, `to_json`) with optimal configuration.
+
+    For a detailed rationale, see `docs/coreason_base_model_rationale.md`.
+    """
+
+    model_config = ConfigDict(populate_by_name=True)
+
+    def dump(self, **kwargs: Any) -> Dict[str, Any]:
+        """Serialize the model to a JSON-compatible dictionary.
+
+        Uses mode='json' to ensure types like UUID and datetime are serialized to strings.
+        Defaults to by_alias=True and exclude_none=True.
+        """
+        # Set defaults but allow overrides
+        kwargs.setdefault("mode", "json")
+        kwargs.setdefault("by_alias", True)
+        kwargs.setdefault("exclude_none", True)
+        return self.model_dump(**kwargs)
+
+    def to_json(self, **kwargs: Any) -> str:
+        """Serialize the model to a JSON string.
+
+        Defaults to by_alias=True and exclude_none=True.
+        """
+        # Set defaults but allow overrides
+        kwargs.setdefault("by_alias", True)
+        kwargs.setdefault("exclude_none", True)
+        return self.model_dump_json(**kwargs)
+
+
+# Strict URI type that serializes to string
+StrictUri = Annotated[
+    AnyUrl,
+    PlainSerializer(lambda x: str(x), return_type=str),
+]
+
+
+class ToolRiskLevel(str, Enum):
+    """Risk level for the tool."""
+
+    SAFE = "safe"
+    STANDARD = "standard"
+    CRITICAL = "critical"

coreason_manifest/governance.py

@@ -0,0 +1,83 @@
+# Copyright (c) 2025 CoReason, Inc.
+#
+# This software is proprietary and dual-licensed.
+# Licensed under the Prosperity Public License 3.0 (the "License").
+# A copy of the license is available at https://prosperitylicense.com/versions/3.0.0
+# For details, see the LICENSE file.
+# Commercial use beyond a 30-day trial requires a separate license.
+#
+# Source Code: https://github.com/CoReason-AI/coreason-manifest
+
+"""Governance and Policy Enforcement module for Coreason Agents.
+
+This module provides tools to validate an AgentDefinition against a set of organizational rules.
+"""
+
+from typing import List, Optional
+
+from pydantic import ConfigDict, Field
+
+from coreason_manifest.common import CoReasonBaseModel, ToolRiskLevel
+
+
+class GovernanceConfig(CoReasonBaseModel):
+    """Configuration for governance rules.
+
+    Attributes:
+        allowed_domains: List of allowed domains for tool URIs.
+        max_risk_level: Maximum allowed risk level for tools.
+        require_auth_for_critical_tools: Whether authentication is required for agents using CRITICAL tools.
+        allow_inline_tools: Whether to allow inline tool definitions (which lack risk scoring).
+        allow_custom_logic: Whether to allow LogicNodes and conditional Edges with custom code.
+        strict_url_validation: Enforce strict, normalized URL validation.
+    """
+
+    model_config = ConfigDict(extra="forbid", frozen=True)
+
+    allowed_domains: Optional[List[str]] = Field(
+        None, description="If provided, all Tool URIs must match one of these domains."
+    )
+    max_risk_level: Optional[ToolRiskLevel] = Field(
+        None, description="If provided, no tool can exceed this risk level."
+    )
+    require_auth_for_critical_tools: bool = Field(
+        True,
+        description="If an agent uses a CRITICAL tool, agent.metadata.requires_auth must be True.",
+    )
+    allow_inline_tools: bool = Field(
+        True, description="Whether to allow inline tool definitions (which lack risk scoring)."
+    )
+    allow_custom_logic: bool = Field(
+        False, description="Whether to allow LogicNodes and conditional Edges with custom code."
+    )
+    strict_url_validation: bool = Field(True, description="Enforce strict, normalized URL validation.")
+
+
+class ComplianceViolation(CoReasonBaseModel):
+    """Details of a compliance violation.
+
+    Attributes:
+        rule: Name of the rule broken.
+        message: Human readable details.
+        component_id: Name of the tool or component causing the issue.
+    """
+
+    model_config = ConfigDict(extra="forbid", frozen=True)
+
+    rule: str = Field(..., description="Name of the rule broken, e.g., 'domain_restriction'.")
+    message: str = Field(..., description="Human readable details.")
+    component_id: Optional[str] = Field(None, description="Name of the tool or component causing the issue.")
+
+
+class ComplianceReport(CoReasonBaseModel):
+    """Report of compliance checks.
+
+    Attributes:
+        passed: Whether the agent passed all checks.
+        violations: List of violations found.
+    """
+
+    model_config = ConfigDict(extra="forbid", frozen=True)
+
+    passed: bool = Field(..., description="Whether the agent passed all checks.")
+    violations: List[ComplianceViolation] = Field(default_factory=list, description="List of violations found.")

coreason_manifest/schemas/__init__.py

@@ -1 +1,9 @@
-# Prosperity-3.0
+# Copyright (c) 2025 CoReason, Inc.
+#
+# This software is proprietary and dual-licensed.
+# Licensed under the Prosperity Public License 3.0 (the "License").
+# A copy of the license is available at https://prosperitylicense.com/versions/3.0.0
+# For details, see the LICENSE file.
+# Commercial use beyond a 30-day trial requires a separate license.
+#
+# Source Code: https://github.com/CoReason-AI/coreason-manifest

coreason_manifest/schemas/coreason-v2.schema.json

@@ -0,0 +1,462 @@
+{
+  "$defs": {
+    "AgentStep": {
+      "additionalProperties": false,
+      "description": "A step that executes an AI Agent.",
+      "properties": {
+        "id": {
+          "description": "Unique identifier for the step.",
+          "title": "Id",
+          "type": "string"
+        },
+        "inputs": {
+          "additionalProperties": true,
+          "description": "Input arguments for the step.",
+          "title": "Inputs",
+          "type": "object"
+        },
+        "x-design": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DesignMetadata"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "UI metadata."
+        },
+        "type": {
+          "const": "agent",
+          "default": "agent",
+          "title": "Type",
+          "type": "string"
+        },
+        "agent": {
+          "description": "Reference to an Agent definition (by ID or name).",
+          "title": "Agent",
+          "type": "string"
+        },
+        "next": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "ID of the next step to execute.",
+          "title": "Next"
+        },
+        "system_prompt": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Optional override for system prompt.",
+          "title": "System Prompt"
+        }
+      },
+      "required": [
+        "id",
+        "agent"
+      ],
+      "title": "AgentStep",
+      "type": "object"
+    },
+    "CouncilStep": {
+      "additionalProperties": false,
+      "description": "A step that involves multiple voters/agents.",
+      "properties": {
+        "id": {
+          "description": "Unique identifier for the step.",
+          "title": "Id",
+          "type": "string"
+        },
+        "inputs": {
+          "additionalProperties": true,
+          "description": "Input arguments for the step.",
+          "title": "Inputs",
+          "type": "object"
+        },
+        "x-design": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DesignMetadata"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "UI metadata."
+        },
+        "type": {
+          "const": "council",
+          "default": "council",
+          "title": "Type",
+          "type": "string"
+        },
+        "voters": {
+          "description": "List of voters (Agent IDs).",
+          "items": {
+            "type": "string"
+          },
+          "title": "Voters",
+          "type": "array"
+        },
+        "strategy": {
+          "default": "consensus",
+          "description": "Voting strategy (e.g., consensus, majority).",
+          "title": "Strategy",
+          "type": "string"
+        },
+        "next": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "ID of the next step to execute.",
+          "title": "Next"
+        }
+      },
+      "required": [
+        "id",
+        "voters"
+      ],
+      "title": "CouncilStep",
+      "type": "object"
+    },
+    "DesignMetadata": {
+      "additionalProperties": false,
+      "description": "UI-specific metadata for the visual builder.",
+      "properties": {
+        "x": {
+          "description": "X coordinate on the canvas.",
+          "title": "X",
+          "type": "number"
+        },
+        "y": {
+          "description": "Y coordinate on the canvas.",
+          "title": "Y",
+          "type": "number"
+        },
+        "icon": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Icon name or URL.",
+          "title": "Icon"
+        },
+        "color": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Color code (hex/name).",
+          "title": "Color"
+        },
+        "label": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Display label.",
+          "title": "Label"
+        },
+        "zoom": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Zoom level.",
+          "title": "Zoom"
+        },
+        "collapsed": {
+          "default": false,
+          "description": "Whether the node is collapsed in UI.",
+          "title": "Collapsed",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "x",
+        "y"
+      ],
+      "title": "DesignMetadata",
+      "type": "object"
+    },
+    "LogicStep": {
+      "additionalProperties": false,
+      "description": "A step that executes custom logic.",
+      "properties": {
+        "id": {
+          "description": "Unique identifier for the step.",
+          "title": "Id",
+          "type": "string"
+        },
+        "inputs": {
+          "additionalProperties": true,
+          "description": "Input arguments for the step.",
+          "title": "Inputs",
+          "type": "object"
+        },
+        "x-design": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DesignMetadata"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "UI metadata."
+        },
+        "type": {
+          "const": "logic",
+          "default": "logic",
+          "title": "Type",
+          "type": "string"
+        },
+        "code": {
+          "description": "Python code or reference to logic to execute.",
+          "title": "Code",
+          "type": "string"
+        },
+        "next": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "ID of the next step to execute.",
+          "title": "Next"
+        }
+      },
+      "required": [
+        "id",
+        "code"
+      ],
+      "title": "LogicStep",
+      "type": "object"
+    },
+    "ManifestMetadata": {
+      "additionalProperties": true,
+      "description": "Metadata for the manifest.",
+      "properties": {
+        "name": {
+          "description": "Human-readable name of the workflow/agent.",
+          "title": "Name",
+          "type": "string"
+        },
+        "x-design": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DesignMetadata"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "UI metadata."
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "title": "ManifestMetadata",
+      "type": "object"
+    },
+    "SwitchStep": {
+      "additionalProperties": false,
+      "description": "A step that routes execution based on conditions.",
+      "properties": {
+        "id": {
+          "description": "Unique identifier for the step.",
+          "title": "Id",
+          "type": "string"
+        },
+        "inputs": {
+          "additionalProperties": true,
+          "description": "Input arguments for the step.",
+          "title": "Inputs",
+          "type": "object"
+        },
+        "x-design": {
+          "anyOf": [
+            {
+              "$ref": "#/$defs/DesignMetadata"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "UI metadata."
+        },
+        "type": {
+          "const": "switch",
+          "default": "switch",
+          "title": "Type",
+          "type": "string"
+        },
+        "cases": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Dictionary of condition expressions to Step IDs.",
+          "title": "Cases",
+          "type": "object"
+        },
+        "default": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Default Step ID if no cases match.",
+          "title": "Default"
+        }
+      },
+      "required": [
+        "id",
+        "cases"
+      ],
+      "title": "SwitchStep",
+      "type": "object"
+    },
+    "Workflow": {
+      "additionalProperties": false,
+      "description": "Defines the execution topology.",
+      "properties": {
+        "start": {
+          "description": "ID of the starting step.",
+          "title": "Start",
+          "type": "string"
+        },
+        "steps": {
+          "additionalProperties": {
+            "description": "Polymorphic step definition.",
+            "discriminator": {
+              "mapping": {
+                "agent": "#/$defs/AgentStep",
+                "council": "#/$defs/CouncilStep",
+                "logic": "#/$defs/LogicStep",
+                "switch": "#/$defs/SwitchStep"
+              },
+              "propertyName": "type"
+            },
+            "oneOf": [
+              {
+                "$ref": "#/$defs/AgentStep"
+              },
+              {
+                "$ref": "#/$defs/LogicStep"
+              },
+              {
+                "$ref": "#/$defs/CouncilStep"
+              },
+              {
+                "$ref": "#/$defs/SwitchStep"
+              }
+            ]
+          },
+          "description": "Dictionary of all steps indexed by ID.",
+          "title": "Steps",
+          "type": "object"
+        }
+      },
+      "required": [
+        "start",
+        "steps"
+      ],
+      "title": "Workflow",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "Root object for Coreason Manifest V2.",
+  "properties": {
+    "apiVersion": {
+      "const": "coreason.ai/v2",
+      "default": "coreason.ai/v2",
+      "description": "API Version.",
+      "title": "Apiversion",
+      "type": "string"
+    },
+    "kind": {
+      "description": "Kind of the object.",
+      "enum": [
+        "Recipe",
+        "Agent"
+      ],
+      "title": "Kind",
+      "type": "string"
+    },
+    "metadata": {
+      "$ref": "#/$defs/ManifestMetadata",
+      "description": "Metadata including name and design info."
+    },
+    "definitions": {
+      "additionalProperties": true,
+      "description": "Reusable definitions.",
+      "title": "Definitions",
+      "type": "object"
+    },
+    "workflow": {
+      "$ref": "#/$defs/Workflow",
+      "description": "The main workflow topology."
+    }
+  },
+  "required": [
+    "kind",
+    "metadata",
+    "workflow"
+  ],
+  "title": "ManifestV2",
+  "type": "object"
+}

coreason_manifest/utils/__init__.py

@@ -1,3 +1,13 @@
+# Copyright (c) 2025 CoReason, Inc.
+#
+# This software is proprietary and dual-licensed.
+# Licensed under the Prosperity Public License 3.0 (the "License").
+# A copy of the license is available at https://prosperitylicense.com/versions/3.0.0
+# For details, see the LICENSE file.
+# Commercial use beyond a 30-day trial requires a separate license.
+#
+# Source Code: https://github.com/CoReason-AI/coreason-manifest
+
 # Copyright (c) 2025 CoReason, Inc.
 #
 # This software is proprietary and dual-licensed.