@restoai/resto-datacli 0.1.11 → 0.2.0

package/dist/report-api/query-plan.js

@@ -86,6 +86,21 @@ function issueToMessage(issue) {
 function findReportField(fields, fieldName) {
     return fields.find((field) => field.fieldName === fieldName);
 }
+function findReportFilterSurface(report, fieldName) {
+    return report.filterSurfaces?.find((surface) => surface.fieldName === fieldName || surface.valueField === fieldName);
+}
+function filterSurfaceToPublicFieldRecord(surface) {
+    return {
+        reportId: surface.reportId,
+        fieldName: surface.fieldName,
+        displayText: surface.displayText,
+        fieldType: "DIMENSION",
+        filterable: true,
+        ...(surface.aliases ? { aliases: surface.aliases } : {}),
+        tags: ["filter", surface.surface],
+        explain: surface.displayText
+    };
+}
 function orderByFieldNames(orderBy) {
     return (orderBy ?? []).flatMap((entry) => Object.keys(entry));
 }
@@ -214,7 +229,7 @@ function validateSafeFilterType(filterType, errors) {
         errors.push("Filter type SUB is not allowed for safe CLI execution");
     }
     else if (!supportedFilterType(filterType)) {
-        errors.push(`Filter type ${filterType} is not supported by report-api`);
+        errors.push(`Filter type ${filterType} is not supported by the report service`);
     }
 }
 export class QueryPlanValidator {
@@ -255,16 +270,17 @@ export class QueryPlanValidator {
         }
         for (const filter of validPlan.filters) {
             const field = findReportField(reportFields, filter.fieldName);
+            const filterSurface = findReportFilterSurface(report, filter.fieldName);
             validateSafeFilterType(filter.filterType, errors);
-            if (!field) {
+            if (!field && !filterSurface) {
                 errors.push(`Filter field ${filter.fieldName} is not available on report ${validPlan.reportId}`);
                 continue;
             }
-            if (field.filterable !== true) {
+            if (field && field.filterable !== true && !filterSurface) {
                 errors.push(`Filter field ${filter.fieldName} is not filterable on report ${validPlan.reportId}`);
                 continue;
             }
-            evidence.filterFields.push(toPublicFieldRecord(field));
+            evidence.filterFields.push(field && field.filterable === true ? toPublicFieldRecord(field) : filterSurfaceToPublicFieldRecord(filterSurface));
         }
         for (const filter of validPlan.aggFilters ?? []) {
             const field = findReportField(reportFields, filter.fieldName);

package/dist/report-api/report-api-client.js

@@ -68,14 +68,14 @@ function throwIfBusinessError(body, sensitiveValues = []) {
     if (!isRecord(body)) {
         return;
     }
-    const code = stringValue(body.code);
+    const code = stringValue(body.code ?? body.errorCode);
     const success = typeof body.success === "boolean" ? body.success : undefined;
     if ((!code || code === "000") && success !== false) {
         return;
     }
     const safeCode = code || "UNKNOWN";
     const message = sanitizeRemoteMessage(body.msg ?? body.message ?? body.errorMessage, sensitiveValues);
-    throw new ReportApiError(`Report API request failed with code ${safeCode}${message ? `: ${message}` : ""}`);
+    throw new ReportApiError(`report-cli-service request failed with code ${safeCode}${message ? `: ${message}` : ""}`);
 }
 function normalizeCurrency(value) {
     if (!isRecord(value)) {
@@ -152,58 +152,148 @@ export function normalizeQueryDataResponse(body) {
         raw: body
     };
 }
-export class ReportApiClient {
+export function normalizeReportOrderDetailResponse(body) {
+    const root = isRecord(body) ? body : {};
+    const data = isRecord(root.data) ? root.data : root;
+    const reportId = stringValue(data.reportId);
+    const shopId = stringValue(data.shopId);
+    const detail = isRecord(data.detail) ? data.detail : undefined;
+    if (!reportId || !shopId || !detail) {
+        throw new ReportApiError("report-cli-service returned an invalid order detail");
+    }
+    return {
+        reportId,
+        shopId,
+        ...(stringValue(data.posOrderId) ? { posOrderId: stringValue(data.posOrderId) } : {}),
+        ...(stringValue(data.orderId) ? { orderId: stringValue(data.orderId) } : {}),
+        detail,
+        raw: body
+    };
+}
+function requireReportCliFilterValues(filter) {
+    const rawValues = Array.isArray(filter.filterValue) ? filter.filterValue : [filter.filterValue];
+    const values = rawValues.flatMap((value) => {
+        const text = stringValue(value);
+        return text === undefined ? [] : [text];
+    });
+    if (values.length !== rawValues.length || values.length === 0) {
+        throw new ReportApiError(`report-cli-service backend does not support non-scalar filter value for ${filter.fieldName}`);
+    }
+    return values;
+}
+function toReportCliOperator(filterType) {
+    if (["EQ", "IN", "RANGE", "LIKE", "GT", "GOE", "LT", "LOE", "NE", "NOT_IN"].includes(filterType)) {
+        return filterType;
+    }
+    throw new ReportApiError(`report-cli-service does not support filter type ${filterType}`);
+}
+function toReportCliFilter(filter) {
+    return {
+        fieldName: filter.fieldName,
+        operator: toReportCliOperator(filter.filterType),
+        ...(filter.operatorType ? { operatorType: filter.operatorType } : {}),
+        values: requireReportCliFilterValues(filter)
+    };
+}
+function toReportCliOrderBy(orderBy) {
+    return (orderBy ?? []).flatMap((entry) => Object.entries(entry).map(([fieldName, direction]) => ({
+        fieldName,
+        direction
+    })));
+}
+function toReportCliServiceRequest(plan, auth) {
+    const filters = plan.filters.map(toReportCliFilter);
+    if (!filters.some((filter) => filter.fieldName === "D_corporationId")) {
+        filters.push({
+            fieldName: "D_corporationId",
+            operator: "EQ",
+            values: [auth.corporationId]
+        });
+    }
+    const aggFilters = (plan.aggFilters ?? []).map(toReportCliFilter);
+    const orderBy = toReportCliOrderBy(plan.orderBy);
+    return {
+        reportId: plan.reportId,
+        selectFields: plan.selectFields,
+        filters,
+        ...(aggFilters.length > 0 ? { aggFilters } : {}),
+        ...(orderBy.length > 0 ? { orderBy } : {}),
+        ...(plan.page ? { page: plan.page } : {}),
+        ...(plan.proportionProperty ? { proportionProperty: plan.proportionProperty } : {}),
+        ...(plan.metricsByDimQryV2 ? { metricsByDimQryV2: plan.metricsByDimQryV2 } : {}),
+        ...(plan.dimAdditionalStrategy ? { dimAdditionalStrategy: plan.dimAdditionalStrategy } : {})
+    };
+}
+export class ReportCliServiceClient {
     auth;
+    baseUrl;
     fetchImpl;
     constructor(options) {
         this.auth = options.auth;
+        this.baseUrl = options.baseUrl;
         this.fetchImpl = options.fetchImpl ?? undiciFetch;
     }
     async queryData(plan, _context = { env: "test", schemaVersion: 1 }) {
-        const response = await this.fetchImpl(`${trimTrailingSlash(this.auth.baseUrl)}/api/report/data/queryData`, {
+        const response = await this.fetchImpl(`${trimTrailingSlash(this.baseUrl)}/api/report-cli/report/data/query`, {
             method: "POST",
             headers: {
-                "corporation-id": this.auth.corporationId,
+                "Corporation-Id": this.auth.corporationId,
                 "Vulcan-Token": this.auth.token,
                 "Language-Code": this.auth.languageCode,
                 "Accept-Timezone": this.auth.timezone,
                 "Content-Type": "application/json"
             },
-            body: JSON.stringify(plan)
+            body: JSON.stringify(toReportCliServiceRequest(plan, this.auth))
         });
         if (!response.ok) {
-            throw new ReportApiError(`Report API request failed with status ${response.status}`, response.status);
+            throw new ReportApiError(`report-cli-service request failed with status ${response.status}`, response.status);
         }
         const body = await response.json();
         throwIfBusinessError(body, [this.auth.token]);
         return normalizeQueryDataResponse(body);
     }
     async getReportShopFilters(request) {
-        const corporationId = Number.parseInt(this.auth.corporationId, 10);
+        const organizationType = Number.parseInt(request.organizationType, 10);
         const body = {
-            corporationId: Number.isFinite(corporationId) ? corporationId : this.auth.corporationId,
-            employeeCode: request.employeeCode,
-            organizationId: request.organizationId,
+            organizationType: Number.isFinite(organizationType) ? organizationType : request.organizationType,
             orgTypeList: request.orgTypeList,
             ...(request.reportId === undefined ? {} : { reportId: request.reportId })
         };
-        const response = await this.fetchImpl(`${trimTrailingSlash(this.auth.baseUrl)}/api/report/merchant/getReportShopFilters`, {
+        const response = await this.fetchImpl(`${trimTrailingSlash(this.baseUrl)}/api/report-cli/shop/filters`, {
             method: "POST",
             headers: {
-                "corporation-id": this.auth.corporationId,
+                "Corporation-Id": this.auth.corporationId,
                 "Vulcan-Token": this.auth.token,
                 "Language-Code": this.auth.languageCode,
                 "Accept-Timezone": this.auth.timezone,
-                "Organization-Type": request.organizationType,
                 "Content-Type": "application/json"
             },
             body: JSON.stringify(body)
         });
         if (!response.ok) {
-            throw new ReportApiError(`Report API request failed with status ${response.status}`, response.status);
+            throw new ReportApiError(`report-cli-service request failed with status ${response.status}`, response.status);
         }
         const responseBody = await response.json();
         throwIfBusinessError(responseBody, [this.auth.token]);
         return normalizeReportShopFiltersResponse(responseBody);
     }
+    async getReportOrderDetail(request) {
+        const response = await this.fetchImpl(`${trimTrailingSlash(this.baseUrl)}/api/report-cli/report/order/detail`, {
+            method: "POST",
+            headers: {
+                "Corporation-Id": this.auth.corporationId,
+                "Vulcan-Token": this.auth.token,
+                "Language-Code": this.auth.languageCode,
+                "Accept-Timezone": this.auth.timezone,
+                "Content-Type": "application/json"
+            },
+            body: JSON.stringify(request)
+        });
+        if (!response.ok) {
+            throw new ReportApiError(`report-cli-service request failed with status ${response.status}`, response.status);
+        }
+        const responseBody = await response.json();
+        throwIfBusinessError(responseBody, [this.auth.token]);
+        return normalizeReportOrderDetailResponse(responseBody);
+    }
 }

package/docs/installation.md

@@ -1,6 +1,6 @@
 # Resto Data CLI 与报表问数 Agent 安装说明
 
-以下步骤面向 AI Agent 和客户实施人员。部分步骤需要用户提供 BO 账号、密码或 token。
+以下步骤面向 AI Agent 和客户实施人员。部分步骤需要用户提供手机号验证码或账号密码来获取 CLI 鉴权凭证。
 
 ## 环境要求
 
@@ -95,7 +95,7 @@ $WORKBUDDY_CONFIG_DIR/skills/resto-datacli
 
 ## 第 2 步 配置访问 Resto BO 的凭证
 
-推荐让用户使用交互式登录。密码和 token 粘贴后不会回显。
+推荐让用户使用交互式登录。验证码和密码粘贴后不会回显。
 
 ```shell
 resto auth login --interactive
@@ -103,35 +103,65 @@ resto auth login --interactive
 
 交互流程：
 
-1. 输入 BO 地址
-   - 测试环境：`https://bo.test.restosuite.ai`
-   - 线上中国区：`https://bo.restosuite.cn`
+1. 输入 CLI 鉴权网关地址
+   - 测试环境：`https://cli.test.restosuite.ai`
+   - 线上中国区：以运维提供的 CLI 鉴权网关域名为准
 2. 输入集团 ID，例如 `256` 或 `302`
 3. 选择鉴权方式
+   - 手机号验证码
    - 账号密码
-   - token
-4. 按提示输入账号、密码或 token
+4. 手机号验证码登录会先发送验证码，再按提示输入验证码；账号密码登录按提示输入账号、密码
 
-非交互式 token 登录：
+非交互式手机号验证码登录：
 
 ```shell
 resto auth login \
-  --base-url https://bo.restosuite.cn \
+  --base-url https://cli.test.restosuite.ai \
+  --plat cli \
   --corporation-id <集团ID> \
-  --token <BO登录token>
+  --phone-number <手机号> \
+  --dynamic-code <验证码>
 ```
 
+手机号验证码登录会通过 CLI 鉴权网关获取 `plat=cli` 专用 token，随后读取 profile 上下文并缓存员工编码。CLI 不接受用户手工粘贴 token 作为登录方式。
+
 非交互式账号密码登录：
 
 ```shell
 resto auth login \
-  --base-url https://bo.restosuite.cn \
+  --base-url https://cli.test.restosuite.ai \
+  --plat cli \
   --corporation-id <集团ID> \
   --username <账号> \
   --password <密码>
 ```
 
-`--base-url` 是 BO 网关地址。登录、知识包同步和 `resto query execute` 都通过该 BO 网关访问；不需要单独配置 `report-knowledge-service` 域名。
+`--base-url` 是 CLI 鉴权网关地址，仅用于登录和获取 token；`--plat` 默认为 `cli`。知识包 manifest 同步/检查、报表查询和门店筛选请求统一发送到 `report-cli-service`；本地或测试服务地址可通过 `--report-cli-url` 或 `RESTO_REPORT_CLI_URL` 配置。
+
+如果要验证本地 `report-cli-service` 查询链路，可以在启动本地 `report-api` 和 `report-cli-service` 后指定 service 地址：
+
+```shell
+resto query execute \
+  --plan ./plan.json \
+  --report-cli-url http://127.0.0.1:18081
+```
+
+也可以通过环境变量固定本地 service 地址：
+
+```shell
+RESTO_REPORT_CLI_URL=http://127.0.0.1:18081 \
+resto query execute --plan ./plan.json
+```
+
+门店筛选同样通过 `report-cli-service`：
+
+```shell
+resto shop search zn线上店铺 \
+  --report-id 888001 \
+  --organization-type 1 \
+  --org-type-list 1,2 \
+  --report-cli-url http://127.0.0.1:18081
+```
 
 中国区上线阶段，`language-code` 和 `timezone` 默认使用：
 
@@ -145,7 +175,7 @@ resto auth login \
 登录完成后，同步当前环境的报表知识：
 
 ```shell
-resto knowledge sync
+resto knowledge sync --report-cli-url http://127.0.0.1:18081
 resto knowledge status
 ```
 
@@ -236,7 +266,7 @@ resto auth login --interactive
 
 ### `resto query execute` 返回 401
 
-一般是 BO token 过期或组织上下文失效。重新登录后再执行：
+一般是 CLI gateway token 过期、不是 `plat=cli` 生成的 token，或组织上下文失效。重新登录后再执行：
 
 ```shell
 resto auth login --interactive

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@restoai/resto-datacli",
-  "version": "0.1.11",
+  "version": "0.2.0",
   "type": "module",
   "bin": {
     "resto": "dist/cli.js"