@mesh-tech/mesh-cli 0.18.2 → 0.20.0

package/dist/src/commands/init/wizard.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Bare `mesh init` — the guided setup of a machine and a repo for one tenant.
+ *
+ * Four questions and four steps, in order:
+ *
+ *   1. tenant   — which tenant this repo belongs to
+ *   2. mode     — local only (`mesh start` / `mesh dev`) or a deployed platform
+ *   3. registry — package-registry access, signing in if the machine has none
+ *   4. platform — (deployed only) `mesh login <tenant>.<env>` in-process
+ *   5. repo     — bootstrap an empty apps repo, or check an existing one
+ *   6. skills   — the agent skills the repo's packages ship
+ *
+ * Two identities never mix: the registry step talks to the ONE global package
+ * registry and never needs a context; the platform step is the only place a
+ * `<tenant>.<env>` context appears, and the local branch never mentions it.
+ *
+ * Every step is data (`WizardStep` → `StepResult`) so the summary, the exit
+ * code and the `--json` document are one reducer over one list, and a step
+ * that fails without blocking (a registry 403 — the user needs the summary to
+ * know whom to ask) lets the rest run. Every prompt has a flag, so a runner
+ * with `--tenant … --local --yes` sees no prompt at all.
+ */
+import { probeRegistryToken } from "../../utils/auth-preflight.js";
+import { type RegistryLoginOptions } from "../registry.js";
+import { type MeshJson } from "../../utils/mesh-json.js";
+/** The flags — one per wizard answer, so a headless run needs no prompt. */
+export interface WizardOptions {
+    tenant?: string;
+    /** Local only: `mesh start` / `mesh dev`, no deployed platform. */
+    local?: boolean;
+    /** A deployed platform's environment (`dev`, `uat`, …) → context `<tenant>.<env>`. */
+    platform?: string;
+    /** Device-code sign-in for the registry and platform steps (headless / SSH). */
+    device?: boolean;
+    /** Deployers only: an AWS profile that can read the registry (skips the broker). */
+    profile?: string;
+    /** Do not touch the repo (no bootstrap, no doctor, no skills). */
+    skipRepo?: boolean;
+    /** Accept every default and never prompt. */
+    yes?: boolean;
+    /** One JSON document on stdout; human output on stderr. */
+    json?: boolean;
+}
+export type StepStatus = "pass" | "fail" | "warn" | "skip";
+/** One step's verdict — what the summary, the exit code and `--json` all read. */
+export interface StepResult {
+    name: string;
+    status: StepStatus;
+    detail: string;
+    /** The exact command (or, for a grant, the person to ask) that fixes it. */
+    fix?: string;
+    /** `false` = a failure the wizard carries on past (a registry 403). */
+    blocking?: boolean;
+}
+/** Where the tenant runs. */
+export type WizardMode = "local" | {
+    platform: string;
+};
+/** The wizard's answers, shared by every step. */
+export interface WizardCtx {
+    cwd: string;
+    tenant: string;
+    mode: WizardMode;
+    /** The `<tenant>.<env>` context — only in deployed mode. */
+    context: string | null;
+    device?: boolean;
+    profile?: string;
+    /** True when a prompt or a browser can be used on this run. */
+    interactive: boolean;
+    /**
+     * True when no browser can open here (SSH, a container, no TTY), so the
+     * device code is the sign-in that works and every remediation names it.
+     */
+    remote: boolean;
+    yes: boolean;
+    skipRepo: boolean;
+    prompts: Prompts;
+    /** Test seams for the steps' side effects; production leaves them unset. */
+    seams?: WizardSeams;
+}
+/** The impure calls a step makes, injectable so the real steps run under test. */
+export interface WizardSeams {
+    /** The `~/.npmrc` token probe — defaults to `probeRegistryToken`. */
+    probe?: typeof probeRegistryToken;
+    /** The in-process registry login — defaults to `runRegistryLogin(undefined, opts)`. */
+    runRegistryLogin?: (opts: RegistryLoginOptions) => Promise<void>;
+}
+/** A step: a name and a runner. */
+export interface WizardStep {
+    name: "registry" | "platform" | "repo" | "skills";
+    run(ctx: WizardCtx): Promise<StepResult>;
+}
+/** The final document — rendered for a terminal or emitted as `--json`. */
+export interface WizardOutcome {
+    tenant: string;
+    mode: WizardMode;
+    steps: StepResult[];
+    next: string[];
+}
+/** The prompt surface, injectable so the flow is testable without a TTY. */
+export interface Prompts {
+    input(args: {
+        message: string;
+        default?: string;
+        validate?: (v: string) => true | string;
+    }): Promise<string>;
+    select<T extends string>(args: {
+        message: string;
+        choices: Array<{
+            name: string;
+            value: T;
+        }>;
+        default?: T;
+    }): Promise<T>;
+    confirm(args: {
+        message: string;
+        default?: boolean;
+    }): Promise<boolean>;
+}
+/** Printed when the registry step has no session and no way to sign in. */
+export declare const NO_SESSION_NO_TTY_MESSAGE: string;
+/** Printed when a non-TTY run has no `--tenant`. */
+export declare const TENANT_REQUIRED_MESSAGE = "--tenant is required (no TTY for interactive mode)";
+/** Exit code for a Ctrl-C at a prompt: nothing half-written, conventional SIGINT code. */
+export declare const INTERRUPTED_EXIT_CODE = 130;
+/**
+ * The exit code for a finished run: 1 when any step failed (blocking or not
+ * — a registry 403 still means the machine is not set up), else 0.
+ *
+ * @example
+ * wizardExitCode([{ name: "Registry access", status: "fail", detail: "…", blocking: false }]); // → 1
+ */
+export declare function wizardExitCode(steps: ReadonlyArray<Pick<StepResult, "status">>): number;
+/**
+ * The commands to run next, by mode.
+ *
+ * @example
+ * wizardNextCommands({ platform: "dev" }); // → ["mesh create-app", "mesh deploy up   # from the app directory"]
+ */
+export declare function wizardNextCommands(mode: WizardMode): string[];
+/**
+ * Whether the wizard should stop after `result`: a failing step that did not
+ * opt out of blocking.
+ */
+export declare function stepBlocks(result: StepResult): boolean;
+/** The mode as a short phrase for the summary heading. */
+export declare function describeMode(mode: WizardMode): string;
+/**
+ * Render the summary check-list — the same lines for a terminal and for the
+ * stderr side of `--json`.
+ *
+ * @example
+ * renderWizardSummary({ tenant: "acme", mode: "local", steps: [], next: ["mesh create-app"] });
+ */
+export declare function renderWizardSummary(outcome: WizardOutcome, opts?: {
+    color?: boolean;
+}): string;
+/**
+ * Resolve the answers that need no prompt: flags first, then `--yes`
+ * defaults, then what the repo already records. Returns the questions still
+ * open so the caller prompts for exactly those.
+ *
+ * @example
+ * resolveAnswers({ tenant: "acme", local: true }, null, false)
+ * // → { tenant: "acme", mode: "local", open: [] }
+ */
+export declare function resolveAnswers(opts: WizardOptions, recorded: MeshJson | null, interactive: boolean): {
+    tenant?: string;
+    mode?: WizardMode;
+    open: Array<"tenant" | "mode">;
+};
+/** The registry step, exported so a test can drive the real thing through its seams. */
+export declare const registryStep: WizardStep;
+/** What kind of directory the wizard is standing in. */
+export type RepoKind = "platform-monorepo" | "empty-apps-repo" | "apps-repo" | "other-repo" | "no-repo";
+/**
+ * Classify `cwd` for the repo step. Pure over the filesystem; exported for
+ * tests.
+ *
+ * @example
+ * classifyRepo("/tmp/empty-git-clone"); // → "empty-apps-repo"
+ */
+export declare function classifyRepo(cwd: string): {
+    kind: RepoKind;
+    root: string;
+};
+/** The steps in run order. Exported so tests can drive the reducer with fakes. */
+export declare const WIZARD_STEPS: readonly WizardStep[];
+/**
+ * Run `steps` in order, stopping after the first blocking failure. Pure over
+ * the steps' results — the reducer the CLI and the tests share.
+ *
+ * @example
+ * const steps = await runWizardSteps(ctx, WIZARD_STEPS);
+ */
+export declare function runWizardSteps(ctx: WizardCtx, steps: readonly WizardStep[]): Promise<StepResult[]>;
+/**
+ * The wizard entry point behind bare `mesh init`.
+ *
+ * Returns the process exit code instead of exiting, so the caller decides
+ * (and a test can assert on it). Ctrl-C at a prompt returns 130 with nothing
+ * written. All human output goes to stderr under `--json`, leaving stdout for
+ * the one document.
+ *
+ * @example
+ * process.exitCode = await runInitWizard({ tenant: "acme", local: true, yes: true });
+ */
+export declare function runInitWizard(opts: WizardOptions, deps?: {
+    cwd?: string;
+    prompts?: Prompts;
+    steps?: readonly WizardStep[];
+    interactive?: boolean;
+    remote?: boolean;
+    seams?: WizardSeams;
+}): Promise<number>;
+//# sourceMappingURL=wizard.d.ts.map

package/dist/src/commands/init/wizard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wizard.d.ts","sourceRoot":"","sources":["../../../../src/commands/init/wizard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAOH,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACnE,OAAO,EAA8B,KAAK,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AAEvF,OAAO,EAAkD,KAAK,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAazG,4EAA4E;AAC5E,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,sFAAsF;IACtF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gFAAgF;IAChF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kEAAkE;IAClE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,6CAA6C;IAC7C,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,2DAA2D;IAC3D,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3D,kFAAkF;AAClF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,uEAAuE;IACvE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,6BAA6B;AAC7B,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,kDAAkD;AAClD,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,OAAO,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB;AAED,kFAAkF;AAClF,MAAM,WAAW,WAAW;IAC1B,qEAAqE;IACrE,KAAK,CAAC,EAAE,OAAO,kBAAkB,CAAC;IAClC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE;AAED,mCAAmC;AACnC,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;IAClD,GAAG,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;CAC1C;AAED,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,UAAU,CAAC;IACjB,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,4EAA4E;AAC5E,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7G,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,CAAC,CAAA;SAAE,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzH,OAAO,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACzE;AAED,2EAA2E;AAC3E,eAAO,MAAM,yBAAyB,QAGc,CAAC;AAErD,oDAAoD;AACpD,eAAO,MAAM,uBAAuB,uDAAuD,CAAC;AAE5F,0FAA0F;AAC1F,eAAO,MAAM,qBAAqB,MAAM,CAAC;AAWzC;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,GAAG,MAAM,CAEvF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE,CAI7D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAEtD;AAED,0DAA0D;AAC1D,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAErD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,aAAa,EAAE,IAAI,GAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAO,GAAG,MAAM,CAYlG;AAED;;;;;;;;GAQG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,aAAa,EACnB,QAAQ,EAAE,QAAQ,GAAG,IAAI,EACzB,WAAW,EAAE,OAAO,GACnB;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,CAAA;CAAE,CA0BxE;AAID,wFAAwF;AACxF,eAAO,MAAM,YAAY,EAAE,UAsD1B,CAAC;AAkCF,wDAAwD;AACxD,MAAM,MAAM,QAAQ,GAAG,mBAAmB,GAAG,iBAAiB,GAAG,WAAW,GAAG,YAAY,GAAG,SAAS,CAAC;AAExG;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAW1E;AAuED,kFAAkF;AAClF,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAAuD,CAAC;AAEtG;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAQxG;AAqBD;;;;;;;;;;GAUG;AACH,wBAAsB,aAAa,CACjC,IAAI,EAAE,aAAa,EACnB,IAAI,GAAE;IACJ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;IAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,WAAW,CAAC;CAChB,GACL,OAAO,CAAC,MAAM,CAAC,CAmGjB"}