@contentful/experience-design-system-cli 2.32.1-dev-build-403b769.0 → 2.32.1-dev-build-6b922ec.0

package/dist/src/lib/agent-definitions.d.ts

@@ -0,0 +1,7 @@
+import type { AgentName } from '@contentful/experience-design-system-generation';
+export interface AgentDefinition {
+    name: string;
+    binary: AgentName;
+    installHint: string;
+}
+export declare const AGENT_DEFS: readonly AgentDefinition[];

package/dist/src/setup/command.d.ts

@@ -1,15 +1,6 @@
 import type { Command } from 'commander';
-import type { AgentName } from '@contentful/experience-design-system-generation';
-export declare function promptCodexModel(ask?: (q: string) => Promise<string>): Promise<string | undefined>;
-export declare function setupAgent(): Promise<{
-    agent: AgentName | undefined;
-    agentModel: string | undefined;
-}>;
-export type SkillPromptKind = 'select' | 'generate';
-/**
- * Prompt the operator for a custom skill prompt path. Returns the resolved
- * trimmed value, or `undefined` to leave the current value unchanged, or `null`
- * to clear it. `ask` is injectable so tests can stub stdin.
- */
-export declare function promptCustomSkillPath(kind: SkillPromptKind, current: string | undefined, ask?: (q: string) => Promise<string>): Promise<string | undefined | null>;
+import type { SetupScreenDependencies } from './tui/SetupScreen.js';
+export declare const SETUP_REQUIRES_TTY_MESSAGE = "Error: experiences setup requires an interactive terminal.";
+export declare function getCliVersion(): string;
+export declare function createSetupScreenDependencies(): SetupScreenDependencies;
 export declare function registerSetupCommand(program: Command): void;

package/dist/src/setup/lib/checks.d.ts

@@ -0,0 +1,69 @@
+import { binaryExists, pathExists, runSpawn, type ShellCommandResult } from './shell.js';
+/**
+ * The decision half of each prerequisite check, shared by `experiences doctor`
+ * and the setup wizard's Prerequisites step. Neither writes output from here:
+ * doctor streams ANSI, setup emits events for Ink, and both need the same
+ * verdict. Anything a caller needs for its own wording is returned rather than
+ * printed.
+ */
+export interface NodeVersionCheck {
+    passed: boolean;
+    version: string;
+    major: number;
+    required: number;
+}
+export declare function checkNodeVersion(nodeVersion?: string): NodeVersionCheck;
+/** Which Node version manager is available, so callers can offer the right fix. */
+export interface NodeVersionManagers {
+    nvm: boolean;
+    fnm: boolean;
+    nvmScript: string;
+}
+export declare function detectNodeVersionManagers(homeDir: string, deps?: {
+    binaryExists: typeof binaryExists;
+    pathExists: typeof pathExists;
+}): Promise<NodeVersionManagers>;
+export type PnpmCheck = {
+    status: 'missing';
+} | {
+    status: 'broken';
+} | {
+    status: 'unusable-in-repo';
+    version: string;
+} | {
+    status: 'ok';
+    version: string;
+};
+type PnpmDeps = {
+    binaryExists: typeof binaryExists;
+    run: typeof runSpawn;
+};
+/** Whether pnpm is on PATH and reports a version. */
+export declare function detectPnpm(deps?: PnpmDeps): Promise<Extract<PnpmCheck, {
+    status: 'missing' | 'broken' | 'ok';
+}>>;
+/**
+ * `detectPnpm` plus proof that pnpm can execute inside the repo. A store built
+ * against a different Node version still passes `--version` but fails there,
+ * which is the failure operators actually hit — so doctor checks it, while the
+ * setup wizard only needs to know pnpm exists before it installs.
+ */
+export declare function checkPnpm(pkgRoot: string, deps?: PnpmDeps): Promise<PnpmCheck>;
+export interface InstallCheck {
+    passed: boolean;
+    /** Whether `node_modules` was already present, which changes doctor's wording. */
+    hadNodeModules: boolean;
+    result: ShellCommandResult;
+}
+export declare function installDependencies(pkgRoot: string, deps?: {
+    pathExists: typeof pathExists;
+    run: typeof runSpawn;
+}): Promise<InstallCheck>;
+export interface BuildCheck {
+    passed: boolean;
+    result: ShellCommandResult;
+}
+export declare function buildCli(repoRoot: string, deps?: {
+    run: typeof runSpawn;
+}): Promise<BuildCheck>;
+export {};

package/dist/src/setup/lib/layout.d.ts

@@ -0,0 +1,34 @@
+export declare const SETUP_SCREENS: readonly [{
+    readonly title: "Prerequisites";
+    readonly kind: "required";
+}, {
+    readonly title: "Coding agent";
+    readonly kind: "required";
+}, {
+    readonly title: "Contentful";
+    readonly kind: "optional";
+}, {
+    readonly title: "Preferences";
+    readonly kind: "optional";
+}];
+export declare const SETUP_TITLE = "experiences setup";
+export declare const WIDE_STEPPER_MIN_COLUMNS: number;
+export type SetupStepState = 'complete' | 'active' | 'pending';
+export interface SetupStepperEntry {
+    step: number;
+    title: string;
+    state: SetupStepState;
+    label: string;
+}
+export declare function shouldUseWideStepper(columns?: number): boolean;
+export declare function setupStepperSeparator(columns?: number): string;
+export declare function setupStepperEntries(activeStep: number, columns?: number): SetupStepperEntry[];
+export declare function shouldAlignVersionRight(version: string, columns?: number): boolean;
+export type SetupResultStatus = 'completed' | 'skipped' | 'failed';
+export interface SetupResultEntry {
+    name: string;
+    status: SetupResultStatus;
+    required: boolean;
+}
+export declare function countRequiredFailures(results: readonly SetupResultEntry[]): number;
+export declare function formatSetupCompletionMessage(results: readonly SetupResultEntry[]): string;

package/dist/src/setup/lib/prompt-input.d.ts

@@ -0,0 +1,17 @@
+/**
+ * A terminal coalesces fast input, so a pasted value and the Enter that follows
+ * it arrive in a single chunk (`"my-token\r"`). Only the first line is kept, so
+ * a multi-line paste submits its first value instead of filling one field with
+ * all of them.
+ *
+ * This is why setup reads raw chunks instead of using @inkjs/ui's TextInput.
+ * Ink's `parseKeypress` reports `key.return` only for a bare `"\r"`, so a
+ * coalesced chunk arrives as text with `key.return === false`; TextInput then
+ * inserts the whole thing — trailing CR and all — and never submits. Verified
+ * against @inkjs/ui 2 on Ink 5, where PasswordInput behaves the same way and
+ * ConfirmInput ignores `"y\r"` outright.
+ */
+export declare function splitPromptInput(input: string): {
+    text: string;
+    submitted: boolean;
+};

package/dist/src/setup/lib/shell.d.ts

@@ -0,0 +1,15 @@
+export declare const REQUIRED_NODE_MAJOR = 24;
+export interface ShellCommandResult {
+    exitCode: number;
+    stdout: string;
+    stderr: string;
+}
+export declare function binaryExists(name: string): Promise<boolean>;
+export declare function pathExists(path: string): Promise<boolean>;
+export declare function runSpawn(cmd: string, args: string[], opts?: {
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+}): Promise<ShellCommandResult>;
+export declare function detectShellProfile(): Promise<string>;
+export declare function profileContains(profilePath: string, value: string): Promise<boolean>;
+export declare function appendToProfile(profilePath: string, lines: string): Promise<void>;

package/dist/src/setup/lib/types.d.ts

@@ -0,0 +1,55 @@
+import type { AgentName } from '@contentful/experience-design-system-generation';
+import type { ExperiencesCredentials } from '../../credentials-store.js';
+import type { ShellCommandResult } from './shell.js';
+export type SetupActionEventKind = 'success' | 'failure' | 'warning' | 'info' | 'value' | 'help' | 'page';
+export interface SetupActionEvent {
+    kind: SetupActionEventKind;
+    message: string;
+}
+export interface SetupChoice {
+    label: string;
+    description?: string;
+}
+/**
+ * Everything a setup step needs from the outside world. Prompts and output are
+ * supplied by whatever renders the step — the Ink screen in production, stubs in
+ * tests — so the steps hold the business rules and none of the presentation.
+ */
+export interface SetupActionDependencies {
+    nodeVersion: string;
+    homeDir: string;
+    env: NodeJS.ProcessEnv;
+    ask(question: string): Promise<string>;
+    askSecret(question: string): Promise<string>;
+    confirm(question: string, defaultYes?: boolean): Promise<boolean>;
+    /** Resolves the chosen index, or `undefined` when the operator skips. */
+    choose(question: string, options: readonly SetupChoice[]): Promise<number | undefined>;
+    write(event: SetupActionEvent): void;
+    binaryExists(binary: string): Promise<boolean>;
+    run(command: string, args: string[], options?: {
+        cwd?: string;
+        env?: NodeJS.ProcessEnv;
+    }): Promise<ShellCommandResult>;
+    pathExists(path: string): Promise<boolean>;
+    profileContains(profilePath: string, value: string): Promise<boolean>;
+    appendToProfile(profilePath: string, lines: string): Promise<void>;
+    readCredentials(): Promise<ExperiencesCredentials>;
+    writeCredentials(credentials: ExperiencesCredentials): Promise<void>;
+    credentialsPath(): string;
+}
+export interface SetupCheckResult {
+    passed: boolean;
+}
+export interface PrerequisitesSetupResult {
+    node: SetupCheckResult & {
+        restartRequired?: boolean;
+    };
+    pnpm?: SetupCheckResult;
+    build?: SetupCheckResult;
+}
+export interface AgentSetupResult {
+    agent: AgentName | undefined;
+    agentModel: string | undefined;
+    passed: boolean;
+}
+export declare function emit(dependencies: SetupActionDependencies, kind: SetupActionEventKind, message: string): void;

package/dist/src/setup/lib/yes-no-prompt.d.ts

@@ -0,0 +1,8 @@
+import type { SetupActionDependencies } from './types.js';
+/**
+ * Ask a yes/no question that defaults to the operator's current setting.
+ *
+ * Empty input — and anything that is not a yes or a no — keeps the current
+ * value, so pressing Enter through the wizard never silently changes a setting.
+ */
+export declare function askYesNo(ask: SetupActionDependencies['ask'], question: string, defaultValue: boolean): Promise<boolean>;

package/dist/src/setup/steps/coding-agent.d.ts

@@ -0,0 +1,2 @@
+import { type AgentSetupResult, type SetupActionDependencies } from '../lib/types.js';
+export declare function runAgentSetup(dependencies: SetupActionDependencies): Promise<AgentSetupResult>;

package/dist/src/setup/steps/contentful.d.ts

@@ -0,0 +1,2 @@
+import { type SetupActionDependencies, type SetupCheckResult } from '../lib/types.js';
+export declare function runCredentialsSetup(dependencies: SetupActionDependencies): Promise<SetupCheckResult>;

package/dist/src/setup/steps/preferences/analytics.d.ts

@@ -0,0 +1,5 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const ANALYTICS_HELP = "Shares anonymous usage data about which CLI commands run.";
+/** Returns whether analytics should be *disabled*, matching the stored field. */
+export declare function promptAnalyticsPreference(ask: SetupActionDependencies['ask'], current?: boolean): Promise<boolean>;
+export declare function configureAnalytics(dependencies: SetupActionDependencies): Promise<void>;

package/dist/src/setup/steps/preferences/auto-filter.d.ts

@@ -0,0 +1,4 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const AUTO_FILTER_HELP = "Filters out components irrelevant to experience orchestration during extraction.";
+export declare function promptAutoFilterPreference(ask: SetupActionDependencies['ask'], current?: boolean): Promise<boolean>;
+export declare function configureAutoFilter(dependencies: SetupActionDependencies): Promise<void>;

package/dist/src/setup/steps/preferences/concurrency.d.ts

@@ -0,0 +1,3 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const CONCURRENCY_HELP = "Analyzes more components at once, which is faster on machines with spare cores.";
+export declare function configureConcurrency(dependencies: SetupActionDependencies, profilePath: string): Promise<void>;

package/dist/src/setup/steps/preferences/custom-prompts.d.ts

@@ -0,0 +1,8 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const CUSTOM_PROMPTS_HELP = "Replaces the built-in instructions the coding agent follows when it selects and generates components.";
+/**
+ * Ask for one custom prompt path. Returns the trimmed path, `undefined` to leave
+ * the stored value alone, or `null` to clear it.
+ */
+export declare function promptCustomSkillPathAction(kind: 'select' | 'generate', current: string | undefined, ask: SetupActionDependencies['ask']): Promise<string | undefined | null>;
+export declare function configureCustomPrompts(dependencies: SetupActionDependencies): Promise<void>;

package/dist/src/setup/steps/preferences/debug.d.ts

@@ -0,0 +1,4 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const DEBUG_HELP = "Writes a verbose trace of every command decision, for troubleshooting.";
+export declare function promptDebugModePreference(ask: SetupActionDependencies['ask'], current?: boolean): Promise<boolean>;
+export declare function configureDebug(dependencies: SetupActionDependencies): Promise<void>;

package/dist/src/setup/steps/preferences/index.d.ts

@@ -0,0 +1,41 @@
+import type { SetupActionDependencies } from '../../lib/types.js';
+import { configureAnalytics } from './analytics.js';
+import { configureAutoFilter } from './auto-filter.js';
+import { configureConcurrency } from './concurrency.js';
+import { configureCustomPrompts } from './custom-prompts.js';
+import { configureDebug } from './debug.js';
+import { configureNoColor } from './no-color.js';
+/**
+ * The preferences the wizard walks, in the order it presents them. Each entry
+ * pairs its label with the function that owns that setting's help text, prompt,
+ * and persistence — so adding a preference means adding a file and a row here.
+ */
+export declare const PREFERENCE_OPTIONS: readonly [{
+    readonly key: "autoFilter";
+    readonly label: "AI auto-filter";
+    readonly configure: typeof configureAutoFilter;
+}, {
+    readonly key: "concurrency";
+    readonly label: "Performance concurrency";
+    readonly configure: typeof configureConcurrency;
+}, {
+    readonly key: "customPrompts";
+    readonly label: "Custom prompts";
+    readonly configure: typeof configureCustomPrompts;
+}, {
+    readonly key: "debug";
+    readonly label: "Debug logging";
+    readonly configure: typeof configureDebug;
+}, {
+    readonly key: "analytics";
+    readonly label: "Usage analytics";
+    readonly configure: typeof configureAnalytics;
+}, {
+    readonly key: "noColor";
+    readonly label: "Disable terminal colors";
+    readonly configure: typeof configureNoColor;
+}];
+export type PreferenceKey = (typeof PREFERENCE_OPTIONS)[number]['key'];
+export declare function runPreferenceSetupAction(dependencies: SetupActionDependencies, profilePath: string): Promise<{
+    selected: PreferenceKey[];
+}>;

package/dist/src/setup/steps/preferences/no-color.d.ts

@@ -0,0 +1,3 @@
+import { type SetupActionDependencies } from '../../lib/types.js';
+export declare const NO_COLOR_HELP = "Prints plain text with no color, which suits CI logs and basic terminals.";
+export declare function configureNoColor(dependencies: SetupActionDependencies, profilePath: string): Promise<void>;

package/dist/src/setup/steps/prerequisites/build.d.ts

@@ -0,0 +1,2 @@
+import { type SetupActionDependencies, type SetupCheckResult } from '../../lib/types.js';
+export declare function runBuildSetup(dependencies: SetupActionDependencies, repoRoot: string): Promise<SetupCheckResult>;

package/dist/src/setup/steps/prerequisites/index.d.ts

@@ -0,0 +1,8 @@
+import type { PrerequisitesSetupResult, SetupActionDependencies } from '../../lib/types.js';
+import { runBuildSetup } from './build.js';
+import { runNodeSetup } from './node.js';
+import { runPnpmSetup } from './pnpm.js';
+export { runBuildSetup, runNodeSetup, runPnpmSetup };
+export declare function runPrerequisitesSetup(dependencies: SetupActionDependencies, repoRoot: string, options?: {
+    skipBuild?: boolean;
+}): Promise<PrerequisitesSetupResult>;

package/dist/src/setup/steps/prerequisites/node.d.ts

@@ -0,0 +1,4 @@
+import { type SetupActionDependencies, type SetupCheckResult } from '../../lib/types.js';
+export declare function runNodeSetup(dependencies: SetupActionDependencies): Promise<SetupCheckResult & {
+    restartRequired?: boolean;
+}>;

package/dist/src/setup/steps/prerequisites/pnpm.d.ts

@@ -0,0 +1,2 @@
+import { type SetupActionDependencies, type SetupCheckResult } from '../../lib/types.js';
+export declare function runPnpmSetup(dependencies: SetupActionDependencies): Promise<SetupCheckResult>;

package/dist/src/setup/tui/SetupScreen.d.ts

@@ -0,0 +1,30 @@
+import React from 'react';
+import { type SetupResultEntry } from '../lib/layout.js';
+import type { SetupActionDependencies } from '../lib/types.js';
+/** Prompts and output are UI-owned; the screen supplies the rest itself. */
+export type SetupScreenDependencies = Omit<SetupActionDependencies, 'ask' | 'askSecret' | 'confirm' | 'choose' | 'write'>;
+export type SetupSkipFlags = {
+    skipBuild?: boolean;
+    skipAgent?: boolean;
+    skipCredentials?: boolean;
+    skipOptional?: boolean;
+};
+export type SetupOutcome = {
+    results: SetupResultEntry[];
+    exitCode: number;
+    restartRequired: boolean;
+    runDoctor: boolean;
+};
+type SetupScreenProps = {
+    version: string;
+    repoRoot: string;
+    profilePath: string;
+    dependencies: SetupScreenDependencies;
+    skip?: SetupSkipFlags;
+    /** Defaults to the live Ink stdout columns. */
+    columns?: number;
+    offerDoctor?: boolean;
+    onComplete: (outcome: SetupOutcome) => void;
+};
+export declare function SetupScreen({ version, repoRoot, profilePath, dependencies, skip, columns: columnsOverride, offerDoctor, onComplete, }: SetupScreenProps): React.ReactElement;
+export {};

package/dist/src/setup/tui/SetupStepper.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+type SetupStepperProps = {
+    activeStep: number;
+    columns?: number;
+};
+export declare function SetupStepper({ activeStep, columns }: SetupStepperProps): React.ReactElement;
+export {};

package/dist/src/setup/tui/usePromptInput.d.ts

@@ -0,0 +1,19 @@
+export type PromptKey = {
+    return: boolean;
+    escape: boolean;
+    tab: boolean;
+    backspace: boolean;
+    delete: boolean;
+    upArrow: boolean;
+    downArrow: boolean;
+    ctrl: boolean;
+    meta: boolean;
+};
+export type PromptInputHandler = (chunk: string, key: PromptKey) => void;
+/**
+ * Raw-mode stdin that hands the handler the unparsed chunk.
+ *
+ * Setup needs the raw data because `useImmediateInput` blanks `input` for a
+ * chunk that ends in a newline, which is exactly how a pasted value arrives.
+ */
+export declare function usePromptInput(handler: PromptInputHandler): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentful/experience-design-system-cli",
-  "version": "2.32.1-dev-build-403b769.0",
+  "version": "2.32.1-dev-build-6b922ec.0",
   "description": "Contentful Experiences design system import CLI",
   "license": "MIT",
   "type": "module",
@@ -29,6 +29,7 @@
     "skills/"
   ],
   "dependencies": {
+    "@inkjs/ui": "^2.0.0",
     "@segment/analytics-node": "^3.0.0",
     "@vue/compiler-sfc": "^3.5.31",
     "commander": "^13.1.0",
@@ -40,8 +41,8 @@
     "svelte": "^5.56.4",
     "ts-morph": "^27.0.2",
     "typescript": "^5.9.3",
-    "@contentful/experience-design-system-cli-v2": "2.32.1-dev-build-403b769.0",
-    "@contentful/experience-design-system-types": "2.32.1-dev-build-403b769.0"
+    "@contentful/experience-design-system-cli-v2": "2.32.1-dev-build-6b922ec.0",
+    "@contentful/experience-design-system-types": "2.32.1-dev-build-6b922ec.0"
   },
   "devDependencies": {
     "@tsconfig/node24": "^24.0.4",
@@ -53,9 +54,9 @@
     "ink-testing-library": "^4.0.0",
     "typescript-eslint": "^8.67.0",
     "vitest": "^4.0.16",
-    "@contentful/experience-design-system-generation": "2.32.1-dev-build-403b769.0",
-    "@contentful/experience-design-system-client": "2.32.1-dev-build-403b769.0",
-    "@contentful/experience-design-system-extraction": "2.32.1-dev-build-403b769.0"
+    "@contentful/experience-design-system-extraction": "2.32.1-dev-build-6b922ec.0",
+    "@contentful/experience-design-system-generation": "2.32.1-dev-build-6b922ec.0",
+    "@contentful/experience-design-system-client": "2.32.1-dev-build-6b922ec.0"
   },
   "repository": {
     "type": "git",

package/dist/src/setup/analytics-prompt.d.ts

@@ -1,13 +0,0 @@
-/**
- * Ask the operator whether to persist an opt-out of anonymous usage analytics.
- *
- * The helper is injectable so it can be unit-tested without a TTY. The caller
- * provides an `ask` function that yields one line of input per call.
- *
- * Behavior:
- *   - Empty input returns `current` if defined, else `false` (default: enabled).
- *   - Input starting with 'y' or 'Y' returns `true` (disabled).
- *   - Input starting with 'n' or 'N' returns `false` (enabled).
- *   - Any other input falls back to the same rule as empty input.
- */
-export declare function promptAnalyticsPreference(ask: (q: string) => Promise<string>, current?: boolean): Promise<boolean>;

package/dist/src/setup/auto-filter-prompt.d.ts

@@ -1,13 +0,0 @@
-/**
- * Ask the operator whether to enable the AI auto-filter by default.
- *
- * The helper is injectable so it can be unit-tested without a TTY. The caller
- * provides an `ask` function that yields one line of input per call.
- *
- * Behavior:
- *   - Empty input returns `current` if defined, else `true` (default ON).
- *   - Input starting with 'y' or 'Y' returns `true`.
- *   - Input starting with 'n' or 'N' returns `false`.
- *   - Any other input falls back to the same rule as empty input.
- */
-export declare function promptAutoFilterPreference(ask: (q: string) => Promise<string>, current?: boolean): Promise<boolean>;

package/dist/src/setup/composition-mode-prompt.d.ts

@@ -1,14 +0,0 @@
-import type { CompositionMode } from '../lib/composition-mode.js';
-/**
- * Setup prompts for composition (spec T10). Parallels `promptAutoFilterPreference`
- * — injectable `ask` for TTY-free unit testing.
- *
- * (a) Composite-mode default. Default N → atomic (composition OFF); the
- *     low-surprise default. `--composite` opts in per invocation.
- */
-export declare function promptCompositeModePreference(ask: (q: string) => Promise<string>, current?: CompositionMode): Promise<CompositionMode>;
-/**
- * (b) Agentic mapping resolution. Default N — opt-in (it costs tokens and the
- *     output needs review), and only meaningful in composite mode.
- */
-export declare function promptAgenticResolutionPreference(ask: (q: string) => Promise<string>, current?: boolean): Promise<boolean>;

package/dist/src/setup/debug-mode-prompt.d.ts

@@ -1,11 +0,0 @@
-/**
- * Ask the operator whether to enable debug logging by default.
- *
- * When ON, every command writes a JSONL trace of its decisions to
- * ~/.contentful/experience-design-system-cli/debug/. Off by default because
- * the trace file grows quickly and contains verbose per-tool-call detail
- * intended for developers debugging the CLI.
- *
- * Injectable `ask` so tests can drive without a TTY.
- */
-export declare function promptDebugModePreference(ask: (q: string) => Promise<string>, current?: boolean): Promise<boolean>;