File size: 2,577 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 | /**
* Stage API - AI Agent Toolkit
*
* Provides a complete Stage operation interface for AI Agents to create and manage course content
*
* Design Principles:
* 1. Type Safety: Fully leverage TypeScript's type system
* 2. Ease of Use: Provide high-level abstractions with clear, intuitive API naming
* 3. Extensibility: Support adding new scene types in the future
* 4. Idempotency: Multiple calls with the same parameters produce the same result
* 5. Error Handling: Return explicit success/failure status and error messages
*
* @example
* ```typescript
* const api = createStageAPI(stageStore);
*
* // Create a new scene
* const sceneId = api.scene.create({
* type: 'slide',
* title: 'Introduction',
* // speech is now in actions
* });
*
* // Add an element
* const elementId = api.element.add(sceneId, {
* type: 'text',
* content: 'Hello World',
* left: 100,
* top: 100
* });
*
* // Highlight an element (teaching feature)
* api.canvas.highlight(sceneId, elementId, 3000);
* ```
*/
// Re-export all types
export type {
APIResult,
CreateSceneParams,
CreateElementParams,
HighlightOptions,
SpotlightOptions,
StageStore,
} from './stage-api-types';
// Re-export utility functions that were previously accessible
export {
generateId,
validateSceneId,
getScene,
createDefaultContent,
createDefaultSlideContent,
createDefaultQuizContent,
createDefaultInteractiveContent,
createDefaultPBLContent,
} from './stage-api-defaults';
// Import sub-API factories
import { createSceneAPI } from './stage-api-scene';
import { createElementAPI } from './stage-api-element';
import { createCanvasAPI } from './stage-api-canvas';
import { createNavigationAPI } from './stage-api-navigation';
import { createWhiteboardAPI } from './stage-api-whiteboard';
import { createModeAPI, createStageMetaAPI } from './stage-api-mode';
import type { StageStore } from './stage-api-types';
// ==================== Stage API Implementation ====================
/**
* Create a Stage API instance
*
* @param store - Zustand store instance
* @returns Stage API object
*/
export function createStageAPI(store: StageStore) {
return {
scene: createSceneAPI(store),
navigation: createNavigationAPI(store),
element: createElementAPI(store),
canvas: createCanvasAPI(store),
whiteboard: createWhiteboardAPI(store),
mode: createModeAPI(store),
stage: createStageMetaAPI(store),
};
}
// ==================== Type Exports ====================
export type StageAPI = ReturnType<typeof createStageAPI>;
|