@posthog/wizard 2.9.1 → 2.10.1

package/dist/router-D5A1Sb4p.js

@@ -0,0 +1,141 @@
+import { t as __exportAll } from "./rolldown-runtime-B_-DWIq7.js";
+import { t as WORKFLOW_REGISTRY } from "./bin.js";
+import { n as AGENT_SKILL_STEPS } from "./agent-skill-BVjJqol6.js";
+//#region src/lib/workflows/workflow-step.ts
+/**
+* Project a Workflow into the narrower FlowEntry shape the router consumes.
+*
+* Two things happen here:
+*   1. Headless steps (no `screen`) are filtered out. The router walks
+*      visible screens; gate-only steps like `detect` are store concerns.
+*   2. The step is narrowed to just { screen, show, isComplete } — the
+*      router has no business touching gate, onInit, id, or label.
+*
+* This intentional separation keeps the router focused on one question:
+* "Which screen should be rendered right now?"
+*/
+function workflowToFlowEntries(workflow) {
+	const entries = workflow.filter((step) => step.screen != null).map((step) => ({
+		screen: step.screen,
+		show: step.show,
+		isComplete: step.isComplete ?? step.gate
+	}));
+	entries.push({
+		screen: "exit",
+		show: void 0,
+		isComplete: void 0
+	});
+	return entries;
+}
+//#endregion
+//#region src/ui/tui/flows.ts
+/** Named flows the router can run */
+let Flow = /* @__PURE__ */ function(Flow) {
+	Flow["PostHogIntegration"] = "posthog-integration";
+	Flow["RevenueAnalyticsSetup"] = "revenue-analytics-setup";
+	Flow["AgentSkill"] = "agent-skill";
+	Flow["McpAdd"] = "mcp-add";
+	Flow["McpRemove"] = "mcp-remove";
+	return Flow;
+}({});
+/** Raw workflow step arrays — used by the store for gate/onInit definitions. */
+const WORKFLOW_STEPS = {
+	...Object.fromEntries(WORKFLOW_REGISTRY.map((c) => [c.flowKey, c.steps])),
+	["agent-skill"]: AGENT_SKILL_STEPS
+};
+/**
+* All flow pipelines.
+*
+* Workflow-based flows are derived from the registry.
+* MCP add/remove flows are standalone.
+*/
+const FLOWS = {
+	...Object.fromEntries(WORKFLOW_REGISTRY.map((c) => [c.flowKey, workflowToFlowEntries(c.steps)])),
+	["agent-skill"]: workflowToFlowEntries(AGENT_SKILL_STEPS),
+	["mcp-add"]: [
+		{
+			screen: "mcp-add",
+			isComplete: (s) => s.mcpComplete
+		},
+		{ screen: "outro" },
+		{ screen: "exit" }
+	],
+	["mcp-remove"]: [
+		{
+			screen: "mcp-remove",
+			isComplete: (s) => s.mcpComplete
+		},
+		{ screen: "outro" },
+		{ screen: "exit" }
+	]
+};
+//#endregion
+//#region src/ui/tui/router.ts
+var router_exports = /* @__PURE__ */ __exportAll({
+	Flow: () => Flow,
+	WizardRouter: () => WizardRouter
+});
+var WizardRouter = class {
+	flow;
+	flowName;
+	overlays = [];
+	constructor(flowName = "posthog-integration") {
+		this.flowName = flowName;
+		this.flow = FLOWS[flowName];
+	}
+	/**
+	* Resolve which screen should be active based on session state.
+	* Walks the flow pipeline, skipping hidden entries and completed entries,
+	* returns the first incomplete screen.
+	*/
+	resolve(session) {
+		if (this.overlays.length > 0) return this.overlays[this.overlays.length - 1];
+		for (const entry of this.flow) {
+			if (entry.show && !entry.show(session)) continue;
+			if (entry.isComplete && entry.isComplete(session)) continue;
+			return entry.screen;
+		}
+		return this.flow[this.flow.length - 1].screen;
+	}
+	/** The screen that should be rendered right now. */
+	get activeScreen() {
+		if (this.overlays.length > 0) return this.overlays[this.overlays.length - 1];
+		return this.flow[0].screen;
+	}
+	/** The name of the active flow. */
+	get activeFlow() {
+		return this.flowName;
+	}
+	/** Whether an overlay is currently active. */
+	get hasOverlay() {
+		return this.overlays.length > 0;
+	}
+	/**
+	* Push an overlay that interrupts the current flow.
+	* The flow resumes when the overlay is dismissed via popOverlay().
+	*/
+	pushOverlay(overlay) {
+		this.overlays.push(overlay);
+	}
+	/**
+	* Dismiss the topmost overlay. The flow screen underneath resumes.
+	*/
+	popOverlay() {
+		this.overlays.pop();
+	}
+	/**
+	* Direction hint for screen transitions.
+	*/
+	_lastDirection = null;
+	get lastNavDirection() {
+		return this._lastDirection;
+	}
+	/** @internal — called by store wrapper to track direction */
+	_setDirection(dir) {
+		this._lastDirection = dir;
+	}
+};
+//#endregion
+export { WORKFLOW_STEPS as i, router_exports as n, Flow as r, WizardRouter as t };
+
+//# sourceMappingURL=router-D5A1Sb4p.js.map

package/dist/router-D5A1Sb4p.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-D5A1Sb4p.js","names":[],"sources":["../src/lib/workflows/workflow-step.ts","../src/ui/tui/flows.ts","../src/ui/tui/router.ts"],"sourcesContent":["import type { WizardSession, DiscoveredFeature } from '../wizard-session';\nimport type { WizardReadinessResult } from '../health-checks/readiness.js';\nimport type { WorkflowRun } from '../agent/agent-runner.js';\nimport type { Integration } from '../constants.js';\nimport type { FrameworkConfig } from '../framework-config.js';\n\n/**\n * A workflow step is the primary unit of the wizard's execution model.\n *\n * It can own:\n * - a screen in the TUI (optional — some steps are headless)\n * - agent work via a workflow reference (optional — some steps are UI-only)\n * - completion and visibility predicates\n *\n * The current PostHog integration flow is one ordered list of steps.\n * Future flows (e.g. revenue analytics) register a different step list.\n */\n/**\n * Context passed to onInit callbacks — fires during store construction,\n * before bin.ts has assigned the real session.\n */\nexport interface StoreInitContext {\n  readonly session: WizardSession;\n  readonly setReadinessResult: (result: WizardReadinessResult | null) => void;\n  readonly setFrameworkContext: (key: string, value: unknown) => void;\n  readonly emitChange: () => void;\n}\n\n/**\n * Context passed to onReady callbacks — fires after bin.ts has assigned\n * the real session, so reading `session.installDir` returns the target\n * project. Use for async pre-flow work like prerequisite detection.\n */\nexport interface WorkflowReadyContext {\n  readonly session: WizardSession;\n  readonly setFrameworkContext: (key: string, value: unknown) => void;\n\n  // Detection-specific methods — used by core-integration's detect step\n  readonly setFrameworkConfig: (\n    integration: Integration,\n    config: FrameworkConfig,\n  ) => void;\n  readonly setDetectedFramework: (label: string) => void;\n  readonly setUnsupportedVersion: (info: {\n    current: string;\n    minimum: string;\n    docsUrl: string;\n  }) => void;\n  readonly addDiscoveredFeature: (feature: DiscoveredFeature) => void;\n  readonly setDetectionComplete: () => void;\n}\n\nexport interface WorkflowStep {\n  /** Unique identifier for this step */\n  id: string;\n\n  /** Human-readable label for progress display */\n  label: string;\n\n  /**\n   * TUI screen this step owns, if any.\n   * Matches the Screen enum values (e.g. 'intro', 'run', 'outro').\n   */\n  screen?: string;\n\n  /**\n   * Whether this step should be visible in the current flow.\n   * If omitted, the step is always visible.\n   */\n  show?: (session: WizardSession) => boolean;\n\n  /**\n   * Exit condition for the screen. Router advances when true.\n   * Defaults to `gate` if unset.\n   */\n  isComplete?: (session: WizardSession) => boolean;\n\n  /**\n   * Define a gate if your screen needs to await user interactions.\n   * bin.ts can `await store.getGate(stepId)` to pause until the\n   * predicate becomes true.\n   */\n  gate?: (session: WizardSession) => boolean;\n\n  /**\n   * Called once during store construction, with the default session.\n   * Use for session-independent fire-and-forget work that should start\n   * as early as possible (e.g. health check kicked off while the user\n   * is still reading the intro screen).\n   */\n  onInit?: (ctx: StoreInitContext) => void;\n\n  /**\n   * Called once after bin.ts has assigned the real session to the store,\n   * before any gate is awaited. Awaited in sequence with other steps'\n   * onReady callbacks. Use for session-dependent pre-flow work like\n   * scanning the installDir for prerequisites. May be sync or async.\n   */\n  onReady?: (ctx: WorkflowReadyContext) => void | Promise<void>;\n}\n\n/**\n * An ordered list of workflow steps that defines a wizard flow.\n */\nexport type Workflow = WorkflowStep[];\n\n/**\n * Uniform configuration for a wizard workflow.\n *\n * Each workflow directory exports one of these. The system uses it\n * for CLI registration, flow/step wiring, and skill bootstrap.\n */\nexport interface WorkflowConfig {\n  /** CLI command name (e.g. 'revenue'). Omit for the default flow. */\n  command?: string;\n  /** CLI description shown in --help */\n  description: string;\n  /** Unique flow key — matches the Flow enum value */\n  flowKey: string;\n  /** The ordered step list */\n  steps: Workflow;\n  /** Agent run config. Static object or async function for dynamic config. */\n  run?: WorkflowRun | ((session: WizardSession) => Promise<WorkflowRun>);\n  /** Prerequisites: other workflow flowKeys that must have run first */\n  requires?: string[];\n}\n\n/**\n * Project a Workflow into the narrower FlowEntry shape the router consumes.\n *\n * Two things happen here:\n *   1. Headless steps (no `screen`) are filtered out. The router walks\n *      visible screens; gate-only steps like `detect` are store concerns.\n *   2. The step is narrowed to just { screen, show, isComplete } — the\n *      router has no business touching gate, onInit, id, or label.\n *\n * This intentional separation keeps the router focused on one question:\n * \"Which screen should be rendered right now?\"\n */\nexport function workflowToFlowEntries(workflow: Workflow): Array<{\n  screen: string;\n  show?: (session: WizardSession) => boolean;\n  isComplete?: (session: WizardSession) => boolean;\n}> {\n  const entries = workflow\n    .filter((step) => step.screen != null)\n    .map((step) => ({\n      screen: step.screen!,\n      show: step.show,\n      // `isComplete` defaults to `gate` — for most steps they're the same\n      // predicate (e.g. intro: setupConfirmed unblocks bin.ts AND finishes\n      // the screen). Only override when the two conditions diverge.\n      isComplete: step.isComplete ?? step.gate,\n    }));\n\n  // Every workflow ends with the exit screen.\n  entries.push({ screen: 'exit', show: undefined, isComplete: undefined });\n\n  return entries;\n}\n","/**\n * Flow pipelines — declarative screen sequences for each wizard flow.\n *\n * Owns the Screen and Flow enums (re-exported by router.ts) to avoid\n * circular imports between router ↔ flows.\n *\n * Workflow-based flows are derived from WORKFLOW_REGISTRY via\n * workflowToFlowEntries(). MCP add/remove flows are standalone since\n * they don't go through the agent runner.\n */\n\nimport type { WizardSession } from '../../lib/wizard-session.js';\nimport {\n  workflowToFlowEntries,\n  type Workflow,\n} from '../../lib/workflows/workflow-step.js';\nimport { WORKFLOW_REGISTRY } from '../../lib/workflows/workflow-registry.js';\nimport { AGENT_SKILL_STEPS } from '../../lib/workflows/agent-skill/index.js';\n\n// ── Screen + Flow enums ──────────────────────────────────────────────\n\n/** Screens that participate in linear flows */\nexport enum Screen {\n  Intro = 'intro',\n  RevenueIntro = 'revenue-intro',\n  AgentSkillIntro = 'agent-skill-intro',\n  HealthCheck = 'health-check',\n  Setup = 'setup',\n  Auth = 'auth',\n  Run = 'run',\n  Mcp = 'mcp',\n  KeepSkills = 'keep-skills',\n  Outro = 'outro',\n  Exit = 'exit',\n  McpAdd = 'mcp-add',\n  McpRemove = 'mcp-remove',\n}\n\n/** Named flows the router can run */\nexport enum Flow {\n  PostHogIntegration = 'posthog-integration',\n  RevenueAnalyticsSetup = 'revenue-analytics-setup',\n  AgentSkill = 'agent-skill',\n  McpAdd = 'mcp-add',\n  McpRemove = 'mcp-remove',\n}\n\n// ── Flow definitions ─────────────────────────────────────────────────\n\nexport interface FlowEntry {\n  /** Screen to show */\n  screen: Screen;\n  /** If provided, screen is skipped when this returns false. Omit = always show. */\n  show?: (session: WizardSession) => boolean;\n  /** If provided, screen is considered complete when this returns true. */\n  isComplete?: (session: WizardSession) => boolean;\n}\n\n// ── Derived from WORKFLOW_REGISTRY ───────────────────────────────────\n\n/** Raw workflow step arrays — used by the store for gate/onInit definitions. */\nexport const WORKFLOW_STEPS: Partial<Record<Flow, Workflow>> = {\n  ...(Object.fromEntries(\n    WORKFLOW_REGISTRY.map((c) => [c.flowKey, c.steps]),\n  ) as Partial<Record<Flow, Workflow>>),\n  [Flow.AgentSkill]: AGENT_SKILL_STEPS,\n};\n\n/**\n * All flow pipelines.\n *\n * Workflow-based flows are derived from the registry.\n * MCP add/remove flows are standalone.\n */\nexport const FLOWS: Record<Flow, FlowEntry[]> = {\n  // Derive workflow flows from registry\n  ...(Object.fromEntries(\n    WORKFLOW_REGISTRY.map((c) => [\n      c.flowKey,\n      workflowToFlowEntries(c.steps) as FlowEntry[],\n    ]),\n  ) as Record<Flow, FlowEntry[]>),\n\n  // Generic agent skill flow\n  [Flow.AgentSkill]: workflowToFlowEntries(AGENT_SKILL_STEPS) as FlowEntry[],\n\n  // Standalone MCP flows\n  [Flow.McpAdd]: [\n    {\n      screen: Screen.McpAdd,\n      isComplete: (s) => s.mcpComplete,\n    },\n    { screen: Screen.Outro },\n    { screen: Screen.Exit },\n  ],\n\n  [Flow.McpRemove]: [\n    {\n      screen: Screen.McpRemove,\n      isComplete: (s) => s.mcpComplete,\n    },\n    { screen: Screen.Outro },\n    { screen: Screen.Exit },\n  ],\n};\n","/**\n * WizardRouter — declarative flow pipelines + overlay stack.\n *\n * Two layers:\n *   Flow cursor    — linear pipeline of screens, advanced with next()\n *   Overlay stack  — interrupts (outage, auth-expired, etc.) that push/pop\n *\n * The visible screen is: top of overlay stack if non-empty, otherwise the flow cursor.\n *\n * Adding a flow screen = append to a pipeline array.\n * Adding an overlay = call pushOverlay() from anywhere.\n * No switch statements, no hardcoded transitions in business logic.\n */\n\nimport type { WizardSession } from '../../lib/wizard-session.js';\nimport { FLOWS, Screen, Flow, type FlowEntry } from './flows.js';\n\n// Re-export so existing imports from './router.js' keep working\nexport { Screen, Flow };\nexport type { FlowEntry };\n\n// ── Screen name taxonomy ──────────────────────────────────────────────\n\n/** Screens that interrupt flows as overlays */\nexport enum Overlay {\n  SettingsOverride = 'settings-override',\n  ManagedSettings = 'managed-settings',\n  PortConflict = 'port-conflict',\n  AuthError = 'auth-error',\n}\n\n/** Union of all screen names */\nexport type ScreenName = Screen | Overlay;\n\n// ── Router ────────────────────────────────────────────────────────────\n\nexport class WizardRouter {\n  private flow: FlowEntry[];\n  private flowName: Flow;\n  private overlays: Overlay[] = [];\n\n  constructor(flowName: Flow = Flow.PostHogIntegration) {\n    this.flowName = flowName;\n    this.flow = FLOWS[flowName];\n  }\n\n  /**\n   * Resolve which screen should be active based on session state.\n   * Walks the flow pipeline, skipping hidden entries and completed entries,\n   * returns the first incomplete screen.\n   */\n  resolve(session: WizardSession): ScreenName {\n    if (this.overlays.length > 0) {\n      return this.overlays[this.overlays.length - 1];\n    }\n\n    for (const entry of this.flow) {\n      if (entry.show && !entry.show(session)) continue;\n      if (entry.isComplete && entry.isComplete(session)) continue;\n      return entry.screen;\n    }\n\n    // All entries complete — show the last screen (outro)\n    return this.flow[this.flow.length - 1].screen;\n  }\n\n  /** The screen that should be rendered right now. */\n  get activeScreen(): ScreenName {\n    // Overlays take priority — resolve() handles this too,\n    // but activeScreen is called before session is available in some paths\n    if (this.overlays.length > 0) {\n      return this.overlays[this.overlays.length - 1];\n    }\n    return this.flow[0].screen;\n  }\n\n  /** The name of the active flow. */\n  get activeFlow(): Flow {\n    return this.flowName;\n  }\n\n  /** Whether an overlay is currently active. */\n  get hasOverlay(): boolean {\n    return this.overlays.length > 0;\n  }\n\n  /**\n   * Push an overlay that interrupts the current flow.\n   * The flow resumes when the overlay is dismissed via popOverlay().\n   */\n  pushOverlay(overlay: Overlay): void {\n    this.overlays.push(overlay);\n  }\n\n  /**\n   * Dismiss the topmost overlay. The flow screen underneath resumes.\n   */\n  popOverlay(): void {\n    this.overlays.pop();\n  }\n\n  /**\n   * Direction hint for screen transitions.\n   */\n  private _lastDirection: 'push' | 'pop' | null = null;\n\n  get lastNavDirection(): 'push' | 'pop' | null {\n    return this._lastDirection;\n  }\n\n  /** @internal — called by store wrapper to track direction */\n  _setDirection(dir: 'push' | 'pop' | null): void {\n    this._lastDirection = dir;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;AA2IA,SAAgB,sBAAsB,UAInC;CACD,MAAM,UAAU,SACb,QAAQ,SAAS,KAAK,UAAU,KAAK,CACrC,KAAK,UAAU;EACd,QAAQ,KAAK;EACb,MAAM,KAAK;EAIX,YAAY,KAAK,cAAc,KAAK;EACrC,EAAE;AAGL,SAAQ,KAAK;EAAE,QAAQ;EAAQ,MAAM,KAAA;EAAW,YAAY,KAAA;EAAW,CAAC;AAExE,QAAO;;;;;ACvHT,IAAY,OAAL,yBAAA,MAAA;AACL,MAAA,wBAAA;AACA,MAAA,2BAAA;AACA,MAAA,gBAAA;AACA,MAAA,YAAA;AACA,MAAA,eAAA;;KACD;;AAgBD,MAAa,iBAAkD;CAC7D,GAAI,OAAO,YACT,kBAAkB,KAAK,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CACnD;kBACkB;CACpB;;;;;;;AAQD,MAAa,QAAmC;CAE9C,GAAI,OAAO,YACT,kBAAkB,KAAK,MAAM,CAC3B,EAAE,SACF,sBAAsB,EAAE,MAAM,CAC/B,CAAC,CACH;kBAGkB,sBAAsB,kBAAkB;cAG5C;EACb;GACE,QAAA;GACA,aAAa,MAAM,EAAE;GACtB;EACD,EAAE,QAAA,SAAsB;EACxB,EAAE,QAAA,QAAqB;EACxB;iBAEiB;EAChB;GACE,QAAA;GACA,aAAa,MAAM,EAAE;GACtB;EACD,EAAE,QAAA,SAAsB;EACxB,EAAE,QAAA,QAAqB;EACxB;CACF;;;;;;;ACpED,IAAa,eAAb,MAA0B;CACxB;CACA;CACA,WAA8B,EAAE;CAEhC,YAAY,WAAA,uBAA0C;AACpD,OAAK,WAAW;AAChB,OAAK,OAAO,MAAM;;;;;;;CAQpB,QAAQ,SAAoC;AAC1C,MAAI,KAAK,SAAS,SAAS,EACzB,QAAO,KAAK,SAAS,KAAK,SAAS,SAAS;AAG9C,OAAK,MAAM,SAAS,KAAK,MAAM;AAC7B,OAAI,MAAM,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAE;AACxC,OAAI,MAAM,cAAc,MAAM,WAAW,QAAQ,CAAE;AACnD,UAAO,MAAM;;AAIf,SAAO,KAAK,KAAK,KAAK,KAAK,SAAS,GAAG;;;CAIzC,IAAI,eAA2B;AAG7B,MAAI,KAAK,SAAS,SAAS,EACzB,QAAO,KAAK,SAAS,KAAK,SAAS,SAAS;AAE9C,SAAO,KAAK,KAAK,GAAG;;;CAItB,IAAI,aAAmB;AACrB,SAAO,KAAK;;;CAId,IAAI,aAAsB;AACxB,SAAO,KAAK,SAAS,SAAS;;;;;;CAOhC,YAAY,SAAwB;AAClC,OAAK,SAAS,KAAK,QAAQ;;;;;CAM7B,aAAmB;AACjB,OAAK,SAAS,KAAK;;;;;CAMrB,iBAAgD;CAEhD,IAAI,mBAA0C;AAC5C,SAAO,KAAK;;;CAId,cAAc,KAAkC;AAC9C,OAAK,iBAAiB"}