@almadar/agent 3.5.11 → 3.5.13

package/dist/gates/prompts.d.ts

@@ -11,22 +11,84 @@
  */
 import type { OrbitalDefinition, Trait, Transition, Entity, StateMachine } from '@almadar/core/types';
 export declare function buildGate0SystemPrompt(): string;
+/**
+ * Build the user prompt for Gate 0 (Application Decomposition).
+ *
+ * Creates a prompt that guides the LLM to decompose a user request into
+ * an orbital schema with entities, traits, and pages.
+ *
+ * @param {string} prompt - The original user request/prompt
+ * @param {object} [guidedData] - Optional guidance data from behavior analysis
+ * @param {number} guidedData.orbitalCount - Expected number of orbitals
+ * @param {string[]} guidedData.entityNames - Expected entity names
+ * @param {string[]} guidedData.traitNames - Expected trait names
+ * @returns {string} The formatted user prompt for Gate 0
+ */
 export declare function buildGate0UserPrompt(prompt: string, guidedData?: {
     orbitalCount: number;
     entityNames: string[];
     traitNames: string[];
 }): string;
 export declare function buildGate1SystemPrompt(): string;
+/**
+ * Build the user prompt for Gate 1 (Orbital Structure).
+ *
+ * Creates a prompt that guides the LLM to enrich an orbital shell with
+ * full entity fields, persistence config, and page definitions.
+ *
+ * @param {OrbitalDefinition} orbital - The orbital shell to enrich
+ * @param {OrbitalDefinition[]} allOrbitals - All orbitals for cross-reference context
+ * @param {OrbitalDefinition} [guidedOrbital] - Optional reference orbital for guidance
+ * @returns {string} The formatted user prompt for Gate 1
+ */
 export declare function buildGate1UserPrompt(orbital: OrbitalDefinition, allOrbitals: OrbitalDefinition[], guidedOrbital?: OrbitalDefinition): string;
 export declare function buildGate2SystemPrompt(): string;
+/**
+ * Build the user prompt for Gate 2 (State Machine Design).
+ *
+ * Creates a prompt that guides the LLM to design the state machine topology
+ * and UI slot assignments for a trait.
+ *
+ * @param {Trait} trait - The trait shell to design state machine for
+ * @param {Entity} entity - The entity this trait manages
+ * @param {string} orbitalDescription - Description of the orbital for context
+ * @param {Trait} [guidedTrait] - Optional reference trait for guidance
+ * @returns {string} The formatted user prompt for Gate 2
+ */
 export declare function buildGate2UserPrompt(trait: Trait, entity: Entity, orbitalDescription: string, guidedTrait?: Trait): string;
 export declare function buildGate3SystemPrompt(): string;
+/**
+ * Build the user prompt for Gate 3 (Transition Effects).
+ *
+ * Creates a prompt that guides the LLM to design guards and effects
+ * for a specific state machine transition.
+ *
+ * @param {Transition} transition - The transition to add effects to
+ * @param {Entity} entity - The entity managed by this state machine
+ * @param {StateMachine} sm - The full state machine for context
+ * @param {Transition} [guidedTransition] - Optional reference transition for guidance
+ * @returns {string} The formatted user prompt for Gate 3
+ */
 export declare function buildGate3UserPrompt(transition: Transition, entity: Entity, sm: StateMachine, guidedTransition?: Transition): string;
 export declare function buildGate4SystemPrompt(matchedPatterns?: string[]): string;
 export interface SlotContext {
     stateSlots: Record<string, 'main' | 'modal'>;
     exitsModal: boolean;
 }
+/**
+ * Build the user prompt for Gate 4 (UI Rendering).
+ *
+ * Creates a prompt that guides the LLM to produce render-ui pattern trees
+ * for a transition's target state.
+ *
+ * @param {Transition} transition - The transition being rendered
+ * @param {Entity} entity - The entity being displayed
+ * @param {string} targetStateName - The state to render UI for
+ * @param {StateMachine} sm - The full state machine for context
+ * @param {SlotContext} slotContext - Context about which slots states render to
+ * @param {Array<{slot: string; tree: object}>} [guidedRenderEffects] - Optional reference render effects
+ * @returns {string} The formatted user prompt for Gate 4
+ */
 export declare function buildGate4UserPrompt(transition: Transition, entity: Entity, targetStateName: string, sm: StateMachine, slotContext: SlotContext, guidedRenderEffects?: Array<{
     slot: string;
     tree: Record<string, unknown>;