skema-core 0.1.0 → 0.1.2

package/dist/server.d.mts

@@ -193,10 +193,12 @@ interface GeminiCLIEvent {
 }
 /**
  * Build a prompt for Gemini CLI from an annotation
+ *
+ * @see /server/prompts.ts for the actual prompt templates
  */
 declare function buildPromptFromAnnotation(annotation: Partial<Annotation> & {
     comment?: string;
-}, projectContext?: ProjectContext, options?: {
+}, _projectContext?: ProjectContext, options?: {
     fastMode?: boolean;
     visionDescription?: string;
 }): string;
@@ -207,12 +209,21 @@ declare function spawnGeminiCLI(prompt: string, options?: GeminiCLIOptions): {
     process: ChildProcess;
     events: AsyncIterable<GeminiCLIEvent>;
 };
+/**
+ * Options for createGeminiCLIStream with abort support
+ */
+interface StreamOptions extends GeminiCLIOptions {
+    /** Abort signal for cancellation */
+    signal?: AbortSignal;
+    /** Callback when cancelled - for cleanup like reverting snapshots */
+    onCancel?: () => void;
+}
 /**
  * Create a streaming response for use in API routes (Next.js, Express, etc.)
  */
 declare function createGeminiCLIStream(annotation: Partial<Annotation> & {
     comment?: string;
-}, projectContext?: ProjectContext, options?: GeminiCLIOptions): ReadableStream<Uint8Array>;
+}, projectContext?: ProjectContext, options?: StreamOptions): ReadableStream<Uint8Array>;
 /**
  * Run Gemini CLI and wait for completion
  */
@@ -257,4 +268,198 @@ declare function createRevertRouteHandler(defaultOptions?: {
 declare const POST: (request: Request) => Promise<Response>;
 declare const DELETE: (request: Request) => Promise<Response>;
 
-export { DELETE, type GeminiCLIEvent, type GeminiCLIOptions, POST, type ProjectContext, buildPromptFromAnnotation, createGeminiCLIStream, createGeminiRouteHandler, createRevertRouteHandler, getTrackedAnnotations, revertAnnotation, runGeminiCLI, spawnGeminiCLI };
+/**
+ * Skema AI Prompts
+ *
+ * This file contains all AI prompts used by Skema for generating code changes.
+ *
+ * Prompts:
+ * - FAST_DOM_SELECTION_PROMPT: Quick, minimal prompt for DOM element changes
+ * - DETAILED_DOM_SELECTION_PROMPT: Full context prompt for complex DOM changes
+ * - DRAWING_TO_CODE_PROMPT: Converts wireframe sketches to React components
+ * - IMAGE_ANALYSIS_PROMPT: Gemini Vision prompt to analyze drawing images
+ */
+
+interface DomSelectionInput {
+    comment: string;
+    selector?: string;
+    text?: string;
+    tagName?: string;
+}
+interface DetailedDomSelectionInput extends DomSelectionInput {
+    elementPath?: string;
+    cssClasses?: string;
+    attributes?: Record<string, string>;
+    elements?: Array<{
+        tagName: string;
+        selector: string;
+        elementPath: string;
+        text?: string;
+    }>;
+}
+interface GestureInput {
+    comment: string;
+    gesture?: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+    };
+}
+interface DrawingInput {
+    comment: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    drawingSvg?: string;
+    drawingImage?: string;
+    extractedText?: string;
+    gridConfig?: {
+        color: string;
+        size: number;
+        labels: boolean;
+    };
+    viewport?: ViewportInfo;
+    projectStyles?: ProjectStyleContext;
+    nearbyElements?: NearbyElement[];
+    visionDescription?: string;
+}
+/**
+ * Fast mode prompt for quick DOM element changes.
+ * Used when fastMode is enabled for simple, targeted edits.
+ *
+ * @example
+ * // Result: "Make this button blue (target: "Submit"). Make the change directly..."
+ * buildFastDomSelectionPrompt({ comment: "Make this button blue", text: "Submit" })
+ */
+declare function buildFastDomSelectionPrompt(input: DomSelectionInput): string;
+/**
+ * Detailed mode prompt for DOM element changes with full context.
+ * Used for complex changes that need more information about the target.
+ *
+ * @example
+ * buildDetailedDomSelectionPrompt({
+ *   comment: "Add a hover effect",
+ *   tagName: "button",
+ *   selector: "#submit-btn",
+ *   text: "Submit Form"
+ * })
+ */
+declare function buildDetailedDomSelectionPrompt(input: DetailedDomSelectionInput): string;
+/**
+ * Prompt for gesture-based annotations (circles, scribbles, etc.)
+ */
+declare function buildGesturePrompt(input: GestureInput): string;
+/**
+ * Comprehensive prompt for converting wireframe sketches into React components.
+ * This is the most complex prompt, used when users draw UI elements.
+ *
+ * The prompt instructs the AI to:
+ * 1. Analyze the sketch to understand the visual intent
+ * 2. Interpret (not transcribe) the low-fidelity drawing
+ * 3. Generate high-quality inline JSX with Tailwind CSS
+ * 4. Integrate naturally with the existing page flow
+ */
+declare function buildDrawingToCodePrompt(input: DrawingInput): string;
+/**
+ * Prompt for Gemini Vision to analyze a wireframe sketch image.
+ * This generates a description that is then passed to the main drawing prompt.
+ */
+declare const IMAGE_ANALYSIS_PROMPT: string;
+
+type AIProvider = 'gemini' | 'claude';
+interface AIProviderConfig {
+    provider: AIProvider;
+    /** Working directory for CLI commands */
+    cwd?: string;
+    /** Model override (provider-specific) */
+    model?: string;
+}
+interface AIStreamEvent {
+    type: 'init' | 'text' | 'tool_use' | 'tool_result' | 'error' | 'done' | 'debug';
+    content?: string;
+    timestamp: string;
+    provider: AIProvider;
+    /** Raw event from the CLI (provider-specific) */
+    raw?: unknown;
+}
+interface AIRunResult {
+    success: boolean;
+    output: string;
+    events: AIStreamEvent[];
+    provider: AIProvider;
+}
+/**
+ * Spawn an AI CLI and return an async iterator of events
+ */
+declare function spawnAICLI(prompt: string, config: AIProviderConfig): {
+    process: ChildProcess;
+    events: AsyncIterable<AIStreamEvent>;
+};
+/**
+ * Run an AI CLI and wait for completion (non-streaming)
+ */
+declare function runAICLI(prompt: string, config: AIProviderConfig): Promise<AIRunResult>;
+/**
+ * Check if a provider CLI is available
+ */
+declare function isProviderAvailable(provider: AIProvider): boolean;
+/**
+ * Get available providers
+ */
+declare function getAvailableProviders(): AIProvider[];
+
+interface DaemonConfig {
+    /** Port for WebSocket server (default: 9999) */
+    port?: number;
+    /** Working directory for file operations and AI commands */
+    cwd?: string;
+    /** Default AI provider */
+    defaultProvider?: AIProvider;
+}
+interface IncomingMessage {
+    id: string;
+    type: string;
+    [key: string]: unknown;
+}
+interface OutgoingMessage {
+    id?: string;
+    type: string;
+    success?: boolean;
+    error?: string;
+    [key: string]: unknown;
+}
+interface DaemonInstance {
+    port: number;
+    close: () => void;
+}
+/**
+ * Start the Skema daemon (WebSocket server)
+ */
+declare function startDaemon(config?: DaemonConfig): DaemonInstance;
+
+interface VisionAnalysisResult {
+    success: boolean;
+    description: string;
+    provider: AIProvider;
+    error?: string;
+}
+interface VisionConfig {
+    provider: AIProvider;
+    /** API key for vision API (falls back to env vars) */
+    apiKey?: string;
+    /** Model to use for vision */
+    model?: string;
+}
+/**
+ * Analyze an image using the specified AI provider's vision capabilities
+ */
+declare function analyzeImage(base64Image: string, config: VisionConfig): Promise<VisionAnalysisResult>;
+/**
+ * Check if vision analysis is available for a provider
+ */
+declare function isVisionAvailable(provider: AIProvider): boolean;
+
+export { type AIProvider, type AIProviderConfig, type AIRunResult, type AIStreamEvent, DELETE, type DaemonConfig, type DaemonInstance, type DetailedDomSelectionInput, type DomSelectionInput, type DrawingInput, type GeminiCLIEvent, type GeminiCLIOptions, type GestureInput, IMAGE_ANALYSIS_PROMPT, type IncomingMessage, type OutgoingMessage, POST, type ProjectContext, type VisionAnalysisResult, type VisionConfig, analyzeImage, buildDetailedDomSelectionPrompt, buildDrawingToCodePrompt, buildFastDomSelectionPrompt, buildGesturePrompt, buildPromptFromAnnotation, createGeminiCLIStream, createGeminiRouteHandler, createRevertRouteHandler, getAvailableProviders, getTrackedAnnotations, isProviderAvailable, isVisionAvailable, revertAnnotation, runAICLI, runGeminiCLI, spawnAICLI, spawnGeminiCLI, startDaemon };

package/dist/server.d.ts

@@ -193,10 +193,12 @@ interface GeminiCLIEvent {
 }
 /**
  * Build a prompt for Gemini CLI from an annotation
+ *
+ * @see /server/prompts.ts for the actual prompt templates
  */
 declare function buildPromptFromAnnotation(annotation: Partial<Annotation> & {
     comment?: string;
-}, projectContext?: ProjectContext, options?: {
+}, _projectContext?: ProjectContext, options?: {
     fastMode?: boolean;
     visionDescription?: string;
 }): string;
@@ -207,12 +209,21 @@ declare function spawnGeminiCLI(prompt: string, options?: GeminiCLIOptions): {
     process: ChildProcess;
     events: AsyncIterable<GeminiCLIEvent>;
 };
+/**
+ * Options for createGeminiCLIStream with abort support
+ */
+interface StreamOptions extends GeminiCLIOptions {
+    /** Abort signal for cancellation */
+    signal?: AbortSignal;
+    /** Callback when cancelled - for cleanup like reverting snapshots */
+    onCancel?: () => void;
+}
 /**
  * Create a streaming response for use in API routes (Next.js, Express, etc.)
  */
 declare function createGeminiCLIStream(annotation: Partial<Annotation> & {
     comment?: string;
-}, projectContext?: ProjectContext, options?: GeminiCLIOptions): ReadableStream<Uint8Array>;
+}, projectContext?: ProjectContext, options?: StreamOptions): ReadableStream<Uint8Array>;
 /**
  * Run Gemini CLI and wait for completion
  */
@@ -257,4 +268,198 @@ declare function createRevertRouteHandler(defaultOptions?: {
 declare const POST: (request: Request) => Promise<Response>;
 declare const DELETE: (request: Request) => Promise<Response>;
 
-export { DELETE, type GeminiCLIEvent, type GeminiCLIOptions, POST, type ProjectContext, buildPromptFromAnnotation, createGeminiCLIStream, createGeminiRouteHandler, createRevertRouteHandler, getTrackedAnnotations, revertAnnotation, runGeminiCLI, spawnGeminiCLI };
+/**
+ * Skema AI Prompts
+ *
+ * This file contains all AI prompts used by Skema for generating code changes.
+ *
+ * Prompts:
+ * - FAST_DOM_SELECTION_PROMPT: Quick, minimal prompt for DOM element changes
+ * - DETAILED_DOM_SELECTION_PROMPT: Full context prompt for complex DOM changes
+ * - DRAWING_TO_CODE_PROMPT: Converts wireframe sketches to React components
+ * - IMAGE_ANALYSIS_PROMPT: Gemini Vision prompt to analyze drawing images
+ */
+
+interface DomSelectionInput {
+    comment: string;
+    selector?: string;
+    text?: string;
+    tagName?: string;
+}
+interface DetailedDomSelectionInput extends DomSelectionInput {
+    elementPath?: string;
+    cssClasses?: string;
+    attributes?: Record<string, string>;
+    elements?: Array<{
+        tagName: string;
+        selector: string;
+        elementPath: string;
+        text?: string;
+    }>;
+}
+interface GestureInput {
+    comment: string;
+    gesture?: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+    };
+}
+interface DrawingInput {
+    comment: string;
+    boundingBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    drawingSvg?: string;
+    drawingImage?: string;
+    extractedText?: string;
+    gridConfig?: {
+        color: string;
+        size: number;
+        labels: boolean;
+    };
+    viewport?: ViewportInfo;
+    projectStyles?: ProjectStyleContext;
+    nearbyElements?: NearbyElement[];
+    visionDescription?: string;
+}
+/**
+ * Fast mode prompt for quick DOM element changes.
+ * Used when fastMode is enabled for simple, targeted edits.
+ *
+ * @example
+ * // Result: "Make this button blue (target: "Submit"). Make the change directly..."
+ * buildFastDomSelectionPrompt({ comment: "Make this button blue", text: "Submit" })
+ */
+declare function buildFastDomSelectionPrompt(input: DomSelectionInput): string;
+/**
+ * Detailed mode prompt for DOM element changes with full context.
+ * Used for complex changes that need more information about the target.
+ *
+ * @example
+ * buildDetailedDomSelectionPrompt({
+ *   comment: "Add a hover effect",
+ *   tagName: "button",
+ *   selector: "#submit-btn",
+ *   text: "Submit Form"
+ * })
+ */
+declare function buildDetailedDomSelectionPrompt(input: DetailedDomSelectionInput): string;
+/**
+ * Prompt for gesture-based annotations (circles, scribbles, etc.)
+ */
+declare function buildGesturePrompt(input: GestureInput): string;
+/**
+ * Comprehensive prompt for converting wireframe sketches into React components.
+ * This is the most complex prompt, used when users draw UI elements.
+ *
+ * The prompt instructs the AI to:
+ * 1. Analyze the sketch to understand the visual intent
+ * 2. Interpret (not transcribe) the low-fidelity drawing
+ * 3. Generate high-quality inline JSX with Tailwind CSS
+ * 4. Integrate naturally with the existing page flow
+ */
+declare function buildDrawingToCodePrompt(input: DrawingInput): string;
+/**
+ * Prompt for Gemini Vision to analyze a wireframe sketch image.
+ * This generates a description that is then passed to the main drawing prompt.
+ */
+declare const IMAGE_ANALYSIS_PROMPT: string;
+
+type AIProvider = 'gemini' | 'claude';
+interface AIProviderConfig {
+    provider: AIProvider;
+    /** Working directory for CLI commands */
+    cwd?: string;
+    /** Model override (provider-specific) */
+    model?: string;
+}
+interface AIStreamEvent {
+    type: 'init' | 'text' | 'tool_use' | 'tool_result' | 'error' | 'done' | 'debug';
+    content?: string;
+    timestamp: string;
+    provider: AIProvider;
+    /** Raw event from the CLI (provider-specific) */
+    raw?: unknown;
+}
+interface AIRunResult {
+    success: boolean;
+    output: string;
+    events: AIStreamEvent[];
+    provider: AIProvider;
+}
+/**
+ * Spawn an AI CLI and return an async iterator of events
+ */
+declare function spawnAICLI(prompt: string, config: AIProviderConfig): {
+    process: ChildProcess;
+    events: AsyncIterable<AIStreamEvent>;
+};
+/**
+ * Run an AI CLI and wait for completion (non-streaming)
+ */
+declare function runAICLI(prompt: string, config: AIProviderConfig): Promise<AIRunResult>;
+/**
+ * Check if a provider CLI is available
+ */
+declare function isProviderAvailable(provider: AIProvider): boolean;
+/**
+ * Get available providers
+ */
+declare function getAvailableProviders(): AIProvider[];
+
+interface DaemonConfig {
+    /** Port for WebSocket server (default: 9999) */
+    port?: number;
+    /** Working directory for file operations and AI commands */
+    cwd?: string;
+    /** Default AI provider */
+    defaultProvider?: AIProvider;
+}
+interface IncomingMessage {
+    id: string;
+    type: string;
+    [key: string]: unknown;
+}
+interface OutgoingMessage {
+    id?: string;
+    type: string;
+    success?: boolean;
+    error?: string;
+    [key: string]: unknown;
+}
+interface DaemonInstance {
+    port: number;
+    close: () => void;
+}
+/**
+ * Start the Skema daemon (WebSocket server)
+ */
+declare function startDaemon(config?: DaemonConfig): DaemonInstance;
+
+interface VisionAnalysisResult {
+    success: boolean;
+    description: string;
+    provider: AIProvider;
+    error?: string;
+}
+interface VisionConfig {
+    provider: AIProvider;
+    /** API key for vision API (falls back to env vars) */
+    apiKey?: string;
+    /** Model to use for vision */
+    model?: string;
+}
+/**
+ * Analyze an image using the specified AI provider's vision capabilities
+ */
+declare function analyzeImage(base64Image: string, config: VisionConfig): Promise<VisionAnalysisResult>;
+/**
+ * Check if vision analysis is available for a provider
+ */
+declare function isVisionAvailable(provider: AIProvider): boolean;
+
+export { type AIProvider, type AIProviderConfig, type AIRunResult, type AIStreamEvent, DELETE, type DaemonConfig, type DaemonInstance, type DetailedDomSelectionInput, type DomSelectionInput, type DrawingInput, type GeminiCLIEvent, type GeminiCLIOptions, type GestureInput, IMAGE_ANALYSIS_PROMPT, type IncomingMessage, type OutgoingMessage, POST, type ProjectContext, type VisionAnalysisResult, type VisionConfig, analyzeImage, buildDetailedDomSelectionPrompt, buildDrawingToCodePrompt, buildFastDomSelectionPrompt, buildGesturePrompt, buildPromptFromAnnotation, createGeminiCLIStream, createGeminiRouteHandler, createRevertRouteHandler, getAvailableProviders, getTrackedAnnotations, isProviderAvailable, isVisionAvailable, revertAnnotation, runAICLI, runGeminiCLI, spawnAICLI, spawnGeminiCLI, startDaemon };