@contentful/experience-design-system-cli 2.37.1-dev-build-64f41b0b.0 → 2.37.1-dev-build-97b615d3.0

package/dist/app.js

@@ -2018,7 +2018,7 @@ var init_cache_keys = __esm({
 
 // packages/experience-design-system-cli/app.tsx
 import { join as join25 } from "node:path";
-import { useEffect as useEffect27, useState as useState33 } from "react";
+import { useEffect as useEffect26, useState as useState33 } from "react";
 
 // packages/experience-design-system-cli/src/tui/home/home.tsx
 import { useEffect as useEffect2, useState as useState2 } from "react";
@@ -20584,7 +20584,6 @@ function buildFlowStart(input) {
 }
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/screen.tsx
-import { useEffect as useEffect20, useRef as useRef12 } from "react";
 import { Box as Box41 } from "ink";
 
 // packages/experience-design-system-types/dist/src/cdf/validate.js
@@ -26985,18 +26984,10 @@ function FlowScreen({
   controller,
   livePreview = true,
   generatePromptPath,
-  onExit,
-  onStepChange
+  onExit
 }) {
   const totalSteps = totalStepsFor(state);
   const quit = () => onExit(0);
-  const previousStep = useRef12(state.step);
-  useEffect20(() => {
-    if (previousStep.current !== state.step) {
-      onStepChange?.();
-      previousStep.current = state.step;
-    }
-  }, [state.step, onStepChange]);
   const content = (() => {
     switch (state.step) {
       case "final-review":
@@ -27122,7 +27113,7 @@ function FlowScreen({
 }
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/use-flow.ts
-import { useEffect as useEffect21, useRef as useRef13, useSyncExternalStore } from "react";
+import { useEffect as useEffect20, useRef as useRef12, useSyncExternalStore } from "react";
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/controller.ts
 import { appendFileSync, writeFileSync } from "node:fs";
@@ -27712,6 +27703,12 @@ function createFlowController(start, deps) {
       deps.log({ update: sanitizeForLog(patch) });
     } catch {
     }
+    if (patch.step !== void 0 && patch.step !== state.step) {
+      try {
+        deps.beforeStepChange?.();
+      } catch {
+      }
+    }
     state = { ...state, ...patch };
     for (const listener of listeners) listener();
   };
@@ -27849,28 +27846,32 @@ function createFlowController(start, deps) {
 }
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/use-flow.ts
-function useFlow(start, deps = realFlowDeps) {
-  const controller = useRef13();
+function useFlow(start, options = {}) {
+  const controller = useRef12();
   if (start && !controller.current) {
     try {
       startWizardLog();
     } catch {
     }
-    controller.current = createFlowController(start, deps());
+    const flowDeps = (options.deps ?? realFlowDeps)();
+    controller.current = createFlowController(start, {
+      ...flowDeps,
+      ...options.beforeStepChange ? { beforeStepChange: options.beforeStepChange } : {}
+    });
   }
   const current = controller.current;
   const state = useSyncExternalStore(
     (listener) => current?.subscribe(listener) ?? (() => void 0),
     () => current?.getState()
   );
-  useEffect21(() => {
+  useEffect20(() => {
     if (!start) controller.current = void 0;
   }, [start]);
   return current && state ? { controller: current, state } : void 0;
 }
 
 // packages/experience-design-system-cli/src/tui/help/PageContainer.tsx
-import { useEffect as useEffect22, useState as useState27 } from "react";
+import { useEffect as useEffect21, useState as useState27 } from "react";
 import { Box as Box42, Text as Text44, useInput as useInput9 } from "ink";
 
 // packages/experience-design-system-cli/src/tui/debug-store.ts
@@ -28064,7 +28065,7 @@ function Section({ title, rows }) {
 }
 function HelpScreen({ onDone }) {
   const [info, setInfo] = useState27();
-  useEffect22(() => {
+  useEffect21(() => {
     startDebugRun({ flow: "help", step: "01-help", menuOption: "Help", inputs: {} });
     void readHelpInfo().then(setInfo);
   }, []);
@@ -28157,7 +28158,7 @@ function SettingsScreen({
 }
 
 // packages/experience-design-system-cli/src/tui/settings/contentful-configuration/ContentfulConfigScreen.tsx
-import { useEffect as useEffect23, useState as useState29 } from "react";
+import { useEffect as useEffect22, useState as useState29 } from "react";
 import { Box as Box44, Text as Text46, useInput as useInput11 } from "ink";
 import TextInput4 from "ink-text-input";
 
@@ -28225,7 +28226,7 @@ function ConfigurationScreen({ onDone }) {
   const [lastSaved, setLastSaved] = useState29(null);
   const [editing, setEditing] = useState29(false);
   const [valueBeforeEdit, setValueBeforeEdit] = useState29("");
-  useEffect23(() => {
+  useEffect22(() => {
     readCredentials().then((cfg) => {
       setConfig(cfg);
       setStage("form");
@@ -28362,7 +28363,7 @@ function ConfigurationScreen({ onDone }) {
 }
 
 // packages/experience-design-system-cli/src/tui/settings/opt-in-analytics/screen.tsx
-import { useEffect as useEffect24, useState as useState30 } from "react";
+import { useEffect as useEffect23, useState as useState30 } from "react";
 import { Box as Box45, Text as Text47, useInput as useInput12 } from "ink";
 
 // packages/experience-design-system-cli/src/tui/settings/opt-in-analytics/analytics-store.ts
@@ -28385,7 +28386,7 @@ import { Fragment as Fragment18, jsx as jsx56, jsxs as jsxs46 } from "react/jsx-
 function OptInAnalyticsScreen({ onDone }) {
   const [loading, setLoading] = useState30(true);
   const [enabled, setEnabled] = useState30(true);
-  useEffect24(() => {
+  useEffect23(() => {
     readAnalyticsSetting().then((setting) => {
       setEnabled(setting.enabled);
       setLoading(false);
@@ -28439,13 +28440,13 @@ function OptInAnalyticsScreen({ onDone }) {
 }
 
 // packages/experience-design-system-cli/src/tui/upgrade/PageContainer.tsx
-import { useEffect as useEffect25, useState as useState31 } from "react";
+import { useEffect as useEffect24, useState as useState31 } from "react";
 import { Box as Box46, Text as Text48, useInput as useInput13 } from "ink";
 import { jsx as jsx57, jsxs as jsxs47 } from "react/jsx-runtime";
 var UPGRADE_COMMANDS = ["git pull", "pnpm install", "pnpm build"];
 function UpgradeScreen({ onDone }) {
   const [upgradeCheck, setUpgradeCheck] = useState31();
-  useEffect25(() => {
+  useEffect24(() => {
     startDebugRun({
       flow: "upgrade",
       step: "01-upgrade",
@@ -28510,13 +28511,13 @@ function renderBody(upgradeCheck) {
 }
 
 // packages/experience-design-system-cli/src/tui/settings/debug-mode/screen.tsx
-import { useEffect as useEffect26, useState as useState32 } from "react";
+import { useEffect as useEffect25, useState as useState32 } from "react";
 import { Box as Box47, Text as Text49, useInput as useInput14 } from "ink";
 import { jsx as jsx58, jsxs as jsxs48 } from "react/jsx-runtime";
 function DebugModeScreen({ onDone }) {
   const [loading, setLoading] = useState32(true);
   const [enabled, setEnabled] = useState32(true);
-  useEffect26(() => {
+  useEffect25(() => {
     readDebugModeSetting().then((setting) => {
       setEnabled(setting.enabled);
       setLoading(false);
@@ -28594,9 +28595,9 @@ function App({ importOptions, inkClear }) {
   const [generationInput, setGenerationInput] = useState33();
   const generation = useGeneration(generationInput);
   const [flowStart, setFlowStart] = useState33();
-  const flow = useFlow(flowStart);
+  const flow = useFlow(flowStart, { beforeStepChange: inkClear });
   const [importDefaults, setImportDefaults] = useState33();
-  useEffect27(() => {
+  useEffect26(() => {
     if (screen !== "import") {
       setImportDefaults(void 0);
       return;
@@ -28654,12 +28655,12 @@ function App({ importOptions, inkClear }) {
       }
     });
   };
-  useEffect27(() => {
+  useEffect26(() => {
     if (!extractionRun || extraction?.status !== "done" || !extraction.result.ok) return;
     setExtractionRun(void 0);
     setScopeRun({ ...extractionRun, extraction: extraction.result.extraction });
   }, [extraction, extractionRun]);
-  useEffect27(() => {
+  useEffect26(() => {
     if (!scopeRun || scopeFlow?.status !== "confirmed" || generationInput) return;
     const { extraction: produced, input, generatePromptPath } = scopeRun;
     setGenerationInput({
@@ -28677,7 +28678,7 @@ function App({ importOptions, inkClear }) {
       ...generatePromptPath ? { generatePromptPath } : {}
     });
   }, [scopeFlow, scopeRun, generationInput]);
-  useEffect27(() => {
+  useEffect26(() => {
     if (!scopeRun || generation?.status !== "done" || !generation.result.ok) return;
     const { credentialsSkipped, tokenStrategy, extraction: produced, input, generatePromptPath } = scopeRun;
     inkClear();
@@ -28728,8 +28729,7 @@ function App({ importOptions, inkClear }) {
             state: flow.state,
             controller: flow.controller,
             generatePromptPath: flowStart.generatePromptPath,
-            onExit: setImportExitCode,
-            onStepChange: inkClear
+            onExit: setImportExitCode
           }
         );
       }

package/dist/index.js

@@ -31134,7 +31134,6 @@ var init_run_teaser = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/screen.tsx
-import { useEffect as useEffect20, useRef as useRef12 } from "react";
 import { Box as Box41 } from "ink";
 import { jsx as jsx52, jsxs as jsxs42 } from "react/jsx-runtime";
 function totalStepsFor(state) {
@@ -31150,18 +31149,10 @@ function FlowScreen({
   controller,
   livePreview = true,
   generatePromptPath,
-  onExit,
-  onStepChange
+  onExit
 }) {
   const totalSteps = totalStepsFor(state);
   const quit = () => onExit(0);
-  const previousStep = useRef12(state.step);
-  useEffect20(() => {
-    if (previousStep.current !== state.step) {
-      onStepChange?.();
-      previousStep.current = state.step;
-    }
-  }, [state.step, onStepChange]);
   const content = (() => {
     switch (state.step) {
       case "final-review":
@@ -31929,6 +31920,12 @@ function createFlowController(start, deps) {
       deps.log({ update: sanitizeForLog(patch) });
     } catch {
     }
+    if (patch.step !== void 0 && patch.step !== state.step) {
+      try {
+        deps.beforeStepChange?.();
+      } catch {
+      }
+    }
     state = { ...state, ...patch };
     for (const listener of listeners) listener();
   };
@@ -32081,22 +32078,26 @@ var init_controller = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/import/steps/10-flow/flow/use-flow.ts
-import { useEffect as useEffect21, useRef as useRef13, useSyncExternalStore } from "react";
-function useFlow(start, deps = realFlowDeps) {
-  const controller = useRef13();
+import { useEffect as useEffect20, useRef as useRef12, useSyncExternalStore } from "react";
+function useFlow(start, options = {}) {
+  const controller = useRef12();
   if (start && !controller.current) {
     try {
       startWizardLog();
     } catch {
     }
-    controller.current = createFlowController(start, deps());
+    const flowDeps = (options.deps ?? realFlowDeps)();
+    controller.current = createFlowController(start, {
+      ...flowDeps,
+      ...options.beforeStepChange ? { beforeStepChange: options.beforeStepChange } : {}
+    });
   }
   const current = controller.current;
   const state = useSyncExternalStore(
     (listener) => current?.subscribe(listener) ?? (() => void 0),
     () => current?.getState()
   );
-  useEffect21(() => {
+  useEffect20(() => {
     if (!start) controller.current = void 0;
   }, [start]);
   return current && state ? { controller: current, state } : void 0;
@@ -32309,7 +32310,7 @@ var init_help_info = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/help/PageContainer.tsx
-import { useEffect as useEffect22, useState as useState27 } from "react";
+import { useEffect as useEffect21, useState as useState27 } from "react";
 import { Box as Box42, Text as Text44, useInput as useInput9 } from "ink";
 import { Fragment as Fragment16, jsx as jsx53, jsxs as jsxs43 } from "react/jsx-runtime";
 function Section({ title, rows }) {
@@ -32323,7 +32324,7 @@ function Section({ title, rows }) {
 }
 function HelpScreen({ onDone }) {
   const [info, setInfo] = useState27();
-  useEffect22(() => {
+  useEffect21(() => {
     startDebugRun({ flow: "help", step: "01-help", menuOption: "Help", inputs: {} });
     void readHelpInfo().then(setInfo);
   }, []);
@@ -32472,7 +32473,7 @@ var init_config_store = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/settings/contentful-configuration/ContentfulConfigScreen.tsx
-import { useEffect as useEffect23, useState as useState29 } from "react";
+import { useEffect as useEffect22, useState as useState29 } from "react";
 import { Box as Box44, Text as Text46, useInput as useInput11 } from "ink";
 import TextInput4 from "ink-text-input";
 import { Fragment as Fragment17, jsx as jsx55, jsxs as jsxs45 } from "react/jsx-runtime";
@@ -32494,7 +32495,7 @@ function ConfigurationScreen({ onDone }) {
   const [lastSaved, setLastSaved] = useState29(null);
   const [editing, setEditing] = useState29(false);
   const [valueBeforeEdit, setValueBeforeEdit] = useState29("");
-  useEffect23(() => {
+  useEffect22(() => {
     readCredentials().then((cfg) => {
       setConfig(cfg);
       setStage("form");
@@ -32678,13 +32679,13 @@ var init_analytics_store = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/settings/opt-in-analytics/screen.tsx
-import { useEffect as useEffect24, useState as useState30 } from "react";
+import { useEffect as useEffect23, useState as useState30 } from "react";
 import { Box as Box45, Text as Text47, useInput as useInput12 } from "ink";
 import { Fragment as Fragment18, jsx as jsx56, jsxs as jsxs46 } from "react/jsx-runtime";
 function OptInAnalyticsScreen({ onDone }) {
   const [loading, setLoading] = useState30(true);
   const [enabled, setEnabled] = useState30(true);
-  useEffect24(() => {
+  useEffect23(() => {
     readAnalyticsSetting().then((setting) => {
       setEnabled(setting.enabled);
       setLoading(false);
@@ -32747,12 +32748,12 @@ var init_screen11 = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/upgrade/PageContainer.tsx
-import { useEffect as useEffect25, useState as useState31 } from "react";
+import { useEffect as useEffect24, useState as useState31 } from "react";
 import { Box as Box46, Text as Text48, useInput as useInput13 } from "ink";
 import { jsx as jsx57, jsxs as jsxs47 } from "react/jsx-runtime";
 function UpgradeScreen({ onDone }) {
   const [upgradeCheck, setUpgradeCheck] = useState31();
-  useEffect25(() => {
+  useEffect24(() => {
     startDebugRun({
       flow: "upgrade",
       step: "01-upgrade",
@@ -32827,13 +32828,13 @@ var init_PageContainer4 = __esm({
 });
 
 // packages/experience-design-system-cli/src/tui/settings/debug-mode/screen.tsx
-import { useEffect as useEffect26, useState as useState32 } from "react";
+import { useEffect as useEffect25, useState as useState32 } from "react";
 import { Box as Box47, Text as Text49, useInput as useInput14 } from "ink";
 import { jsx as jsx58, jsxs as jsxs48 } from "react/jsx-runtime";
 function DebugModeScreen({ onDone }) {
   const [loading, setLoading] = useState32(true);
   const [enabled, setEnabled] = useState32(true);
-  useEffect26(() => {
+  useEffect25(() => {
     readDebugModeSetting().then((setting) => {
       setEnabled(setting.enabled);
       setLoading(false);
@@ -32896,7 +32897,7 @@ __export(app_exports, {
   runApp: () => runApp
 });
 import { join as join27 } from "node:path";
-import { useEffect as useEffect27, useState as useState33 } from "react";
+import { useEffect as useEffect26, useState as useState33 } from "react";
 import { Fragment as Fragment19, jsx as jsx59 } from "react/jsx-runtime";
 function App({ importOptions, inkClear }) {
   const [screen, setScreen] = useState33("start");
@@ -32926,9 +32927,9 @@ function App({ importOptions, inkClear }) {
   const [generationInput, setGenerationInput] = useState33();
   const generation = useGeneration(generationInput);
   const [flowStart, setFlowStart] = useState33();
-  const flow = useFlow(flowStart);
+  const flow = useFlow(flowStart, { beforeStepChange: inkClear });
   const [importDefaults, setImportDefaults] = useState33();
-  useEffect27(() => {
+  useEffect26(() => {
     if (screen !== "import") {
       setImportDefaults(void 0);
       return;
@@ -32986,12 +32987,12 @@ function App({ importOptions, inkClear }) {
       }
     });
   };
-  useEffect27(() => {
+  useEffect26(() => {
     if (!extractionRun || extraction?.status !== "done" || !extraction.result.ok) return;
     setExtractionRun(void 0);
     setScopeRun({ ...extractionRun, extraction: extraction.result.extraction });
   }, [extraction, extractionRun]);
-  useEffect27(() => {
+  useEffect26(() => {
     if (!scopeRun || scopeFlow?.status !== "confirmed" || generationInput) return;
     const { extraction: produced, input, generatePromptPath } = scopeRun;
     setGenerationInput({
@@ -33009,7 +33010,7 @@ function App({ importOptions, inkClear }) {
       ...generatePromptPath ? { generatePromptPath } : {}
     });
   }, [scopeFlow, scopeRun, generationInput]);
-  useEffect27(() => {
+  useEffect26(() => {
     if (!scopeRun || generation?.status !== "done" || !generation.result.ok) return;
     const { credentialsSkipped, tokenStrategy, extraction: produced, input, generatePromptPath } = scopeRun;
     inkClear();
@@ -33060,8 +33061,7 @@ function App({ importOptions, inkClear }) {
             state: flow.state,
             controller: flow.controller,
             generatePromptPath: flowStart.generatePromptPath,
-            onExit: setImportExitCode,
-            onStepChange: inkClear
+            onExit: setImportExitCode
           }
         );
       }

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.37.1-dev-build-64f41b0b.0",
+  "version": "2.37.1-dev-build-97b615d3.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",

package/dist/src/tui/import/steps/10-flow/flow/controller.d.ts

@@ -38,6 +38,12 @@ export interface FlowDeps {
     /** Writes one line of the wizard's step log. */
     log: (entry: Record<string, unknown>) => void;
     stderr: (text: string) => void;
+    /**
+     * Called when the step is about to change, before anything is told about the new one. The host clears the terminal
+     * here so the next screen is drawn on a clean one. It has to be before: Ink paints as soon as it is told, and a clear
+     * after the paint wipes a static screen like the done step, which nothing draws again.
+     */
+    beforeStepChange?: () => void;
 }
 export declare function startWizardLog(): void;
 export declare function realFlowDeps(): FlowDeps;

package/dist/src/tui/import/steps/10-flow/flow/screen.d.ts

@@ -8,12 +8,10 @@ interface FlowScreenProps {
     generatePromptPath?: string;
     /** Leaves the import with the exit code the wizard would have exited with. */
     onExit: (exitCode: number) => void;
-    /** Called when the step changes so the host can clear Ink's render buffer without scrollback pollution. */
-    onStepChange?: () => void;
 }
 /** How many steps the import has, as the wizard counted them. */
 export declare function totalStepsFor(state: Pick<FlowState, 'tokensPath' | 'rawTokensPath' | 'mapTokensEligible'>): number;
 /** Whether the preview gate offers "[e] Edit definitions": only when the document has components to edit. */
 export declare function canEditFromPreview(cdf: FlowState['cdf']): boolean;
-export declare function FlowScreen({ state, controller, livePreview, generatePromptPath, onExit, onStepChange, }: FlowScreenProps): React.ReactElement;
+export declare function FlowScreen({ state, controller, livePreview, generatePromptPath, onExit, }: FlowScreenProps): React.ReactElement;
 export {};

package/dist/src/tui/import/steps/10-flow/flow/use-flow.d.ts

@@ -3,7 +3,10 @@ import { type FlowController, type FlowDeps, type FlowStart } from './controller
  * The flow for a start, once. `start` is undefined until the generation stage has finished, so the hook can be called
  * unconditionally; the step log is started with the controller, as the wizard started it with its first render.
  */
-export declare function useFlow(start: FlowStart | undefined, deps?: () => FlowDeps): {
+export declare function useFlow(start: FlowStart | undefined, options?: {
+    beforeStepChange?: () => void;
+    deps?: () => FlowDeps;
+}): {
     controller: FlowController;
     state: ReturnType<FlowController['getState']>;
 } | undefined;

package/legacy/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.37.1-dev-build-64f41b0b.0",
+  "version": "2.37.1-dev-build-97b615d3.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.37.1-dev-build-64f41b0b.0",
+  "version": "2.37.1-dev-build-97b615d3.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",
@@ -29,8 +29,8 @@
     "skills/"
   ],
   "dependencies": {
-    "@contentful/experience-design-system-backend-pipeline": "2.37.1-dev-build-64f41b0b.0",
-    "@contentful/experience-design-system-types": "2.37.1-dev-build-64f41b0b.0",
+    "@contentful/experience-design-system-backend-pipeline": "2.37.1-dev-build-97b615d3.0",
+    "@contentful/experience-design-system-types": "2.37.1-dev-build-97b615d3.0",
     "@inkjs/ui": "^2.0.0",
     "@segment/analytics-node": "^3.0.0",
     "@vue/compiler-sfc": "^3.5.31",