@lark-apaas/miaoda-cli 0.1.0-alpha.097a394

package/LICENSE

@@ -0,0 +1,13 @@
+MIT License
+
+Copyright (c) 2024 Lark Technologies Pte. Ltd. and/or its affiliates
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,provided that the above copyright notice and this permission notice appear in all copies.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
+INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
+CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
+DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
+ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# miaoda-cli
+
+妙搭开发平台 Code Agent 命令行工具，为 Agent 提供原子能力。
+
+## 安装
+
+```bash
+pnpm add -g @lark-apaas/miaoda-cli
+```
+
+## 使用
+
+```bash
+# 设置默认应用（需要应用上下文的命令可用 --app-id 覆盖）
+export MIAODA_APP_ID=app_demo_xxx
+
+# 插件管理
+miaoda plugin list-packages
+miaoda plugin install @demo/example-plugin
+```
+
+JSON 结构化输出（Agent 推荐）：
+
+```bash
+# 输出全部字段
+miaoda plugin list --json
+
+# 可选字段级选择
+miaoda plugin list --json id,name
+
+# 或通过 --output 指定格式
+miaoda plugin list --output json
+```
+
+## 命令树
+
+命令以"域"作为第一级命名空间：
+
+| 域 | 用途 |
+|---|---|
+| `miaoda plugin ...` | 插件管理：安装、更新、移除、插件实例查询 |
+
+完整命令通过 `miaoda --help` 或 `miaoda <domain> --help` 查看。
+
+## 全局参数
+
+- `--json [fields]`：输出结构化 JSON，可选字段级选择（如 `--json id,name`）。
+- `--output <pretty|json>`：输出格式，默认 `pretty`。
+- `--verbose`：输出调试日志到 stderr。
+
+> `--app-id <id>` 非全局参数，需要应用上下文的命令会各自声明，默认读取 `MIAODA_APP_ID` 环境变量。
+
+## 环境变量
+
+- `MIAODA_APP_ID`：默认应用 ID，等价于 `--app-id`。
+- `MIAODA_CANARY_HEADER`：设置后所有 HTTP 请求自动带上 `x-tt-env: <值>` 小流量头（例：`export MIAODA_CANARY_HEADER=boe_xxx`）。
+
+## 输出契约
+
+- 默认文本输出（pretty），`--json` 或 `--output json` 切换为 JSON。
+- 错误始终写 stderr，业务数据写 stdout。
+- 完整的输出格式、JSON envelope、错误 shape、错误码前缀、退出码分类等见 [Agent 友好 CLI 设计规范](./docs/agent-friendly-cli.md)。
+
+## 贡献
+
+详见 [AGENTS.md](./AGENTS.md)。

package/bin/miaoda.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("../dist/main.js");

package/dist/api/db/api.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execSql = execSql;
+exports.getSchema = getSchema;
+exports.importData = importData;
+exports.exportData = exportData;
+const http_1 = require("../../utils/http");
+const error_1 = require("../../utils/error");
+const client_1 = require("./client");
+/** dataloom 默认 dbBranch —— 单环境应用均传 main */
+const DEFAULT_DB_BRANCH = "main";
+// ── db sql → InnerExecuteSQL ──
+/**
+ * 执行 SQL。
+ * 后端：POST /v1/app/{appId}/dataloom/sql?dbBranch=main
+ *
+ * 返回所有 results[]（多条语句时每条一项）；CLI 侧按 PRD 仅取最后一条展示，
+ * 但 API 层保留完整列表以便测试和高级用法。
+ */
+async function execSql(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/sql", {
+        dbBranch: opts.dbBranch ?? DEFAULT_DB_BRANCH,
+    });
+    const response = await client.post(url, { sql: opts.sql });
+    if (!response.ok) {
+        // 4xx / 5xx：尝试解析 body 取 status_code 映射业务错误
+        let body = null;
+        try {
+            body = (await response.json());
+        }
+        catch {
+            // ignore
+        }
+        if (body)
+            (0, client_1.extractData)(body);
+        throw new error_1.HttpError(response.status, url, `Failed to execute SQL: ${String(response.status)} ${response.statusText}`);
+    }
+    const body = (await response.json());
+    const data = (0, client_1.extractData)(body);
+    return data.results ?? [];
+}
+// ── db schema → InnerGetSchema ──
+/**
+ * 查询 schema。
+ * 后端：GET /v1/app/{appId}/dataloom/schema?format=schema|ddl&tableNames=...&includeStats=...&dbBranch=main
+ *
+ * 返回 body.data（含 `schema` 或 `ddl`）供 handler 使用。
+ */
+async function getSchema(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/schema", {
+        format: opts.format ?? "schema",
+        tableNames: opts.tableNames,
+        includeStats: opts.includeStats ? "true" : undefined,
+        dbBranch: opts.dbBranch ?? DEFAULT_DB_BRANCH,
+    });
+    const response = await client.get(url);
+    if (!response.ok) {
+        let body = null;
+        try {
+            body = (await response.json());
+        }
+        catch {
+            // ignore
+        }
+        if (body)
+            (0, client_1.extractData)(body);
+        throw new error_1.HttpError(response.status, url, `Failed to get schema: ${String(response.status)} ${response.statusText}`);
+    }
+    const body = (await response.json());
+    return (0, client_1.extractData)(body);
+}
+// ── db data import → InnerImportData ──
+/**
+ * 导入文件。
+ * 后端：POST /v1/app/{appId}/dataloom/data/import?tableName=...&format=csv|json&dbBranch=main
+ *
+ * Body 为原始文件字节（不走 JSON envelope）。
+ */
+async function importData(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/data/import", {
+        tableName: opts.tableName,
+        format: opts.format,
+        dbBranch: opts.dbBranch ?? DEFAULT_DB_BRANCH,
+    });
+    const contentType = opts.format === "csv" ? "text/csv" : "application/json";
+    const ab = opts.body.buffer.slice(opts.body.byteOffset, opts.body.byteOffset + opts.body.byteLength);
+    const response = await client.request({
+        method: "POST",
+        url,
+        headers: { "Content-Type": contentType },
+        body: ab,
+    });
+    if (!response.ok) {
+        let body = null;
+        try {
+            body = (await response.json());
+        }
+        catch {
+            // ignore
+        }
+        if (body)
+            (0, client_1.extractData)(body);
+        throw new error_1.HttpError(response.status, url, `Failed to import data: ${String(response.status)} ${response.statusText}`);
+    }
+    // 后端 InnerImportData 响应里 data 直接返 {tableName, rows, durationMs}
+    const body = (await response.json());
+    const data = (0, client_1.extractData)(body);
+    return {
+        tableName: data.tableName ?? opts.tableName,
+        rows: data.rows ?? 0,
+        durationMs: data.durationMs ?? 0,
+    };
+}
+// ── db data export → InnerExportData ──
+/**
+ * 导出数据。
+ * 后端：POST /v1/app/{appId}/dataloom/data/export?tableName=...&format=csv|json&dbBranch=main
+ *
+ * 响应 body 为原始 CSV/JSON 字节（不走 envelope）。错误仍通过 HTTP 4xx/5xx + BaseResp 传达。
+ */
+async function exportData(opts) {
+    const client = (0, http_1.getHttpClient)();
+    const url = (0, client_1.buildInnerUrl)(opts.appId, "/data/export", {
+        tableName: opts.tableName,
+        format: opts.format,
+        dbBranch: opts.dbBranch ?? DEFAULT_DB_BRANCH,
+    });
+    const reqBody = { limit: opts.limit ?? 5000 };
+    const response = await client.post(url, reqBody);
+    if (!response.ok) {
+        // 错误路径：body 是 JSON envelope
+        let body = null;
+        try {
+            body = (await response.json());
+        }
+        catch {
+            // ignore
+        }
+        if (body)
+            (0, client_1.extractData)(body);
+        throw new error_1.HttpError(response.status, url, `Failed to export data: ${String(response.status)} ${response.statusText}`);
+    }
+    // 成功路径：响应 body 是原始 CSV/JSON 字节
+    const contentType = response.headers.get("Content-Type") ??
+        (opts.format === "csv" ? "text/csv" : "application/json");
+    const ab = await response.arrayBuffer();
+    const buf = Buffer.from(new Uint8Array(ab));
+    if (buf.length === 0) {
+        throw new error_1.AppError("INTERNAL_DB_ERROR", "Empty export response body");
+    }
+    return {
+        tableName: opts.tableName,
+        format: opts.format,
+        contentType,
+        body: buf,
+    };
+}

package/dist/api/db/client.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLSTATE_MAP = void 0;
+exports.ensureInnerSuccess = ensureInnerSuccess;
+exports.extractData = extractData;
+exports.buildInnerUrl = buildInnerUrl;
+const error_1 = require("../../utils/error");
+/**
+ * 校验 dataloom InnerAPI 响应的 envelope。
+ *
+ * 真实响应结构：`{ data: {...业务字段...}, status_code: "0" }`
+ * - `status_code == "0"` 或缺省视为成功
+ * - 其他值视为业务错误，按业务 code 或 SQLSTATE 映射到 CLI code
+ */
+function ensureInnerSuccess(body) {
+    if (!body) {
+        throw new error_1.AppError("INTERNAL_DB_ERROR", "empty response body");
+    }
+    const code = body.status_code ?? body.ErrorCode ?? "0";
+    if (code === "0" || code === "")
+        return;
+    const message = body.error_msg ?? body.ErrorMessage ?? `dataloom API error [${code}]`;
+    // k_dl_1300002 是 PG 执行透传错误；error_msg 里常带 SQLSTATE，优先按 SQLSTATE 映射
+    if (code === "k_dl_1300002") {
+        const sqlstate = extractSqlstate(message);
+        if (sqlstate && exports.SQLSTATE_MAP[sqlstate]) {
+            throw new error_1.AppError(exports.SQLSTATE_MAP[sqlstate], message);
+        }
+    }
+    // k_dl_1600000 是 dataloom 通用参数错误，不能整体映射；
+    // 只有 message 以 "Invalid DB Branch" 开头的情况对应"用户传了 --env 但 dbBranch 不存在 / 多环境未初始化"，
+    // 按技术方案固定映射为 MULTI_ENV_NOT_INITIALIZED（含固定 message 与 hint）。
+    if (code === "k_dl_1600000" && message.startsWith("Invalid DB Branch")) {
+        throw new error_1.AppError("MULTI_ENV_NOT_INITIALIZED", "--env is not available (multi-env not initialized)", {
+            next_actions: [
+                "Current app uses a single database for dev and production. Run `miaoda db migration init` to set up multi-env.",
+            ],
+        });
+    }
+    // 业务 code 优先映射到语义 CLI code；未知 code 透传为 DB_API_<code> 样式
+    const mapped = BIZ_ERR_MAP.get(code);
+    if (mapped) {
+        throw new error_1.AppError(mapped.code, mapped.message ?? message, {
+            next_actions: mapped.hint ? [mapped.hint] : undefined,
+        });
+    }
+    // 兜底：dataloom 未映射的 code 原样透传
+    throw new error_1.AppError(`DB_API_${code}`, message);
+}
+/** 从 PG 执行错误消息里提取 "(SQLSTATE XXXXX)"。 */
+function extractSqlstate(msg) {
+    const m = /SQLSTATE\s+([0-9A-Z]{5})/.exec(msg);
+    return m?.[1];
+}
+/**
+ * dataloom 业务错误码 → CLI 语义化 code 映射。
+ *
+ * 长期维护，观察到新 code 在此增补。
+ * 常见 dataloom 错误：详见 `common/dataloom_error/` 错误码定义（范围 `k_dl_*xxxxx`）。
+ */
+const BIZ_ERR_MAP = new Map(Object.entries({
+    // 来源：真实环境探测（dataloom InnerExecuteSQL / InnerGetSchema）
+    // k_dl_000001：DB 连接 / QPS 限流 等基础设施层错误
+    "k_dl_000001": { code: "INTERNAL_DB_ERROR", hint: "检查 dbBranch 与应用 PG 实例状态，或稍后重试" },
+    // k_dl_000002：SQL 解析 / 不支持的 SQL 类型（VACUUM、COPY、SET、SHOW 等）
+    "k_dl_000002": { code: "SQL_SYNTAX_ERROR" },
+    // k_dl_000003：查询命中系统表（pg_tables / pg_user 等）被拒
+    "k_dl_000003": { code: "SQL_OPERATION_FORBIDDEN" },
+    // k_dl_1300002：PG 执行错误；实际 SQLSTATE 由 extractSqlstate 单独映射
+    // 未匹配到 SQLSTATE 时走下面兜底 DB_API_<code>
+}));
+/** PG SQLSTATE → CLI code（当前 dataloom 不一定透传，预留未来使用） */
+exports.SQLSTATE_MAP = {
+    "42601": "SQL_SYNTAX_ERROR",
+    "42P01": "TABLE_NOT_FOUND",
+    "42703": "COLUMN_NOT_FOUND",
+    "57014": "STATEMENT_TIMEOUT",
+    "23505": "UNIQUE_VIOLATION",
+    "22P02": "TYPE_MISMATCH",
+};
+/**
+ * 从 envelope 里取 data 业务字段，校验成功后返回；失败则 throw。
+ */
+function extractData(body) {
+    ensureInnerSuccess(body);
+    if (!body?.data) {
+        throw new error_1.AppError("INTERNAL_DB_ERROR", "response missing data field");
+    }
+    return body.data;
+}
+/**
+ * 组装 `/v1/app/{appId}/dataloom/...` URL。
+ */
+function buildInnerUrl(appId, path, query) {
+    const normalized = path.startsWith("/") ? path : `/${path}`;
+    let url = `/v1/app/${encodeURIComponent(appId)}/dataloom${normalized}`;
+    if (query) {
+        const usp = new URLSearchParams();
+        for (const [k, v] of Object.entries(query)) {
+            if (v !== undefined && v !== "")
+                usp.append(k, v);
+        }
+        const qs = usp.toString();
+        if (qs)
+            url += `?${qs}`;
+    }
+    return url;
+}

package/dist/api/db/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pickTableDetail = exports.flattenSchemaList = exports.parseSqlResult = exports.SQLSTATE_MAP = exports.ensureInnerSuccess = exports.buildInnerUrl = exports.exportData = exports.importData = exports.getSchema = exports.execSql = void 0;
+var api_1 = require("./api");
+Object.defineProperty(exports, "execSql", { enumerable: true, get: function () { return api_1.execSql; } });
+Object.defineProperty(exports, "getSchema", { enumerable: true, get: function () { return api_1.getSchema; } });
+Object.defineProperty(exports, "importData", { enumerable: true, get: function () { return api_1.importData; } });
+Object.defineProperty(exports, "exportData", { enumerable: true, get: function () { return api_1.exportData; } });
+var client_1 = require("./client");
+Object.defineProperty(exports, "buildInnerUrl", { enumerable: true, get: function () { return client_1.buildInnerUrl; } });
+Object.defineProperty(exports, "ensureInnerSuccess", { enumerable: true, get: function () { return client_1.ensureInnerSuccess; } });
+Object.defineProperty(exports, "SQLSTATE_MAP", { enumerable: true, get: function () { return client_1.SQLSTATE_MAP; } });
+var parsers_1 = require("./parsers");
+Object.defineProperty(exports, "parseSqlResult", { enumerable: true, get: function () { return parsers_1.parseSqlResult; } });
+Object.defineProperty(exports, "flattenSchemaList", { enumerable: true, get: function () { return parsers_1.flattenSchemaList; } });
+Object.defineProperty(exports, "pickTableDetail", { enumerable: true, get: function () { return parsers_1.pickTableDetail; } });

package/dist/api/db/parsers.js

@@ -0,0 +1,157 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSqlResult = parseSqlResult;
+exports.flattenSchemaList = flattenSchemaList;
+exports.pickTableDetail = pickTableDetail;
+const error_1 = require("../../utils/error");
+// ── SQL 结果 ──
+/**
+ * 解析 InnerExecuteSQL 的单条 results[]（PRD 要求多条语句只取最后一条）。
+ */
+function parseSqlResult(r) {
+    if (r.sqlType === "SELECT") {
+        let rows = [];
+        if (r.data) {
+            try {
+                const parsed = JSON.parse(r.data);
+                if (Array.isArray(parsed))
+                    rows = parsed;
+            }
+            catch {
+                throw new error_1.AppError("INTERNAL_DB_ERROR", "Failed to parse SELECT result JSON");
+            }
+        }
+        return {
+            kind: "select",
+            rows,
+            recordCount: r.recordCount ?? rows.length,
+        };
+    }
+    if (r.sqlType === "INSERT" || r.sqlType === "UPDATE" || r.sqlType === "DELETE") {
+        const affected = r.affectedRows ?? extractRowCount(r.data);
+        return {
+            kind: "dml",
+            sqlType: r.sqlType,
+            affectedRows: affected,
+        };
+    }
+    // DDL or unknown
+    return { kind: "ddl" };
+}
+/** DML 的 data 通常是 `[{"rowCount": N}]`；兜底从这里读影响行数。 */
+function extractRowCount(data) {
+    if (!data)
+        return 0;
+    try {
+        const parsed = JSON.parse(data);
+        if (Array.isArray(parsed) && parsed.length > 0) {
+            const first = parsed[0];
+            const v = first.rowCount ?? first.affected_rows;
+            if (typeof v === "number")
+                return v;
+        }
+    }
+    catch {
+        // ignore
+    }
+    return 0;
+}
+// ── schema ──
+/**
+ * 合并 tables / views / materializedViews 为扁平 TableSummary[]（schema list 视图）。
+ * 统计信息（estimated_row_count / size_bytes）来自 `root.tableStats[tableName]`，
+ * 需请求带 `includeStats=true` 才会有。
+ */
+function flattenSchemaList(root) {
+    if (!root)
+        return [];
+    const statsMap = root.tableStats ?? {};
+    const out = [];
+    for (const t of root.tables?.data ?? [])
+        out.push(toSummary(t, statsMap[t.tableName]));
+    for (const v of root.views?.data ?? [])
+        out.push(toSummary(v, statsMap[v.tableName]));
+    for (const mv of root.materializedViews?.data ?? [])
+        out.push(toSummary(mv, statsMap[mv.tableName]));
+    return out;
+}
+function toSummary(t, stats) {
+    return {
+        name: t.tableName,
+        description: t.comment && t.comment.length > 0 ? t.comment : null,
+        columns: (t.fields ?? []).length,
+        estimated_row_count: typeof stats?.estimatedRowCount === "number" ? stats.estimatedRowCount : null,
+        size_bytes: typeof stats?.sizeBytes === "number" ? stats.sizeBytes : null,
+        updated_at: t.updatedAt,
+    };
+}
+/**
+ * 从 InnerSchemaRespVO 里定位单表 → 转 CLI TableDetail。
+ * 依次查 tables / views / materializedViews；找不到返回 null。
+ */
+function pickTableDetail(root, tableName) {
+    if (!root)
+        return null;
+    const stats = root.tableStats?.[tableName];
+    const pools = [
+        root.tables?.data,
+        root.views?.data,
+        root.materializedViews?.data,
+    ];
+    for (const arr of pools) {
+        if (!arr)
+            continue;
+        const hit = arr.find((t) => t.tableName === tableName);
+        if (hit)
+            return toDetail(hit, stats);
+    }
+    return null;
+}
+function toDetail(t, stats) {
+    // 优先用 tableStats.indexes（PRIMARY + UNIQUE + INDEX 统一视图）；
+    // 回退到 TableVO.indexes（仅二级索引，老后端没返回 tableStats 时使用）
+    const rawIndexes = stats?.indexes ?? t.indexes ?? [];
+    return {
+        name: t.tableName,
+        description: t.comment && t.comment.length > 0 ? t.comment : null,
+        columns: (t.fields ?? []).map(toColumn),
+        indexes: rawIndexes.map(toIndex),
+        estimated_row_count: typeof stats?.estimatedRowCount === "number" ? stats.estimatedRowCount : null,
+        size_bytes: typeof stats?.sizeBytes === "number" ? stats.sizeBytes : null,
+        created_at: t.createdAt,
+        updated_at: t.updatedAt,
+    };
+}
+function toColumn(f) {
+    const type = f.arrayElementType ? `${f.arrayElementType}[]` : f.type;
+    return {
+        name: f.fieldName,
+        type,
+        nullable: f.isNullable ?? false,
+        default: f.defaultValue ?? null,
+        // 后端 comment *string 在没有 comment 时可能返 "" 或 null，这里统一归一为 null（对齐 PRD）
+        comment: f.comment && f.comment.length > 0 ? f.comment : null,
+    };
+}
+function toIndex(i) {
+    return {
+        name: i.indexName,
+        type: translateIndexType(i.indexType),
+        columns: i.indexColumns ?? [],
+    };
+}
+/**
+ * 把后端原始 IndexType（小写：primary / unique / normal / foreign）翻译为 PRD 约定的展示值。
+ * 规则：
+ *   primary  → "PRIMARY KEY"
+ *   unique   → "UNIQUE"
+ *   其它    → "INDEX"（foreign 外键通过 relationships 表达，不进 indexes；真的遇到也归 INDEX）
+ */
+function translateIndexType(raw) {
+    const s = raw.toLowerCase();
+    if (s === "primary")
+        return "PRIMARY KEY";
+    if (s === "unique")
+        return "UNIQUE";
+    return "INDEX";
+}

package/dist/api/db/types.js

@@ -0,0 +1,10 @@
+"use strict";
+// ── dataloom InnerAPI 响应信封 ──
+//
+// 实际响应结构（与 file-storage 类似）：
+//   { "data": { ...业务字段... }, "status_code": "0", "error_msg": "..." }
+//
+// - `status_code == "0"` 成功
+// - `status_code != "0"` 业务错误（如 PG SQLSTATE 映射后的 code）
+// - 业务字段统一在 `data` 下：`results` / `schema` / `ddl` 等
+Object.defineProperty(exports, "__esModule", { value: true });