@amplitude/wizard 1.0.0-beta.0

package/dist/src/ui/tui/store.d.ts

@@ -0,0 +1,231 @@
+/**
+ * WizardStore — Nanostore-backed reactive store for the TUI.
+ * React components subscribe via useSyncExternalStore.
+ *
+ * Navigation is delegated to WizardRouter.
+ * The active screen is derived from session state — not imperatively set.
+ * Overlays (outage, etc.) are the only imperative navigation.
+ *
+ * All session mutations that affect screen resolution go through
+ * explicit setters so emitChange() is always called.
+ */
+import { TaskStatus, type EventPlanDecision } from '../wizard-ui.js';
+import { type WizardSession, type OutroData, type DiscoveredFeature, AdditionalFeature, McpOutcome, SlackOutcome, RunPhase } from '../../lib/wizard-session.js';
+import { WizardRouter, type ScreenName, Screen, Overlay, Flow } from './router.js';
+export { TaskStatus, Screen, Overlay, Flow, RunPhase, McpOutcome, SlackOutcome, };
+export type { ScreenName, OutroData, WizardSession };
+export interface TaskItem {
+    label: string;
+    activeForm?: string;
+    status: TaskStatus;
+    /** Legacy compat */
+    done: boolean;
+}
+export interface PlannedEvent {
+    name: string;
+    description: string;
+}
+export type PendingPrompt = {
+    kind: 'confirm';
+    message: string;
+    resolve: (value: boolean) => void;
+} | {
+    kind: 'choice';
+    message: string;
+    options: string[];
+    resolve: (value: string) => void;
+} | {
+    kind: 'event-plan';
+    events: PlannedEvent[];
+    resolve: (value: EventPlanDecision) => void;
+};
+export declare class WizardStore {
+    private $session;
+    private $statusMessages;
+    private $tasks;
+    private $eventPlan;
+    private $version;
+    /** True while the user is typing a slash command in the command bar. */
+    private $commandMode;
+    /** Transient feedback message shown in the command bar after a command runs. */
+    private $commandFeedback;
+    /** Error caught by the app error boundary — shown in ConsoleView. */
+    private $screenError;
+    private $screenErrorRetry;
+    /** Tab id to switch to imperatively (e.g. from a slash command). */
+    private $requestedTab;
+    /** Last screen seen — used to detect screen transitions for analytics. */
+    private _lastScreen;
+    /** Hooks run when transitioning onto a screen. */
+    private _enterScreenHooks;
+    version: string;
+    /** Navigation router — resolves active screen from session state. */
+    readonly router: WizardRouter;
+    /**
+     * Setup promise — IntroScreen resolves this when the user confirms.
+     * bin.ts awaits it before calling runWizard.
+     */
+    private _resolveSetup;
+    readonly setupComplete: Promise<void>;
+    /** Blocks agent execution until the settings-override overlay is dismissed. */
+    private _resolveSettingsOverride;
+    private _backupAndFixSettings;
+    /** Pending confirmation or choice prompt from the agent. */
+    private $pendingPrompt;
+    constructor(flow?: Flow);
+    get session(): WizardSession;
+    set session(value: WizardSession);
+    get commandMode(): boolean;
+    get commandFeedback(): string | null;
+    get screenError(): Error | null;
+    get screenErrorRetry(): number;
+    get requestedTab(): string | null;
+    get statusMessages(): string[];
+    get tasks(): TaskItem[];
+    get eventPlan(): PlannedEvent[];
+    get pendingPrompt(): PendingPrompt | null;
+    /** Advances the flow past IntroScreen. Does not start the agent. */
+    concludeIntro(): void;
+    /**
+     * Unblocks bin.ts via the setupComplete promise, signalling that the agent
+     * can start. Called by bin.ts via onEnterScreen(Screen.Run) so it fires at
+     * the right point in the flow — after auth, data check, and setup questions.
+     */
+    completeSetup(): void;
+    setRunPhase(phase: RunPhase): void;
+    setCredentials(credentials: WizardSession['credentials']): void;
+    setFrameworkConfig(integration: WizardSession['integration'], config: WizardSession['frameworkConfig']): void;
+    setDetectionComplete(): void;
+    setDetectedFramework(label: string): void;
+    setLoginUrl(url: string | null): void;
+    setRegion(region: string): void;
+    /** Force the RegionSelect screen to re-appear (/region command). */
+    setRegionForced(): void;
+    private _retryResolve;
+    setScreenError(error: Error): void;
+    clearScreenError(): void;
+    /**
+     * Returns a Promise that resolves the next time clearScreenError() is called
+     * (i.e. the user presses R). Used by InkUI.setRunError to block until retry.
+     */
+    waitForRetry(): Promise<void>;
+    /** Show a confirmation prompt. Resolves with true (yes) or false (no / skipped). */
+    promptConfirm(message: string): Promise<boolean>;
+    /** Show a multiple-choice prompt. Resolves with the chosen option or empty string if skipped. */
+    promptChoice(message: string, options: string[]): Promise<string>;
+    /** Resolve a confirm or choice pending prompt. */
+    resolvePrompt(answer: boolean | string): void;
+    /** Show an event-plan confirmation. Resolves when the user approves, skips, or gives feedback. */
+    promptEventPlan(events: PlannedEvent[]): Promise<EventPlanDecision>;
+    /** Resolve the pending event-plan prompt. */
+    resolveEventPlan(decision: EventPlanDecision): void;
+    /** Enter or exit slash command mode. */
+    setCommandMode(active: boolean): void;
+    showSnakeOverlay(): void;
+    hideSnakeOverlay(): void;
+    showMcpOverlay(): void;
+    hideMcpOverlay(): void;
+    showSlackOverlay(): void;
+    hideSlackOverlay(): void;
+    showLogoutOverlay(): void;
+    hideLogoutOverlay(): void;
+    showLoginOverlay(): void;
+    hideLoginOverlay(): void;
+    /** Update just the access token in credentials without triggering auth analytics. */
+    updateAccessToken(accessToken: string): void;
+    /** Request the TabContainer to switch to a tab by id. Clears after consumption. */
+    setRequestedTab(id: string): void;
+    clearRequestedTab(): void;
+    /** Show a transient feedback message in the command bar. Clears after ms. */
+    setCommandFeedback(message: string, ms?: number): void;
+    setProjectHasData(value: boolean): void;
+    setActivationLevel(level: 'none' | 'partial' | 'full'): void;
+    setSnippetConfigured(value: boolean): void;
+    setDataIngestionConfirmed(): void;
+    setChecklistChartComplete(): void;
+    setChecklistDashboardComplete(): void;
+    setChecklistComplete(): void;
+    setActivationOptionsComplete(): void;
+    /**
+     * Called from bin.ts when OAuth completes (browser redirect done).
+     * Stores auth tokens + org list so AuthScreen can show the SUSI pickers.
+     * Also sets region from the detected cloud zone.
+     */
+    setOAuthComplete(data: {
+        accessToken: string;
+        idToken: string;
+        cloudRegion: WizardSession['pendingAuthCloudRegion'];
+        orgs: WizardSession['pendingOrgs'];
+    }): void;
+    /**
+     * Called from AuthScreen when the user finishes org + workspace selection.
+     * Writes ampli.json and records org/workspace on the session.
+     */
+    setOrgAndWorkspace(org: {
+        id: string;
+        name: string;
+    }, workspace: {
+        id: string;
+        name: string;
+    }, installDir: string): void;
+    setServiceStatus(status: {
+        description: string;
+        statusPageUrl: string;
+    } | null): void;
+    /**
+     * Push the settings-override overlay and return a promise that blocks
+     * until the user dismisses it via backupAndFixSettingsOverride().
+     */
+    showSettingsOverride(keys: string[], backupAndFix: () => boolean): Promise<void>;
+    /**
+     * Back up .claude/settings.json. Dismisses the overlay on success.
+     */
+    backupAndFixSettingsOverride(): boolean;
+    addDiscoveredFeature(feature: DiscoveredFeature): void;
+    /**
+     * Enable an additional feature: enqueue it for the stop hook
+     * and set any feature-specific session flags.
+     */
+    enableFeature(feature: AdditionalFeature): void;
+    setAmplitudePreDetected(): void;
+    setMcpComplete(outcome?: McpOutcome, installedClients?: string[]): void;
+    setSlackComplete(outcome?: SlackOutcome): void;
+    setOutroData(data: OutroData): void;
+    setFrameworkContext(key: string, value: unknown): void;
+    /**
+     * The screen that should be rendered right now.
+     * Derived from session state via the router.
+     */
+    get currentScreen(): ScreenName;
+    /** Direction hint for screen transitions. */
+    get lastNavDirection(): 'push' | 'pop' | null;
+    getVersion(): number;
+    /**
+     * Notify React that state has changed.
+     * The router re-resolves the active screen on next render.
+     */
+    emitChange(): void;
+    pushOverlay(overlay: Overlay): void;
+    popOverlay(): void;
+    /**
+     * Register a callback to run when transitioning onto the given screen.
+     * Fires after every transition that lands on this screen.
+     */
+    onEnterScreen(screen: ScreenName, fn: () => void): void;
+    /**
+     * Detect screen transitions, run enter-screen hooks, and fire analytics.
+     * Called at the end of emitChange/pushOverlay/popOverlay.
+     */
+    private _detectTransition;
+    pushStatus(message: string): void;
+    setTasks(tasks: TaskItem[]): void;
+    updateTask(index: number, done: boolean): void;
+    setEventPlan(events: PlannedEvent[]): void;
+    syncTodos(todos: Array<{
+        content: string;
+        status: string;
+        activeForm?: string;
+    }>): void;
+    subscribe(callback: () => void): () => void;
+    getSnapshot(): number;
+}