@posthog/wizard 2.8.0 → 2.9.1

package/dist/src/ui/tui/__tests__/router.test.js

@@ -0,0 +1,87 @@
+import { buildSession, RunPhase } from '../../../lib/wizard-session.js';
+import { WizardReadiness } from '../../../lib/health-checks/readiness.js';
+import { WizardRouter, Flow, Screen, Overlay } from '../router.js';
+function baseWizardSession() {
+    return buildSession({});
+}
+describe('WizardRouter', () => {
+    describe('resolve', () => {
+        it('returns the first incomplete visible screen for the wizard flow', () => {
+            const router = new WizardRouter(Flow.PostHogIntegration);
+            const session = baseWizardSession();
+            expect(router.resolve(session)).toBe(Screen.Intro);
+            session.setupConfirmed = true;
+            session.readinessResult = {
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            };
+            session.credentials = {
+                accessToken: 'tok',
+                projectApiKey: 'pk',
+                host: 'https://app.posthog.com',
+                projectId: 1,
+            };
+            expect(router.resolve(session)).toBe(Screen.Run);
+        });
+        it('skips the setup screen when there are no unanswered framework questions', () => {
+            const router = new WizardRouter(Flow.PostHogIntegration);
+            const session = baseWizardSession();
+            session.setupConfirmed = true;
+            session.readinessResult = {
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            };
+            session.frameworkConfig = {
+                metadata: {
+                    setup: {
+                        questions: [{ key: 'packageManager' }],
+                    },
+                },
+            };
+            session.frameworkContext = { packageManager: 'pnpm' };
+            expect(router.resolve(session)).toBe(Screen.Auth);
+        });
+        it('returns the last flow screen when every entry is complete', () => {
+            const router = new WizardRouter(Flow.PostHogIntegration);
+            const session = baseWizardSession();
+            session.setupConfirmed = true;
+            session.readinessResult = {
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            };
+            session.credentials = {
+                accessToken: 'tok',
+                projectApiKey: 'pk',
+                host: 'https://app.posthog.com',
+                projectId: 1,
+            };
+            session.runPhase = RunPhase.Completed;
+            session.mcpComplete = true;
+            expect(router.resolve(session)).toBe(Screen.Outro);
+        });
+        it('gives the topmost overlay precedence over the flow screen', () => {
+            const router = new WizardRouter(Flow.PostHogIntegration);
+            const session = baseWizardSession();
+            router.pushOverlay(Overlay.SettingsOverride);
+            router.pushOverlay(Overlay.AuthError);
+            expect(router.resolve(session)).toBe(Overlay.AuthError);
+            router.popOverlay();
+            expect(router.resolve(session)).toBe(Overlay.SettingsOverride);
+        });
+    });
+    describe('activeScreen', () => {
+        it('defaults to the first screen in the active flow', () => {
+            const router = new WizardRouter(Flow.McpRemove);
+            expect(router.activeScreen).toBe(Screen.McpRemove);
+        });
+        it('returns the top overlay when overlays are active', () => {
+            const router = new WizardRouter(Flow.PostHogIntegration);
+            router.pushOverlay(Overlay.ManagedSettings);
+            expect(router.activeScreen).toBe(Overlay.ManagedSettings);
+        });
+    });
+});
+//# sourceMappingURL=router.test.js.map

package/dist/src/ui/tui/__tests__/router.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.test.js","sourceRoot":"","sources":["../../../../../src/ui/tui/__tests__/router.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEnE,SAAS,iBAAiB;IACxB,OAAO,YAAY,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC;AAED,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;YAEpC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAEnD,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;YAC9B,OAAO,CAAC,eAAe,GAAG;gBACxB,QAAQ,EAAE,eAAe,CAAC,GAAG;gBAC7B,MAAM,EAAE,EAAW;gBACnB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,OAAO,CAAC,WAAW,GAAG;gBACpB,WAAW,EAAE,KAAK;gBAClB,aAAa,EAAE,IAAI;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,SAAS,EAAE,CAAC;aACb,CAAC;YAEF,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE;YACjF,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;YAEpC,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;YAC9B,OAAO,CAAC,eAAe,GAAG;gBACxB,QAAQ,EAAE,eAAe,CAAC,GAAG;gBAC7B,MAAM,EAAE,EAAW;gBACnB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,OAAO,CAAC,eAAe,GAAG;gBACxB,QAAQ,EAAE;oBACR,KAAK,EAAE;wBACL,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,gBAAgB,EAAE,CAAC;qBACvC;iBACF;aACO,CAAC;YACX,OAAO,CAAC,gBAAgB,GAAG,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC;YAEtD,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;YAEpC,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;YAC9B,OAAO,CAAC,eAAe,GAAG;gBACxB,QAAQ,EAAE,eAAe,CAAC,GAAG;gBAC7B,MAAM,EAAE,EAAW;gBACnB,OAAO,EAAE,EAAE;aACZ,CAAC;YACF,OAAO,CAAC,WAAW,GAAG;gBACpB,WAAW,EAAE,KAAK;gBAClB,aAAa,EAAE,IAAI;gBACnB,IAAI,EAAE,yBAAyB;gBAC/B,SAAS,EAAE,CAAC;aACb,CAAC;YACF,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,SAAS,CAAC;YACtC,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;YAE3B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACzD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;YAEpC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC7C,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAEtC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAExD,MAAM,CAAC,UAAU,EAAE,CAAC;YACpB,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAEhD,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;YAEzD,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAE5C,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { buildSession, RunPhase } from '../../../lib/wizard-session.js';\nimport { WizardReadiness } from '../../../lib/health-checks/readiness.js';\nimport { WizardRouter, Flow, Screen, Overlay } from '../router.js';\n\nfunction baseWizardSession() {\n  return buildSession({});\n}\n\ndescribe('WizardRouter', () => {\n  describe('resolve', () => {\n    it('returns the first incomplete visible screen for the wizard flow', () => {\n      const router = new WizardRouter(Flow.PostHogIntegration);\n      const session = baseWizardSession();\n\n      expect(router.resolve(session)).toBe(Screen.Intro);\n\n      session.setupConfirmed = true;\n      session.readinessResult = {\n        decision: WizardReadiness.Yes,\n        health: {} as never,\n        reasons: [],\n      };\n      session.credentials = {\n        accessToken: 'tok',\n        projectApiKey: 'pk',\n        host: 'https://app.posthog.com',\n        projectId: 1,\n      };\n\n      expect(router.resolve(session)).toBe(Screen.Run);\n    });\n\n    it('skips the setup screen when there are no unanswered framework questions', () => {\n      const router = new WizardRouter(Flow.PostHogIntegration);\n      const session = baseWizardSession();\n\n      session.setupConfirmed = true;\n      session.readinessResult = {\n        decision: WizardReadiness.Yes,\n        health: {} as never,\n        reasons: [],\n      };\n      session.frameworkConfig = {\n        metadata: {\n          setup: {\n            questions: [{ key: 'packageManager' }],\n          },\n        },\n      } as never;\n      session.frameworkContext = { packageManager: 'pnpm' };\n\n      expect(router.resolve(session)).toBe(Screen.Auth);\n    });\n\n    it('returns the last flow screen when every entry is complete', () => {\n      const router = new WizardRouter(Flow.PostHogIntegration);\n      const session = baseWizardSession();\n\n      session.setupConfirmed = true;\n      session.readinessResult = {\n        decision: WizardReadiness.Yes,\n        health: {} as never,\n        reasons: [],\n      };\n      session.credentials = {\n        accessToken: 'tok',\n        projectApiKey: 'pk',\n        host: 'https://app.posthog.com',\n        projectId: 1,\n      };\n      session.runPhase = RunPhase.Completed;\n      session.mcpComplete = true;\n\n      expect(router.resolve(session)).toBe(Screen.Outro);\n    });\n\n    it('gives the topmost overlay precedence over the flow screen', () => {\n      const router = new WizardRouter(Flow.PostHogIntegration);\n      const session = baseWizardSession();\n\n      router.pushOverlay(Overlay.SettingsOverride);\n      router.pushOverlay(Overlay.AuthError);\n\n      expect(router.resolve(session)).toBe(Overlay.AuthError);\n\n      router.popOverlay();\n      expect(router.resolve(session)).toBe(Overlay.SettingsOverride);\n    });\n  });\n\n  describe('activeScreen', () => {\n    it('defaults to the first screen in the active flow', () => {\n      const router = new WizardRouter(Flow.McpRemove);\n\n      expect(router.activeScreen).toBe(Screen.McpRemove);\n    });\n\n    it('returns the top overlay when overlays are active', () => {\n      const router = new WizardRouter(Flow.PostHogIntegration);\n\n      router.pushOverlay(Overlay.ManagedSettings);\n\n      expect(router.activeScreen).toBe(Overlay.ManagedSettings);\n    });\n  });\n});\n"]}

package/dist/src/ui/tui/__tests__/store.test.js

@@ -1,6 +1,6 @@
 import { WizardStore, TaskStatus, Flow, Screen, Overlay, RunPhase, McpOutcome, } from '../store.js';
 import { OutroKind, AdditionalFeature } from '../../../lib/wizard-session.js';
-import { WizardReadiness } from '../../../lib/health-checks/readiness.js';
+import { WizardReadiness, evaluateWizardReadiness, } from '../../../lib/health-checks/readiness.js';
 import { buildSession } from '../../../lib/wizard-session.js';
 import { Integration } from '../../../lib/constants.js';
 import { analytics } from '../../../utils/analytics.js';
@@ -30,9 +30,19 @@ function createStore(flow) {
     return new WizardStore(flow);
 }
 const wizardCaptureMock = analytics.wizardCapture;
+const evaluateWizardReadinessMock = evaluateWizardReadiness;
+async function flushMicrotasks() {
+    await Promise.resolve();
+    await Promise.resolve();
+}
 describe('WizardStore', () => {
     beforeEach(() => {
         jest.clearAllMocks();
+        evaluateWizardReadinessMock.mockResolvedValue({
+            decision: WizardReadiness.Yes,
+            health: {},
+            reasons: [],
+        });
     });
     // ── Construction ─────────────────────────────────────────────────
     describe('constructor', () => {
@@ -45,7 +55,7 @@ describe('WizardStore', () => {
         });
         it('defaults to Wizard flow', () => {
             const store = createStore();
-            expect(store.router.activeFlow).toBe(Flow.Wizard);
+            expect(store.router.activeFlow).toBe(Flow.PostHogIntegration);
         });
         it('accepts a custom flow', () => {
             const store = createStore(Flow.McpAdd);
@@ -112,13 +122,13 @@ describe('WizardStore', () => {
     });
     // ── Session setters ──────────────────────────────────────────────
     describe('session setters', () => {
-        it('completeSetup sets setupConfirmed and resolves setupComplete promise', async () => {
+        it('completeSetup sets setupConfirmed and resolves intro gate', async () => {
             const store = createStore();
             const cb = jest.fn();
             store.subscribe(cb);
             store.completeSetup();
             expect(store.session.setupConfirmed).toBe(true);
-            await store.setupComplete;
+            await store.getGate('intro');
             expect(cb).toHaveBeenCalled();
         });
         it('setRunPhase updates session.runPhase', () => {
@@ -342,7 +352,7 @@ describe('WizardStore', () => {
             store.setRunPhase(RunPhase.Completed);
             store.setMcpComplete();
             store.setOutroDismissed();
-            expect(store.currentScreen).toBe(Screen.Skills);
+            expect(store.currentScreen).toBe(Screen.KeepSkills);
         });
         it('starts at McpAdd for McpAdd flow', () => {
             const store = createStore(Flow.McpAdd);
@@ -720,7 +730,7 @@ describe('WizardStore', () => {
             const store = createStore();
             store.completeSetup();
             store.completeSetup(); // second call — promise already resolved
-            await store.setupComplete;
+            await store.getGate('intro');
             expect(store.session.setupConfirmed).toBe(true);
         });
         it('version property (string) is independent from internal _version counter', () => {
@@ -735,7 +745,7 @@ describe('WizardStore', () => {
     });
     // ── Full wizard flow simulation ──────────────────────────────────
     describe('full wizard flow', () => {
-        it('walks through the entire wizard flow correctly', () => {
+        it('walks through the posthog integration flow correctly', () => {
             const store = createStore();
             const screenHistory = [];
             store.subscribe(() => screenHistory.push(store.currentScreen));
@@ -768,30 +778,156 @@ describe('WizardStore', () => {
             expect(store.currentScreen).toBe(Screen.Outro);
             // Step 6: Dismiss outro
             store.setOutroDismissed();
-            expect(store.currentScreen).toBe(Screen.Skills);
+            expect(store.currentScreen).toBe(Screen.KeepSkills);
             // Verify version was bumped for each setter call
             expect(store.getVersion()).toBe(7);
         });
+        it('walks through the revenue analytics flow correctly', () => {
+            const store = createStore(Flow.RevenueAnalyticsSetup);
+            expect(store.currentScreen).toBe(Screen.RevenueIntro);
+            // Step 1: Confirm intro
+            store.completeSetup();
+            expect(store.currentScreen).toBe(Screen.Auth);
+            // Step 2: Authenticate
+            store.setCredentials({
+                accessToken: 'tok',
+                projectApiKey: 'pk',
+                host: 'https://app.posthog.com',
+                projectId: 1,
+            });
+            expect(store.currentScreen).toBe(Screen.Run);
+            // Step 3: Start and complete run
+            store.setRunPhase(RunPhase.Running);
+            expect(store.currentScreen).toBe(Screen.Run);
+            store.setRunPhase(RunPhase.Completed);
+            expect(store.currentScreen).toBe(Screen.Outro);
+            // Step 4: Dismiss outro
+            store.setOutroDismissed();
+            expect(store.currentScreen).toBe('skills');
+        });
+        it('walks through the agent skill flow correctly', () => {
+            const store = createStore(Flow.AgentSkill);
+            expect(store.currentScreen).toBe(Screen.AgentSkillIntro);
+            // Step 1: Confirm intro
+            store.completeSetup();
+            expect(store.currentScreen).toBe(Screen.Auth);
+            // Step 2: Authenticate
+            store.setCredentials({
+                accessToken: 'tok',
+                projectApiKey: 'pk',
+                host: 'https://app.posthog.com',
+                projectId: 1,
+            });
+            expect(store.currentScreen).toBe(Screen.Run);
+            // Step 3: Start and complete run
+            store.setRunPhase(RunPhase.Running);
+            expect(store.currentScreen).toBe(Screen.Run);
+            store.setRunPhase(RunPhase.Completed);
+            expect(store.currentScreen).toBe(Screen.Outro);
+            // Step 4: Dismiss outro
+            store.setOutroDismissed();
+            expect(store.currentScreen).toBe('skills');
+        });
+    });
+    // ── health-check gate ────────────────────────────────────────────
+    describe('health-check gate', () => {
+        it('resolves immediately for non-Wizard flows', async () => {
+            const store = createStore(Flow.McpAdd);
+            await expect(store.getGate('health-check')).resolves.toBeUndefined();
+        });
+        it('resolves automatically when readiness is non-blocking', async () => {
+            evaluateWizardReadinessMock.mockResolvedValueOnce({
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            });
+            const store = createStore();
+            let resolved = false;
+            void store.getGate('health-check').then(() => {
+                resolved = true;
+            });
+            await flushMicrotasks();
+            expect(resolved).toBe(true);
+            expect(store.session.readinessResult).toEqual({
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            });
+        });
+        it('stays pending for blocking readiness until outage is dismissed', async () => {
+            evaluateWizardReadinessMock.mockResolvedValueOnce({
+                decision: WizardReadiness.No,
+                health: {},
+                reasons: ['Anthropic: down'],
+            });
+            const store = createStore();
+            let resolved = false;
+            void store.getGate('health-check').then(() => {
+                resolved = true;
+            });
+            await flushMicrotasks();
+            expect(resolved).toBe(false);
+            expect(store.currentScreen).toBe(Screen.Intro);
+            store.dismissOutage();
+            await store.getGate('health-check');
+            expect(resolved).toBe(true);
+            expect(store.session.outageDismissed).toBe(true);
+        });
+    });
+    // ── Screen transition analytics ───────────────────────────────────
+    describe('screen transition analytics', () => {
+        it('fires when a real screen transition occurs after the initial screen', () => {
+            const store = createStore();
+            store.completeSetup();
+            wizardCaptureMock.mockClear();
+            store.setReadinessResult({
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            });
+            expect(wizardCaptureMock).toHaveBeenCalledWith('screen auth', expect.objectContaining({
+                from_screen: Screen.HealthCheck,
+            }));
+        });
+        it('does not fire a screen event when the visible screen stays the same', () => {
+            const store = createStore();
+            store.completeSetup();
+            store.setReadinessResult({
+                decision: WizardReadiness.Yes,
+                health: {},
+                reasons: [],
+            });
+            store.setCredentials({
+                accessToken: 'tok',
+                projectApiKey: 'pk',
+                host: 'h',
+                projectId: 1,
+            });
+            wizardCaptureMock.mockClear();
+            store.setRunPhase(RunPhase.Running);
+            expect(store.currentScreen).toBe(Screen.Run);
+            expect(wizardCaptureMock.mock.calls.some(([event]) => typeof event === 'string' && event.startsWith('screen '))).toBe(false);
+        });
     });
-    // ── setupComplete promise ────────────────────────────────────────
-    describe('setupComplete', () => {
+    // ── intro gate ──────────────────────────────────────────────────
+    describe('intro gate', () => {
         it('resolves when completeSetup is called', async () => {
             const store = createStore();
             store.completeSetup();
-            await store.setupComplete;
+            await store.getGate('intro');
             expect(store.session.setupConfirmed).toBe(true);
         });
         it('is a promise that can be awaited before completeSetup is called', async () => {
             const store = createStore();
             let resolved = false;
-            void store.setupComplete.then(() => {
+            void store.getGate('intro').then(() => {
                 resolved = true;
             });
             // Not yet resolved
             await Promise.resolve(); // flush microtasks
             expect(resolved).toBe(false);
             store.completeSetup();
-            await store.setupComplete;
+            await store.getGate('intro');
             expect(resolved).toBe(true);
         });
     });