@aisa-one/cli 0.3.0 → 0.5.0

package/dist/commands/flow.d.ts

@@ -0,0 +1,685 @@
+/**
+ * What `aisa connect` asks, in the order it asks it — as data.
+ *
+ * The page and the terminal are two renderers of this file, not two programs
+ * that happen to agree. Before it existed they were the latter: every sentence
+ * on the T2 page lived inside a template string (82% of that file is markup),
+ * so the terminal carried a hand-written paraphrase of the same choices. Two
+ * copies of the same wording drift, and nothing catches it — there is no test
+ * that can compare a sentence in HTML against a sentence in a log line.
+ *
+ * So copy lives here, beside the structure it belongs to. A step that the page
+ * renders as a card and the terminal renders as a numbered menu is still one
+ * step, with one question and one set of options.
+ *
+ * ── Language ──────────────────────────────────────────────────────────────
+ * Every user-facing string is a `Text`: `{ en, zh }`. This is a product
+ * surface, not the machine-readable one — `aisa manifest`, MCP tool
+ * descriptions and OpenAPI summaries stay English-only, per the workspace
+ * convention, because those are read by agents everywhere. What a person sees
+ * while choosing is a different audience.
+ *
+ * The chosen language is stored by the CLI (see config.ts), not in the
+ * browser: the page is served by this process, and a language kept only in
+ * localStorage would leave the terminal in English while the page is in
+ * Chinese — the exact split this file exists to prevent.
+ *
+ * ── Scope ─────────────────────────────────────────────────────────────────
+ * Step 2 (Your agent) is here now. The remaining steps still render from
+ * connect-t2.ts and are being moved one at a time, each behind the byte-exact
+ * page snapshots in tests/connect-snapshot.test.ts.
+ */
+export declare const LANGS: readonly ["en", "zh"];
+export type Lang = (typeof LANGS)[number];
+/** One string in every language it is offered in. */
+export interface Text {
+    en: string;
+    zh: string;
+}
+export declare function t(text: Text, lang: Lang): string;
+/**
+ * Resolve the language for this run: explicit flag, then what was chosen and
+ * remembered, then the OS, then English.
+ *
+ * The OS check is deliberately loose — `zh_CN.UTF-8`, `zh-Hans`, `zh_TW` all
+ * mean a reader who would rather not be handed English.
+ */
+export declare function resolveLang(flag?: string, stored?: string, env?: NodeJS.ProcessEnv): Lang;
+/** A choice within a step. `detail` is the sentence under the label. */
+export interface FlowOption {
+    id: string;
+    label: Text;
+    detail?: Text;
+    /** Shown instead of `detail` when the thing is not installed. */
+    absentDetail?: Text;
+}
+export interface FlowStep {
+    id: string;
+    n: number;
+    title: Text;
+    sub: Text;
+    question: Text;
+    lede?: Text;
+}
+export declare const STEP_AGENT: FlowStep;
+/**
+ * Fixed card order, whatever is or is not installed: the terminal agents
+ * first, then the editors, then the web targets. Order is part of the flow,
+ * not of one renderer — a menu that renumbers itself between the page and the
+ * terminal would make "pick 2" mean two different things.
+ */
+export declare const AGENT_ORDER: readonly ["claude-code", "codex", "opencode", "vscode", "cursor", "claude-desktop", "claude-ai"];
+export declare function agentRank(id: string): number;
+/** Badges on an agent card. The terminal renders the same three states. */
+export declare const AGENT_BADGE: {
+    detected: {
+        en: string;
+        zh: string;
+    };
+    absent: {
+        en: string;
+        zh: string;
+    };
+    web: {
+        en: string;
+        zh: string;
+    };
+    notFound: {
+        en: string;
+        zh: string;
+    };
+    soon: {
+        en: string;
+        zh: string;
+    };
+};
+export declare const AGENT_SIDE_TITLES: {
+    how: {
+        en: string;
+        zh: string;
+    };
+    have: {
+        en: string;
+        zh: string;
+    };
+};
+/** Offer to install a missing agent, with the exact command that will run. */
+/** Fill {name} placeholders. Keeps punctuation inside the translated string. */
+export declare function fill(text: Text, lang: Lang, vars: Record<string, string | number>): string;
+export declare function installOffer(command: string, lang: Lang): string;
+/**
+ * What connecting each agent actually does, in its own terms.
+ *
+ * These name the real mechanism — `claude mcp add`, a provider block in
+ * config.toml — because the question a reader has at this step is "what are
+ * you about to do to my machine", and the honest answer is the command.
+ */
+export declare const AGENT_NOTES: Record<string, Text>;
+/**
+ * The answer to "will this break what I already have", per agent.
+ *
+ * Asked on this step rather than later because it is what decides whether
+ * someone continues at all.
+ */
+export declare const AGENT_HAVE_NOTES: Record<string, Text>;
+/**
+ * The six steps, and one glyph each.
+ *
+ * `icon` is for the terminal only. The page has a numbered rail down its left
+ * edge — position, colour and a tick already say which step you are on, and a
+ * sixth signal would be decoration. A terminal has none of that: the headers
+ * scroll past in one column of text, and after two of them "3/6" and "4/6"
+ * are the same shape. The glyph is what the eye finds when scrolling back.
+ *
+ * One per step and never repeated, so it identifies rather than decorates.
+ * Deliberately not the marks the journal already uses for outcomes
+ * (✅ ⚠️ ❌ ℹ️) — a step heading is not a result.
+ */
+export declare const STEP_TITLES: Array<{
+    n: number;
+    title: Text;
+    sub: Text;
+    icon: string;
+}>;
+export declare const STEP_WELCOME: {
+    h1: {
+        en: string;
+        zh: string;
+    };
+    lede: {
+        en: string;
+        zh: string;
+    };
+    tiles: {
+        h3: {
+            en: string;
+            zh: string;
+        };
+        p: {
+            en: string;
+            zh: string;
+        };
+    }[];
+};
+export declare const STEP_MODELS: {
+    h1: {
+        en: string;
+        zh: string;
+    };
+    lede: {
+        en: string;
+        zh: string;
+    };
+    callout: {
+        en: string;
+        zh: string;
+    };
+    rerun: {
+        en: string;
+        zh: string;
+    };
+    h2Prefix: {
+        en: string;
+        zh: string;
+    };
+    h2Suffix: {
+        en: string;
+        zh: string;
+    };
+    yourAgent: {
+        en: string;
+        zh: string;
+    };
+    recommended: {
+        en: string;
+        zh: string;
+    };
+    freshSwitch: {
+        name: {
+            en: string;
+            zh: string;
+        };
+        brief: {
+            en: string;
+            zh: string;
+        };
+    };
+    notNow: {
+        name: {
+            en: string;
+            zh: string;
+        };
+        briefFresh: {
+            en: string;
+            zh: string;
+        };
+        briefDetected: {
+            en: string;
+            zh: string;
+        };
+    };
+    backup: {
+        name: {
+            en: string;
+            zh: string;
+        };
+    };
+    switchIt: {
+        name: {
+            en: string;
+            zh: string;
+        };
+        brief: {
+            en: string;
+            zh: string;
+        };
+    };
+    warn: {
+        head: {
+            en: string;
+            zh: string;
+        };
+        body: {
+            en: string;
+            zh: string;
+        };
+        fix: {
+            en: string;
+            zh: string;
+        };
+    };
+};
+/** Why the Models step has nothing to offer a file-configured client. */
+export declare const FILE_MODEL_NOTE: Record<string, Text>;
+/** Backup-mode consent copy, per client — the same contract T1 shows. */
+export declare const BACKUP_COPY: Record<string, Text>;
+export declare const STEP_CAPS: {
+    h1: {
+        en: string;
+        zh: string;
+    };
+    ledeTail: {
+        en: string;
+        zh: string;
+    };
+    pickArea: {
+        en: string;
+        zh: string;
+    };
+    selectAll: {
+        en: string;
+        zh: string;
+    };
+    /**
+     * The counts sentence as one string, because punctuation is not shared
+     * between languages: joining "N", "areas", ", " in code produced
+     * "2 个领域, 2 个 server, 48 个工具." — Chinese text with ASCII commas and a
+     * full stop. Whatever varies goes in as a placeholder instead.
+     */
+    counts: {
+        en: string;
+        zh: string;
+    };
+    /** Category tile meta: "3 servers · 47 tools". */
+    tileMeta: {
+        en: string;
+        zh: string;
+    };
+    /**
+     * A placeholder both renderers can fill. The page used to carry
+     * <b id="mModel"></b> here and fill it with script — which left the
+     * terminal printing "AIsa()" with nothing inside, because stripping tags is
+     * all it can do with markup meant for the other surface.
+     */
+    serversWord: {
+        en: string;
+        zh: string;
+    };
+    serverWord: {
+        en: string;
+        zh: string;
+    };
+    toolsWord: {
+        en: string;
+        zh: string;
+    };
+};
+/** Shown for a file-configured client that has no note of its own. */
+export declare const FILE_MODEL_FALLBACK: Text;
+export declare const CATEGORY_BLURB: Record<string, Text>;
+export declare const STEP_INSTALL: {
+    h1: {
+        en: string;
+        zh: string;
+    };
+    lede: {
+        en: string;
+        zh: string;
+    };
+    authKeyed: {
+        en: string;
+        zh: string;
+    };
+    authFresh: {
+        en: string;
+        zh: string;
+    };
+};
+export declare const STEP_DONE: {
+    eyebrow: {
+        en: string;
+        zh: string;
+    };
+    h1: {
+        en: string;
+        zh: string;
+    };
+    lede: {
+        en: string;
+        zh: string;
+    };
+};
+export declare const RUNTIME_COPY: {
+    readonly nothingSelected: {
+        readonly en: "Nothing selected yet — pick at least one server.";
+        readonly zh: "还没有选择 —— 至少选一个 server。";
+    };
+    readonly planBackup: {
+        readonly "claude-code": {
+            readonly en: "Install the claude-aisa command";
+            readonly zh: "安装 claude-aisa 命令";
+        };
+        readonly codex: {
+            readonly en: "Add the aisa profile and codex-aisa";
+            readonly zh: "添加 aisa profile 和 codex-aisa";
+        };
+        readonly vscode: {
+            readonly en: "Add AIsa models to VS Code chat";
+            readonly zh: "把 AIsa 模型加进 VS Code 聊天";
+        };
+        readonly other: {
+            readonly en: "Add AIsa as a backup provider";
+            readonly zh: "把 AIsa 添加为备用 provider";
+        };
+    };
+    readonly planBackupNote: {
+        readonly en: "your current setup stays untouched";
+        readonly zh: "你现有的配置原封不动";
+    };
+    readonly ledeFailed: {
+        readonly en: "Some steps did not complete — the details are in the list; your results page explains how to retry.";
+        readonly zh: "有些步骤没有完成 —— 明细在上面的列表里,结果页会说明怎么重试。";
+    };
+    readonly ledeAllRan: {
+        readonly en: "Everything ran. Your results, balance and try-it-now prompts are on the last step.";
+        readonly zh: "全部执行完毕。结果、余额和可以直接试的提示语都在最后一步。";
+    };
+    readonly backupIntact: {
+        readonly en: "Your usual setup is untouched.";
+        readonly zh: "你平时用的配置原封不动。";
+    };
+    readonly backupOpencode: {
+        readonly en: "Pick <code>aisa/…</code> from opencode's model list whenever you want AIsa.";
+        readonly zh: "想用 AIsa 的时候,在 opencode 的模型列表里选 <code>aisa/…</code> 即可。";
+    };
+    readonly backupBin: {
+        readonly en: "Run <code>{bin}</code> whenever you want AIsa's models; delete that one file to remove it.";
+        readonly zh: "想用 AIsa 的模型时就跑 <code>{bin}</code>;删掉那一个文件就等于移除。";
+    };
+    readonly noKeyStored: {
+        readonly en: "No key stored here — run <code>aisa login</code>, then copy it from <code>~/.aisa/key</code>.";
+        readonly zh: "本机没有存 key —— 先跑 <code>aisa login</code>,再从 <code>~/.aisa/key</code> 复制。";
+    };
+    readonly cannotStartApp: {
+        readonly en: "Could not start {name} — open it from your Applications folder.";
+        readonly zh: "无法启动 {name} —— 请从应用程序文件夹里手动打开。";
+    };
+    readonly cannotOpenTerminal: {
+        readonly en: "Could not open a terminal — run <b><code>{bin}</code></b> in any terminal.";
+        readonly zh: "无法打开终端 —— 在任意终端里跑 <b><code>{bin}</code></b>。";
+    };
+};
+/** Flatten RUNTIME_COPY to plain strings for the page script. */
+export declare function runtimeCopy(lang: Lang): Record<string, unknown>;
+/** What each language calls itself — never translated. */
+export declare const LANG_LABEL: Record<Lang, string>;
+export declare const NAV: {
+    back: {
+        en: string;
+        zh: string;
+    };
+};
+/** The forward button, worded for the step it leads out of. */
+export declare const NEXT_WORD: Record<number, Text>;
+/** The last gate before anything is written. */
+export declare const CONFIRM: {
+    heading: {
+        en: string;
+        zh: string;
+    };
+    agent: {
+        en: string;
+        zh: string;
+    };
+    models: {
+        en: string;
+        zh: string;
+    };
+    capabilities: {
+        en: string;
+        zh: string;
+    };
+    /**
+     * A word, not a keystroke. Everything up to here was reversible browsing;
+     * this is the point where files on the machine change, and a prompt you can
+     * clear with a stray return is the wrong shape for it.
+     */
+    /**
+     * A picker rather than a typed word.
+     *
+     * Typing was the first shape, and it fought the arrow-key steps beside it:
+     * keys left in the buffer by the picker arrived at readline as empty lines,
+     * which re-asked, which read again — the prompt repeated down the screen
+     * and tangled with the one after it. One input method for the whole flow.
+     *
+     * The deliberateness is kept by where the cursor starts: on "go back", so
+     * a stray return changes nothing.
+     */
+    apply: {
+        en: string;
+        zh: string;
+    };
+    goBack: {
+        en: string;
+        zh: string;
+    };
+    ask: {
+        en: string;
+        zh: string;
+    };
+    cancelled: {
+        en: string;
+        zh: string;
+    };
+    /** n means change something, not give up — the run is still yours. */
+    backToEdit: {
+        en: string;
+        zh: string;
+    };
+};
+/** The last question: run something now, or hand the terminal back. */
+export declare const LAUNCH: {
+    question: {
+        en: string;
+        zh: string;
+    };
+    exit: {
+        en: string;
+        zh: string;
+    };
+    /** Says what it does: the page goes with it. Claiming the page survives
+     *  was true only while the process lingered, which is what made Exit feel
+     *  broken — it did not exit. */
+    exitNote: {
+        en: string;
+        zh: string;
+    };
+};
+/** Shown on a page a newer run has taken over. */
+/**
+ * How a run introduces the two surfaces it is about to use.
+ *
+ * The console case used to lead with what was missing — "no browser on this
+ * machine" — which reads like a fault report for something that is not a
+ * fault at all. A server without a desktop is a perfectly ordinary place to
+ * run this, and the terminal is a first-class way through the flow, not a
+ * consolation. So it is introduced as a mode, by name, and the sentence
+ * after it gets on with the work.
+ */
+export declare const SURFACE: {
+    readonly pageTitle: {
+        readonly en: "Open this page to choose";
+        readonly zh: "打开这个页面来选择";
+    };
+    readonly opening: {
+        readonly en: "opening your browser… (or answer here — both stay in step)";
+        readonly zh: "正在打开浏览器…(也可以直接在这里回答 —— 两边始终同步)";
+    };
+    readonly urlOnly: {
+        readonly en: "open the URL above, or answer here — both stay in step";
+        readonly zh: "打开上面的地址,或者直接在这里回答 —— 两边始终同步";
+    };
+    readonly consoleTitle: {
+        readonly en: "Console mode";
+        readonly zh: "控制台模式";
+    };
+    readonly consoleBody: {
+        readonly en: "The browser view is not open here, so we will do this together in the terminal — the same questions, and it is very easy. Off we go.";
+        readonly zh: "这里没有开浏览器界面,我们就用命令行一起把它选完 —— 问题都一样,非常简单。这就开始。";
+    };
+};
+/**
+ * Signing in from a machine whose browser is somewhere else.
+ *
+ * Clerk offers authorization_code and refresh_token and nothing else — no
+ * device grant — so there is no "type this short code" flow to reach for.
+ * What there is works, but only if the person is told plainly that the last
+ * page is *supposed* to fail: they are being asked to copy an address out of
+ * a browser that is showing an error, which nobody does unless told to.
+ */
+export declare const SIGNIN: {
+    readonly start: {
+        readonly en: "Signing in to AIsa…";
+        readonly zh: "正在登录 AIsa…";
+    };
+    readonly willOpen: {
+        readonly en: "Your browser will open — approve the sign-in there.";
+        readonly zh: "浏览器就要打开了 —— 在那里确认登录。";
+    };
+    readonly ifNot: {
+        readonly en: "If it does not open, visit:";
+        readonly zh: "如果没有自动打开,访问:";
+    };
+    readonly here: {
+        readonly en: "This machine has no browser, so sign in on the one in front of you.";
+        readonly zh: "这台机器上没有浏览器,请在你面前那台电脑上登录。";
+    };
+    readonly step1: {
+        readonly en: "1. Open this address there:";
+        readonly zh: "1. 在那台电脑上打开这个地址:";
+    };
+    readonly step2: {
+        readonly en: "2. Sign in. A page then shows you a short block of text — press Copy.";
+        readonly zh: "2. 登录。之后会出现一个页面,上面有一小段文字 —— 点「复制」。";
+    };
+    readonly step3: {
+        readonly en: "3. Paste it below.";
+        readonly zh: "3. 粘贴到下面。";
+    };
+    readonly prompt: {
+        readonly en: "Paste it here: ";
+        readonly zh: "粘贴到这里: ";
+    };
+    readonly badPaste: {
+        readonly en: "that does not look like the redirect — it should contain code=";
+        readonly zh: "这看起来不是那个跳转地址 —— 里面应该有 code=";
+    };
+};
+/** What the browser is told when a sign-in lands back on this machine. */
+export declare const SIGNIN_PAGE: {
+    readonly ok: {
+        readonly title: {
+            readonly en: "Signed in";
+            readonly zh: "登录成功";
+        };
+        readonly body: {
+            readonly en: "Your key has been created on the machine you started from. You can close this tab.";
+            readonly zh: "key 已经在你发起登录的那台机器上生成好了。可以关掉这个标签页了。";
+        };
+    };
+    readonly failed: {
+        readonly title: {
+            readonly en: "Sign-in was not completed";
+            readonly zh: "登录没有完成";
+        };
+        readonly body: {
+            readonly en: "Nothing was changed. Return to your terminal and try again.";
+            readonly zh: "什么都没有改动。回到终端重新试一次。";
+        };
+    };
+};
+export declare const SUPERSEDED: {
+    title: {
+        en: string;
+        zh: string;
+    };
+    /** The other way a page ends: nobody replaced it, its time ran out. */
+    expiringTitle: {
+        en: string;
+        zh: string;
+    };
+    expiringBody: {
+        en: string;
+        zh: string;
+    };
+    body: {
+        en: string;
+        zh: string;
+    };
+    seconds: {
+        en: string;
+        zh: string;
+    };
+    closed: {
+        en: string;
+        zh: string;
+    };
+    /**
+     * The two lines every ending carries, whatever ended.
+     *
+     * A surface that is closing has the reader's attention and nothing left to
+     * spend it on — which is the one moment these are useful rather than in the
+     * way. Both are addresses, not buttons: a button is clicked once and
+     * forgotten, while `console.aisa.one` and `aisa connect` are things someone
+     * can still type next week. That is the whole point of putting them here.
+     */
+    console: {
+        en: string;
+        zh: string;
+    };
+    consoleDomain: string;
+    againBefore: {
+        en: string;
+        zh: string;
+    };
+    againCmd: string;
+    againAfter: {
+        en: string;
+        zh: string;
+    };
+};
+/**
+ * The second tab, once the sign-in is done.
+ *
+ * A sign-in started from inside `connect` opens a new tab, and that tab has
+ * to end somewhere. Ending it on "you can close this tab" is right for
+ * standalone `aisa login`, where closing it is the whole of what is left —
+ * but wrong here, where a setup is still running one tab over and the reader
+ * has just been sent away from it. This page goes back instead.
+ */
+export declare const RETURN_PAGE: {
+    readonly ok: {
+        readonly title: {
+            readonly en: "Signed in";
+            readonly zh: "登录成功";
+        };
+        readonly body: {
+            readonly en: "Taking you back to your setup — it carries on from where it was.";
+            readonly zh: "正在带你回到刚才的配置流程 —— 会从原来的位置继续。";
+        };
+    };
+    readonly failed: {
+        readonly title: {
+            readonly en: "Sign-in was not completed";
+            readonly zh: "登录没有完成";
+        };
+        readonly body: {
+            readonly en: "Nothing was changed. Go back to your setup and try the sign-in again.";
+            readonly zh: "什么都没有改动。回到配置流程再登录一次。";
+        };
+    };
+    readonly stale: {
+        readonly title: {
+            readonly en: "Nothing is waiting for this";
+            readonly zh: "这次回调已经没人在等了";
+        };
+        readonly body: {
+            readonly en: "This sign-in has already been answered. Back to your setup.";
+            readonly zh: "这次登录已经处理过了。回到你的配置流程。";
+        };
+    };
+    readonly link: {
+        readonly en: "Back to your setup";
+        readonly zh: "回到配置流程";
+    };
+};