File size: 17,322 Bytes
a10e62e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 | """
Custom Canvas Components API Endpoints
REST API for managing custom HTML/CSS/JS canvas components with:
- Component CRUD operations
- Version control and rollback
- Usage tracking and statistics
- Security validation and governance
Endpoints:
- POST /api/components/create - Create new component
- GET /api/components - List components (with filters)
- GET /api/components/{id} - Get component by ID
- GET /api/components/by-slug/{slug} - Get component by slug
- PUT /api/components/{id} - Update component
- DELETE /api/components/{id} - Delete component
- GET /api/components/{id}/versions - Get version history
- POST /api/components/{id}/rollback - Rollback to version
- GET /api/components/{id}/stats - Get usage statistics
"""
import logging
from typing import Any, Dict, Optional
from fastapi import Depends, Query
from pydantic import BaseModel, Field
from sqlalchemy.orm import Session
from core.base_routes import BaseAPIRouter
from core.custom_components_service import ComponentSecurityError, CustomComponentsService
from core.database import get_db
logger = logging.getLogger(__name__)
router = BaseAPIRouter(prefix="/api/components", tags=["Custom Components"])
# ============================================================================
# Request/Response Models
# ============================================================================
class CreateComponentRequest(BaseModel):
"""Request to create a custom component."""
name: str = Field(..., description="Component name")
html_content: str = Field(..., description="HTML template")
css_content: Optional[str] = Field(None, description="CSS styles")
js_content: Optional[str] = Field(None, description="JavaScript behavior (AUTONOMOUS only)")
description: Optional[str] = Field(None, description="Component description")
category: str = Field(default="custom", description="Component category")
props_schema: Optional[Dict[str, Any]] = Field(None, description="JSON schema for properties")
default_props: Optional[Dict[str, Any]] = Field(None, description="Default property values")
dependencies: Optional[list[str]] = Field(None, description="External library dependencies")
is_public: bool = Field(default=False, description="Share with other users")
agent_id: Optional[str] = Field(None, description="Agent creating component (for governance)")
class UpdateComponentRequest(BaseModel):
"""Request to update a component."""
name: Optional[str] = Field(None, description="Component name")
html_content: Optional[str] = Field(None, description="HTML template")
css_content: Optional[str] = Field(None, description="CSS styles")
js_content: Optional[str] = Field(None, description="JavaScript behavior")
description: Optional[str] = Field(None, description="Component description")
props_schema: Optional[Dict[str, Any]] = Field(None, description="JSON schema for properties")
default_props: Optional[Dict[str, Any]] = Field(None, description="Default property values")
dependencies: Optional[list[str]] = Field(None, description="External library dependencies")
is_public: Optional[bool] = Field(None, description="Share with other users")
change_description: Optional[str] = Field(None, description="Description of changes")
agent_id: Optional[str] = Field(None, description="Agent updating component (for governance)")
class RollbackComponentRequest(BaseModel):
"""Request to rollback a component."""
target_version: int = Field(..., description="Version number to restore")
class RecordUsageRequest(BaseModel):
"""Request to record component usage."""
canvas_id: str = Field(..., description="Canvas where component was used")
session_id: Optional[str] = Field(None, description="Canvas session ID")
agent_id: Optional[str] = Field(None, description="Agent that rendered component")
props_passed: Optional[Dict[str, Any]] = Field(None, description="Properties passed to component")
rendering_time_ms: Optional[int] = Field(None, description="Rendering time in milliseconds")
error_message: Optional[str] = Field(None, description="Any rendering errors")
governance_check_passed: Optional[bool] = Field(None, description="Governance check result")
agent_maturity_level: Optional[str] = Field(None, description="Agent maturity level")
# ============================================================================
# Component CRUD Endpoints
# ============================================================================
@router.post("/create")
async def create_component(
request: CreateComponentRequest,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Create a new custom component.
Creates a custom HTML/CSS/JS component with security validation
and governance checks.
**Security Requirements**:
- HTML/CSS components: SUPERVISED+ maturity
- JavaScript components: AUTONOMOUS maturity only
Request Body:
- name: Component name
- html_content: HTML template
- css_content: Optional CSS styles
- js_content: Optional JavaScript (AUTONOMOUS required)
- description: Component description
- category: Component category
- props_schema: JSON schema for component properties
- default_props: Default property values
- dependencies: External library URLs (whitelist enforced)
- is_public: Share with other users
- agent_id: Agent creating component (for governance check)
Query Parameters:
- user_id: Owner user ID
Response:
Created component data with ID, slug, and version
"""
service = CustomComponentsService(db)
try:
result = service.create_component(
user_id=user_id,
name=request.name,
html_content=request.html_content,
css_content=request.css_content,
js_content=request.js_content,
description=request.description,
category=request.category,
props_schema=request.props_schema,
default_props=request.default_props,
dependencies=request.dependencies,
is_public=request.is_public,
agent_id=request.agent_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result.get("error", "Operation failed")
)
return router.success_response(
data=result,
message="Operation completed successfully"
)
except ComponentSecurityError as e:
raise router.permission_denied_error(
action="component_operation",
resource="CustomComponent",
details={"reason": str(e)}
)
@router.get("")
async def list_components(
user_id: Optional[str] = Query(None, description="User ID (for private components)"),
category: Optional[str] = Query(None, description="Filter by category"),
is_public: Optional[bool] = Query(None, description="Filter by public/private"),
limit: int = Query(50, ge=1, le=100, description="Max results"),
db: Session = Depends(get_db)
):
"""
List components with optional filtering.
Returns user's own components plus public components.
Query Parameters:
- user_id: User ID (to include private components)
- category: Filter by category
- is_public: Filter by public/private
- limit: Maximum results
Response:
List of components with summary info
"""
service = CustomComponentsService(db)
result = service.list_components(
user_id=user_id,
category=category,
is_public=is_public,
limit=limit
)
return router.success_response(
data=result.get("components", result),
message=f"Retrieved {len(result.get('components', []))} components"
)
@router.get("/{component_id}")
async def get_component(
component_id: str,
user_id: Optional[str] = Query(None, description="User ID for permission check"),
db: Session = Depends(get_db)
):
"""
Get a component by ID.
Returns component HTML/CSS/JS content. JavaScript content
is only returned to component owners.
Path Parameters:
- component_id: Component ID
Query Parameters:
- user_id: User ID (for permission check)
Response:
Full component data including code
"""
service = CustomComponentsService(db)
result = service.get_component(
component_id=component_id,
user_id=user_id
)
if "error" in result:
raise router.not_found_error(
resource="Component",
resource_id=component_id if 'component_id' in locals() else slug,
details={"error": result.get("error")}
)
return router.success_response(
data=result,
message="Component retrieved successfully"
)
@router.get("/by-slug/{slug}")
async def get_component_by_slug(
slug: str,
user_id: Optional[str] = Query(None, description="User ID for permission check"),
db: Session = Depends(get_db)
):
"""
Get a component by slug.
Alternative lookup method using URL-friendly slug.
Path Parameters:
- slug: Component slug
Query Parameters:
- user_id: User ID (for permission check)
Response:
Full component data including code
"""
service = CustomComponentsService(db)
result = service.get_component(
slug=slug,
user_id=user_id
)
if "error" in result:
raise router.not_found_error(
resource="Component",
resource_id=component_id if 'component_id' in locals() else slug,
details={"error": result.get("error")}
)
return router.success_response(
data=result,
message="Component retrieved successfully"
)
@router.put("/{component_id}")
async def update_component(
component_id: str,
request: UpdateComponentRequest,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Update an existing component.
Creates a new version with the updated content.
Only component owners can update components.
Path Parameters:
- component_id: Component to update
Query Parameters:
- user_id: User ID (must be owner)
Request Body:
Fields to update (same as create)
Response:
Updated component data with new version number
"""
service = CustomComponentsService(db)
try:
result = service.update_component(
component_id=component_id,
user_id=user_id,
name=request.name,
html_content=request.html_content,
css_content=request.css_content,
js_content=request.js_content,
description=request.description,
props_schema=request.props_schema,
default_props=request.default_props,
dependencies=request.dependencies,
is_public=request.is_public,
change_description=request.change_description,
agent_id=request.agent_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result.get("error", "Operation failed")
)
return router.success_response(
data=result,
message="Operation completed successfully"
)
except ComponentSecurityError as e:
raise router.permission_denied_error(
action="component_operation",
resource="CustomComponent",
details={"reason": str(e)}
)
@router.delete("/{component_id}")
async def delete_component(
component_id: str,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Delete a component (soft delete).
Sets is_active=False. Only component owners can delete.
Path Parameters:
- component_id: Component to delete
Query Parameters:
- user_id: User ID (must be owner)
Response:
Deletion confirmation
"""
service = CustomComponentsService(db)
result = service.delete_component(
component_id=component_id,
user_id=user_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result["error"]
)
return result
# ============================================================================
# Version Control Endpoints
# ============================================================================
@router.get("/{component_id}/versions")
async def get_component_versions(
component_id: str,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Get version history for a component.
Returns all versions with change descriptions.
Only component owners can view version history.
Path Parameters:
- component_id: Component ID
Query Parameters:
- user_id: User ID (must be owner)
Response:
List of versions with metadata
"""
service = CustomComponentsService(db)
result = service.get_component_versions(
component_id=component_id,
user_id=user_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result["error"]
)
return result
@router.post("/{component_id}/rollback")
async def rollback_component(
component_id: str,
request: RollbackComponentRequest,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Rollback component to a previous version.
Creates a new version with content from the target version.
Only component owners can rollback.
Path Parameters:
- component_id: Component to rollback
Query Parameters:
- user_id: User ID (must be owner)
Request Body:
- target_version: Version number to restore
Response:
Rollback result with new version number
"""
service = CustomComponentsService(db)
result = service.rollback_component(
component_id=component_id,
target_version=request.target_version,
user_id=user_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result["error"]
)
return result
# ============================================================================
# Usage Tracking Endpoints
# ============================================================================
@router.post("/{component_id}/record-usage")
async def record_component_usage(
component_id: str,
request: RecordUsageRequest,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Record component usage on a canvas.
Called when a component is rendered on a canvas.
Path Parameters:
- component_id: Component that was used
Query Parameters:
- user_id: User who rendered component
Request Body:
- canvas_id: Canvas where component was used
- session_id: Optional canvas session
- agent_id: Optional agent that rendered component
- props_passed: Properties passed to component
- rendering_time_ms: Rendering performance
- error_message: Any rendering errors
- governance_check_passed: Governance check result
- agent_maturity_level: Agent maturity level
Response:
Usage record confirmation
"""
service = CustomComponentsService(db)
result = service.record_component_usage(
component_id=component_id,
canvas_id=request.canvas_id,
user_id=user_id,
session_id=request.session_id,
agent_id=request.agent_id,
props_passed=request.props_passed,
rendering_time_ms=request.rendering_time_ms,
error_message=request.error_message,
governance_check_passed=request.governance_check_passed,
agent_maturity_level=request.agent_maturity_level
)
if "error" in result:
raise router.validation_error(
field="component",
message=result["error"]
)
return result
@router.get("/{component_id}/stats")
async def get_component_stats(
component_id: str,
user_id: str = Query(..., description="User ID"),
db: Session = Depends(get_db)
):
"""
Get usage statistics for a component.
Returns detailed usage metrics including render counts,
success rates, and top canvases.
Path Parameters:
- component_id: Component ID
Query Parameters:
- user_id: User ID (must be owner)
Response:
Usage statistics
"""
service = CustomComponentsService(db)
result = service.get_component_usage_stats(
component_id=component_id,
user_id=user_id
)
if "error" in result:
raise router.validation_error(
field="component",
message=result["error"]
)
return result
|