feishu-codex-console 1.0.0-beta.6

package/dist/runbook-card.js

@@ -0,0 +1,272 @@
+import { runbookHasDefaultInputs } from "./runbooks.js";
+export function renderRunbookCenterCard(snapshot) {
+    const ready = snapshot.catalog.status === "ready";
+    return {
+        schema: "2.0",
+        config: {
+            update_multi: true,
+            width_mode: "default",
+            enable_forward: false,
+            summary: {
+                content: `Codex 团队运行手册 · ${snapshot.projectName} · ${snapshot.catalog.runbooks.length} 项`,
+            },
+        },
+        header: {
+            title: { tag: "plain_text", content: "Codex 团队运行手册" },
+            subtitle: {
+                tag: "plain_text",
+                content: "仓库内审核过的任务模板，一键运行也不会提升权限",
+            },
+            template: ready ? "violet" : "grey",
+            icon: { tag: "standard_icon", token: "tasklist_colorful" },
+            text_tag_list: [
+                {
+                    tag: "text_tag",
+                    text: { tag: "plain_text", content: safe(snapshot.projectName).slice(0, 28) },
+                    color: "blue",
+                },
+                {
+                    tag: "text_tag",
+                    text: {
+                        tag: "plain_text",
+                        content: ready ? `${snapshot.catalog.runbooks.length} 个模板` : statusLabel(snapshot.catalog.status),
+                    },
+                    color: ready ? "violet" : "neutral",
+                },
+            ],
+        },
+        body: {
+            direction: "vertical",
+            padding: "12px 12px 18px 12px",
+            vertical_spacing: "12px",
+            elements: [
+                ...(snapshot.feedback ? [feedbackPanel(snapshot.feedback)] : []),
+                sourcePanel(snapshot),
+                ...(snapshot.catalog.runbooks.length > 0
+                    ? snapshot.catalog.runbooks.slice(0, 12).map((runbook, index) => runbookPanel(runbook, index, snapshot.canOperate))
+                    : [emptyPanel(snapshot)]),
+                actionGrid(),
+                {
+                    tag: "markdown",
+                    element_id: "runbook_safety_note",
+                    text_size: "notation",
+                    text_align: "center",
+                    content: "<font color='grey'>模板只能降低权限；提交、推送、部署和 PR 不能通过一键运行预授权。</font>",
+                },
+            ],
+        },
+    };
+}
+function sourcePanel(snapshot) {
+    const status = snapshot.catalog.status;
+    const detail = status === "ready"
+        ? "配置已通过格式与安全校验；任务仍按成员角色、项目 ACL 和仓库策略执行。"
+        : status === "missing"
+            ? "当前项目还没有运行手册。复制示例文件到仓库根目录并提交评审即可启用。"
+            : `配置未启用：${snapshot.catalog.error ?? "未知格式错误"}`;
+    return {
+        tag: "column_set",
+        element_id: "runbook_source",
+        flex_mode: "none",
+        columns: [
+            {
+                tag: "column",
+                width: "weighted",
+                weight: 1,
+                background_style: status === "invalid" ? "red-50" : status === "ready" ? "blue-50" : "grey-50",
+                padding: "10px 12px 10px 12px",
+                elements: [
+                    {
+                        tag: "markdown",
+                        element_id: "runbook_source_text",
+                        content: `**${statusLabel(status)}**\n<font color='grey'>${safe(detail)}</font>`,
+                    },
+                ],
+            },
+        ],
+    };
+}
+function runbookPanel(runbook, index, canOperate) {
+    const runnable = canOperate && runbookHasDefaultInputs(runbook);
+    const parameterHint = runbook.parameters.length > 0
+        ? `参数 ${runbook.parameters.map((parameter) => parameter.label).join("、")}`
+        : "无需参数";
+    const settingHint = [
+        runbook.model ? `模型 ${runbook.model}` : "沿用模型",
+        runbook.reasoningEffort ? `推理 ${runbook.reasoningEffort}` : "沿用推理",
+        runbook.sandboxMode ? permissionLabel(runbook.sandboxMode) : "不提升权限",
+    ].join(" · ");
+    const elements = [
+        {
+            tag: "markdown",
+            element_id: `runbook_text_${index}`,
+            content: `**${safe(runbook.name)}**  <text_tag color='violet'>${safe(runbook.id)}</text_tag>\n` +
+                `${safe(runbook.description)}\n` +
+                `<font color='grey'>${safe(parameterHint)} · ${safe(settingHint)}</font>\n` +
+                `<font color='grey'>任务预览</font>  ${safe(promptPreview(runbook.prompt))}`,
+        },
+    ];
+    if (runnable) {
+        elements.push(runButton(runbook, index));
+    }
+    else if (!canOperate) {
+        elements.push({
+            tag: "markdown",
+            element_id: `runbook_readonly_${index}`,
+            text_size: "notation",
+            content: "<font color='grey'>只读成员不能启动运行手册。</font>",
+        });
+    }
+    else {
+        elements.push({
+            tag: "markdown",
+            element_id: `runbook_usage_${index}`,
+            text_size: "notation",
+            content: `<font color='blue'>发送 /run ${safe(runbook.id)} ${safe(parameterUsage(runbook))}</font>`,
+        });
+    }
+    return {
+        tag: "column_set",
+        element_id: `runbook_${index}`,
+        flex_mode: "none",
+        columns: [
+            {
+                tag: "column",
+                width: "weighted",
+                weight: 1,
+                background_style: "grey-50",
+                padding: "12px 12px 12px 12px",
+                vertical_spacing: "8px",
+                elements,
+            },
+        ],
+    };
+}
+function runButton(runbook, index) {
+    return {
+        tag: "button",
+        element_id: `runbook_run_${index}`,
+        text: { tag: "plain_text", content: "使用默认参数运行" },
+        type: "primary_filled",
+        width: "fill",
+        confirm: {
+            title: { tag: "plain_text", content: `运行“${runbook.name}”？` },
+            text: {
+                tag: "plain_text",
+                content: "会在当前项目创建独立任务；实际权限不会高于你的当前设置。",
+            },
+        },
+        behaviors: [
+            {
+                type: "callback",
+                value: {
+                    bridge: "feishu-codex-v7",
+                    action: "runbook_run",
+                    runbook_id: runbook.id,
+                },
+            },
+        ],
+    };
+}
+function emptyPanel(snapshot) {
+    return {
+        tag: "column_set",
+        element_id: "runbook_empty",
+        flex_mode: "none",
+        columns: [
+            {
+                tag: "column",
+                width: "weighted",
+                weight: 1,
+                background_style: "grey-50",
+                padding: "12px 12px 12px 12px",
+                elements: [
+                    {
+                        tag: "markdown",
+                        content: snapshot.catalog.status === "invalid"
+                            ? "**运行手册已暂停**\n<font color='grey'>修复仓库配置后点击刷新；无效模板不会执行。</font>"
+                            : "**从一个小模板开始**\n<font color='grey'>建议先加入测试、检查或生成文档类任务。</font>",
+                    },
+                ],
+            },
+        ],
+    };
+}
+function feedbackPanel(feedback) {
+    return {
+        tag: "column_set",
+        element_id: "runbook_feedback",
+        flex_mode: "none",
+        columns: [
+            {
+                tag: "column",
+                width: "weighted",
+                weight: 1,
+                background_style: "green-50",
+                padding: "10px 12px 10px 12px",
+                elements: [{ tag: "markdown", content: `<font color='green'>${safe(feedback)}</font>` }],
+            },
+        ],
+    };
+}
+function actionGrid() {
+    const actions = [
+        button("项目工作台", "runbook_projects"),
+        button("团队工作台", "runbook_team"),
+        button("刷新", "runbook_refresh"),
+    ];
+    return {
+        tag: "column_set",
+        element_id: "runbook_actions",
+        flex_mode: "none",
+        horizontal_spacing: "8px",
+        columns: actions.map((action) => ({
+            tag: "column",
+            width: "weighted",
+            weight: 1,
+            elements: [action],
+        })),
+    };
+}
+function button(text, action) {
+    return {
+        tag: "button",
+        element_id: action,
+        text: { tag: "plain_text", content: text },
+        type: "default",
+        width: "fill",
+        behaviors: [
+            {
+                type: "callback",
+                value: { bridge: "feishu-codex-v7", action },
+            },
+        ],
+    };
+}
+function statusLabel(status) {
+    if (status === "ready")
+        return "配置已校验";
+    if (status === "missing")
+        return "尚未配置";
+    return "配置需修复";
+}
+function permissionLabel(mode) {
+    return mode === "read-only" ? "只读" : "工作区写入";
+}
+function promptPreview(prompt) {
+    const normalized = prompt.replace(/\s+/g, " ");
+    return normalized.length > 140 ? `${normalized.slice(0, 139)}…` : normalized;
+}
+function parameterUsage(runbook) {
+    return runbook.parameters
+        .map((parameter) => `${parameter.name}="${parameter.defaultValue ?? parameter.label}"`)
+        .join(" ");
+}
+function safe(value) {
+    return value
+        .replaceAll("<", "＜")
+        .replaceAll(">", "＞")
+        .replaceAll("*", "＊")
+        .replaceAll("`", "｀")
+        .slice(0, 1_000);
+}

package/dist/runbooks.js

@@ -0,0 +1,191 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { externalActionsForPrompt } from "./policy.js";
+export const RUNBOOK_FILE = ".feishu-codex-runbooks.json";
+const MAX_RUNBOOK_FILE_BYTES = 256 * 1024;
+const MAX_RUNBOOKS = 30;
+export async function loadProjectRunbooks(projectPath) {
+    const file = path.join(projectPath, RUNBOOK_FILE);
+    try {
+        const source = await readFile(file);
+        if (source.byteLength > MAX_RUNBOOK_FILE_BYTES) {
+            throw new Error(`${RUNBOOK_FILE} 不能超过 ${MAX_RUNBOOK_FILE_BYTES / 1024} KB`);
+        }
+        return { file, status: "ready", runbooks: parseRunbookCatalog(source.toString("utf8")) };
+    }
+    catch (error) {
+        const code = error.code;
+        if (code === "ENOENT")
+            return { file, status: "missing", runbooks: [] };
+        return {
+            file,
+            status: "invalid",
+            runbooks: [],
+            error: error instanceof Error ? error.message : String(error),
+        };
+    }
+}
+export function parseRunbookCatalog(source) {
+    let parsed;
+    try {
+        parsed = JSON.parse(source);
+    }
+    catch {
+        throw new Error(`${RUNBOOK_FILE} 不是有效 JSON`);
+    }
+    if (!isRecord(parsed) || parsed.version !== 1 || !Array.isArray(parsed.runbooks)) {
+        throw new Error(`${RUNBOOK_FILE} 必须包含 version: 1 和 runbooks 数组`);
+    }
+    if (parsed.runbooks.length > MAX_RUNBOOKS) {
+        throw new Error(`每个项目最多配置 ${MAX_RUNBOOKS} 个运行手册`);
+    }
+    const ids = new Set();
+    return parsed.runbooks.map((raw, index) => {
+        if (!isRecord(raw))
+            throw new Error(`runbooks[${index}] 必须是对象`);
+        const id = requiredString(raw.id, `runbooks[${index}].id`, 40);
+        if (!/^[a-z0-9][a-z0-9_-]*$/i.test(id)) {
+            throw new Error(`运行手册 ID ${id} 只能包含字母、数字、下划线和连字符`);
+        }
+        if (ids.has(id))
+            throw new Error(`运行手册 ID 重复：${id}`);
+        ids.add(id);
+        const prompt = requiredString(raw.prompt, `${id}.prompt`, 8_000);
+        if (externalActionsForPrompt(prompt).length > 0) {
+            throw new Error(`${id}.prompt 包含提交、推送、部署或 PR 动作；一键运行手册不允许预授权外部动作`);
+        }
+        const sandboxMode = optionalEnum(raw.sandboxMode, ["read-only", "workspace-write"], `${id}.sandboxMode`);
+        const reasoningEffort = optionalEnum(raw.reasoningEffort, ["minimal", "low", "medium", "high", "xhigh", "ultra"], `${id}.reasoningEffort`);
+        const parameters = parseParameters(raw.parameters, id);
+        assertPromptParameters(prompt, parameters, id);
+        return {
+            id,
+            name: requiredString(raw.name, `${id}.name`, 60),
+            description: optionalString(raw.description, `${id}.description`, 180) ?? "团队审核过的任务模板",
+            prompt,
+            ...(sandboxMode ? { sandboxMode } : {}),
+            ...(typeof raw.model === "string" && raw.model.trim()
+                ? { model: requiredString(raw.model, `${id}.model`, 100) }
+                : {}),
+            ...(reasoningEffort ? { reasoningEffort } : {}),
+            parameters,
+        };
+    });
+}
+export function parseRunbookInvocation(prompt) {
+    const match = prompt
+        .trim()
+        .match(/^(?:运行手册|运行|run|\/run)\s+([a-z0-9][a-z0-9_-]*)(?:\s+(.+))?$/i);
+    if (!match?.[1])
+        return null;
+    const values = {};
+    const source = match[2]?.trim() ?? "";
+    if (source) {
+        const tokenPattern = /([a-z][a-z0-9_-]*)=("[^"]*"|'[^']*'|\S+)/gi;
+        let consumed = "";
+        for (const token of source.matchAll(tokenPattern)) {
+            const whole = token[0];
+            const name = token[1];
+            const rawValue = token[2];
+            if (!whole || !name || rawValue === undefined)
+                continue;
+            consumed += `${whole} `;
+            values[name] = unquote(rawValue).slice(0, 500);
+        }
+        const normalizedSource = source.replace(/\s+/g, " ").trim();
+        const normalizedConsumed = consumed.replace(/\s+/g, " ").trim();
+        if (normalizedSource !== normalizedConsumed)
+            return null;
+    }
+    return { id: match[1], values };
+}
+export function renderRunbookPrompt(runbook, values = {}) {
+    const known = new Set(runbook.parameters.map((parameter) => parameter.name));
+    const unknown = Object.keys(values).find((name) => !known.has(name));
+    if (unknown)
+        throw new Error(`运行手册不支持参数：${unknown}`);
+    let prompt = runbook.prompt;
+    for (const parameter of runbook.parameters) {
+        const value = values[parameter.name]?.trim() || parameter.defaultValue;
+        if (parameter.required && !value)
+            throw new Error(`缺少参数：${parameter.label}`);
+        const replacement = value ?? "";
+        prompt = prompt.replaceAll(`{{${parameter.name}}}`, replacement);
+    }
+    return prompt;
+}
+export function runbookHasDefaultInputs(runbook) {
+    return runbook.parameters.every((parameter) => !parameter.required || Boolean(parameter.defaultValue));
+}
+function parseParameters(value, runbookId) {
+    if (value === undefined)
+        return [];
+    if (!Array.isArray(value) || value.length > 12) {
+        throw new Error(`${runbookId}.parameters 必须是最多 12 项的数组`);
+    }
+    const names = new Set();
+    return value.map((raw, index) => {
+        if (!isRecord(raw))
+            throw new Error(`${runbookId}.parameters[${index}] 必须是对象`);
+        const name = requiredString(raw.name, `${runbookId}.parameters[${index}].name`, 40);
+        if (!/^[a-z][a-z0-9_-]*$/i.test(name)) {
+            throw new Error(`参数名 ${name} 格式无效`);
+        }
+        if (names.has(name))
+            throw new Error(`参数名重复：${name}`);
+        names.add(name);
+        const defaultValue = optionalString(raw.default, `${runbookId}.${name}.default`, 500);
+        return {
+            name,
+            label: requiredString(raw.label, `${runbookId}.${name}.label`, 60),
+            ...(typeof raw.description === "string" && raw.description.trim()
+                ? {
+                    description: requiredString(raw.description, `${runbookId}.${name}.description`, 120),
+                }
+                : {}),
+            required: raw.required === true,
+            ...(defaultValue !== undefined ? { defaultValue } : {}),
+        };
+    });
+}
+function assertPromptParameters(prompt, parameters, runbookId) {
+    const declared = new Set(parameters.map((parameter) => parameter.name));
+    const placeholders = [...prompt.matchAll(/\{\{([a-z][a-z0-9_-]*)\}\}/gi)].map((match) => match[1]);
+    const undeclared = placeholders.find((name) => !declared.has(name));
+    if (undeclared)
+        throw new Error(`${runbookId}.prompt 使用了未声明参数：${undeclared}`);
+    const unused = parameters.find((parameter) => !placeholders.includes(parameter.name));
+    if (unused)
+        throw new Error(`${runbookId}.parameters 声明了未使用参数：${unused.name}`);
+}
+function requiredString(value, name, max) {
+    if (typeof value !== "string" || !value.trim())
+        throw new Error(`${name} 必须是非空字符串`);
+    const normalized = value.trim();
+    if (normalized.length > max)
+        throw new Error(`${name} 不能超过 ${max} 个字符`);
+    return normalized;
+}
+function optionalString(value, name, max) {
+    if (value === undefined)
+        return undefined;
+    return requiredString(value, name, max);
+}
+function optionalEnum(value, allowed, name) {
+    if (value === undefined)
+        return undefined;
+    if (typeof value !== "string" || !allowed.includes(value)) {
+        throw new Error(`${name} 必须是：${allowed.join("、")}`);
+    }
+    return value;
+}
+function unquote(value) {
+    if ((value.startsWith('"') && value.endsWith('"')) ||
+        (value.startsWith("'") && value.endsWith("'"))) {
+        return value.slice(1, -1);
+    }
+    return value;
+}
+function isRecord(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}