File size: 8,455 Bytes
f56a29b | 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 | /**
* Unified Action System
*
* Actions are the sole mechanism for agents to interact with the presentation.
* Two categories:
* - Fire-and-forget: visual effects on slides (spotlight, laser)
* - Synchronous: must wait for completion before next action (speech, whiteboard, discussion)
*
* Both online (streaming) and offline (playback) paths consume the same Action types.
*/
// ==================== Base ====================
export interface ActionBase {
id: string;
title?: string;
description?: string;
}
// ==================== Fire-and-forget actions ====================
/** Spotlight β focus on a single element, dim everything else */
export interface SpotlightAction extends ActionBase {
type: 'spotlight';
elementId: string;
dimOpacity?: number; // default 0.5
}
/** Laser β point at an element with a laser effect */
export interface LaserAction extends ActionBase {
type: 'laser';
elementId: string;
color?: string; // default '#ff0000'
}
// ==================== Synchronous actions ====================
/** Speech β teacher narration (wait for TTS to finish) */
export interface SpeechAction extends ActionBase {
type: 'speech';
text: string;
audioId?: string;
audioUrl?: string; // Server-generated TTS audio URL
voice?: string;
speed?: number; // default 1.0
}
/** Open whiteboard (wait for animation) */
export interface WbOpenAction extends ActionBase {
type: 'wb_open';
}
/** Draw text on whiteboard (wait for render) */
export interface WbDrawTextAction extends ActionBase {
type: 'wb_draw_text';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
content: string; // HTML string or plain text
x: number;
y: number;
width?: number; // default 400
height?: number; // default 100
fontSize?: number; // default 18
color?: string; // default '#333333'
}
/** Draw shape on whiteboard (wait for render) */
export interface WbDrawShapeAction extends ActionBase {
type: 'wb_draw_shape';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
shape: 'rectangle' | 'circle' | 'triangle';
x: number;
y: number;
width: number;
height: number;
fillColor?: string; // default '#5b9bd5'
}
/** Draw chart on whiteboard (wait for render) */
export interface WbDrawChartAction extends ActionBase {
type: 'wb_draw_chart';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
chartType: 'bar' | 'column' | 'line' | 'pie' | 'ring' | 'area' | 'radar' | 'scatter';
x: number;
y: number;
width: number;
height: number;
data: {
labels: string[];
legends: string[];
series: number[][];
};
themeColors?: string[];
}
/** Draw LaTeX formula on whiteboard (wait for render) */
export interface WbDrawLatexAction extends ActionBase {
type: 'wb_draw_latex';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
latex: string;
x: number;
y: number;
width?: number; // default 400
height?: number; // auto-calculated based on formula aspect ratio
color?: string; // default '#000000'
}
/** Draw table on whiteboard (wait for render) */
export interface WbDrawTableAction extends ActionBase {
type: 'wb_draw_table';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
x: number;
y: number;
width: number;
height: number;
data: string[][]; // Simplified 2D string array, first row is header
outline?: { width: number; style: string; color: string };
theme?: { color: string };
}
/** Draw line/arrow on whiteboard (wait for render) */
export interface WbDrawLineAction extends ActionBase {
type: 'wb_draw_line';
elementId?: string; // Custom element ID for later reference (e.g. wb_delete)
startX: number; // Start X position (0-1000)
startY: number; // Start Y position (0-562)
endX: number; // End X position (0-1000)
endY: number; // End Y position (0-562)
color?: string; // Default '#333333'
width?: number; // Line width, default 2
style?: 'solid' | 'dashed'; // Default 'solid'
points?: ['', 'arrow'] | ['arrow', ''] | ['arrow', 'arrow'] | ['', '']; // Endpoint markers, default ['', '']
}
/** Clear all whiteboard elements */
export interface WbClearAction extends ActionBase {
type: 'wb_clear';
}
/** Delete a specific whiteboard element by ID */
export interface WbDeleteAction extends ActionBase {
type: 'wb_delete';
elementId: string;
}
/** Close whiteboard (wait for animation) */
export interface WbCloseAction extends ActionBase {
type: 'wb_close';
}
/** Draw code block on whiteboard (wait for typing animation) */
export interface WbDrawCodeAction extends ActionBase {
type: 'wb_draw_code';
elementId?: string;
language: string;
code: string; // Raw code text, lines separated by \n
x: number;
y: number;
width?: number; // Default 500
height?: number; // Default 300
fileName?: string;
}
/** Edit code block on whiteboard (line-level operations) */
export interface WbEditCodeAction extends ActionBase {
type: 'wb_edit_code';
elementId: string; // Target code block ID
operation: 'insert_after' | 'insert_before' | 'delete_lines' | 'replace_lines';
lineId?: string; // Reference line ID for insert operations
lineIds?: string[]; // Target line IDs for delete/replace operations
content?: string; // New content for insert/replace, lines separated by \n
}
/** Play video β start playback of a video element on the slide */
export interface PlayVideoAction extends ActionBase {
type: 'play_video';
elementId: string;
}
/** Discussion β trigger a roundtable discussion */
export interface DiscussionAction extends ActionBase {
type: 'discussion';
topic: string;
prompt?: string;
agentId?: string;
}
// ==================== Widget Interaction Actions ====================
/** Widget Highlight β highlight an element in a widget iframe */
export interface WidgetHighlightAction extends ActionBase {
type: 'widget_highlight';
target: string; // CSS selector or element ID in the iframe
content?: string; // Speech text to accompany the highlight
}
/** Widget SetState β set widget state (e.g., simulation variables) */
export interface WidgetSetStateAction extends ActionBase {
type: 'widget_setState';
state: Record<string, unknown>;
content?: string; // Speech text to accompany the state change
}
/** Widget Annotation β add floating annotation to an element */
export interface WidgetAnnotationAction extends ActionBase {
type: 'widget_annotation';
target: string;
content?: string;
}
/** Widget Reveal β reveal hidden content in widget */
export interface WidgetRevealAction extends ActionBase {
type: 'widget_reveal';
target: string;
content?: string;
}
// ==================== Union type ====================
export type Action =
| SpotlightAction
| LaserAction
| PlayVideoAction
| SpeechAction
| WbOpenAction
| WbDrawTextAction
| WbDrawShapeAction
| WbDrawChartAction
| WbDrawLatexAction
| WbDrawTableAction
| WbDrawLineAction
| WbClearAction
| WbDeleteAction
| WbCloseAction
| WbDrawCodeAction
| WbEditCodeAction
| DiscussionAction
| WidgetHighlightAction
| WidgetSetStateAction
| WidgetAnnotationAction
| WidgetRevealAction;
export type ActionType = Action['type'];
/** Action types that fire immediately without blocking */
export const FIRE_AND_FORGET_ACTIONS: ActionType[] = ['spotlight', 'laser'];
/** Action types that only work on slide scenes (require slide canvas elements) */
export const SLIDE_ONLY_ACTIONS: ActionType[] = ['spotlight', 'laser'];
/** Action types that must complete before the next action runs */
export const SYNC_ACTIONS: ActionType[] = [
'speech',
'play_video',
'wb_open',
'wb_draw_text',
'wb_draw_shape',
'wb_draw_chart',
'wb_draw_latex',
'wb_draw_table',
'wb_draw_line',
'wb_draw_code',
'wb_edit_code',
'wb_clear',
'wb_delete',
'wb_close',
'discussion',
'widget_highlight',
'widget_setState',
'widget_annotation',
'widget_reveal',
];
// ==================== Canvas utility types (non-action) ====================
/**
* Percentage-based geometry (0-100 coordinate system)
* Used by spotlight/laser overlays for responsive positioning.
*/
export interface PercentageGeometry {
x: number; // 0-100
y: number; // 0-100
w: number; // 0-100
h: number; // 0-100
centerX: number; // 0-100
centerY: number; // 0-100
}
|