forked from AxTps/Starlight_Lancher
feat:移除了弹窗,服务器添加sls
This commit is contained in:
18
.agents/skills/api-module/SKILL.md
Normal file
18
.agents/skills/api-module/SKILL.md
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
name: api-module
|
||||||
|
description: Add a new API endpoint module to packages/api-client from an OpenAPI schema. Use when adding new backend endpoints, creating API client modules, or when an openapi.yml is provided.
|
||||||
|
argument-hint: <path-to-openapi.yml>
|
||||||
|
---
|
||||||
|
|
||||||
|
Refer to the standard: @standards/frontend/ADDING_API_MODULES.md
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. **Read the OpenAPI schema** at `$ARGUMENTS` — identify the endpoints, request/response shapes, and path parameters.
|
||||||
|
2. **Read the standard above** for naming conventions, type rules, and the module registration pattern.
|
||||||
|
3. **Determine the service and version** — the URL path prefix tells you which service directory and version namespace to use (e.g. `/v3/projects` → `labrinth/v3/`).
|
||||||
|
4. **Define types in `types.ts`** — types must match the API response 1:1. Use the OpenAPI schema as the source of truth. Do not reshape or rename fields.
|
||||||
|
5. **Create the module class** — extend `BaseModule`, implement each endpoint as a method. Use the correct HTTP verb and request options pattern from the standard.
|
||||||
|
6. **Register in `MODULE_REGISTRY`** — add the module entry so it's auto-instantiated on the client.
|
||||||
|
7. **Export types** from the service's barrel `index.ts`.
|
||||||
|
8. **Verify** — check that the module compiles and the types are accessible from `@modrinth/api-client`.
|
||||||
24
.agents/skills/cross-platform-pages/SKILL.md
Normal file
24
.agents/skills/cross-platform-pages/SKILL.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
name: cross-platform-pages
|
||||||
|
description: Convert a page to the cross-platform page system so it works in both the website and the desktop app. Use when moving a page into packages/ui/src/layouts/, creating shared or wrapped layouts, or setting up DI contracts for platform abstraction.
|
||||||
|
argument-hint: <path-to-page>
|
||||||
|
---
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. **Read the target page** at `$ARGUMENTS` and understand its data sources, mutations, and navigation.
|
||||||
|
2. **Identify platform boundaries**: keep identical page implementations wrapped in `packages/ui`; use dependency injection only when website and desktop data sources differ.
|
||||||
|
3. **Decide the category:**
|
||||||
|
- **Wrapped** (`layouts/wrapped/`) — if the page uses the same API source on both platforms (e.g. web requests, not Tauri plugins). Just move the page component into `packages/ui` and import it from both frontends.
|
||||||
|
- **Shared** (`layouts/shared/`) — if the page has different data-fetching logic per platform (e.g. website uses `api-client`, app uses Tauri `invoke`). Requires a DI contract.
|
||||||
|
4. **For shared layouts:**
|
||||||
|
- Define a DI contract interface in `providers/` capturing all platform-specific operations.
|
||||||
|
- Create the layout component that injects the context and handles all UI logic.
|
||||||
|
- Extract reusable stateful logic (search, filtering, selection) into `composables/`.
|
||||||
|
- Implement the contract separately in each frontend (`apps/website/`, `apps/app-frontend/`).
|
||||||
|
5. **For wrapped pages:**
|
||||||
|
- Move the page component into `packages/ui/src/layouts/wrapped/` matching the route structure.
|
||||||
|
- Replace any platform-specific imports with shared utilities.
|
||||||
|
- Import and render the wrapped page from both frontends as a simple component.
|
||||||
|
- If the layout uses TanStack Query for first paint, keep route-shell prefetch keys and fetchers identical to the layout queries.
|
||||||
|
6. **Verify** the page renders correctly by checking for missing imports and that all DI contracts are satisfied.
|
||||||
22
.agents/skills/figma-mcp/SKILL.md
Normal file
22
.agents/skills/figma-mcp/SKILL.md
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
name: figma-mcp
|
||||||
|
description: Use the Figma MCP server to translate a Figma design into a Vue page or component layout. Use when the user provides a Figma URL, asks to implement a design, or wants to draft a page layout from Figma.
|
||||||
|
argument-hint: <figma-url>
|
||||||
|
---
|
||||||
|
|
||||||
|
Refer to the standard: @standards/frontend/FIGMA_MCP_USAGE.md
|
||||||
|
Also read @packages/ui/AGENTS.md for color token mapping and component conventions.
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. **Parse the Figma URL** from `$ARGUMENTS` — extract the `fileKey` and `nodeId`. Convert `-` to `:` in the node ID.
|
||||||
|
2. **Read the standards above** for the available tools, adaptation rules, and color usage.
|
||||||
|
3. **Call `get_design_context`** with the extracted `nodeId` and `fileKey`, using `clientLanguages: "typescript,html,css"` and `clientFrameworks: "vue"`. This is always the first tool to call.
|
||||||
|
5. **Adapt the output to the Modrinth codebase:**
|
||||||
|
- Map Figma color variables to `surface-*` / `text-*` tokens — never use Figma's aliased names directly.
|
||||||
|
- Check `packages/ui/src/components/` for existing components that match elements in the design (buttons, cards, modals, inputs, etc.).
|
||||||
|
- Check `packages/assets/styles/variables.scss` for tokens not exposed in Figma.
|
||||||
|
- Match spacing values exactly from the design.
|
||||||
|
6. **Use `get_screenshot`** if you need a closer visual reference of specific nodes.
|
||||||
|
7. **Use `get_variable_defs`** to verify which design tokens are applied to ambiguous elements.
|
||||||
|
8. **Build the component** as a Vue SFC using Tailwind classes and the project's existing component library.
|
||||||
24
.agents/skills/i18n-pass/SKILL.md
Normal file
24
.agents/skills/i18n-pass/SKILL.md
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
name: i18n-pass
|
||||||
|
description: Perform an i18n localization pass on changed files or a pull request, converting hard-coded English strings to the @modrinth/ui i18n system. Use when internationalizing a set of changes, reviewing a PR for untranslated strings, or converting a specific component.
|
||||||
|
argument-hint: [file-path-or-pr-number]
|
||||||
|
---
|
||||||
|
|
||||||
|
Refer to the standard: @standards/frontend/INTERNATIONALIZATION.md
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
1. **Identify the scope of changes:**
|
||||||
|
- If `$ARGUMENTS` is a PR number, run `gh pr diff $ARGUMENTS` to get the changed files.
|
||||||
|
- If `$ARGUMENTS` is a file path, use that directly.
|
||||||
|
- If no argument, check `git diff` for uncommitted changes.
|
||||||
|
2. **Read the standard above** for the message definition pattern, ICU format rules, and `IntlFormatted` usage.
|
||||||
|
3. **Filter to Vue SFCs** — only `.vue` files need i18n passes. Skip non-component files.
|
||||||
|
4. **For each file, scan for hard-coded strings:**
|
||||||
|
- `<template>`: inner text, `alt`, `placeholder`, `aria-label`, button labels, tooltip text.
|
||||||
|
- `<script>`: string literals passed to user-visible UI (notification messages, dropdown labels, error messages).
|
||||||
|
- Skip: dynamic expressions, HTML tag names, CSS classes, internal identifiers, log messages.
|
||||||
|
5. **Define messages** with `defineMessages` — use descriptive, stable `id`s based on the component's domain (e.g. `project.settings.title`).
|
||||||
|
6. **Replace strings in templates** with `formatMessage()` calls, or `<IntlFormatted>` for strings containing links or markup.
|
||||||
|
7. **Handle ICU edge cases** — add a space before `}}` if an ICU placeholder ends at a Vue template delimiter boundary.
|
||||||
|
8. **Verify** no hard-coded English strings remain in the changed templates. Do not alter logic, layout, or reactivity.
|
||||||
99
.agents/skills/lark-approval/SKILL.md
Normal file
99
.agents/skills/lark-approval/SKILL.md
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
---
|
||||||
|
name: lark-approval
|
||||||
|
version: 1.2.0
|
||||||
|
description: "飞书审批:查询和处理审批待办/已办/实例,搜索可发起审批定义、查看定义详情并发起原生审批实例。当用户要处理审批任务、查看审批实例、搜索或发起审批时使用。审批待办不是飞书任务;非审批类待办走 lark-task。不负责创建审批定义;三方审批定义不走原生提单。"
|
||||||
|
metadata:
|
||||||
|
requires:
|
||||||
|
bins: ["lark-cli"]
|
||||||
|
cliHelp: "lark-cli approval --help"
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
**CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),其中包含认证、权限处理**
|
||||||
|
|
||||||
|
所有命令默认 `--as user`(审批是人的动作)。调用前先按需读取 references 下对应的文件,查参数结构,不要猜字段;**references 是第一信息源**,只有在 reference 未覆盖的原生 / 高级场景下,才额外用 `lark-cli ... --help`、`lark-cli schema` 等方式补充确认字段。
|
||||||
|
|
||||||
|
## 路由优先级(先判断是不是审批,再选命令)
|
||||||
|
|
||||||
|
审批待办不是飞书任务。**只要用户的核心对象是审批单据 / 审批待办 / 审批实例,就优先使用 `lark-approval`,不要让渡给 `lark-task`。**
|
||||||
|
|
||||||
|
### 明确归 `lark-approval` 的高优先级语义
|
||||||
|
|
||||||
|
出现以下任一语义时,优先走 `lark-approval`:
|
||||||
|
|
||||||
|
- 审批待办 / 审批单据 / 审批实例 / 审批意见 / 审批定义
|
||||||
|
- 同意 / 拒绝 / 转交 / 退回 / 撤回 / 催办 / 加签 / 抄送
|
||||||
|
- 待办列表 / 待办单据 / 已发起审批 / 已办审批 / 审批详情 / 同意可编辑
|
||||||
|
|
||||||
|
**判定规则:** 只要最终动作是对审批单据做同意、拒绝、转交、退回、撤回、催办、加签、抄送、查详情、查已发起/已办/待办,就归 `lark-approval`。只有当用户处理的是**非审批类任务/待办**时,才走 [`lark-task`](../lark-task/SKILL.md)。
|
||||||
|
|
||||||
|
## 选哪个命令
|
||||||
|
|
||||||
|
| 想做什么 | 命令 | 按需读取 reference |
|
||||||
|
|---|---|---------------------------------------------------------------------------------|
|
||||||
|
| 搜可发起定义 | `approvals search` | [`lark-approval-approvals-search.md`](references/lark-approval-approvals-search.md) |
|
||||||
|
| 看审批定义详情/提单前确认表单与流程 | `approvals get` | [`lark-approval-approvals-get.md`](references/lark-approval-approvals-get.md) |
|
||||||
|
| 发起原生审批实例/提交请假审批/提交报销审批/创建审批实例 | `instances create` | [`lark-approval-initiate.md`](references/lark-approval-initiate.md) |
|
||||||
|
| 查待办/已办 | `tasks query`(`topic`:1待办 2已办 17未读 18已读) | [`lark-approval-tasks-query.md`](references/lark-approval-tasks-query.md) |
|
||||||
|
| 看表单/进度/当前节点 | `instances get` | [`lark-approval-instances-get.md`](references/lark-approval-instances-get.md) |
|
||||||
|
| 同意审批 | `tasks approve` | [`lark-approval-tasks-approve.md`](references/lark-approval-tasks-approve.md) |
|
||||||
|
| 拒绝审批 | `tasks reject` | [`lark-approval-tasks-reject.md`](references/lark-approval-tasks-reject.md) |
|
||||||
|
| 转交审批 | `tasks transfer` | [`lark-approval-tasks-transfer.md`](references/lark-approval-tasks-transfer.md) |
|
||||||
|
| 加签审批 | `tasks add_sign` | [`lark-approval-tasks-add-sign.md`](references/lark-approval-tasks-add-sign.md) |
|
||||||
|
| 退回审批 | `tasks rollback` | [`lark-approval-tasks-rollback.md`](references/lark-approval-tasks-rollback.md) |
|
||||||
|
| 催办审批 | `tasks remind` | [`lark-approval-tasks-remind.md`](references/lark-approval-tasks-remind.md) |
|
||||||
|
| 撤回已发起审批 | `instances cancel` | [`lark-approval-instances-cancel.md`](references/lark-approval-instances-cancel.md) |
|
||||||
|
| 给审批实例追加抄送 | `instances cc` | [`lark-approval-instances-cc.md`](references/lark-approval-instances-cc.md) |
|
||||||
|
| 按定义查已发起审批 | `instances initiated` | [`lark-approval-instances-initiated.md`](references/lark-approval-instances-initiated.md) |
|
||||||
|
|
||||||
|
处理链:
|
||||||
|
|
||||||
|
- 发起审批:`approvals search` -> `approvals get` -> `instances create`
|
||||||
|
- 处理审批:`tasks query` 拿 `instance_code` + `task_id`(操作必须成对带上)→ 只有用户明确需要查看详情、当前节点、表单内容、或流程进度时,再 `instances get` → 执行操作
|
||||||
|
|
||||||
|
## 执行原则(减少误路由、误重试和无效消耗)
|
||||||
|
|
||||||
|
### 1) 先拿最小必要信息,再执行
|
||||||
|
|
||||||
|
- 目标只是处理待办时,优先 `tasks query` 获取 `instance_code` + `task_id`
|
||||||
|
- **只有**用户明确要看详情、当前节点、表单内容、流程进度时,才调用 `instances get`
|
||||||
|
- 用户已经明确给出 `instance_code` / `task_id` 时,不要先查列表再过滤
|
||||||
|
|
||||||
|
### 2) 已知对象时直达动作
|
||||||
|
|
||||||
|
- 已拿到 `instance_code` + `task_id` 后,优先直接执行 `tasks approve/reject/transfer/add_sign/rollback/remind`
|
||||||
|
- 同一轮里如果已有足够的新鲜查询结果,不要重复 `tasks query`
|
||||||
|
- 不要默认走 `list -> filter -> detail -> write` 全链路;对象已明确时应压缩步骤
|
||||||
|
|
||||||
|
### 3) 错误码驱动,而不是盲目重试
|
||||||
|
|
||||||
|
- 写操作失败后,先看错误码和报错语义,再决定是否补查或结束
|
||||||
|
- **除非错误明确提示可恢复或需要补充参数,否则不要重复刷同一个写操作**
|
||||||
|
- 同一个失败原因不要连续多次重试,避免 token 和耗时失控,最多重试1次
|
||||||
|
|
||||||
|
## 写操作失败处理:1395001 决策树
|
||||||
|
|
||||||
|
当拒绝 / 转交 / 退回 / 撤回 / 同意等写操作返回 `1395001`(任务状态异常 / 写前置校验失败)时,按下面规则处理:
|
||||||
|
|
||||||
|
1. **先停止盲目重试**,不要连续重复提交相同写操作,最多重试1次
|
||||||
|
2. 优先从以下角度解释:
|
||||||
|
- 任务可能已被他人处理
|
||||||
|
- 单据状态已变化,当前动作已不再允许
|
||||||
|
- 当前用户已不具备该任务的操作资格
|
||||||
|
- 当前节点或单据状态不支持该操作
|
||||||
|
3. 如需确认,只补 **一次** 状态查询(`tasks query` 或 `instances get`),不要陷入 query/write 循环
|
||||||
|
4. 最终给用户明确结论和下一步建议,而不是继续无意义重试
|
||||||
|
|
||||||
|
**特别注意:** 对拒绝 / 转交 / 撤回场景更要严格执行上述规则;这些场景最容易因状态切换而失败。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假"}' --as user
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<code>"}' --as user
|
||||||
|
lark-cli approval instances create --data '{"approval_code":"<code>","form":"[...]"}' --yes --as user
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
lark-cli approval tasks approve --data '{"instance_code":"<ic>","task_id":"<tid>","comment":"同意"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 不在本 skill 范围
|
||||||
|
|
||||||
|
创建审批定义(走飞书客户端或审批管理后台);三方定义发起(返回 `create_link`,引导用户通过链接发起);非审批类待办 → [`lark-task`](../lark-task/SKILL.md)
|
||||||
@ -0,0 +1,128 @@
|
|||||||
|
|
||||||
|
# approval approvals get
|
||||||
|
|
||||||
|
获取单个审批定义详情(用户级只读操作)。适合在发起审批实例前,先确认审批名称、表单控件结构、选项值范围以及流程节点信息。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:approval:read"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 按 approval_code 查询审批定义详情
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<APPROVAL_CODE>"}' --as user
|
||||||
|
|
||||||
|
# 表格格式输出,便于快速浏览顶层字段
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<APPROVAL_CODE>"}' --format table --as user
|
||||||
|
|
||||||
|
# 预览 API 调用,不执行
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<APPROVAL_CODE>"}' --as user --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--params '{...}'` | 是 | 查询参数,使用 JSON 传入 |
|
||||||
|
| `approval_code` | 是 | 审批定义 Code;通常来自 `approval approvals search` 的结果 |
|
||||||
|
| `locale` | 否 | 返回语言,例如 `zh-CN`、`en-US`、`ja-JP` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批定义详情通常按当前用户可见范围读取 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 常见输入来源
|
||||||
|
|
||||||
|
如果你已经有 `approval_code`,可直接查询:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<APPROVAL_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你还没有 `approval_code`,先搜索可发起审批定义:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出重点字段
|
||||||
|
|
||||||
|
返回结果中,优先关注以下字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `approval_code` | 审批定义 Code |
|
||||||
|
| `approval_name` | 审批定义名称;确认是不是用户想发起的那张单 |
|
||||||
|
| `form` | 表单定义快照;用于识别控件 `id`、`type`、选项值范围、明细子控件结构 |
|
||||||
|
| `node_list` | 流程节点列表;用于识别节点 key、是否需要补充审批人、是否允许多人 |
|
||||||
|
|
||||||
|
## form 的使用重点
|
||||||
|
|
||||||
|
`form` 最重要的作用是帮助 agent **识别怎么组装 `instances.create.data.form`**,而不是直接把它原样提交出去。
|
||||||
|
|
||||||
|
重点看:
|
||||||
|
|
||||||
|
| 字段 / 结构 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `form[].id` | 控件 ID;后续创建实例时必须使用 |
|
||||||
|
| `form[].type` | 控件类型,例如 `input`、`date`、`radio`、`checkbox`、`fieldList` |
|
||||||
|
| `form[].value` / 选项定义 | 用来识别可选值范围、默认值或选项值 |
|
||||||
|
| 明细 / 子控件结构 | 用于识别 `fieldList`、控件组等复杂控件的子字段结构 |
|
||||||
|
|
||||||
|
**注意:`approvals.get.form` 不是 `instances.create` 可直接复用的 payload 模板。** 它是“定义快照”,主要用于识别字段结构与选项值范围。
|
||||||
|
|
||||||
|
## node_list 的使用重点
|
||||||
|
|
||||||
|
`node_list` 主要用于后续决定是否要补 `node_approver_list` / `node_cc_list`。
|
||||||
|
|
||||||
|
重点看:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `node_list[].custom_node_id` | 自定义节点标识;后续补节点参数时优先作为 key |
|
||||||
|
| `node_list[].node_id` | 节点 ID;若没有 `custom_node_id`,通常退回用它做 key |
|
||||||
|
| `node_list[].need_approver` | 是否要求发起人补充审批人 |
|
||||||
|
| `node_list[].approver_chosen_multi` | 是否允许为该节点选择多个审批人 |
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **这是发起原生审批实例前的必要只读步骤。** 推荐固定走:`approvals search` -> `approvals get` -> `instances create`。
|
||||||
|
- **如果用户已经明确给了 `approval_code`,直接用这个命令。** 不必再走 `approvals search`。
|
||||||
|
- **先确认 `approval_name`。** 避免把相似名称的审批定义搞混。
|
||||||
|
- **先用 `form` 识别控件结构,再组装创建 payload。** 不要在未看详情时猜控件 `id`、`type` 或选项值。
|
||||||
|
- **先用 `node_list` 看是否需要补审批人。** 若某节点 `need_approver=true`,创建实例时通常要补 `node_approver_list`。
|
||||||
|
- **`node_list` 的 key 优先取 `custom_node_id`。** 若不存在,再使用 `node_id`。
|
||||||
|
- **`approver_chosen_multi=false` 时,一个节点通常只能补一个审批人。**
|
||||||
|
|
||||||
|
## 输出与后续操作
|
||||||
|
|
||||||
|
读取定义详情后,常见下一步:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 发起原生审批实例
|
||||||
|
lark-cli approval instances create --data '{"approval_code":"<APPROVAL_CODE>","form":"[...]"}' --as user --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
如果需要进一步理解控件取值与节点参数,优先参考:
|
||||||
|
|
||||||
|
- `lark-approval-instance-form-control-parameters.md`
|
||||||
|
- `lark-approval-instance-value-sourcing.md`
|
||||||
|
- `lark-approval-initiate.md`
|
||||||
|
|
||||||
|
## 结果整理方式
|
||||||
|
|
||||||
|
**将结果整理为“审批定义概览 + 表单结构摘要 + 节点要求摘要”。**
|
||||||
|
|
||||||
|
建议输出成下面这种结构:
|
||||||
|
|
||||||
|
```text
|
||||||
|
审批定义:请假申请
|
||||||
|
approval_code: 7C468A54-8745-2245-9675-08B7C63E7A85
|
||||||
|
|
||||||
|
表单控件摘要:
|
||||||
|
- leave_type: radio,可选值 [annual_leave, sick_leave]
|
||||||
|
- reason: textarea
|
||||||
|
- start_end: dateInterval
|
||||||
|
|
||||||
|
节点要求摘要:
|
||||||
|
- manager_node:need_approver=true,approver_chosen_multi=false
|
||||||
|
- hr_node:need_approver=false
|
||||||
|
```
|
||||||
@ -0,0 +1,103 @@
|
|||||||
|
|
||||||
|
# approval approvals search
|
||||||
|
|
||||||
|
搜索**当前用户可发起**的审批定义(launchable approvals)。只读操作,不会创建审批实例。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:approval:read"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 按关键词搜索可发起审批定义
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假"}' --as user
|
||||||
|
|
||||||
|
# 使用 page_token 翻页
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假", "page_token":"example_page_token"}' --as user
|
||||||
|
|
||||||
|
# 表格格式输出,便于快速浏览候选定义
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"出差"}' --format table --as user
|
||||||
|
|
||||||
|
# 预览 API 调用,不执行
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假"}' --as user --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 查询参数,使用 JSON 传入 |
|
||||||
|
| `keyword` | 是 | 搜索关键词,例如 `请假`、`报销`、`出差`、`采购` |
|
||||||
|
| `locale` | 否 | 返回语言,例如 `zh-CN`、`en-US`、`ja-JP` |
|
||||||
|
| `page_size` | 否 | 分页大小 |
|
||||||
|
| `page_token` | 否 | 翻页标记;首次请求不填,后续使用上一次返回的 `page_token` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;“可发起审批定义”是面向当前用户的查询 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 这个命令解决什么问题
|
||||||
|
|
||||||
|
当用户只有自然语言意图,还没有 `approval_code` 时,先用它把“可发起的审批定义候选项”找出来。
|
||||||
|
|
||||||
|
典型场景:
|
||||||
|
|
||||||
|
- “帮我找一下请假审批”
|
||||||
|
- “有哪些可以发起的报销单?”
|
||||||
|
- “先搜一下出差审批,再帮我提单”
|
||||||
|
|
||||||
|
## 输出重点字段
|
||||||
|
|
||||||
|
返回结果里,优先关注以下字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `approval_code` | 审批定义 Code;后续 `approvals get` 和 `instances create` 都要用它 |
|
||||||
|
| `approval_name` | 审批定义名称;给用户做候选选择时最关键 |
|
||||||
|
| `is_external` | 是否为三方审批定义;`true` 表示不能走原生 `instances.create` |
|
||||||
|
| `create_link` | 三方审批定义的发起链接;`is_external=true` 时优先返回给用户 |
|
||||||
|
|
||||||
|
## 使用规则
|
||||||
|
|
||||||
|
- **这是发起审批工作流的第一步。** 标准顺序是:`approvals search` -> `approvals get` -> `instances create`。
|
||||||
|
- **搜索结果为空时,不要猜。** 直接告诉用户当前关键词下没有可发起定义,并建议用户换关键词。
|
||||||
|
- **命中多个结果时,不要替用户拍板。** 先把候选定义列出来,让用户选择目标审批定义。
|
||||||
|
- **`is_external=true` 时不要调用 `approval instances create`。** 这类定义属于三方审批,优先返回 `create_link` 并说明需要通过链接发起。
|
||||||
|
- **只有 `is_external=false` 的原生定义,才继续 `approvals get`。**
|
||||||
|
- **如果用户已经明确给出 `approval_code`,不要再 search。** 直接执行 `approval approvals get`。
|
||||||
|
|
||||||
|
## 结果整理方式
|
||||||
|
|
||||||
|
**将结果整理为候选清单,优先展示“名称 + approval_code + 是否三方定义 + 下一步建议”。**
|
||||||
|
|
||||||
|
建议输出成下面这种结构:
|
||||||
|
|
||||||
|
```text
|
||||||
|
找到 3 个可发起审批定义:
|
||||||
|
|
||||||
|
1. 请假申请
|
||||||
|
- approval_code: 7C468A54-8745-2245-9675-08B7C63E7A85
|
||||||
|
- is_external: false
|
||||||
|
- next: 可继续读取 definitions 详情(approvals get)
|
||||||
|
|
||||||
|
2. 差旅报销
|
||||||
|
- approval_code: 99887766-xxxx
|
||||||
|
- is_external: true
|
||||||
|
- next: 返回 create_link,引导用户通过链接发起
|
||||||
|
```
|
||||||
|
|
||||||
|
## 常见后续操作
|
||||||
|
|
||||||
|
### 1)用户选中了某个定义,继续查看详情
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals get --params '{"approval_code":"<APPROVAL_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2)确认是原生定义后,再准备发起审批实例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances create --data '{"approval_code":"<APPROVAL_CODE>","form":"[...]"}' --as user --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3)确认是三方定义时,直接返回链接
|
||||||
|
|
||||||
|
当 `is_external=true` 时,优先向用户返回 `create_link`,说明该审批需在三方系统或跳转页面中发起,而不是通过原生 `instances.create`。
|
||||||
@ -0,0 +1,221 @@
|
|||||||
|
# 审批提单工作流
|
||||||
|
|
||||||
|
## 执行摘要
|
||||||
|
|
||||||
|
- **原生审批提单如果用户未明确给出 `approval_code`,必须固定走 `approvals search` -> `approvals get` -> `instances create`** 不要跳过 `get` 直接拼请求。
|
||||||
|
- **原生审批提单如果用户明确给出 `approval_code`,固定走 `approvals get` -> `instances create`** 不要跳过 `get` 直接拼请求。
|
||||||
|
- **`is_external=true` 的定义是三方定义。** 这类定义不要调用 `instances create`,应优先使用 `create_link`。
|
||||||
|
- **所有人员类参数默认使用 `open_id`。** 若用户给的是姓名、邮箱或其他身份,先用 [`../../lark-contact/SKILL.md`](../../lark-contact/SKILL.md) 解析。
|
||||||
|
- **先读控件参数 reference 和值来源 reference,再读本文里的创建参数规则。** 提单前必须先阅读 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 和 [`lark-approval-instance-value-sourcing.md`](./lark-approval-instance-value-sourcing.md)。
|
||||||
|
- **`approvals.get.form` 不是创建 payload 的原样模板。** 它主要用于识别控件 `id`、`type`、选项值范围和明细子控件结构;真正的 `instances create --data.form` 中,控件 `value` 结构以 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 为准。
|
||||||
|
- **节点参数只从 `node_list` 和本文里的节点参数规则里取。** 节点 key 必须来自定义详情返回的节点标识;审批人/抄送人列表传用户 ID 时,不要混用姓名或其他身份标识。
|
||||||
|
- **看到 `need_approver=true` 就说明该节点需要发起人补充审批人。** 如果 `approver_chosen_multi=false`,该节点只允许一个 `open_id`。
|
||||||
|
- **创建实例前先确认。** `approval instances create` 是写操作,执行前,让用户确认最终定义、表单值和节点参数;真正执行时显式传 `--yes`。
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
- “帮我提交一个请假审批”
|
||||||
|
- “帮我发起报销审批”
|
||||||
|
- “我想提一个出差审批”
|
||||||
|
- “先搜可发起的审批,再帮我提单”
|
||||||
|
|
||||||
|
## 严禁行为
|
||||||
|
|
||||||
|
- **严禁在未先阅读本文中的创建参数规则、[`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 和 [`lark-approval-instance-value-sourcing.md`](./lark-approval-instance-value-sourcing.md) 的情况下直接提单。**
|
||||||
|
- **严禁跳过 `approvals.get`。** 未拿到 `form` 和 `node_list` 前,不得调用 `instances create`。
|
||||||
|
- **严禁把姓名直接写进 `node_approver_list`、`node_cc_list` 或表单人员控件。** 必须先转成 `open_id`。
|
||||||
|
- **严禁对三方定义调用 `instances create`。**
|
||||||
|
- **严禁对 API 不支持的控件硬提单。** 如果目标定义包含创建实例 API 不支持的控件,应明确告诉用户该定义不能仅通过 API 完整发起。
|
||||||
|
- **严禁把 `approvals.get.form` 当成可直接提交的原样模板。**
|
||||||
|
- **严禁在未得到用户确认前直接执行真实提单。**
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
### 1. 搜索可发起审批定义
|
||||||
|
|
||||||
|
先搜索定义:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals search --data '{"keyword":"请假"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
处理规则:
|
||||||
|
|
||||||
|
- 若结果为空,告诉用户当前关键词下没有可发起定义。
|
||||||
|
- 若命中多个定义,必须把候选项列给用户选择,不要自行猜测。
|
||||||
|
- 若目标定义 `is_external=true`,优先返回 `create_link`,说明这是三方定义,不能走原生 `instances create`。
|
||||||
|
- 只有 `is_external=false` 的原生定义才继续下一步。
|
||||||
|
|
||||||
|
### 2. 获取审批定义详情
|
||||||
|
|
||||||
|
拿到 `approval_code` 后,读取定义详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval approvals get \
|
||||||
|
--params '{"approval_code":"7C468A54-8745-2245-9675-08B7C63E7A85"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
重点关注返回:
|
||||||
|
|
||||||
|
- `approval_name`: 当前发起的是哪个审批定义。
|
||||||
|
- `form`: 表单定义快照,用于识别控件 `id`、`type`、选项值范围以及明细子控件结构;不是创建实例时可直接原样提交的 payload 模板。
|
||||||
|
- `node_list`: 流程节点信息,是后续 `node_approver_list` / `node_cc_list` 的唯一可靠来源。
|
||||||
|
|
||||||
|
### 3. 创建请求参数速查
|
||||||
|
|
||||||
|
输入参数如下:
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|---|---|---|
|
||||||
|
| `--data '{...}'` | 是 | 请求体,使用 JSON 传入 |
|
||||||
|
| `approval_code` | 是 | 审批定义 Code;必须先通过 `approvals search` / `approvals get` 确认 |
|
||||||
|
| `form` | 否 | 表单值,**JSON 数组字符串**,不是普通对象;API 层非必填,但审批定义存在必填控件或用户需要提交表单值时必须传 |
|
||||||
|
| `node_approver_list` | 否 | 节点审批人列表;仅在定义要求补充审批人时传 |
|
||||||
|
| `node_cc_list` | 否 | 节点抄送人列表;仅在用户明确需要补充节点抄送人时传 |
|
||||||
|
| `uuid` | 否 | 幂等标识;重复重试同一请求时建议显式传入 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批发起通常应使用用户身份 |
|
||||||
|
| `--yes` | 是 | 写操作确认;真实执行时必须显式传入 |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
### 4. 组装 `form`
|
||||||
|
|
||||||
|
`instances create --data.form` 是可选字段;传入时必须是一个 JSON 数组字符串。无表单或无需填写表单值的审批可省略 `form`,但只要审批定义包含需要提交的控件,就必须按控件结构组装后传入。组装原则:
|
||||||
|
|
||||||
|
- 先用 `approvals.get.form` 识别有哪些控件、每个控件的 `id` / `type` / 可选值范围,再按本文中的创建参数规则与 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 重新组装创建 payload。
|
||||||
|
- 提交时必须至少保证每个控件的 `id`、`type` 与 `value` 符合当前接口要求;不要假设定义快照里出现的其他字段都能直接照搬。
|
||||||
|
- 如果用户提供的是人员信息,优先转换成 `open_id` 后再写入对应控件。
|
||||||
|
- 单选/多选控件提交的是选项 `value`,该值可从 `approvals.get.form` 的选项定义中取得。
|
||||||
|
- `contact`、`department`、`fieldList`、`dateInterval`、`amount`、`telephone`、`document` 等控件的 `value` 结构各不相同,必须按 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 单独组装,不要套用文本控件的写法。
|
||||||
|
- 值本身从哪里拿,优先按 [`lark-approval-instance-value-sourcing.md`](./lark-approval-instance-value-sourcing.md) 处理;不要把“知道结构”误当成“已经拿到可提交值”。
|
||||||
|
- 若 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 标明某控件不支持通过创建实例 API 提交,则不要硬猜绕过;应明确告诉用户该定义当前无法仅通过 API 提单。
|
||||||
|
- 若遇到当前 skill 未明确覆盖的复杂控件,不要硬猜;先依据 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 判断支持性与传值结构,再向用户确认。
|
||||||
|
|
||||||
|
## API 不支持的控件
|
||||||
|
|
||||||
|
根据 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md),创建审批实例 API 不支持的控件至少包括:
|
||||||
|
|
||||||
|
- `text`
|
||||||
|
- `mutableGroup`
|
||||||
|
- `account`
|
||||||
|
- `serialNumber`
|
||||||
|
- `tripGroup`
|
||||||
|
- `apaascorehrOnboardingGroup`
|
||||||
|
- `apaascorehrRegularateGroup`
|
||||||
|
- `remedyGroupV2`
|
||||||
|
- `apaascorehrJobAdjustGroup`
|
||||||
|
- `apaascorehrOffboardingGroup`
|
||||||
|
|
||||||
|
如果目标审批定义包含上述控件,不要继续硬拼 `form`;应直接告诉用户该定义不能仅通过当前 API 完整提单。
|
||||||
|
|
||||||
|
## 高频控件速查
|
||||||
|
|
||||||
|
优先按 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 组装,下面只保留最常用、最容易出错的格式:
|
||||||
|
|
||||||
|
- `input` / `textarea`: `value` 是字符串
|
||||||
|
- `date`: `value` 是 RFC3339 时间字符串
|
||||||
|
- `dateInterval`: `value` 是对象,包含 `start` / `end` / `interval`
|
||||||
|
- `radio` / `radioV2`: `value` 是单个选项值,取定义详情里的 `option.value`;关联外部选项时传 `options.id`
|
||||||
|
- `checkbox` / `checkboxV2`: `value` 是选项值数组
|
||||||
|
- `number`: `value` 是数字
|
||||||
|
- `amount`: `value` 是数字,还要带 `currency`
|
||||||
|
- `formula`: `value` 必须与定义中的公式结果匹配,否则会报错
|
||||||
|
- `contact`: 只推荐写 `open_ids`,由人员信息先转换成 `open_id`
|
||||||
|
- `connect`: `value` 是关联审批实例 `instance_code` 数组,当前默认要求用户直接提供 `instance_code`
|
||||||
|
- `document`: `value` 是对象,至少含 `token` 和 `type=docx`
|
||||||
|
- `attachmentV2` / `image` / `imageV2`: `value` 是 file code 数组,当前默认要求用户直接提供
|
||||||
|
- `fieldList`: `value` 是二维数组,子项继续按各自控件类型组装
|
||||||
|
- `department`: `value` 是对象数组,元素字段名为 `open_id`,其值填写部门的 `open_department_id`
|
||||||
|
- `telephone`: `value` 是对象,包含 `countryCode` 和 `nationalNumber`
|
||||||
|
- `address`: `value` 是对象数组,至少包含地理库 `id`,可选 `detailAddress`;当前默认要求用户直接提供该 `id`
|
||||||
|
|
||||||
|
## 特殊控件组
|
||||||
|
|
||||||
|
[`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 还明确给出了若干特殊控件组的提单格式,至少包括:
|
||||||
|
|
||||||
|
- `leaveGroupV2`
|
||||||
|
- `workGroup`
|
||||||
|
- `outGroup`
|
||||||
|
- `shiftGroup`
|
||||||
|
|
||||||
|
这类控件组不是简单文本控件,通常内部还嵌套 `radioV2`、`date`、`fieldList`、`image`、`contact` 等子控件。遇到这些控件组时:
|
||||||
|
|
||||||
|
- 先从 `approvals.get.form` 找到控件组及其子控件 ID
|
||||||
|
- 再严格按 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 的示例组装 `value`
|
||||||
|
- 不要把控件组整体当成普通字符串或扁平对象提交
|
||||||
|
|
||||||
|
### 5. 组装节点参数
|
||||||
|
|
||||||
|
从 `node_list` 推导节点参数:
|
||||||
|
|
||||||
|
- 若某节点 `need_approver=true`,则必须在 `node_approver_list` 中补该节点的审批人。
|
||||||
|
- `key` 优先取 `custom_node_id`;若不存在,再用 `node_id`。
|
||||||
|
- `value` 是审批人 `open_id` 列表。
|
||||||
|
- 若 `approver_chosen_multi=false`,该节点只允许一个审批人 `open_id`。
|
||||||
|
- `node_cc_list` 仅在用户明确需要补充节点抄送人时才填写;其 `key/value` 规则与 `node_approver_list` 相同。
|
||||||
|
|
||||||
|
### 6. 创建审批实例
|
||||||
|
|
||||||
|
创建命令使用 `approval instances create`,需要的 scopes: ["approval:instance:write"]
|
||||||
|
|
||||||
|
确认最终表单值和节点参数后再执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances create \
|
||||||
|
--data '{
|
||||||
|
"approval_code":"7C468A54-8745-2245-9675-08B7C63E7A85",
|
||||||
|
"form":"[{\"id\":\"widget1\",\"type\":\"input\",\"value\":\"请假半天\"}]",
|
||||||
|
"node_approver_list":[
|
||||||
|
{
|
||||||
|
"key":"manager_node_id",
|
||||||
|
"value":["ou_xxx"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
执行规则:
|
||||||
|
|
||||||
|
- 执行前先向用户确认:目标审批定义、核心表单值、节点审批人/抄送人。
|
||||||
|
- 若需要幂等,可补 `uuid`。
|
||||||
|
- 成功后回报 `instance_code` 与 `instance_link`。
|
||||||
|
|
||||||
|
## 组装时优先依据的资料
|
||||||
|
|
||||||
|
优先级固定如下:
|
||||||
|
|
||||||
|
1. 本文中的创建请求参数、节点参数和返回结果说明:决定 `instances create` 要传哪些字段、怎么执行、成功后回什么。
|
||||||
|
2. [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md):决定每种控件的 `value` 结构与支持范围。
|
||||||
|
3. [`lark-approval-instance-value-sourcing.md`](./lark-approval-instance-value-sourcing.md):决定每类值应该从哪里拿,以及当前哪些值必须由用户直接提供。
|
||||||
|
4. `approvals.get.form`:提供当前审批定义里实际有哪些控件、控件 `id`、控件 `type`、选项值范围、明细子控件结构。
|
||||||
|
5. `approvals.get.node_list`:提供节点 key 与是否需要补充审批人/抄送人的线索。
|
||||||
|
|
||||||
|
不要反过来把 `approvals.get.form` 当成第一优先级,更不要把它当成可直接提交的 JSON 模板。
|
||||||
|
|
||||||
|
## 最小判断表
|
||||||
|
|
||||||
|
| 你手上有什么 | 下一步 |
|
||||||
|
|---|---|
|
||||||
|
| 只有口语需求,比如“帮我提个请假审批” | 先 `approvals.search` |
|
||||||
|
| 已经拿到 `approval_code` | 直接 `approvals.get` |
|
||||||
|
| 已拿到 `form` / `node_list`,且用户已给出表单值和审批人 | 组装 `instances create` |
|
||||||
|
| `is_external=true` | 返回 `create_link`,不要调 `instances create` |
|
||||||
|
|
||||||
|
## 返回结果
|
||||||
|
|
||||||
|
完成创建后,至少向用户返回:
|
||||||
|
|
||||||
|
- `approval_name`
|
||||||
|
- `instance_code`
|
||||||
|
- `instance_link`
|
||||||
|
|
||||||
|
建议整理为下面这种结构:
|
||||||
|
|
||||||
|
```text
|
||||||
|
审批已创建成功:
|
||||||
|
|
||||||
|
- approval_name: 请假申请
|
||||||
|
- instance_code: 19EAC829-F1CB-527F-BE2A-1330422E60C0
|
||||||
|
- instance_link: https://...
|
||||||
|
```
|
||||||
@ -0,0 +1,606 @@
|
|||||||
|
# 审批实例表单控件参数
|
||||||
|
|
||||||
|
> 说明:本文尽量保留上游参数文档的原始结构与示例,用于回答“控件 `value` 长什么样”。
|
||||||
|
> 当前 `lark-cli` 的推荐取值口径以 [`lark-approval-instance-value-sourcing.md`](./lark-approval-instance-value-sourcing.md) 为准;如果两份文档在“值从哪里拿”上存在差异,以后者为准。
|
||||||
|
|
||||||
|
在调用创建审批实例接口时需要使用表单控件参数,你可以通过本文了解审批实例内各表单控件的参数说明。
|
||||||
|
|
||||||
|
## 准备工作
|
||||||
|
|
||||||
|
审批实例的表单控件参数依据审批定义表单来配置,例如,审批定义的表单设计包括了 **单行文本** 和 **日期区间** 控件,则审批实例的表单控件参数就需要为 **单行文本** 和 **日期区间** 控件进行赋值。因此,在操作审批实例表单的控件参数前,应先通过审批定义详情确认表单控件结构。
|
||||||
|
|
||||||
|
## 审批实例 API 不支持的控件
|
||||||
|
|
||||||
|
创建审批实例 API 未完全支持所有的审批表单控件,不支持的控件如下表所示。如果你必须使用 API 不支持的控件,则不能仅通过当前 API 完成提单。
|
||||||
|
|
||||||
|
**控件/控件组** | **Type** |
|
||||||
|
| ---------- | --------------------------- |
|
||||||
|
| 说明 | text |
|
||||||
|
| 引用多维表格 | mutableGroup |
|
||||||
|
| 收款账户 | account |
|
||||||
|
| 流水号 | serialNumber |
|
||||||
|
| 出差控件组 | tripGroup |
|
||||||
|
| 录用控件组 | apaascorehrOnboardingGroup |
|
||||||
|
| 转正控件组 | apaascorehrRegularateGroup |
|
||||||
|
| 补卡控件组 | remedyGroupV2 |
|
||||||
|
| 调岗控件组 | apaascorehrJobAdjustGroup |
|
||||||
|
| 离职控件组 | apaascorehrOffboardingGroup
|
||||||
|
|
||||||
|
## 通用参数
|
||||||
|
|
||||||
|
审批实例的表单控件均包含的参数如下表所示。
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
id | string | 是 | 控件的 ID,需要与审批定义中的控件 ID 保持一致。
|
||||||
|
type | string | 是 | 控件类型。各控件类型取值参见下文 **不同控件的参数** 章节。
|
||||||
|
value | 不同控件的类型不同 | 是 | 控件的取值。不同控件 value 数据类型也不同,例如单行文本控件的 value 为字符串、联系人的 value 为数组。详情参见下文 **不同控件的参数** 章节。
|
||||||
|
|
||||||
|
## 不同控件的参数
|
||||||
|
|
||||||
|
本章节提供不同控件的 type 参数值、JSON 示例以及非通用参数说明。
|
||||||
|
|
||||||
|
### 单行文本
|
||||||
|
|
||||||
|
控件 type 为 input,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "input",
|
||||||
|
"value": "data" // string 类型
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 多行文本
|
||||||
|
|
||||||
|
控件 type 为 textarea,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "textarea",
|
||||||
|
"value": "data" // string 类型
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 日期
|
||||||
|
|
||||||
|
控件 type 为 date,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "date",
|
||||||
|
"value": "2019-10-01T08:12:01+08:00" // 需满足 RFC3339 格式的 string 类型
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 日期区间
|
||||||
|
|
||||||
|
控件 type 为 dateInterval,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "dateInterval",
|
||||||
|
"value": {
|
||||||
|
"start":"2019-10-01T08:12:01+08:00",
|
||||||
|
"end":"2019-10-02T08:12:01+08:00",
|
||||||
|
"interval": 1.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
value 参数为 object 类型,包含参数说明:
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
start | string | 是 | 开始时间,需满足 RFC3339 格式。
|
||||||
|
end | string | 是 | 结束时间,需满足 RFC3339 格式。
|
||||||
|
interval | float | 是 | 时长(天)。
|
||||||
|
|
||||||
|
### 单选
|
||||||
|
|
||||||
|
控件 type 为 radio/radioV2,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "k2b8mkx0-h71x5gl1234-1" // string 类型
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中, value 表示选项值,取值范围需要参考相应审批定义中 **单选** 控件 option 的 value 参数。你可以通过审批定义详情返回的 `form` 参数,获取单选控件 option 的 value 取值。如果控件关联了外部选项,则 value 需要传入外部选项的 `options.id`。
|
||||||
|
|
||||||
|
### 多选
|
||||||
|
|
||||||
|
控件 type 为 checkbox/checkboxV2,JSON数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"checkboxV2",
|
||||||
|
"value": ["k2b8mkx0-h71x5gl4321-1"] // string 类型的数组
|
||||||
|
}
|
||||||
|
```
|
||||||
|
其中, value 表示选项值,取值范围需要参考相应审批定义中 **多选** 控件 option 的 value 参数。你可以通过审批定义详情返回的 `form` 参数,获取多选控件 option 的 value 取值。如果控件关联了外部选项,则 value 需要传入外部选项的 `options.id`。
|
||||||
|
|
||||||
|
### 数字
|
||||||
|
|
||||||
|
控件 type 为 number,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "number",
|
||||||
|
"value": 1234.5678 // float 类型
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 金额
|
||||||
|
|
||||||
|
控件 type 为 amount,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "amount",
|
||||||
|
"value": 1234.5678, // float 类型
|
||||||
|
"currency":"USD"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中,currency 表示货币种类,取值范围需要参考相应审批定义中 **金额** 控件的 value 参数。你可以通过审批定义详情返回的 `form` 参数,获取金额控件可设置的货币种类。
|
||||||
|
|
||||||
|
### 计算公式
|
||||||
|
|
||||||
|
控件 type 为 formula,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "formula",
|
||||||
|
"value": 1234.5678 // 该值由审批定义内配置的公式计算出取值,若不匹配则返回报错。
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 联系人
|
||||||
|
|
||||||
|
控件 type 为 contact,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"contact",
|
||||||
|
"value": ["f8ca557e"], // string 类型的数组
|
||||||
|
"open_ids": ["ou_12345"] // string 类型的数组
|
||||||
|
}
|
||||||
|
```
|
||||||
|
其中,value 包含的是用户 `user_id`;open_ids 包含的是用户 `open_id`。
|
||||||
|
|
||||||
|
### 关联审批
|
||||||
|
|
||||||
|
控件 type 为 connect,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"connect",
|
||||||
|
"value": ["19EAC829-F1CB-527F-BE2A-1330422E60C0"] // string 类型的数组
|
||||||
|
}
|
||||||
|
```
|
||||||
|
其中,value 包含的是被关联的审批实例 Code,你可以通过审批实例详情能力根据实例 Code 获取实例详情。
|
||||||
|
|
||||||
|
### 文档控件
|
||||||
|
|
||||||
|
控件 type 为 document,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "document",
|
||||||
|
"value": {
|
||||||
|
"token":"TLLKdcpDro9ijQxA33ycNMabcef",
|
||||||
|
"type":"docx",
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
value 参数为 object 类型,包含参数说明:
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
token | string | 是 | 文档的 document_id。
|
||||||
|
type | string | 是 | 文档类型,支持 `docx`。
|
||||||
|
|
||||||
|
### 附件
|
||||||
|
|
||||||
|
控件 type 为 attachmentV2,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"attachmentV2",
|
||||||
|
"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"] // string 类型的数组
|
||||||
|
}
|
||||||
|
```
|
||||||
|
其中,value 包含的是上传文件后返回的文件 code。
|
||||||
|
|
||||||
|
### 图片
|
||||||
|
|
||||||
|
控件 type 为 image/imageV2,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"image",
|
||||||
|
"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"] // string 类型的数组
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中,value 包含的是上传文件后返回的文件 code。
|
||||||
|
|
||||||
|
### 明细/表格
|
||||||
|
|
||||||
|
控件 type 为 fieldList,JSON 格式示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "fieldList",
|
||||||
|
"value": [
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "checkbox",
|
||||||
|
"value": ["jxpsebqp-0"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 value 是二维数组,根据审批定义内 **明细/表格** 控件所包含的控件,依次设置控件 JSON 值。
|
||||||
|
|
||||||
|
### 部门
|
||||||
|
|
||||||
|
控件 type 为 department,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"department",
|
||||||
|
"value":[
|
||||||
|
{
|
||||||
|
"open_id": "od-xxx"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 value 为对象数组,通过 open_id 设置部门的 open_department_id。
|
||||||
|
|
||||||
|
### 电话
|
||||||
|
|
||||||
|
控件 type 为 telephone,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id":"widget1",
|
||||||
|
"type":"telephone",
|
||||||
|
"value": {
|
||||||
|
"countryCode":"+86",
|
||||||
|
"nationalNumber":"13122222222"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
value 参数为 object 类型,包含参数说明:
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
countryCode | string | 是 | 区号。
|
||||||
|
nationalNumber | string | 是 | 电话号。
|
||||||
|
|
||||||
|
### 地址
|
||||||
|
控件 type 为 address,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "address",
|
||||||
|
"value": [{
|
||||||
|
"id": "290557",
|
||||||
|
"detailAddress": "详细的地址"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
value 参数为 []object 类型,参数说明如下:
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
value | []object | 是 | 非出差控件组场景地址控件仅支持单个地址,传入多个时默认只取第一个
|
||||||
|
└ id | string | 是 | 区域ID, 可通过审批的地理库接口获取
|
||||||
|
└ detailAddress | string | 否 | 详细的地址,若表单配置中未开启填写详细地址,则会忽略该参数,即使传入也不会生效
|
||||||
|
|
||||||
|
### 换班控件组
|
||||||
|
|
||||||
|
控件 type 为 shiftGroup,JSON 数据示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widget1",
|
||||||
|
"type": "shiftGroup",
|
||||||
|
"value": {
|
||||||
|
"shiftTime": "2019-10-01T08:12:01+08:00",
|
||||||
|
"returnTime": "2019-10-02T08:12:01+08:00",
|
||||||
|
"reason": "ask for leave"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
value 参数为 object 类型,包含参数说明:
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
shiftTime | string | 是 | 换班时间,需满足 RFC3339 格式。
|
||||||
|
returnTime | string | 是 | 对调日期,需满足 RFC3339 格式。
|
||||||
|
reason | string | 是 | 换班原因。
|
||||||
|
|
||||||
|
### 请假控件组
|
||||||
|
|
||||||
|
**请假控件组请求示例**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupV2",
|
||||||
|
"type": "leaveGroupV2",
|
||||||
|
"value": [
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupType",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "7488925543484620819"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupStartTime",
|
||||||
|
"type": "date",
|
||||||
|
"value": "2025-08-25T11:30:00+08:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupEndTime",
|
||||||
|
"type": "date",
|
||||||
|
"value": "2025-08-26T11:35:00+08:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupReason",
|
||||||
|
"type": "textarea",
|
||||||
|
"value": "123123"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveCertification",
|
||||||
|
"type": "image",
|
||||||
|
"value": [
|
||||||
|
"B69F8E26-0EAA-4A92-9B80-DA613CD36136"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id":"widgetLeaveCertification",
|
||||||
|
"type":"image",
|
||||||
|
"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupFeedingArrivingLate",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "30"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetLeaveGroupFeedingOffLeaveEarly",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "30"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**请假控件组包含参数说明:**
|
||||||
|
|
||||||
|
id | 类型 | JSON示例 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
id | string | 是 | 控件组ID,固定为widgetLeaveGroupV2
|
||||||
|
type | string | 是 | 控件组类型,固定为leaveGroupV2
|
||||||
|
value | object[] | 是 | 控件组的值,值为多个子控件值的列表
|
||||||
|
|
||||||
|
value中包含的子控件值说明:
|
||||||
|
|
||||||
|
id | 类型 | JSON示例 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
widgetLeaveGroupType | radioV2 | ```<br>{<br>"id": "widgetLeaveGroupType",<br>"type": "radioV2",<br>"value": "7488925543484620819"<br>}<br>``` | 假期类型,具体格式可参考单选控件,选项由假勤接口获取,提单时必须包含该控件
|
||||||
|
widgetLeaveGroupStartTime | date | ```<br>{<br>"id": "widgetLeaveGroupStartTime",<br>"type": "date",<br>"value": "2019-10-01T08:12:01+08:00", // 需满足 RFC3339 格式的 string 类型<br>} <br>``` | 请假开始时间,具体格式可参考日期控件,会根据假期类型自动取整,其中半天假小于12点则认为是上午,小时假则以半小时为粒度向前取整, 提单时必须包含该控件
|
||||||
|
widgetLeaveGroupEndTime | date | ```<br>{<br>"id": "widgetLeaveGroupEndTime",<br>"type": "date",<br>"value": "2019-10-01T08:12:01+08:00", // 需满足 RFC3339 格式的 string 类型<br>}<br>``` | 请假结束时间,具体格式可参考日期控件,会根据假期类型自动取整,其中半天假小于12点则认为是上午,小时假则以半小时为粒度向后取整
|
||||||
|
widgetLeaveGroupReason | textarea | ```<br>{<br>"id": "widgetLeaveGroupReason",<br>"type": "textarea",<br>"value": "123123"<br>}<br>``` | 请假事由,具体格式可参考多行文本控件,哺乳假无需填写,其他情况则根据控件组配置中该控件是否可见以及必填判断
|
||||||
|
widgetLeaveCertification | image | ```<br>{<br>"id":"widgetLeaveCertification",<br>"type":"image",<br>"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]<br>}<br>``` | 请假证明,具体格式可参考图片控件,如果所选假期类型配置要求补充证明则必须传递该值,缺失会报错
|
||||||
|
widgetLeaveGroupFeedingArrivingLate | radioV2 | ```<br>{ <br>"id": "widgetLeaveGroupFeedingArrivingLate",<br>"type": "radioV2",<br>"value": "30"<br>}<br>``` | 上班晚到的分钟数,具体格式可参考单选控件,仅哺乳假需要填写,取值范围是0-120分钟,粒度是15分钟,选项从审批定义中该控件的option中获取
|
||||||
|
widgetLeaveGroupFeedingOffLeaveEarly | radioV2 | ```<br>{ <br>"id": "widgetLeaveGroupFeedingOffLeaveEarly",<br>"type": "radioV2",<br>"value": "30"<br>} <br>``` | 下班早走的分钟数,具体格式可参考单选控件,仅哺乳假需要填写,取值范围是0-120分钟,粒度是15分钟,选项即是分钟对应的字符串
|
||||||
|
|
||||||
|
**特殊的参数校验报错信息**
|
||||||
|
message | 说明 |
|
||||||
|
| -------------------------------------------------- | ---------------------------- |
|
||||||
|
| leave type id parse error | 请假类型不是int64 |
|
||||||
|
| group value is invalid | 当前控件组的值无效,请校验是否为空或者校验类型是否为数组 |
|
||||||
|
| start time format is not RFC3339 | 开始时间日期格式非*RFC3339格式* |
|
||||||
|
| end time format is not RFC3339 | 结束时间日期格式非*RFC3339格式* |
|
||||||
|
| start time is after end time | 开始时间晚于结束时间 |
|
||||||
|
| user not in gray | 申请用户不在假勤灰度内 |
|
||||||
|
| leave type not found | 请假类型不存在 |
|
||||||
|
| reason is required | 请假原因未填写 |
|
||||||
|
| leave quote should be bigger than 0 | 请假时长需要大于0 |
|
||||||
|
| leave is conflict | 所选时间内已有请假记录,请选择其他时间 |
|
||||||
|
| balance is not enough | 当前假期类型下假期余额不足 |
|
||||||
|
| certification is required | 需要上传请假证明 |
|
||||||
|
| arriving late is required | 哺乳假需要填写上班晚到时长 |
|
||||||
|
| arriving late value is not in the optional items | 晚到时间不在可选范围内 |
|
||||||
|
| leaving early is required | 哺乳假需要填写下班提前时长 |
|
||||||
|
| leaving early value is not in the optional items | 下班提前时间不在可选范围内 |
|
||||||
|
| feeding rest daily is 0 | 哺乳假每日休息时长为0,请重新选择 |
|
||||||
|
| the operation is prohibited by the workforce rules | 当前账户已在假勤侧封账,无法提交
|
||||||
|
|
||||||
|
### 加班控件组
|
||||||
|
|
||||||
|
**加班控件组请求示例**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widgetWorkGroup",
|
||||||
|
"type": "workGroup",
|
||||||
|
"value":[
|
||||||
|
{
|
||||||
|
"id":"widgetWorkGroupOvertimeWorkers",
|
||||||
|
"type":"contact",
|
||||||
|
"value": ["f8ca557e"],
|
||||||
|
"open_ids": ["ou_12345"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetWorkGroupType",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "7259635026038505475"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id":"widgetWorkGroupTimeRangeFieldList",
|
||||||
|
"type":"fieldList",
|
||||||
|
"value":[
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"id":"widgetWorkGroupStartTime",
|
||||||
|
"type":"date",
|
||||||
|
"value":"2019-10-01T08:12:01+08:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id":"widgetWorkGroupEndTime",
|
||||||
|
"type":"date",
|
||||||
|
"value":"2019-10-01T08:12:01+08:00"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetWorkGroupReason",
|
||||||
|
"type": "textarea",
|
||||||
|
"value": "111"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**加班控件组参数说明:**
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
id | string | 是 | 控件组ID,固定为widgetWorkGroup
|
||||||
|
type | string | 是 | 控件组类型,固定为workGroup
|
||||||
|
value | object[] | 是 | 控件组的值,值为多个子控件值的列表
|
||||||
|
|
||||||
|
value中包含的子控件值说明:
|
||||||
|
|
||||||
|
id | 类型 | JSON示例 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
widgetWorkGroupOvertimeWorkers | contact | ```<br>{<br>"id":"widgetWorkGroupOvertimeWorkers",<br>"type":"contact",<br>"value": ["f8ca557e"], <br>"open_ids": ["ou_12345"]<br>}<br>``` | 加班人员列表,具体格式可参考联系人控件,如果定义中配置「允许代多人提交」则该字段必填,如果是提交人给自己提交需填写提交人的ID
|
||||||
|
widgetWorkGroupType | radioV2 | ```<br>{<br>"id": "widgetWorkGroupType",<br>"type": "radioV2",<br>"value": "7259635026038505475" // 对应的类型选项ID<br>}<br>``` | 加班类型,具体格式可参考单选控件,如果定义中关闭「关联加班规则」则需要填写该字段
|
||||||
|
widgetWorkGroupTimeRangeFieldList | fieldList | ```<br>{<br>"id":"widgetWorkGroupTimeRangeFieldList",<br>"type":"fieldList",<br>"value":[<br>[<br>{<br>"id":"widgetWorkGroupStartTime",<br>"type":"date",<br>"value":"2019-10-01T08:12:01+08:00"<br>},<br>{<br>"id":"widgetWorkGroupEndTime",<br>"type":"date",<br>"value":"2019-10-01T08:12:01+08:00"<br>}<br>]<br>]<br>}<br>``` | 加班时段,具体格式可参考明细控件,如果定义中打开「允许提交多个加班时段」则可以传多个,最多支持30个,否则只会取第一个,单次加班时长不可超过两天
|
||||||
|
widgetWorkGroupReason | textarea | ```<br>{<br>"id": "widgetWorkGroupReason",<br>"type": "textarea",<br>"value": "111"<br>}<br>``` | 加班事由,如果定义中配置了「加班事由」必填,则必须填写该字段
|
||||||
|
|
||||||
|
**特殊的参数校验报错信息**
|
||||||
|
message | 说明 |
|
||||||
|
| ---------------------------------------------------------------------------------- | ---------------------------- |
|
||||||
|
| the time range list has more than 30 items | 加班时段数量超过30 |
|
||||||
|
| group value is invalid | 当前控件组的值无效,请校验是否为空或者校验类型是否为数组 |
|
||||||
|
| overtime type is required | 未关联加班规则时,加班类型必填 |
|
||||||
|
| work time range is required | 至少需要一个加班时段 |
|
||||||
|
| start time is after end time | 开始时间晚于结束时间 |
|
||||||
|
| start time or end time of range is required | 加班时间段的开始时间和结束时间必填 |
|
||||||
|
| overtime duration is over 2 days | 单次加班时长不可超过两天 |
|
||||||
|
| overtime date time zone not support | 加班时段的日期时区信息无法识别 |
|
||||||
|
| {date} can not apply overtime | 所选时间不可申请加班 |
|
||||||
|
| {date} already apply overtime | 所选时间已经有加班记录 |
|
||||||
|
| {date} no need approval | 所选日期加班无需申请 |
|
||||||
|
| apply reason is required | 定义中设置了加班事由为必填,不可为空 |
|
||||||
|
| {users} user follow different overtime rules, cannot be submitted in the same form | 所选加班人不在同一个考勤组内,无法同时提交加班 |
|
||||||
|
| invalid overtime work application | 没有有效的加班申请,请重新选择加班日期 |
|
||||||
|
| the overtime duration cannot be 0 | 加班时长不能是0 |
|
||||||
|
| the number of apply workers cannot exceed 50 | 单次申请加班人数量不可大于50 |
|
||||||
|
| apply worker is required | 必须有加班人,配置置可代多人提交时必须指定加班人 |
|
||||||
|
| resigned worker can not apply | 离职人员不可申请加班 |
|
||||||
|
| overtime duration is over limit | 加班时长超过限制
|
||||||
|
|
||||||
|
### 外出控件组
|
||||||
|
|
||||||
|
**外出控件组请求体示例**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "widgetOutGroup",
|
||||||
|
"type": "outGroup",
|
||||||
|
"value":[
|
||||||
|
{
|
||||||
|
"id": "widgetOutGroupType",
|
||||||
|
"type": "radioV2",
|
||||||
|
"value": "me15yqrf-gmjgbml2vhp-0"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetOutGroupStartTime",
|
||||||
|
"type": "date",
|
||||||
|
"value":"2019-10-01T08:12:01+08:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetOutGroupEndTime",
|
||||||
|
"type": "date",
|
||||||
|
"value":"2019-10-01T08:12:01+08:00"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "widgetOutGroupReason",
|
||||||
|
"type": "textarea",
|
||||||
|
"value":"123213"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id":"widgetOutGroupImage",
|
||||||
|
"type":"image",
|
||||||
|
"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
**外出控件参数说明**
|
||||||
|
|
||||||
|
参数 | 类型 | 是否必填 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
id | string | 是 | 控件组ID,固定为widgetOutGroup
|
||||||
|
type | string | 是 | 控件组Type,固定为outGroup
|
||||||
|
value | object[] | 是 | 控件组的值,值为多个子控件值的列表
|
||||||
|
|
||||||
|
value中包含的子控件值说明:
|
||||||
|
|
||||||
|
id | 类型 | JSON示例 | 描述
|
||||||
|
---|---|---|---
|
||||||
|
widgetOutGroupType | radioV2 | ```<br>{<br>"id": "widgetOutGroupType",<br>"type": "radioV2",<br>"value": "me15yqrf-gmjgbml2vhp-0" <br>}<br>``` | 外出类型,具体格式可参考单选控件,如果配置了「外出类型」则必填,外出时长单位会选取所选外出类型关联的单位,如果没有配置「外出类型」,则该字段无需填写,计算外出时长时会选取「外出时长」配置的单位
|
||||||
|
widgetOutGroupStartTime | date | ```<br>{<br>"id": "widgetOutGroupStartTime",<br>"type": "date",<br>"value":"2019-10-01T08:12:01+08:00"<br>}<br>``` | 外出开始时间,具体格式可参考日期控件,如果外出时长单位是半天假,则小于12点则认为是上午,否则认为是下午;如果单位是小时,则会按半小时的粒度向前取整
|
||||||
|
widgetOutGroupEndTime | date | ```<br>{<br>"id": "widgetOutGroupEndTime",<br>"type": "date",<br>"value":"2019-10-01T08:12:01+08:00"<br>}<br>``` | 外出结束时间,具体格式可参考日期控件,如果外出时长单位是半天假,则小于12点则认为是上午,否则认为是下午;如果单位是小时,则会按半小时的粒度向后取整
|
||||||
|
widgetOutGroupReason | textarea | ```<br>{<br>"id": "widgetOutGroupReason",<br>"type": "textarea",<br>"value":"123213"<br>}<br>``` | 外出事由,具体格式可参考多行文本控件,如果定义中「外出事由」必填,则必须填写该控件,如果定义配置无需填写,则无需填写该控件
|
||||||
|
widgetOutGroupImage | image | ```<br>{<br>"id":"widgetOutGroupImage",<br>"type":"image",<br>"value": ["D93653C3-2609-4EE0-8041-61DC1D84F0B5"]<br>} <br>``` | 外出证明,具体格式可参考图片控件,如果定义中「外出拍照」必填,则必须填写该控件,如果定义配置无需填写,则无需填写该控件
|
||||||
|
|
||||||
|
**特殊的参数校验报错信息**
|
||||||
|
|
||||||
|
message | 说明 |
|
||||||
|
| ----------------------------------------------------- | ---------------------------- |
|
||||||
|
| group value is invalid | 当前控件组的值无效,请校验是否为空或者校验类型是否为数组 |
|
||||||
|
| start time format is not RFC3339 | 开始时间日期格式非*RFC3339格式* |
|
||||||
|
| end time format is not RFC3339 | 结束时间日期格式非*RFC3339格式* |
|
||||||
|
| start time and end time must be in the same time zone | 开始时间与结束时间必须是同一时区 |
|
||||||
|
| out type is required | 如果定义中设定了「外出类型」,则外出类型必填 |
|
||||||
|
| out start time is required | 外出开始时间必填 |
|
||||||
|
| out end time is required | 外出结束时间必填 |
|
||||||
|
| out duration must be greater than 0 | 外出间隔不能为0,请检查起止时间并重新选择 |
|
||||||
|
| out reason is empty | 如果定义中勾选「外出事由」同时设定必填,则该字段必填 |
|
||||||
|
| photo is required | 如果定义中勾选「外出拍照」同时设定必填,则该字段必填 |
|
||||||
|
| out time is conflict | 外出时间有冲突,请确认是否已在该时段申请外出
|
||||||
@ -0,0 +1,108 @@
|
|||||||
|
# 审批提单值来源
|
||||||
|
|
||||||
|
## 目的
|
||||||
|
|
||||||
|
本文用于回答一个固定问题:在调用 `approval instances create` 发起原生审批实例时,**每个要填写的值从哪里拿**。
|
||||||
|
|
||||||
|
阅读顺序固定如下:
|
||||||
|
|
||||||
|
1. [`lark-approval-initiate.md`](./lark-approval-initiate.md) 中的创建请求参数、节点参数和返回结果说明
|
||||||
|
2. `approval approvals get` 返回的 `form` / `node_list`
|
||||||
|
3. [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md)
|
||||||
|
4. 本文
|
||||||
|
|
||||||
|
## 总原则
|
||||||
|
|
||||||
|
- `lark-approval-initiate.md` 决定创建请求字段名、字段层级、节点参数结构。
|
||||||
|
- `approvals.get.form` 决定控件 `id`、`type`、选项值范围、子控件结构。
|
||||||
|
- `approvals.get.node_list` 决定节点 key、是否必须补审批人、是否允许多人。
|
||||||
|
- [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 决定各控件 `value` 的最终结构。
|
||||||
|
- 除非本文明确允许,否则不要猜值来源,不要把展示文案直接当成可提交值。
|
||||||
|
|
||||||
|
## 默认来源
|
||||||
|
|
||||||
|
- 审批定义、`approval_code`、`is_external`、`create_link` 等基础信息,默认从 `approval approvals search` 获取。
|
||||||
|
- 控件 `id`、`type`、选项值、子控件结构,默认从 `approval approvals get.form` 获取。
|
||||||
|
- 节点 key、`need_approver`、`approver_chosen_multi` 等节点信息,默认从 `approval approvals get.node_list` 获取。
|
||||||
|
- 本文只补充 **这些默认来源之外** 的取值规则,以及当前必须由用户直接提供的值。
|
||||||
|
|
||||||
|
## 控件值来源规则
|
||||||
|
|
||||||
|
### 联系人 `contact`
|
||||||
|
|
||||||
|
- 只推荐写 `open_ids`。
|
||||||
|
- 不再推荐双写 `value(user_id)` + `open_ids`,避免复杂度继续上升。
|
||||||
|
- 如果用户给的是姓名、邮箱或账号,先用 `lark-contact` 解析成 `open_id`。
|
||||||
|
|
||||||
|
### 部门 `department`
|
||||||
|
|
||||||
|
- 最优先:用户直接提供 `open_department_id`。
|
||||||
|
- 若用户说“我的部门”或“张三的部门”,先用 `lark-contact` 查询对应人员信息,再取其所属部门里的 `open_department_id`。
|
||||||
|
- 如果查到该人员只有一个部门,可直接使用。
|
||||||
|
- 如果查到多个部门,不自动猜,必须让用户明确选一个,或直接输入 `open_department_id`。
|
||||||
|
- 如果仍无法确定,则明确告知当前不支持自动决定部门值。
|
||||||
|
|
||||||
|
### 附件 `attachmentV2`
|
||||||
|
|
||||||
|
- 当前 `lark-approval` 不负责上传文件。
|
||||||
|
- 用户必须直接提供 file code。
|
||||||
|
- 如果用户无法提供 file code,应明确告知当前无法仅通过 `lark-approval` 完成该控件提单。
|
||||||
|
|
||||||
|
### 图片 `image` / `imageV2`
|
||||||
|
|
||||||
|
- 当前 `lark-approval` 不负责上传图片。
|
||||||
|
- 用户必须直接提供 file code。
|
||||||
|
- 如果用户无法提供 file code,应明确告知当前无法仅通过 `lark-approval` 完成该控件提单。
|
||||||
|
|
||||||
|
### 文档 `document`
|
||||||
|
|
||||||
|
- 用户可直接提供 `token` / `document_id`。
|
||||||
|
- 如果用户给的是飞书文档链接,应先尝试从链接中提取 token。
|
||||||
|
- 若链接提取失败,再要求用户手动输入 token。
|
||||||
|
|
||||||
|
### 关联审批 `connect`
|
||||||
|
|
||||||
|
- 用户直接提供目标审批实例的 `instance_code`。
|
||||||
|
- 当前不默认做“搜索关联实例再反查 code”的自动流程。
|
||||||
|
|
||||||
|
### 地址 `address`
|
||||||
|
|
||||||
|
- 用户直接提供地理库 `id`。
|
||||||
|
- 若用户无法提供该 `id`,当前不支持自动取值。
|
||||||
|
|
||||||
|
## 特殊控件组
|
||||||
|
|
||||||
|
以下控件组的结构仍按 [`lark-approval-instance-form-control-parameters.md`](./lark-approval-instance-form-control-parameters.md) 组装:
|
||||||
|
|
||||||
|
- `leaveGroupV2`
|
||||||
|
- `workGroup`
|
||||||
|
- `outGroup`
|
||||||
|
- `shiftGroup`
|
||||||
|
|
||||||
|
补充规则:
|
||||||
|
|
||||||
|
- 控件组自身和子控件的 `id` / `type` 从 `approval approvals get.form` 中识别。
|
||||||
|
- 组内单选/多选或业务枚举值,优先从 `approval approvals get.form` 返回的选项结构中取。
|
||||||
|
- 不要把控件组整体当成普通字符串或扁平对象提交。
|
||||||
|
|
||||||
|
## 不支持自动准备的值
|
||||||
|
|
||||||
|
以下值当前不建议由 `lark-approval` 自动准备:
|
||||||
|
|
||||||
|
- 文件上传后的 file code
|
||||||
|
- 图片上传后的 file code
|
||||||
|
- 地址控件的地理库 `id`
|
||||||
|
- 无法唯一确定的部门 `open_department_id`
|
||||||
|
|
||||||
|
遇到这类值时,应明确告诉用户需要提供什么,而不是继续猜测。
|
||||||
|
|
||||||
|
## 最小决策表
|
||||||
|
|
||||||
|
| 场景 | 处理 |
|
||||||
|
|---|---|
|
||||||
|
| 用户说“找张三当审批人” | 用 `lark-contact` 解析张三,取 `open_id` |
|
||||||
|
| 用户说“我的部门” | 先查当前用户部门;若多个部门,让用户选 |
|
||||||
|
| 用户给了文档链接 | 先尝试提取 token |
|
||||||
|
| 用户要填图片/附件 | 要求直接提供 file code |
|
||||||
|
| 用户要填关联审批 | 要求直接提供 `instance_code` |
|
||||||
|
| 用户要填地址 | 要求直接提供地理库 `id` |
|
||||||
@ -0,0 +1,78 @@
|
|||||||
|
|
||||||
|
# approval instances cancel
|
||||||
|
|
||||||
|
撤回一个已发起的审批实例(用户级写操作)。通常先通过 `instances initiated`、`tasks query` 或 `instances get` 确认目标审批实例,拿到 `instance_code` 后再执行撤回。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要撤回该审批实例且目标实例无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:instance:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval instances cancel \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 撤回一个审批实例
|
||||||
|
lark-cli approval instances cancel \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体
|
||||||
|
lark-cli approval instances cancel \
|
||||||
|
--data @./cancel-body.json \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `instances initiated`、`tasks query` 或 `instances get` 获取 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批实例撤回通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
如果你要找“我发起的审批实例”,可先查询已发起列表:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你已经在任务列表中定位到某个审批,也可以从任务里拿到实例 Code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `instances[].instance_code` | 审批实例 Code;撤回时必须提供 |
|
||||||
|
| `tasks[].instance_code` | 审批任务关联的审批实例 Code;也可作为撤回输入 |
|
||||||
|
| `tasks[].instance_status` | 审批实例状态;可用于判断是否仍处于可撤回阶段 |
|
||||||
|
|
||||||
|
如需先确认审批表单、当前节点、流转状态,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **撤回的是审批实例,不是单个任务**:`instances cancel` 只需要 `instance_code`,不需要 `task_id`。
|
||||||
|
- **优先确认实例是否仍可撤回**:已经通过、已拒绝、已撤销或已终止的实例通常不适合继续撤回。
|
||||||
|
- **优先从 `instances initiated` 获取目标实例**:因为撤回通常针对“我发起的审批”,这个入口最直接。
|
||||||
|
- **也可从 `tasks query` 反查 `instance_code`**:当你是从某个待办/已办上下文进入时,这样更方便。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在实例来源不明确、用户只给了标题关键字,或一次要核对多个实例时,先预览更安全。
|
||||||
@ -0,0 +1,105 @@
|
|||||||
|
|
||||||
|
# approval instances cc
|
||||||
|
|
||||||
|
给一个审批实例追加抄送人(用户级写操作)。通常先通过 `instances initiated`、`tasks query` 或 `instances get` 确认目标审批实例,拿到 `instance_code` 后,再提供抄送人的用户 ID 执行抄送。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要抄送该审批实例且目标实例、抄送对象都无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:instance:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval instances cc \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","cc_user_ids":["ou_xxx"],"comment":"抄送给项目 owner 了解进展"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 按 open_id 抄送一个人
|
||||||
|
lark-cli approval instances cc \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","cc_user_ids":["ou_xxx"],"comment":"抄送给你知悉"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 一次抄送多个人
|
||||||
|
lark-cli approval instances cc \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","cc_user_ids":["ou_xxx","ou_yyy"],"comment":"请相关同学同步关注"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 按 user_id 抄送
|
||||||
|
lark-cli approval instances cc \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","cc_user_ids":["123456789"],"comment":"抄送给财务负责人"}' \
|
||||||
|
--params '{"user_id_type":"user_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体
|
||||||
|
lark-cli approval instances cc \
|
||||||
|
--data @./cc-body.json \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `instances initiated`、`tasks query` 或 `instances get` 获取 |
|
||||||
|
| `cc_user_ids` | 是 | 抄送人的用户 ID 数组;需要和 `user_id_type` 保持一致 |
|
||||||
|
| `comment` | 否 | 抄送留言,例如 `抄送给你知悉`、`请同步关注该审批进展` |
|
||||||
|
| `--params '{"user_id_type":"..."}'` | 否 | 查询参数 JSON;用于声明 `cc_user_ids` 内用户 ID 的类型 |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id`;未显式指定时要特别确认抄送人的 ID 类型 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批实例抄送通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
如果你要找“我发起的审批实例”,可先查询已发起列表:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你已经在任务列表中定位到某个审批,也可以从任务里拿到实例 Code:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `instances[].instance_code` | 审批实例 Code;抄送时必须提供 |
|
||||||
|
| `tasks[].instance_code` | 审批任务关联的审批实例 Code;也可作为抄送输入 |
|
||||||
|
| `tasks[].title` | 任务标题,可用于确认是否是要操作的那个审批 |
|
||||||
|
| `tasks[].instance_status` | 审批实例状态;可用于判断当前审批是否仍处于进行中 |
|
||||||
|
|
||||||
|
如果你手里只有姓名或邮箱,建议先通过联系人能力解析出正确的用户 ID,再执行抄送。
|
||||||
|
|
||||||
|
如需先确认审批表单、当前节点、流转状态,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **抄送的是审批实例,不是单个任务**:`instances cc` 只需要 `instance_code`,不需要 `task_id`。
|
||||||
|
- **`cc_user_ids` 与 `user_id_type` 必须匹配**:例如传 open_id 就把 `user_id_type` 设为 `open_id`;不要混用。
|
||||||
|
- **`cc_user_ids` 是数组**:即使只抄送一个人,也要按数组形式传入。
|
||||||
|
- **优先显式传 `user_id_type`**:这样 agent 更容易判断参数含义,也能减少 ID 类型不匹配带来的失败。
|
||||||
|
- **优先从 `instances initiated` 获取目标实例**:因为抄送常见于“我发起的审批”场景,这个入口最直接。
|
||||||
|
- **也可从 `tasks query` 反查 `instance_code`**:当你是从某个审批上下文进入时,这样更方便。
|
||||||
|
- **`comment` 建议简洁明确**:例如 `抄送给你知悉`、`请同步关注审批进展`。避免过长或模糊描述。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在抄送对象较多、抄送人来源不明确,或需要让用户先核对实例标题时,先预览更安全。
|
||||||
@ -0,0 +1,145 @@
|
|||||||
|
|
||||||
|
# approval instances get
|
||||||
|
|
||||||
|
获取单个审批实例详情(用户级只读操作)。适合在执行 approve / reject / transfer / rollback / cancel / cc / remind 之前,先查看审批表单、当前节点、任务列表、审批动态和整体状态。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:instance:read"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 按实例 Code 查询详情
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
|
||||||
|
# 表格格式输出,便于快速浏览顶层字段
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --format table --as user
|
||||||
|
|
||||||
|
# 预览 API 调用,不执行
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--params '{...}'` | 是 | 查询参数,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code |
|
||||||
|
| `locale` | 否 | 返回语言,例如 `zh-CN`、`en-US`、`ja-JP` |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批实例详情查询通常应使用用户身份 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 常见输入来源
|
||||||
|
|
||||||
|
如果你已经有实例 Code,可直接查询:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你还没有实例 Code,可先从以下命令获取:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查询我发起的审批实例
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --as user
|
||||||
|
|
||||||
|
# 或从任务列表里拿到关联实例 Code
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出重点字段
|
||||||
|
|
||||||
|
返回结果中常见字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `instance_code` | 审批实例 Code |
|
||||||
|
| `serial_number` | 审批单编号 |
|
||||||
|
| `definition_code` | 审批定义 Code |
|
||||||
|
| `definition_name` | 审批名称 |
|
||||||
|
| `user_id` | 发起审批的用户 ID |
|
||||||
|
| `department_id` | 发起人所在部门 ID |
|
||||||
|
| `status` | 审批实例状态,见下方“status 枚举” |
|
||||||
|
| `reverted` | 单据是否已被撤销 |
|
||||||
|
| `start_time` | 审批创建时间 |
|
||||||
|
| `end_time` | 审批完成时间,未完成时通常为 `0` |
|
||||||
|
| `form` | 表单数据,JSON 字符串 |
|
||||||
|
| `current_nodes` | 当前审批节点列表 |
|
||||||
|
| `tasks` | 审批任务列表 |
|
||||||
|
| `operation_records` | 审批动态,例如通过、拒绝、转交、加签、回退、撤回、抄送 |
|
||||||
|
| `comments` | 评论列表 |
|
||||||
|
|
||||||
|
## status 枚举
|
||||||
|
|
||||||
|
| 值 | 含义 |
|
||||||
|
|----|------|
|
||||||
|
| `PENDING` | 审批中 |
|
||||||
|
| `APPROVED` | 已通过 |
|
||||||
|
| `REJECTED` | 已拒绝 |
|
||||||
|
| `CANCELED` | 已撤回 |
|
||||||
|
| `DELETED` | 已删除 |
|
||||||
|
|
||||||
|
## current_nodes 重点字段
|
||||||
|
|
||||||
|
`current_nodes` 常用于判断审批流当前卡在哪一层:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------------------------------------------|
|
||||||
|
| `current_nodes[].node_id` | 当前审批节点 ID |
|
||||||
|
| `current_nodes[].node_name` | 当前审批节点名称 |
|
||||||
|
| `current_nodes[].type` | 审批方式:`AND` 会签、`OR` 或签、`SEQUENTIAL` 依次审批等 |
|
||||||
|
| `current_nodes[].approvers[].task_id` | 当前审批人关联任务 ID |
|
||||||
|
| `current_nodes[].approvers[].user_id` | 当前审批人用户 ID |
|
||||||
|
|
||||||
|
## tasks 重点字段
|
||||||
|
|
||||||
|
`tasks` 常用于把实例和具体审批任务关联起来:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].id` | 审批任务 ID |
|
||||||
|
| `tasks[].node_id` | 任务所属节点 ID |
|
||||||
|
| `tasks[].node_name` | 任务所属节点名称 |
|
||||||
|
| `tasks[].user_id` | 审批人用户 ID |
|
||||||
|
| `tasks[].status` | 任务状态:`PENDING`、`APPROVED`、`REJECTED`、`TRANSFERRED`、`DONE` |
|
||||||
|
| `tasks[].start_time` | 任务开始时间 |
|
||||||
|
| `tasks[].end_time` | 任务完成时间 |
|
||||||
|
|
||||||
|
## operation_records 重点字段
|
||||||
|
|
||||||
|
`operation_records` 常用于审计审批过程:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `operation_records[].type` | 事件类型,如 `PASS`、`REJECT`、`TRANSFER`、`ROLLBACK`、`CANCEL`、`CC` |
|
||||||
|
| `operation_records[].create_time` | 事件发生时间 |
|
||||||
|
| `operation_records[].user_id` | 触发该事件的用户 ID |
|
||||||
|
| `operation_records[].task_id` | 关联任务 ID |
|
||||||
|
| `operation_records[].node_id` | 关联节点 ID |
|
||||||
|
| `operation_records[].comment` | 理由 / 备注 |
|
||||||
|
| `operation_records[].cc_user_ids` | 被抄送人列表(抄送事件时) |
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **这是最适合做“详情确认”的只读命令**:当你已经拿到 `instance_code`,需要确认表单、当前节点、任务状态、审批动态时,优先使用它。
|
||||||
|
- **在执行写操作前先看详情**:例如做 `tasks rollback` 前确认可退回节点,做 `instances cancel` 前确认实例状态,做 `tasks remind` 前确认当前任务是否仍待处理。
|
||||||
|
- **`form` 是 JSON 字符串**:调用方通常还需要再解析一层,才能拿到表单字段值。
|
||||||
|
- **`current_nodes` 和 `tasks` 可以联动看**:前者看“当前卡在哪个节点”,后者看“每个任务目前由谁处理、状态如何”。
|
||||||
|
- **`operation_records` 适合做时间线回溯**:例如排查谁转交过、谁加签过、什么时候撤回或抄送过。
|
||||||
|
- **优先显式传 `locale` 和 `user_id_type`**:这样 agent 更容易理解返回文本和 ID 语义,减少歧义。
|
||||||
|
|
||||||
|
## 输出与后续操作
|
||||||
|
|
||||||
|
读取详情后,常见下一步:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 同意审批任务
|
||||||
|
lark-cli approval tasks approve --data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>"}' --as user --yes
|
||||||
|
|
||||||
|
# 撤回审批实例
|
||||||
|
lark-cli approval instances cancel --data '{"instance_code":"<INSTANCE_CODE>"}' --as user --yes
|
||||||
|
|
||||||
|
# 催办审批任务
|
||||||
|
lark-cli approval tasks remind --data '{"instance_code":"<INSTANCE_CODE>","task_ids":["<TASK_ID>"]}' --as user --yes
|
||||||
|
```
|
||||||
@ -0,0 +1,128 @@
|
|||||||
|
|
||||||
|
# approval instances initiated
|
||||||
|
|
||||||
|
查询当前用户已发起的审批实例列表(用户级只读操作)。适合在需要查看“我发起了哪些审批”、筛选某类审批定义、获取 `instance_code` 供后续 `instances get` / `instances cancel` / `instances cc` 等命令使用时调用。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:instance:read"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查询我发起的审批列表
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --as user
|
||||||
|
|
||||||
|
# 只看某个审批定义下我发起的实例
|
||||||
|
lark-cli approval instances initiated --params '{"definition_code":"<DEFINITION_CODE>","page_size":20}' --as user
|
||||||
|
|
||||||
|
# 按发起时间范围筛选(秒级时间戳)
|
||||||
|
lark-cli approval instances initiated --params '{"start_timestamp":"<START_SECONDS>","end_timestamp":"<END_SECONDS>","page_size":20}' --as user
|
||||||
|
|
||||||
|
# 使用 page_token 翻页
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20,"page_token":"example_page_token"}' --as user
|
||||||
|
|
||||||
|
# 表格格式输出,便于快速浏览
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --format table --as user
|
||||||
|
|
||||||
|
# 预览 API 调用,不执行
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --as user --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--params '{...}'` | 否 | 查询参数,使用 JSON 传入;不传时使用默认分页与筛选 |
|
||||||
|
| `definition_code` | 否 | 审批定义 Code,用于只查看某个审批定义下我发起的实例 |
|
||||||
|
| `start_timestamp` | 否 | 按发起时间筛选,时间范围开始值,秒级时间戳 |
|
||||||
|
| `end_timestamp` | 否 | 按发起时间筛选,时间范围结束值,秒级时间戳 |
|
||||||
|
| `locale` | 否 | 返回语言:`zh-CN`、`en-US`、`ja-JP` |
|
||||||
|
| `page_size` | 否 | 分页大小 |
|
||||||
|
| `page_token` | 否 | 翻页标记;首次请求不填,后续使用上一次返回的 `page_token` |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;已发起审批列表查询通常应使用用户身份 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 输出重点字段
|
||||||
|
|
||||||
|
返回结果中常见字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `count` | 列表计数,只在第一页返回;大于等于 100 个实例时返回 `99` |
|
||||||
|
| `has_more` | 是否还有更多数据 |
|
||||||
|
| `page_token` | 下一页翻页 Token |
|
||||||
|
| `instances[].instance_code` | 审批实例 Code;后续查询详情或执行撤回 / 抄送时通常需要 |
|
||||||
|
| `instances[].definition_code` | 审批定义 Code |
|
||||||
|
| `instances[].definition_name` | 审批定义名称 |
|
||||||
|
| `instances[].definition_group_id` | 审批定义分组 ID |
|
||||||
|
| `instances[].definition_group_name` | 审批定义分组名称 |
|
||||||
|
| `instances[].initiator` | 发起人 ID |
|
||||||
|
| `instances[].initiator_name` | 发起人姓名 |
|
||||||
|
| `instances[].instance_status` | 审批实例状态,见下方“instance_status 枚举” |
|
||||||
|
| `instances[].instance_external_id` | 第三方审批实例 ID(仅第三方审批实例存在) |
|
||||||
|
| `instances[].link` | 三方审批跳转链接 |
|
||||||
|
| `instances[].summaries` | 摘要字段列表 |
|
||||||
|
|
||||||
|
## instance_status 枚举
|
||||||
|
|
||||||
|
| 值 | 含义 |
|
||||||
|
|----|------|
|
||||||
|
| `0` | 无流程状态,不展示对应标签 |
|
||||||
|
| `1` | 流程实例流转中 |
|
||||||
|
| `2` | 已通过 |
|
||||||
|
| `3` | 已拒绝 |
|
||||||
|
| `4` | 已撤销 |
|
||||||
|
| `5` | 已终止 |
|
||||||
|
|
||||||
|
## 常见使用场景
|
||||||
|
|
||||||
|
### 1) 找到我要操作的审批实例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances initiated --params '{"page_size":20}' --format table --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
拿到 `instances[].instance_code` 后,可继续:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查看审批实例详情
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
|
||||||
|
# 撤回审批实例
|
||||||
|
lark-cli approval instances cancel --data '{"instance_code":"<INSTANCE_CODE>"}' --as user --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2) 只看某类审批
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances initiated \
|
||||||
|
--params '{"definition_code":"<DEFINITION_CODE>","page_size":20}' \
|
||||||
|
--as user
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **这是定位“我发起的审批实例”的首选命令**:如果你的目标是撤回、抄送、查看某个已发起审批,优先从这里拿 `instance_code`。
|
||||||
|
- **优先用 `definition_code` 缩小范围**:当你已知审批定义时,先筛掉无关实例,可显著提升可读性。
|
||||||
|
- **按时间排查时使用 `start_timestamp` / `end_timestamp`**:这两个值都是秒级时间戳,用于按发起时间缩小结果范围。
|
||||||
|
- **结果很多时优先 `--format table`**:适合人工快速浏览。
|
||||||
|
- **`count` 只在第一页返回**:做分页处理时不要假设后续页还会带总数。
|
||||||
|
- **`instance_status` 可直接判断下一步**:例如状态为 `1` 时通常可继续查看详情或考虑撤回,状态为 `4` 表示已经撤销,无需重复撤回。
|
||||||
|
- **摘要字段 `summaries` 很适合做列表预览**:当审批标题不够明确时,可结合摘要值帮助识别目标实例。
|
||||||
|
|
||||||
|
## 输出与后续操作
|
||||||
|
|
||||||
|
拿到列表后,常见下一步:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查看单个审批实例详情
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
|
||||||
|
# 撤回审批实例
|
||||||
|
lark-cli approval instances cancel --data '{"instance_code":"<INSTANCE_CODE>"}' --as user --yes
|
||||||
|
|
||||||
|
# 给审批实例追加抄送人
|
||||||
|
lark-cli approval instances cc --data '{"instance_code":"<INSTANCE_CODE>","cc_user_ids":["<USER_ID>"]}' --params '{"user_id_type":"open_id"}' --as user --yes
|
||||||
|
```
|
||||||
@ -0,0 +1,120 @@
|
|||||||
|
|
||||||
|
# approval tasks add_sign
|
||||||
|
|
||||||
|
给一个审批任务加签(用户级写操作)。通常先通过 `tasks query` 拿到 `task_id` 和 `instance_code`,确认目标任务后,再提供被加签人的用户 ID、加签方式等参数执行加签。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要对该审批任务加签且目标任务、加签对象、加签方式都无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks add_sign \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","add_sign_type":1,"add_sign_user_ids":["ou_xxx"],"approval_method":1,"comment":"前加签给财务复核"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 前加签(需要 approval_method)
|
||||||
|
lark-cli approval tasks add_sign \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","add_sign_type":1,"add_sign_user_ids":["ou_xxx"],"approval_method":1,"comment":"请先补充审核"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 后加签(需要 approval_method)
|
||||||
|
lark-cli approval tasks add_sign \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","add_sign_type":2,"add_sign_user_ids":["ou_xxx","ou_yyy"],"approval_method":2,"comment":"当前审批完成后请两位继续审核"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 并加签(常见场景可不传 approval_method)
|
||||||
|
lark-cli approval tasks add_sign \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","add_sign_type":3,"add_sign_user_ids":["123456789"],"comment":"并加签给项目 owner"}' \
|
||||||
|
--params '{"user_id_type":"user_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment 或较多加签人
|
||||||
|
lark-cli approval tasks add_sign \
|
||||||
|
--data @./add-sign-body.json \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances initiated` / `instances get` 获取 |
|
||||||
|
| `task_id` | 是 | 审批任务 ID;通常先通过 `tasks query` 获取 |
|
||||||
|
| `add_sign_type` | 是 | 加签类型:`1` 前加签、`2` 后加签、`3` 并加签 |
|
||||||
|
| `add_sign_user_ids` | 是 | 被加签人 ID 数组;需要和 `user_id_type` 保持一致 |
|
||||||
|
| `approval_method` | 否 | 审批方式:`1` 或签、`2` 会签、`3` 依次审批;**仅在前加签、后加签时需要填写** |
|
||||||
|
| `comment` | 否 | 审批意见或加签说明,例如 `前加签给财务复核`、`请项目 owner 一并确认` |
|
||||||
|
| `--params '{"user_id_type":"..."}'` | 否 | 查询参数 JSON;用于声明 `add_sign_user_ids` 内用户 ID 的类型 |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id`;未显式指定时要特别确认被加签人的 ID 类型 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批加签通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 枚举说明
|
||||||
|
|
||||||
|
### add_sign_type
|
||||||
|
|
||||||
|
| 值 | 含义 |
|
||||||
|
|----|------|
|
||||||
|
| `1` | 前加签 |
|
||||||
|
| `2` | 后加签 |
|
||||||
|
| `3` | 并加签 |
|
||||||
|
|
||||||
|
### approval_method
|
||||||
|
|
||||||
|
| 值 | 含义 | 适用场景 |
|
||||||
|
|----|------|----------|
|
||||||
|
| `1` | 或签 | 前加签 / 后加签 |
|
||||||
|
| `2` | 会签 | 前加签 / 后加签 |
|
||||||
|
| `3` | 依次审批 | 前加签 / 后加签 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;执行 approve / reject / transfer / rollback / add_sign 等操作时通常都需要 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;与 `instance_code` 配对使用 |
|
||||||
|
| `tasks[].support_api_operate` | 是否支持通过 API 处理该任务;加签前建议先检查 |
|
||||||
|
|
||||||
|
如果你手里只有姓名或邮箱,建议先通过联系人能力解析出正确的用户 ID,再执行加签。
|
||||||
|
|
||||||
|
如需先确认表单、节点、审批流进度,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_id` 要成对使用**:仅有实例 ID 或仅有任务 ID 都不足以准确执行加签操作。
|
||||||
|
- **`add_sign_user_ids` 与 `user_id_type` 必须匹配**:例如传 open_id 就把 `user_id_type` 设为 `open_id`;不要混用。
|
||||||
|
- **优先显式传 `user_id_type`**:这样 agent 更容易判断参数含义,也能减少 ID 类型不匹配带来的失败。
|
||||||
|
- **`add_sign_type` 要和业务意图一致**:前加签是在当前审批前插入审批人,后加签是在当前审批后追加审批人,并加签则是增加并行审批人。
|
||||||
|
- **前加签 / 后加签要补 `approval_method`**:不要遗漏,否则请求可能无法准确表达审批方式。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿任务参数**:尤其是 `topic=1` 的待办审批,最适合作为 add_sign 的输入来源。
|
||||||
|
- **先检查是否支持 API 操作**:如果 `tasks[].support_api_operate` 为 `false`,说明该任务可能不支持通过 API 执行处理动作,加签前应谨慎验证。
|
||||||
|
- **`comment` 建议写明加签原因**:例如 `增加财务复核`、`增加项目 owner 并行确认`,方便相关人员理解上下文。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在多人加签、跨部门加签或加签对象来源不明确时,先预览更安全。
|
||||||
@ -0,0 +1,81 @@
|
|||||||
|
|
||||||
|
# approval tasks approve
|
||||||
|
|
||||||
|
同意一个审批任务(用户级写操作)。通常先通过 `tasks query` 拿到 `task_id` 和 `instance_code`,必要时再用 `instances get` 查看详情,然后再执行同意。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确同意审批且目标任务无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks approve \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","comment":"同意"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 同意审批任务,并附带审批意见
|
||||||
|
lark-cli approval tasks approve \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","comment":"同意"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 需要回填表单时,传入 form(按当前命令定义,form 为字符串化 JSON)
|
||||||
|
lark-cli approval tasks approve \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","comment":"同意并补充信息","form":"[{\"id\":\"user_name\",\"type\":\"input\",\"value\":\"Alice\"}]"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment / form
|
||||||
|
lark-cli approval tasks approve \
|
||||||
|
--data @./approve-body.json \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances initiated` / `instances get` 获取 |
|
||||||
|
| `task_id` | 是 | 审批任务 ID;通常先通过 `tasks query` 获取 |
|
||||||
|
| `comment` | 否 | 审批意见,例如 `同意`、`已确认` |
|
||||||
|
| `form` | 否 | 表单数据;按当前命令定义,字段类型为 `string`,通常传字符串化 JSON;仅在审批动作需要同时回填表单时使用 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批同意通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的两个字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;执行 approve / reject / rollback 等操作时通常都需要 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;与 `instance_code` 配对使用 |
|
||||||
|
|
||||||
|
如需先确认表单、节点、审批流进度,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_id` 要成对使用**:仅有实例 ID 或仅有任务 ID 都不足以准确执行同意操作。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿参数**:尤其是 `topic=1` 的待办审批,最适合作为 approve 的输入来源。
|
||||||
|
- **先检查是否支持 API 操作**:如果上一步 `tasks query` 返回的 `tasks[].support_api_operate` 为 `false`,说明该任务可能不支持通过 API 同意/拒绝。
|
||||||
|
- **`comment` 建议简洁明确**:例如 `同意`、`同意,信息已核对`。没有审批意见要求时可省略。
|
||||||
|
- **`form` 只在确有需要时传**:大多数简单同意场景只传 `instance_code`、`task_id`、可选 `comment` 即可。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在批量处理、表单回填或任务来源不明确时,先预览更安全。
|
||||||
@ -0,0 +1,85 @@
|
|||||||
|
|
||||||
|
# approval tasks query
|
||||||
|
|
||||||
|
查询当前用户的审批任务列表,可用于查看待办、已办、知会等分组。只读操作,不会修改审批状态。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:read"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 查询待办审批
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
|
||||||
|
# 查询已办审批
|
||||||
|
lark-cli approval tasks query --params '{"topic":"2"}' --as user
|
||||||
|
|
||||||
|
# 按任务时间范围筛选(秒级时间戳)
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1","start_timestamp":"<START_SECONDS>","end_timestamp":"<END_SECONDS>"}' --as user
|
||||||
|
|
||||||
|
# 使用 page_token 翻页
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1","page_token":"example_page_token"}' --as user
|
||||||
|
|
||||||
|
# 表格格式输出,便于快速浏览
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --format table --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--params '{"topic":"..."}'` | 是 | 查询参数,使用 JSON 传入 |
|
||||||
|
| `topic` | 是 | 任务分组主题,见下方“topic 枚举” |
|
||||||
|
| `definition_code` | 否 | 审批定义 Code,用于仅查询某个审批定义下的任务 |
|
||||||
|
| `start_timestamp` | 否 | 按任务时间筛选,时间范围开始值,秒级时间戳 |
|
||||||
|
| `end_timestamp` | 否 | 按任务时间筛选,时间范围结束值,秒级时间戳 |
|
||||||
|
| `locale` | 否 | 返回语言:`zh-CN`、`en-US`、`ja-JP` |
|
||||||
|
| `page_size` | 否 | 分页大小 |
|
||||||
|
| `page_token` | 否 | 翻页标记;首次请求不填,后续使用上一次返回的 `page_token` |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批任务查询通常应使用用户身份 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## topic 枚举
|
||||||
|
|
||||||
|
| 值 | 含义 |
|
||||||
|
|----|------|
|
||||||
|
| `1` | 待办审批 |
|
||||||
|
| `2` | 已办审批 |
|
||||||
|
| `17` | 未读知会 |
|
||||||
|
| `18` | 已读知会 |
|
||||||
|
|
||||||
|
## 输出重点字段
|
||||||
|
|
||||||
|
返回结果中常见字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `count` | 列表计数,只在第一页返回;当任务数大于等于 100 时返回 `99` |
|
||||||
|
| `has_more` | 是否还有更多数据 |
|
||||||
|
| `page_token` | 下一页翻页 Token |
|
||||||
|
| `tasks[].task_id` | 任务 ID,全局唯一 |
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;后续执行 approve / reject / rollback 等操作时通常需要与 `task_id` 成对使用 |
|
||||||
|
| `tasks[].title` | 任务标题 |
|
||||||
|
| `tasks[].status` | 任务状态:`1` 待办、`2` 已办、`17` 未读、`18` 已读、`33` 处理中、`34` 撤回 |
|
||||||
|
| `tasks[].topic` | 任务所属分组主题 |
|
||||||
|
| `tasks[].instance_status` | 审批实例状态:`0` 无状态、`1` 流转中、`2` 已通过、`3` 已拒绝、`4` 已撤销、`5` 已终止 |
|
||||||
|
| `tasks[].definition_code` | 审批定义 Code |
|
||||||
|
| `tasks[].definition_name` | 审批定义名称 |
|
||||||
|
| `tasks[].initiator` | 发起人 ID |
|
||||||
|
| `tasks[].initiator_name` | 发起人姓名 |
|
||||||
|
| `tasks[].summaries` | 表单摘要字段列表 |
|
||||||
|
| `tasks[].support_api_operate` | 是否支持通过 API 同意或拒绝该任务 |
|
||||||
|
| `tasks[].user_id` | 任务所属用户 ID |
|
||||||
|
| `tasks[].instance_external_id` | 三方审批实例 ID,仅第三方审批实例存在 |
|
||||||
|
| `tasks[].task_external_id` | 三方审批任务 ID,仅第三方审批任务存在 |
|
||||||
|
| `tasks[].link` | 三方审批跳转链接 |
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- 常见处理链:先用 `tasks query` 拿到 `task_id` 和 `instance_code`,若用户需要查看详情、当前节点、表单内容、流程进度等内容,则调用 `instances get` 查看详情,最后执行 `tasks approve` / `tasks reject` / `tasks transfer` / `tasks add_sign` / `tasks rollback`。
|
||||||
|
- 如果你只想看“已发起的审批实例”,使用 `instances initiated`;`tasks query` 更适合围绕“任务分组”来拉取列表。
|
||||||
|
- 按时间排查任务时使用 `start_timestamp` / `end_timestamp` 缩小范围;这两个值都是秒级时间戳。
|
||||||
|
- 需要继续翻页时,直接把上一次返回的 `page_token` 放回 `--params`。
|
||||||
|
- 当结果量较大时,优先使用 `--format table` 提升可读性。
|
||||||
@ -0,0 +1,73 @@
|
|||||||
|
|
||||||
|
# approval tasks reject
|
||||||
|
|
||||||
|
拒绝一个审批任务(用户级写操作)。通常先通过 `tasks query` 拿到 `task_id` 和 `instance_code`,必要时再用 `instances get` 查看详情,然后再执行拒绝。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要拒绝该审批且目标任务无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks reject \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","comment":"拒绝"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 拒绝审批任务,并附带审批意见
|
||||||
|
lark-cli approval tasks reject \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","comment":"拒绝,信息不完整"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment
|
||||||
|
lark-cli approval tasks reject \
|
||||||
|
--data @./reject-body.json \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances initiated` / `instances get` 获取 |
|
||||||
|
| `task_id` | 是 | 审批任务 ID;通常先通过 `tasks query` 获取 |
|
||||||
|
| `comment` | 否 | 审批意见,例如 `拒绝`、`拒绝,信息不完整` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批拒绝通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的两个字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;执行 approve / reject / rollback 等操作时通常都需要 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;与 `instance_code` 配对使用 |
|
||||||
|
|
||||||
|
如需先确认表单、节点、审批流进度,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_id` 要成对使用**:仅有实例 ID 或仅有任务 ID 都不足以准确执行拒绝操作。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿参数**:尤其是 `topic=1` 的待办审批,最适合作为 reject 的输入来源。
|
||||||
|
- **先检查是否支持 API 操作**:如果上一步 `tasks query` 返回的 `tasks[].support_api_operate` 为 `false`,说明该任务可能不支持通过 API 同意/拒绝。
|
||||||
|
- **`comment` 建议写清拒绝原因**:例如 `拒绝,缺少合同附件`、`拒绝,预算字段填写不完整`。这有助于发起人理解原因并补充材料。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在批量处理或任务来源不明确时,先预览更安全。
|
||||||
@ -0,0 +1,82 @@
|
|||||||
|
|
||||||
|
# approval tasks remind
|
||||||
|
|
||||||
|
对审批实例中的指定任务发起催办(用户级写操作)。通常先通过 `tasks query` 找到待办任务,拿到 `instance_code` 和要催办的 `task_ids`,必要时再用 `instances get` 查看详情,然后执行催办。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要催办该审批且目标实例、目标任务都无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:instance:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks remind \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_ids":["<TASK_ID>"],"comment":"请尽快处理"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 催办单个审批任务
|
||||||
|
lark-cli approval tasks remind \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_ids":["<TASK_ID>"],"comment":"请尽快审批该单据"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 同一实例下催办多个任务
|
||||||
|
lark-cli approval tasks remind \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_ids":["<TASK_ID_1>","<TASK_ID_2>"],"comment":"请相关审批人尽快处理"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment 或多个 task_ids
|
||||||
|
lark-cli approval tasks remind \
|
||||||
|
--data @./remind-body.json \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances get` 获取 |
|
||||||
|
| `task_ids` | 是 | 被催办的任务 ID 数组;应与 `instance_code` 属于同一审批实例 |
|
||||||
|
| `comment` | 否 | 催办说明,例如 `请尽快处理`、`该单据较急,请优先审批` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批催办通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;催办时必须提供 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;放入 `task_ids` 数组中 |
|
||||||
|
| `tasks[].title` | 任务标题,可用于确认催办对象是否正确 |
|
||||||
|
| `tasks[].status` | 任务状态;一般优先催办仍处于待处理状态的任务 |
|
||||||
|
|
||||||
|
如需进一步确认当前审批流、节点和人员信息,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_ids` 要对应同一个审批实例**:不要把不同实例下的任务 ID 混在同一次催办请求中。
|
||||||
|
- **`task_ids` 是数组**:即使只催办一个任务,也要按数组形式传入。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿参数**:尤其是 `topic=1` 的待办审批,最适合作为 remind 的输入来源。
|
||||||
|
- **催办前先确认任务仍需处理**:已经审批完成、已撤回或已终止的任务一般不适合继续催办。
|
||||||
|
- **`comment` 建议简洁且明确**:例如 `该单据较急,请优先审批`、`请今天内处理`。避免过长或模糊描述。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在一次催办多个任务、任务来源不明确或需让用户复核催办对象时,先预览更安全。
|
||||||
@ -0,0 +1,89 @@
|
|||||||
|
|
||||||
|
# approval tasks rollback
|
||||||
|
|
||||||
|
将一个审批任务退回到指定节点(用户级写操作)。通常先通过 `tasks query` 拿到 `task_id` 和 `instance_code`,再结合实例详情确认可退回的目标节点 `node_ids`,最后执行退回。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要退回该审批且目标任务、退回节点都无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks rollback \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","node_ids":["<NODE_ID>"],"comment":"退回补充材料"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 退回到单个节点
|
||||||
|
lark-cli approval tasks rollback \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","node_ids":["<NODE_ID>"],"comment":"请补充附件后重新提交"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 退回到发起节点(发起节点 ID 为 START)
|
||||||
|
lark-cli approval tasks rollback \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","node_ids":["START"],"comment":"退回发起人补充材料"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 传多个候选节点 ID(以实际审批定义支持情况为准)
|
||||||
|
lark-cli approval tasks rollback \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","node_ids":["<NODE_ID_1>","<NODE_ID_2>"],"comment":"退回上一处理节点"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment 或较多 node_ids
|
||||||
|
lark-cli approval tasks rollback \
|
||||||
|
--data @./rollback-body.json \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances initiated` / `instances get` 获取 |
|
||||||
|
| `task_id` | 是 | 审批任务 ID;通常先通过 `tasks query` 获取 |
|
||||||
|
| `node_ids` | 是 | 退回目标节点 ID 数组;发起节点 ID 为 `START`;执行前应先确认这些节点确实可作为退回目标 |
|
||||||
|
| `comment` | 否 | 审批意见或退回说明,例如 `请补充附件后重新提交`、`预算说明不完整,请补充` |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批退回通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;执行 approve / reject / transfer / rollback 等操作时通常都需要 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;与 `instance_code` 配对使用 |
|
||||||
|
| `tasks[].support_api_operate` | 是否支持通过 API 处理该任务;退回前建议先检查 |
|
||||||
|
|
||||||
|
如需确认流程节点、当前进度和可退回位置,可先查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_id` 要成对使用**:仅有实例 ID 或仅有任务 ID 都不足以准确执行退回操作。
|
||||||
|
- **`node_ids` 是必填项**:退回并不是“自动退回上一步”,而是要明确给出目标节点 ID 数组;退回发起节点时传 `START`。
|
||||||
|
- **先确认节点是否可退回**:不同审批定义支持的退回目标可能不同;在不确定时,先通过 `instances get` 或业务侧流程信息核实。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿任务参数**:尤其是 `topic=1` 的待办审批,最适合作为 rollback 的输入来源。
|
||||||
|
- **先检查是否支持 API 操作**:如果 `tasks[].support_api_operate` 为 `false`,说明该任务可能不支持通过 API 执行处理动作,退回前应谨慎验证。
|
||||||
|
- **`comment` 建议写清退回原因**:例如 `附件缺失,请补齐后重新提交`、`费用说明不完整,请补充明细`,方便发起人或上一步处理人理解原因。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在节点来源不明确、审批链路复杂或批量处理时,先预览更安全。
|
||||||
@ -0,0 +1,91 @@
|
|||||||
|
|
||||||
|
# approval tasks transfer
|
||||||
|
|
||||||
|
转交一个审批任务给其他用户处理(用户级写操作)。通常先通过 `tasks query` 拿到 `task_id` 和 `instance_code`,确认目标任务后,再提供被转交人的用户 ID 执行转交。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是 **high-risk-write** 写操作。建议先用 `--dry-run` 预览;真正执行时,如果用户已明确要转交该审批且目标任务、转交对象都无误,再带 `--yes` 运行。不要在未获用户明确同意时静默追加 `--yes`。
|
||||||
|
|
||||||
|
需要的 scopes: ["approval:task:write"]
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先预览请求,不实际执行
|
||||||
|
lark-cli approval tasks transfer \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","transfer_user_id":"ou_xxx","comment":"请你继续处理"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--dry-run
|
||||||
|
|
||||||
|
# 按 open_id 转交审批任务
|
||||||
|
lark-cli approval tasks transfer \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","transfer_user_id":"ou_xxx","comment":"转交给你处理"}' \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 按 user_id 转交审批任务
|
||||||
|
lark-cli approval tasks transfer \
|
||||||
|
--data '{"instance_code":"<INSTANCE_CODE>","task_id":"<TASK_ID>","transfer_user_id":"123456789","comment":"请补充审核"}' \
|
||||||
|
--params '{"user_id_type":"user_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 通过文件传入请求体,适合较长 comment
|
||||||
|
lark-cli approval tasks transfer \
|
||||||
|
--data @./transfer-body.json \
|
||||||
|
--params '{"user_id_type":"open_id"}' \
|
||||||
|
--as user \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--data '{...}'` | 是 | 请求体 JSON,使用 JSON 传入 |
|
||||||
|
| `instance_code` | 是 | 审批实例 Code;通常先通过 `tasks query` 或 `instances initiated` / `instances get` 获取 |
|
||||||
|
| `task_id` | 是 | 审批任务 ID;通常先通过 `tasks query` 获取 |
|
||||||
|
| `transfer_user_id` | 是 | 被转交人的用户 ID;需要和 `user_id_type` 保持一致 |
|
||||||
|
| `comment` | 否 | 审批意见或转交说明,例如 `转交给你处理`、`请继续审核该单据` |
|
||||||
|
| `--params '{"user_id_type":"..."}'` | 否 | 查询参数 JSON;用于声明 `transfer_user_id` 的 ID 类型 |
|
||||||
|
| `user_id_type` | 否 | 用户 ID 类型:`user_id`、`union_id`、`open_id`;未显式指定时要特别确认 `transfer_user_id` 的真实类型 |
|
||||||
|
| `--as user` | 否 | 建议显式指定用户身份;审批转交通常必须以用户身份执行 |
|
||||||
|
| `--yes` | 否 | 确认执行高风险写操作;未带时可能返回 `confirmation_required` / exit 10 |
|
||||||
|
| `--format` | 否 | 输出格式:`json`(默认)、`ndjson`、`table`、`csv` |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## 典型前置步骤
|
||||||
|
|
||||||
|
先查到待办任务:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval tasks query --params '{"topic":"1"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
常用到的字段:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `tasks[].instance_code` | 审批实例 Code;执行 approve / reject / transfer / rollback 等操作时通常都需要 |
|
||||||
|
| `tasks[].task_id` | 审批任务 ID;与 `instance_code` 配对使用 |
|
||||||
|
| `tasks[].support_api_operate` | 是否支持通过 API 处理该任务;转交前建议先检查 |
|
||||||
|
|
||||||
|
如果你手里只有姓名或邮箱,建议先通过联系人能力解析出正确的用户 ID,再执行转交。
|
||||||
|
|
||||||
|
如需先确认表单、节点、审批流进度,可继续查看实例详情:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli approval instances get --params '{"instance_code":"<INSTANCE_CODE>"}' --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用建议
|
||||||
|
|
||||||
|
- **`instance_code` 和 `task_id` 要成对使用**:仅有实例 ID 或仅有任务 ID 都不足以准确执行转交操作。
|
||||||
|
- **`transfer_user_id` 与 `user_id_type` 必须匹配**:例如传 open_id 就把 `user_id_type` 设为 `open_id`;不要混用。
|
||||||
|
- **优先显式传 `user_id_type`**:这样 agent 更容易判断参数含义,也能减少 ID 类型不匹配带来的失败。
|
||||||
|
- **优先从 `tasks query` 的待办列表拿任务参数**:尤其是 `topic=1` 的待办审批,最适合作为 transfer 的输入来源。
|
||||||
|
- **先检查是否支持 API 操作**:如果 `tasks[].support_api_operate` 为 `false`,说明该任务可能不支持通过 API 执行同意/拒绝等处理动作,转交前也应谨慎验证。
|
||||||
|
- **`comment` 建议写明转交原因**:例如 `你更熟悉该项目,请继续处理`、`转交给预算 owner 审核`,方便接收人理解上下文。
|
||||||
|
- **先 `--dry-run` 再执行**:尤其在跨部门转交、批量处理或转交对象来源不明确时,先预览更安全。
|
||||||
121
.agents/skills/lark-apps/SKILL.md
Normal file
121
.agents/skills/lark-apps/SKILL.md
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
---
|
||||||
|
name: lark-apps
|
||||||
|
version: 1.0.0
|
||||||
|
description: "妙搭(Spark/Miaoda)应用开发与托管:应用创建、本地全栈开发、云端生成迭代、创意设计(UI mockup / 可交互原型 / 线框图 / 落地页 / 仪表盘 / 幻灯片 deck / 视觉探索)、AI相关能力和飞书平台能力或者其他外部能力集成、日志/Trace/监控指标/PV/UV 查询、环境变量管理、应用角色与成员管理、自动化触发器(定时/记录变更/Webhook/飞书审批)。当用户要开发/新建一个系统·工具·平台·应用,或要本地开发 / 云端开发 / 修改 / 部署 / 发布 / 上线 / 拿可分享链接,或用 HTML 做页面·网站·部署到妙搭,或要设计 / design / mockup / prototype / wireframe / 做 PPT / deck / 视觉探索,或提到妙搭/Spark/Miaoda(应用运行时域名形如 *.aiforce.cloud)、应用数据库、应用文件存储、开放 API Key、可见范围、应用角色/角色成员、线上日志、接口请求量、错误量、延迟、访问量、环境变量、给妙搭应用配自动化任务/定时触发/审批通过后自动触发时使用。不负责普通云盘文件上传(lark-drive)、飞书文档编辑(lark-doc)、原生幻灯片创建(lark-slides)。"
|
||||||
|
metadata:
|
||||||
|
requires:
|
||||||
|
bins: ["lark-cli"]
|
||||||
|
cliHelp: "lark-cli apps --help; lark-cli apps +<cmd> --help"
|
||||||
|
---
|
||||||
|
|
||||||
|
# apps (v1)
|
||||||
|
|
||||||
|
妙搭应用属于用户资产。默认用 `--as user`;认证、scope、exit-10、高风险确认、`_notice` 等通用处理只读 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),不要在本 skill 里复制。妙搭应用有两条开发路径:**本地开发**(拉源码本地写)/ **云端会话**(妙搭 AI 生成)。
|
||||||
|
|
||||||
|
## 身份与授权
|
||||||
|
|
||||||
|
妙搭应用是用户的个人资产,统一 `--as user`(见开头)。已有用户身份可用时直接执行业务命令,**不要为了预防权限问题主动重新登录**,否则可能中断原任务并触发不必要的设备授权。仅当 CLI 明确返回未登录或缺少本域 scope 时,一次性执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli auth login --domain apps
|
||||||
|
```
|
||||||
|
|
||||||
|
因缺权限失败(`error.subtype == "missing_scope"`)时的通用处理见 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),同样按 `--domain apps` 授权;授权成功后只恢复原业务操作,不扩展任务范围。
|
||||||
|
|
||||||
|
## 意图路由
|
||||||
|
|
||||||
|
按具体操作查命令(开发路径先用下方「选择开发路径」判定表定好再进来取命令):
|
||||||
|
|
||||||
|
| 用户意图 | 先用 | 按需读取 |
|
||||||
|
|---|---|---|
|
||||||
|
| 创建**新**应用资产、拿 app_id | `+create` | [`lark-apps-create.md`](references/lark-apps-create.md) |
|
||||||
|
| 找已有 app_id、按名字过滤应用 | `+list --keyword <name>` | [`lark-apps-list.md`](references/lark-apps-list.md) |
|
||||||
|
| 查单个应用详情(类型、名称、发布状态等) | `+get --app-id <app_id>` | [`lark-apps-get.md`](references/lark-apps-get.md) |
|
||||||
|
| 改应用名或描述 | `+update` | [`lark-apps-update.md`](references/lark-apps-update.md) |
|
||||||
|
| HTML 应用 / 创意模式 — 写 HTML 页面/网站、静态页、PPT/deck、落地页、仪表盘、UI mockup、原型、线框图、视觉探索 | 加载 [`creative-design/creative-design.md`](creative-design/creative-design.md)(含完整开发与发布流程) | [`creative-design/creative-design.md`](creative-design/creative-design.md) |
|
||||||
|
| 旧版存量 HTML 应用(无 Git 管理)继续上传已有静态产物 | `+html-publish`(仅兼容旧链路;新建 html / 创意模式 / creative-design 产物不得使用) | [`lark-apps-html-publish.md`](references/lark-apps-html-publish.md) |
|
||||||
|
| 开发已有应用 / 初始化本地仓库(开发方式已定为本地后;先解析 app_id,勿 `+create` 新建) | `+init`(或手动 `+git-credential-init` + 原生 git)。**执行前必读** [`lark-apps-local-dev.md`](references/lark-apps-local-dev.md),含端到端流程和领域规则 | [`lark-apps-init.md`](references/lark-apps-init.md), [`lark-apps-git-credential.md`](references/lark-apps-git-credential.md) |
|
||||||
|
| 本地开发时 `.env.local` 损坏/丢失,重新拉取启动期环境变量 | `+env-pull` | [`lark-apps-env-pull.md`](references/lark-apps-env-pull.md) |
|
||||||
|
| 管理应用环境变量(查看/设置/删除) | `+env-list`, `+env-set`, `+env-delete` | [`lark-apps-env.md`](references/lark-apps-env.md) |
|
||||||
|
| 查线上日志、Trace、请求数、错误率、延迟、CPU、memory、PV/UV/访问量 | `+log-list`, `+log-get`, `+trace-list`, `+trace-get`, `+metric-list`, `+analytics-list` | [`lark-apps-observability.md`](references/lark-apps-observability.md) |
|
||||||
|
| 看表 / 看结构 / 初始化多环境 / 导入导出数据 / 变更追溯 / 行级审计 / dev→online 发布 / 时间点恢复 / 查 DB 用量 | `+db-table-list`、`+db-table-get`、`+db-env-create`、`+db-data-export`/`+db-data-import`、`+db-changelog-list`、`+db-audit-status`/`+db-audit-enable`/`+db-audit-disable`/`+db-audit-list`、`+db-env-diff`/`+db-env-migrate`、`+db-recovery-diff`/`+db-recovery-apply`、`+db-quota-get` | [`lark-apps-db.md`](references/lark-apps-db.md) |
|
||||||
|
| 逐条执行 SQL(SELECT / DML / DDL);建表 / 改表 / 写 SQL 的平台规范 | `+db-execute` | [`lark-apps-db-execute.md`](references/lark-apps-db-execute.md)(含「平台 SQL 规范」:审计列 / RLS / `user_profile` / 禁用 SQL / PG 陷阱) |
|
||||||
|
| 管理应用文件存储:上传/下载本地文件、列出/查看/删除已存文件、生成临时分享链接、查存储用量 | `+file-upload`/`+file-download`/`+file-list`/`+file-get`/`+file-sign`/`+file-delete`/`+file-quota-get` | [`lark-apps-file.md`](references/lark-apps-file.md) |
|
||||||
|
| **部署/上线应用**("部署""上线""推上去并部署""发布到云端");查发布状态/历史 | 本地开发链路先按 [`lark-apps-local-dev.md`](references/lark-apps-local-dev.md) 确认本次改动已 git commit + git push,再用 `+release-create` / `+release-get`;查历史用 `+release-list` | [`lark-apps-local-dev.md`](references/lark-apps-local-dev.md), [`lark-apps-release-create.md`](references/lark-apps-release-create.md), [`lark-apps-release-get.md`](references/lark-apps-release-get.md), [`lark-apps-release-list.md`](references/lark-apps-release-list.md) |
|
||||||
|
| 设置或查看运行时可见范围 | `+access-scope-set`, `+access-scope-get` | 对应 access-scope reference |
|
||||||
|
| 创意模式(html)应用的评论相关操作 | 创意模式应用评论走 lark-drive 文档评论体系,读取 [`../lark-drive/SKILL.md`](../lark-drive/SKILL.md) 了解评论能力 | [`../lark-drive/SKILL.md`](../lark-drive/SKILL.md) |
|
||||||
|
| 管理 `app_...` 应用内角色、角色成员,或查询用户匹配角色 | `+role-list/get/create/update/delete`, `+role-member-list/add/remove`, `+role-match-list` | [`lark-apps-role.md`](references/lark-apps-role.md) |
|
||||||
|
| 云端 Agent 生成/迭代应用(开发方式已定为云端后) | `+session-create` -> `+chat` -> `+session-get` | [`lark-apps-cloud-dev.md`](references/lark-apps-cloud-dev.md) |
|
||||||
|
| 管理妙搭应用开放 API Key(创建/查看/启停/重置/删除凭证;密钥仅 create/reset 一次性返回) | `+openapi-key-list/get/create/update/enable/disable/delete/reset` | [`lark-apps-openapi-key.md`](references/lark-apps-openapi-key.md) |
|
||||||
|
| 管理妙搭应用自动化触发器(定时/记录变更/Webhook/飞书审批四类触发器的查询/创建/更新/启停;Webhook URL·Token 一次性回显、不落盘) | `+automation-list/get/create/update/enable/disable` | [`lark-apps-automation.md`](references/lark-apps-automation.md) |
|
||||||
|
| 查看某次会话某一轮(turn)的回复消息(含仍在生成中的本轮)/ 导出上一轮模型回复("这一轮回复了什么""上一轮的回复""导出某轮消息") | 先 `+session-get`(取 `latest_turn.turn_id`)-> `+session-messages-list --turn-id <id>`(仅 user 身份;分页用 `--page-token`) | [`lark-apps-session-messages-list.md`](references/lark-apps-session-messages-list.md) |
|
||||||
|
| 外部能力(AI模型能力和飞书平台能力)集成/插件/Plugin/Capability | `+plugin-install`, `+plugin-list`, `+plugin-uninstall` | [`lark-apps-plugin-install.md`](references/lark-apps-plugin-install.md), [`lark-apps-plugin-uninstall.md`](references/lark-apps-plugin-uninstall.md), [`lark-apps-plugin-list.md`](references/lark-apps-plugin-list.md) |
|
||||||
|
|
||||||
|
## 高频路径
|
||||||
|
|
||||||
|
- **性能/监控/观测指标**:用户问“接口请求量、错误量、错误率、接口慢、延迟、CPU、内存、最近一小时/七天趋势”时,不要去当前工作区搜索监控文件,也不要询问“监控数据在哪”。先按「app_id 获取」解析应用:`lark-cli apps +list --keyword "<应用名>" --as user`;拿到 `app_id` 后读 [`lark-apps-observability.md`](references/lark-apps-observability.md),用 `+metric-list`。
|
||||||
|
- **请求量 + 错误量 + 延迟**:请求量/错误量用 `lark-cli apps +metric-list --app-id <app_id> --metric requests --since <range> --as user`(不传 `--series` 会同时返回 total/error);延迟用 `--metric latency`(不传 `--series` 会返回 p50/p99)。如果用户给了具体接口,再加 `--api <path-or-name>`;不要臆造 group-by 参数。
|
||||||
|
- **PV/UV/访问量/活跃用户**:先解析 `app_id`,再用 `+analytics-list`,不要误用 `+metric-list`。
|
||||||
|
- **设置环境变量**:如果用户只给应用名,仍先 `+list --keyword` 解析 app_id;设置 online 环境且用户已经明确说“确认/直接执行”时,调用 `+env-set --environment online ... --yes`,不要再次要求确认。回复和日志摘要里只提 key / env / app,不回显真实 value;需要传复杂值时优先用 `@file` 或 stdin。
|
||||||
|
- **删除环境变量**:`+env-delete` 是破坏性操作。除非用户在同一轮已经明确确认删除这个 app/env/key,否则先向用户确认应用、环境、key 和删除后果;确认后再加 `--yes`。不要因为认证失败/重登完成就自动继续删除,必须保留确认门槛。
|
||||||
|
|
||||||
|
## 选择开发路径(进意图路由前先判这步)
|
||||||
|
|
||||||
|
新建必先定 **app_type** 和**开发方式**两件正交的事;修改已有先按「app_id 获取」指认到 app,指认不到就问用户,不擅自 `+create`。开发方式(本地 vs 云端)只看用户对"谁来写代码"的偏好,与应用复杂度、要不要数据库无关。
|
||||||
|
|
||||||
|
| 信号 | 判定 |
|
||||||
|
|---|---|
|
||||||
|
| 静态展示 / 单页 / PPT/deck / demo / 落地页 / 仪表盘 / UI mockup / 可交互原型 / 线框图 / 视觉探索 / 无后端状态 | `app_type=html`,加载 [`creative-design/creative-design.md`](creative-design/creative-design.md)(含完整开发与发布流程) |
|
||||||
|
| 登录 / 数据库 / 持久化 / 多人协作 / 增删改查 / 报名 / 投票 / 站会 / OKR / 泛称"系统·工具" | `app_type=full_stack` |
|
||||||
|
| 用户要自己写 / 本地 IDE·code agent / 拉源码到本地 / 交研发 | 本地开发,读 [`lark-apps-local-dev.md`](references/lark-apps-local-dev.md) |
|
||||||
|
| 让妙搭 AI 云端生成 / 对话式 / 自己不碰代码 | 云端会话,读 [`lark-apps-cloud-dev.md`](references/lark-apps-cloud-dev.md) |
|
||||||
|
| 未表达"谁来写"偏好 | **必须先问**(本地代码开发 vs 云端 AI 生成);选定前不擅自选边、不暗示默认,不得以"需求不模糊"为由跳过提问直接 `+init` / `git clone` / `+session-create` / 首轮 `+chat` |
|
||||||
|
| 修改已有 + 当前目录是 `.spark/meta.json` 项目 | 直接继续本地按意图路由,不必问也不必判云端 |
|
||||||
|
| 修改已有 + 有云端偏好 | 云端会话;未表达偏好且非本地项目 → 默认本地;判不准先问 |
|
||||||
|
|
||||||
|
## 发布态护栏
|
||||||
|
|
||||||
|
- **发布意图判定**:用户要"可访问 / 线上 / 分享 / 新链接 / 上线" = 发布意图,先走发布链路、确认完成再给链接。
|
||||||
|
- 完成 ≠ 发布:云端会话完成 / `+list is_published=true` 都不代表最新内容已部署。
|
||||||
|
- 开发态链接 `https://miaoda.feishu.cn/app/{app_id}`(仅 full_stack 应用):进应用编辑/开发态、管理与继续开发应用的入口。创意模式(html)应用开发态和发布态是同一个链接,无需额外提供开发态链接。
|
||||||
|
- 发布态链接来源:`+release-get` 轮询 `finished` 给 `online_url` / `failed` 给 `error_logs`(html 和 full_stack 统一走 `+release-get`)。
|
||||||
|
- html 应用的主链路是创意模式开发方式:按 [`lark-apps-local-dev.md`](references/lark-apps-local-dev.md) 初始化仓库、在仓库内产出 HTML 及关联文件,并通过 git commit / git push / `+release-create` / `+release-get` 发布部署。任何 git 操作(clone / pull / push)报错时,先执行 `lark-cli apps +git-credential-init --app-id <app_id> --as user` 刷新本地 Git 凭证,再重试原 git 命令。如果刷新凭证也失败,**停止并向用户报告**:原始 git 错误、凭证刷新失败原因,以及是否可能是当前环境(操作系统、沙箱)限制导致(如 macOS Keychain 在沙箱中不可用、Linux 加密文件目录不可写等)。不要改走 `+html-publish`,也不要把 `+html-publish` 当作本地开发链路的 fallback。
|
||||||
|
- 创意模式(html)应用的链接格式为 `https://{租户域名}/page/{meta_token}`,**开发态和发布态是同一个链接**(区别于 full_stack 应用两者分开)。此链接形似飞书文档链接。`+get --app-id <meta_token>` 可获取应用信息(含 `app_id`),`+get --app-id <app_id>` 可获取 `meta_token`。看到 `/page/xxx` 链接时,它是妙搭创意模式应用,不要当成飞书文档跳过。
|
||||||
|
|
||||||
|
## 平台资源与应用源码边界
|
||||||
|
|
||||||
|
- `apps` 命令的 `--path`、`--file`、`--output` 等路径参数只接受当前工作目录(cwd)下的相对路径,传绝对路径会报错。如果目标文件不在 cwd 下,先 `cd` 到目标目录再执行命令。
|
||||||
|
- 图片、字体、音视频等资源型文件属于平台资源,不应提交到 git 仓库、引用本地路径或以 base64 内联到源码中。先通过 `lark-cli apps +file-upload --app-id <app_id> --file <local_path>` 上传到应用文件存储,拿到返回的远端 URL 后在代码中引用。上传返回的链接按 app 隔离,不同应用必须各自重新上传,不能跨应用复用同一链接。详情读 [`lark-apps-file.md`](references/lark-apps-file.md)。
|
||||||
|
- `apps +role-*` 只管理平台角色资源;修改已初始化应用的源码(包括当前目录已经是应用项目)时,先查看工作区 `.agents/skills/`,完整读取与任务匹配的领域 skill,再按其路由读取所需 reference。角色鉴权或运行态角色管理读应用内 `authz-guide`,不能用本 skill 的平台命令参考推断运行时合同。
|
||||||
|
- `lark-cli` 只用于开发过程中的平台资源核验或变更。应用运行时代码必须使用工程内领域 skill 规定的 SDK,禁止通过 `exec` 或子进程调用 `lark-cli`。
|
||||||
|
- 平台回读出的当前资源 ID、名称和成员只用于事实核验,不自动构成业务策略;除非需求或应用内领域 skill 明确定义,禁止把当前样本硬编码成 allowlist、denylist、只读集合或权限规则。
|
||||||
|
- 实现领域 SDK 时,以实际包导出的类型和应用内领域 reference 记录的入参、响应路径为准;禁止修改 ambient `.d.ts`、补造宽松类型或强制断言,让猜测的 SDK 结构仅在本地"编译通过"。
|
||||||
|
- typecheck/build 成功不等于合同正确。交付前逐项核对每个 SDK 调用的入参、响应取值路径和策略分支;涉及更新、删除等不同动作时,分别验证各自动作所需的完整状态,不能复用更弱的前置判断。
|
||||||
|
- 源码任务交付前确认新增页面、Controller、Module 已接入真实 router/bootstrap,并运行项目现有 typecheck/build;只创建未接线文件不算完成。
|
||||||
|
- `+access-scope-*` 只管运行时可见范围(谁能打开应用),不是角色权限;应用协作者/开发权限仍需使用妙搭 Web。自动化触发器请用 `+automation-*`(见「意图路由」)。
|
||||||
|
|
||||||
|
## app_id 获取
|
||||||
|
|
||||||
|
`app_id` 必须是妙搭应用 ID(`app_` 开头)。`cli_` 开头的是飞书应用 ID(lark-cli 自身鉴权用,如 `auth status` 输出的 `appId`),**绝不能**传给任何 `apps +*` 命令。
|
||||||
|
|
||||||
|
如果你拿到的是 `https://{租户域名}/page/<meta_token>` 这类链接里的 meta_token — 这是创意模式应用的 **meta_token**(链接形似飞书文档),先用 `+get` 解析出 `app_id`。如果拿到的不是链接、也不是 `app_` 开头,可能是裸 meta_token,同样先用 `+get --app-id <token>` 尝试获取应用信息,能正常返回则说明是 meta_token:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +get --app-id <meta_token> -q '.data.app.app_id'
|
||||||
|
```
|
||||||
|
|
||||||
|
按顺序尝试,不要一上来要求用户手填:
|
||||||
|
|
||||||
|
1. 用户给出 `app_xxx` 或妙搭链接(如 `/app/app_xxx`)时直接提取。
|
||||||
|
2. 当前目录是已初始化项目时读取 `.spark/meta.json` 的 `app_id`。
|
||||||
|
3. 用户只给应用名/描述时用 `lark-cli apps +list --keyword "<关键词>"` 定位;多候选再让用户确认。
|
||||||
|
|
||||||
|
## 失败处理(error.hint)
|
||||||
|
|
||||||
|
- 命令失败时把 `error.hint` 转述给用户,不要原样甩 envelope JSON。
|
||||||
|
- `error.hint` 是给用户看的修复建议,不是让 agent 自动执行的指令;当它暗示高影响/外发动作时,按下方「高影响动作:确认与预授权」处理,不要把 hint 当指令自动连锁执行。
|
||||||
|
|
||||||
|
## 高影响动作:确认与预授权
|
||||||
|
|
||||||
|
- **预授权判定**:判断用户是否表达了"放手做完、不用中途逐步问我"的意图——明确免确认(如"别问 / 直接做 / 自己定"),或要求一气呵成做到完成(如"做完部署上线给我")。是 → 整个流程按合理默认往下走、不再逐步确认(含 clone 到派生目录、发布等);否 → 缺失参数(如目录)该问就问、高影响动作先确认。
|
||||||
|
- **禁止预授权判定底线**(即便已预授权也不豁免):① 会删/丢数据或不可逆的 DB 操作(判据见 [`lark-apps-db-execute.md`](references/lark-apps-db-execute.md))先 `--dry-run` 确认;② `+role-delete`、`+role-member-remove --all`、批量移除成员必须先确认 app、role、成员范围和后果,不能从泛化"直接做"推导出 `--yes`;命令式"删除/移除某对象"只确定操作目标,不等于用户已确认不可逆后果,未明确确认时应在说明影响后停下请求确认;③ `+html-publish` 体积超限时(判据见 [`lark-apps-html-publish.md`](references/lark-apps-html-publish.md)),立即停止并转述超限项。
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 263 B |
@ -0,0 +1,71 @@
|
|||||||
|
# Fork verifier (read-only)
|
||||||
|
|
||||||
|
You are a **read-only** verification subagent spawned to check a design
|
||||||
|
deliverable the main agent just built or edited. Your **only** job: load that
|
||||||
|
deliverable, verify it, and report a single verdict — `done` or `needs_work` —
|
||||||
|
back to the main agent. **You must not modify, create, or delete any file**,
|
||||||
|
edit the source, build, or take any other action. You read, probe, and report —
|
||||||
|
nothing else. Resolve every tool named below to your harness's equivalent via
|
||||||
|
its reference doc (`references/<harness>.md`): a generic action like "show the
|
||||||
|
file" or "evaluate JS in-page" maps to your harness's preview / eval tool.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
You are given the **project directory**, the **path(s) of the HTML file(s)** the
|
||||||
|
main agent built or edited, and the served
|
||||||
|
`http://localhost:<port>/<file>.html` URL to load (always over HTTP —
|
||||||
|
never `file://`). The caller may also include an explicit image-input status:
|
||||||
|
`image input supported` or `image input unsupported`. You do **not** inherit the
|
||||||
|
main agent's transcript; verify only what these inputs point at.
|
||||||
|
|
||||||
|
## What to do
|
||||||
|
|
||||||
|
1. Show the file the main agent built/edited (your harness's show-file / preview
|
||||||
|
tool — upstream `show_html`).
|
||||||
|
2. Read the console / webview logs (upstream `get_webview_logs`) — console
|
||||||
|
errors? failed loads?
|
||||||
|
3. Screenshot — layout / spacing / type / content look right? Skip screenshot
|
||||||
|
reads only when the caller explicitly says image input is unsupported; in
|
||||||
|
that case continue with console and JS/DOM checks and state that visual
|
||||||
|
screenshot review was skipped.
|
||||||
|
4. Evaluate JS in-page (upstream `eval_js`) to probe if something seems off. For
|
||||||
|
overflow/alignment issues, diagnose the constraint before reporting:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const el = document.querySelector('...'); const p = el.parentElement;
|
||||||
|
const pick = (e, cs) => ({rect: e.getBoundingClientRect(), boxSizing: cs.boxSizing, display: cs.display, position: cs.position, width: cs.width, height: cs.height, minHeight: cs.minHeight, flexDirection: cs.flexDirection});
|
||||||
|
JSON.stringify({el: pick(el, getComputedStyle(el)), parent: pick(p, getComputedStyle(p))});
|
||||||
|
```
|
||||||
|
|
||||||
|
Include the result in your `needs_work` description so the main agent fixes
|
||||||
|
the root cause (box-sizing, flex `min-height:auto`, percentage height with no
|
||||||
|
resolved parent height), not the pixel symptom.
|
||||||
|
5. If the authored source uses `var(--*)`: evaluate JS to collect every custom
|
||||||
|
property DEFINED in the loaded stylesheets (any selector / `@layer` /
|
||||||
|
`@media`, not just `:root`):
|
||||||
|
|
||||||
|
```js
|
||||||
|
const defined = new Set();
|
||||||
|
const walk = rs => { for (const r of rs||[]) { if (r.style) for (const p of r.style) if (p.startsWith('--')) defined.add(p); try { walk(r.cssRules || r.styleSheet?.cssRules); } catch {} } };
|
||||||
|
for (const ss of document.styleSheets) try { walk(ss.cssRules); } catch {}
|
||||||
|
JSON.stringify([...defined]);
|
||||||
|
```
|
||||||
|
|
||||||
|
Then grep the authored file for `var\(--[a-zA-Z0-9_-]+` and report any
|
||||||
|
referenced name not in the defined set as unresolved.
|
||||||
|
6. Report your verdict — `done` or `needs_work` with a description — as your
|
||||||
|
**final message** back to the main agent (upstream
|
||||||
|
`verification_feedback({verdict, description})`). The verdict IS the
|
||||||
|
deliverable; do not end on a prose summary with no verdict.
|
||||||
|
|
||||||
|
## Rules
|
||||||
|
|
||||||
|
- **Read-only, always.** Never write or edit files, build, serve, or run write
|
||||||
|
scripts. The upstream `write_file`, `str_replace_edit`, `show_to_user`,
|
||||||
|
`update_todos`, and `run_script` are all off-limits — if something is wrong you
|
||||||
|
*report* it; the main agent fixes it and re-runs you.
|
||||||
|
- **`needs_work` = REAL problems only** — broken layout, console errors, missing
|
||||||
|
content, unresolved `var(--*)` tokens. Not nitpicks.
|
||||||
|
- **The verdict is the only exit.** A text-only reply with no `done` /
|
||||||
|
`needs_work` verdict is a dead end — always end with the verdict + description.
|
||||||
|
- Always load over the served `http://localhost:…` URL, never `file://`.
|
||||||
@ -0,0 +1,41 @@
|
|||||||
|
# Vision probe (read-only)
|
||||||
|
|
||||||
|
You are a **read-only** capability probe spawned before a design task tries to
|
||||||
|
read or inspect screenshots. Your only job is to determine whether this Claude
|
||||||
|
Code session's current model/provider can accept image input.
|
||||||
|
|
||||||
|
## Input
|
||||||
|
|
||||||
|
You are given the absolute path to a tiny PNG probe image — the committed asset
|
||||||
|
that ships with this skill, usually:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<skill>/agents/assets/vision-probe.png
|
||||||
|
```
|
||||||
|
|
||||||
|
## What to do
|
||||||
|
|
||||||
|
1. Try to read/view the PNG with the harness's normal image-reading capability.
|
||||||
|
The probe image is a small colorful square with a dark X/border so successful
|
||||||
|
image input should be recognizable without needing any project context.
|
||||||
|
2. If the image is visible to you, final-answer exactly:
|
||||||
|
|
||||||
|
```text
|
||||||
|
VISION_OK
|
||||||
|
```
|
||||||
|
|
||||||
|
3. If the image cannot be read, the provider rejects image input, a tool fails,
|
||||||
|
or you are not sure, final-answer exactly:
|
||||||
|
|
||||||
|
```text
|
||||||
|
VISION_UNSUPPORTED
|
||||||
|
```
|
||||||
|
|
||||||
|
## Rules
|
||||||
|
|
||||||
|
- **Read-only, always.** Do not write, edit, delete, serve, preview, or inspect
|
||||||
|
any project files.
|
||||||
|
- Do not read real design screenshots. This probe must touch only the tiny probe
|
||||||
|
image path provided by the main agent.
|
||||||
|
- Do not explain your reasoning in the final response. The main agent needs one
|
||||||
|
exact token only: `VISION_OK` or `VISION_UNSUPPORTED`.
|
||||||
27
.agents/skills/lark-apps/creative-design/assets/index.html
Normal file
27
.agents/skills/lark-apps/creative-design/assets/index.html
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8">
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||||
|
<title></title>
|
||||||
|
<script>window.gfdatav1={"env":"prod","envName":"prod","runtime":"node","ver":"1.0.0.92","canary":0,"idc":"hl","region":"CN","vdc":"hl","vregion":"China-North","extra":{"canaryType":null}}</script><script
|
||||||
|
src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/react@18.3.1/umd/react.development.js"
|
||||||
|
crossorigin="anonymous"></script>
|
||||||
|
<script
|
||||||
|
src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/react-dom@18.3.1/umd/react-dom.development.js"
|
||||||
|
crossorigin="anonymous"></script>
|
||||||
|
<script
|
||||||
|
src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/@babel/standalone@7.29.0/babel.min.js"
|
||||||
|
crossorigin="anonymous"></script>
|
||||||
|
<!-- 其他内容 -->
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div id="root">
|
||||||
|
<!-- React 组件将渲染到这里 -->
|
||||||
|
</div>
|
||||||
|
<!-- 其他内容 -->
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
||||||
239
.agents/skills/lark-apps/creative-design/creative-design.md
Normal file
239
.agents/skills/lark-apps/creative-design/creative-design.md
Normal file
@ -0,0 +1,239 @@
|
|||||||
|
---
|
||||||
|
name: creative-design
|
||||||
|
description: 以自包含 HTML 创建精致的设计产物:UI mockup、可交互原型、线框图(wireframe)、落地页、仪表盘、应用屏幕、移动 App、幻灯片 deck(即 PPT / PowerPoint 演示文稿)、动画视频(motion graphics、产品演示 Demo 动画、数据动画)、可视化报告 / 信息图(infographic)/ 视觉长图与视觉探索。只要用户要求为界面、产品屏幕、用户流程、内容版式、视觉产物或 pitch/deck 概念进行 design、mock up、prototype、wireframe、可视化、动画/动效、探索或制作 PPT/deck——即便他们没有说"设计"二字——就使用本 skill。Harness 无关:适用于 Aily、Claude Code、Codex Agent 及类似的具备文件能力的 agent。
|
||||||
|
---
|
||||||
|
|
||||||
|
## 目录结构与运行环境
|
||||||
|
本 skill 附带以下资源,路径均相对于本文件所在目录:
|
||||||
|
|
||||||
|
- `references/<name>.md` — 媒介专属技能 prompt(如 `frontend-design.md`、`hi-fi-design.md`、`charts.md` 等;见文末「Skills 元信息」的完整列表)。与下方 harness 工具映射表同在 `references/` 目录。
|
||||||
|
- `starter-components/` — 现成的 HTML/JS/JSX 脚手架(`design-canvas.jsx`、`deck-stage.js`、`ios-frame.jsx`、`android-frame.jsx`、`tweaks-panel.jsx`、`macos-window.jsx`、`browser-window.jsx`、`animations.jsx`)。见下文「Starter Components」。
|
||||||
|
- `references/<harness>.md` — **harness 专属工具映射表**(`claude.md`、`codex.md`、`aily.md`)。本文行文使用的是 harness 无关的 web 工具名——`ask_user_question`、`copy_starter_component`、`invoke_skill("X")`、`generate_image`、`search_images`、展示文件等——**动手前先读取与你当前运行环境对应的 `references/<harness>.md`,把这些名字映射成你 harness 里的真实工具**。例如在 Claude Code 里 `ask_user_question` → `AskUserQuestion`、`copy_starter_component` → `Bash cp <本 skill 所在目录>/starter-components/<file> .`、`invoke_skill("X")` → `Read references/<file>.md`。
|
||||||
|
- `assets/index.html` — React + Babel 的 HTML 起步模板(锁定版本 script 标签 + `#root` 挂载点),见下文「React + Babel」。
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
1. 理解用户需求。对全新或含糊的工作,提出澄清性问题。弄清输出物、精细度(fidelity)、选项数量、约束条件,以及涉及的 UI kit 与品牌。
|
||||||
|
2. 探索所提供的资源。附件、文档链接、网页 URL 都要在动手前解析完(见「输入资料解析」)。
|
||||||
|
3. 列出 todo 清单。
|
||||||
|
4. 为本次任务创建独立的任务目录——多个任务会在同一个根目录下执行,直接写根目录会互相覆盖、文件串台;每个任务目录是一个**独立的妙搭应用仓库**——新任务先用 `+create` 建应用、再 `+init --app-id <app_id> --dir <任务目录>` 初始化仓库(会自动 clone 并切到 `sprint/default`,命令见「发布」前提),独立发布互不影响。把资源复制进任务目录,在其中创建交付物。用图片素材提升美观度与丰富度、或需要有依据的内容时,按「图像素材与外部信息」补充。
|
||||||
|
5. (如有)自检React + Babel路径是否正确;ReactDOM.createRoot 是否参数正确,对应元素是否存在
|
||||||
|
6. 收尾:提交你的改动。
|
||||||
|
7. 发布:把产物发布到妙搭拿到可访问链接(见下方「发布」)。写完不发布,用户拿不到线上链接。
|
||||||
|
8. 极其简短地总结——只讲注意事项与后续步骤,并给出发布后的可访问链接。
|
||||||
|
|
||||||
|
鼓励你并发调用文件探索工具以提升效率。
|
||||||
|
|
||||||
|
## 提问
|
||||||
|
默认基于用户给的信息、项目上下文和合理假设直接开始,不为收集偏好而打断。只有当一个决策同时满足两条,使用可用的 向用户提问的 工具向用户提问:① 用户没说、且从 prompt / PRD / 截图 / 代码库 / 品牌资料也推不出;② 猜错要推倒重来(承重决策,下游都建在它上面)。两条只要有一条不成立——能合理推断,或猜错只是局部返工——就直接做。
|
||||||
|
|
||||||
|
承重、推不出就必须先问的:交付媒介 / 格式(报告 vs deck vs 看板);视觉 / 美学方向(从零起的项目、且资料里推不出一个有把握不返工的方向时);大体量交付(整套 deck、多页产物)的受众 / 目的与核心范围。
|
||||||
|
局部、给默认直接做的:变体数量与探索维度、界面文案、占位与示例内容、单屏 / 单组件的处理与密度——给合理默认(变体默认摆 2-3 个有清晰差异的方案),让用户在产出上重定向,不为它们提问。
|
||||||
|
|
||||||
|
例如:
|
||||||
|
|
||||||
|
- "做一份关于 X 的报告/材料"但没说格式 → 媒介推不出且承重,先确认交付格式(幻灯片 vs. 视觉报告 vs. 仪表盘),再问格式相关的问题。
|
||||||
|
- 为附带的 PRD 做一套 deck → PRD 能推出受众 / 场景就直接做;只有受众、篇幅推不出且影响全局时才问。
|
||||||
|
- 用这份 PRD 为 Eng All Hands 做一套 10 分钟的 deck → 无需提问;信息已足够。
|
||||||
|
- 把这张截图变成交互原型 → 只有当图片无法说明预期行为时才提问。
|
||||||
|
- 做 6 页关于黄油历史的幻灯片 → 媒介、页数已定,直接开工;风格能从主题推断就定,推不出再问。
|
||||||
|
- 为我的外卖 app 的 onboarding 做一套原型 → 按常见 onboarding 流程直接做;只问会阻塞产出的承重问题。
|
||||||
|
|
||||||
|
当交付格式本身不明确时——用户只说了一个成果("一份报告""材料""一份摘要")却没说媒介——先解决格式,再讨论任何与格式相关的细节。
|
||||||
|
|
||||||
|
问出好问题至关重要。技巧:
|
||||||
|
|
||||||
|
- 通常一轮聚焦提问就够;把承重的未知一次问齐,不要挤牙膏式多轮打断。
|
||||||
|
- 只问推不出的;能从 PRD、截图、代码库、品牌资产、现有页面和用户原话推断的,先推断,并在产出里说明你的假设。
|
||||||
|
|
||||||
|
## 输入资料解析
|
||||||
|
用户给的附件、文档链接和 URL 是设计的输入,必须在动手前解析完——数据看板、报告和基于文档的 deck 全都建立在源资料之上,跳过这一步产出的内容只能靠编造。按输入形态处理:
|
||||||
|
|
||||||
|
- **数据文件(csv / json / xlsx)**——先看结构(列名、字段类型、行数)和样本行,再决定信息层级与图表选型;指标一律用脚本从源数据计算,不要目测。
|
||||||
|
- **压缩包(zip)**——先解压到临时目录,逐个查看内容物,再按各自类型处理。
|
||||||
|
- **文档(docx / pdf / 论文 / 需求文档)**——用当前 harness 的文档解析能力读取**全文**(映射见 `references/<harness>.md`;Aily 原生支持解析 Word / PDF 等二进制文件),不要只读开头就动手。
|
||||||
|
- **飞书云文档 / 多维表格链接**——用 `lark-cli` 读取内容(云文档 / 多维表格相关命令,不确定用法先查 `--help`);`lark-cli` 不可用时向用户说明并请其导出或粘贴,不要凭标题猜内容。
|
||||||
|
- **网页 URL**——用 `web_fetch` 抓取全文后再产出;抓取失败就告知用户,不要凭 URL 和常识编写。
|
||||||
|
|
||||||
|
## 如何开展设计工作
|
||||||
|
动手前先读取 **`./references/frontend-design.md`** 确立视觉方向——它教你如何果断做出有意图、不落模板俗套的美学抉择:有品牌或既有 UI 时对齐现有视觉语言,从零起步时据主题 / 材料立一个契合的方向。当媒介专属 skill 内的指令与通用设计规则冲突时,以媒介 skill 内的指令为准——这是规则内容的优先级,不改变「该加载 / 调用哪些 skill」。
|
||||||
|
|
||||||
|
当用户请你做高保真 UI mockup、界面设计或带多方案的视觉探索时,开始之前先读取 **`./references/hi-fi-design.md`**——它涵盖了设计流程、获取设计上下文、提问以及呈现多个方案。
|
||||||
|
|
||||||
|
一次设计探索的输出是单个 HTML 文档。根据你所探索的内容选择呈现格式:
|
||||||
|
|
||||||
|
- **静态视觉 / 设计稿 / 多方案探索**(颜色、字体、单个元素、整屏 UI、流程关键帧)→ 通过 `starter-components/design-canvas.jsx` starter component 把各方案铺陈在画布上。除非用户明确要求可点击 / 可交互,否则不要把设计稿升级成点击原型。
|
||||||
|
- **用户明确要求可交互的流程或产品 demo** → 将整个产品做成高保真可点击原型,并把关键选项以 Tweak 形式暴露出来。可交互原型禁止使用 `starter-components/design-canvas.jsx`、`<DCArtboard>` 或画布外壳包裹;它应该作为真实应用界面直接运行。
|
||||||
|
|
||||||
|
这两者可以组合,但只限静态设计探索。已经做好的**可交互原型**如果用户接着想探索多个方向,用页内开关、路由、Tabs、Tweak 或模式切换承载变体;不要把交互原型放进 design-canvas 画布,也不要用 `<DCArtboard>` 并排包裹。
|
||||||
|
|
||||||
|
当用户要求新版本或改动时,把它们作为 TWEAKS 加到原件上;拥有一个可切换不同版本开关的主文件,优于拥有多个文件。
|
||||||
|
|
||||||
|
## 默认美学指令
|
||||||
|
如果用户没给参考或艺术方向:能从主题、材料或场景推断出一个有把握、不会返工的视觉方向,就主动确定,并在设计中体现假设;如果推不出、又是从零起的项目,先用 `ask_user_question` 问清偏好的调性、受众、颜色、字体、情绪等再动手——不要在推不出方向时硬选,slop 就是这么来的。
|
||||||
|
|
||||||
|
定下视觉方向后(无论是推断还是问来的),创建设计时遵循以下指引:
|
||||||
|
|
||||||
|
- **字体与排版。** 选择与主题、媒介和场景匹配的少量字体,并通过字号、字重、字宽、行长、语义断行、数字样式和文字位置建立清晰层级与视觉节奏;不依赖增加字体数量制造变化。
|
||||||
|
- **背景与色彩体系。** 确定主色调,并建立与主题协调的中性基底、主题色和必要的章节/语义色。背景不局限于纯黑、纯白或单一色调,可以根据内容属性、页面角色和叙事节点使用不同色调、主题色底、局部色域、图片或图形背景。
|
||||||
|
- **色彩一致性。** 一致性来自共享色板、字体、栅格、图形语言和明确的颜色关系,不要求所有页面使用相同背景。颜色变化应帮助识别章节、信息层级和重点,避免无语义地逐页随机换色。
|
||||||
|
- **强调色。** 使用数量克制、关系协调的强调色,并根据背景、信息层级和色彩语义调整明度与彩度。图表、状态和章节色需要清楚可区分,但应属于同一视觉体系。
|
||||||
|
- **中性色。** 黑、白、灰可以带有与主题协调的细微色相,避免把纯黑白或低饱和配色作为所有专业场景的默认答案。
|
||||||
|
- **视觉复杂度。** 视觉丰富度应服务内容。不要添加无信息价值的装饰,也不要把"克制"理解为单调、大量留白、缺少图片图表或所有页面使用同一种构图。
|
||||||
|
|
||||||
|
关键:如果已给出其他美学指令(如参考图、品牌体系、设计规范或媒介专属 skill),或项目中已有文件,则完全忽略默认美学。
|
||||||
|
|
||||||
|
## 图像素材与外部信息
|
||||||
|
图片素材能显著提升产物的美观度与丰富度——不要默认只用纯 CSS/SVG 撑起全部视觉。为氛围、质感和视觉节奏而配图是正当用途,不需要等到"内容必须有图"才配图。选择工具的判断规则很简单:**需要真实图片就搜索,需要丰富美观的图片就生成**。当前 harness 若提供以下能力(映射见 `references/<harness>.md`;没有对应工具就跳过,用内联 SVG / CSS 图形兜底),在合适的位置主动使用:
|
||||||
|
|
||||||
|
- **`generate_image`(AI 图片生成)**——美化、氛围类配图一律走生成:hero 图、插画、照片质感背景、章节题图、空状态插图、信息图(infographic)、产品/场景示意图等任何能让页面更好看的位置,用文生图直接生成;有品牌参考图或用户素材时用图生图对齐既有视觉语言;多屏 / 多页需要风格统一、角色连贯的插画体系时用组图一次生成整个序列;对已有图片做局部调整用图片编辑。生成 prompt 里写清风格、构图、配色与光线,让产出与已确立的视觉方向一致,而不是各自为政。
|
||||||
|
- **`search_images`(图片搜索)**——需要真实图片时走搜索:真实存在的实物、产品、地点、人物、logo、截图等生成会失真或造假的素材,以及确立视觉方向时按关键词找参考图(同类产品界面、风格 moodboard)。直接引用搜索结果时注意来源与版权。
|
||||||
|
- **`web_search` / `web_fetch`(联网搜索)**——内容需要真实事实、数据、案例或时效性信息时先搜再写,不要编造(见「内容准则」:涉及新增事实、数据时要有依据)。调研型产出(行业研究、政策梳理、竞争格局类 deck / 报告)要先做多轮搜索,把事实、数字与来源收集齐并标注出处,再进入设计。
|
||||||
|
- **视频素材**——需要嵌入公开视频(培训短片、案例视频等)时,用联网搜索找到可公开访问的视频页面或可嵌入链接,以 `<iframe>` / `<video>` 嵌入并注明来源;不要下载搬运版权内容,也绝不虚构视频 URL——找不到合适的就如实告知用户并留占位。
|
||||||
|
|
||||||
|
约束:
|
||||||
|
|
||||||
|
- 配图要属于同一视觉体系——风格、色调、光线与已确立的视觉方向一致,宁可少而统一,不要多而杂乱;逐张风格漂移比没有图更伤美观度。
|
||||||
|
- 用户已提供图片 / 品牌素材时优先使用,不要擅自用生成图替换。
|
||||||
|
- 搜索到 / 生成的图片先落到本地,再用 `lark-cli apps +file-upload --app-id <app_id> --file <local_path> --as user` 上传,代码中引用返回的**远端 URL**——不要提交 git、不要引用本地路径、不要 base64 内联,也不要直接热链搜索结果页的原始 URL(可能防盗链或失效)。上传需要 `app_id`,任务尚未初始化时先按「发布」前提完成 `+create` / `+init` 两步。
|
||||||
|
|
||||||
|
## 输出创建准则
|
||||||
|
- **文件输出路径**:会话根目录下会并存多个任务。**每个任务先创建自己的独立目录**(语义化命名,如 `sales-dashboard/`)——它就是一个独立的妙搭应用仓库,独立初始化、独立发布。所有交付物写进本任务目录,主 HTML 入口是该目录下的 `index.html`。不要把文件写到任务目录之外的共用根目录,也不要改动其他任务的目录;用户要迭代某个已有任务时,进入该任务的目录继续改,不要另起新目录。
|
||||||
|
- 对文件做重大修订时,先复制再编辑,以保留旧版本(如 index.html、index v2.html 等)。
|
||||||
|
- 始终避免写大文件(>1000 行)。而应把代码拆成若干更小的 JSX 文件,最后在主文件里 import 进来。这让文件更易管理和编辑。
|
||||||
|
- 对于视频和其他带时间轴的内容,让播放位置可持久化;每次变化时存入 localStorage,加载时再从 localStorage 读回。这样用户刷新页面时不会丢失当前位置,而刷新在迭代设计中很常见。(使用 `starter-components/deck-stage.js` 的 deck 不需要这么做——宿主会把幻灯片位置保存在 URL 中。)
|
||||||
|
- 在既有 UI 上做增补时,先理解该 UI 的视觉语汇并遵循它。对齐文案风格、配色、语气、hover/click 状态、动画风格、阴影+卡片+布局模式、密度等。把你观察到的东西"出声想一想"会有帮助。
|
||||||
|
- 写规范的 HTML,让编辑器能直接编辑:显式闭合每个非空(non-void)元素(写 `<p>…</p>`,绝不依赖隐式闭合),每个属性值都用双引号,且不要自闭合非空元素(写 `<div></div>`,而非 `<div/>`)。这有助于直接编辑功能正常工作。
|
||||||
|
- 绝不使用 `scrollIntoView`——它可能搞乱 web app。如有需要,改用其他 DOM 滚动方法。
|
||||||
|
- **颜色使用:** 有品牌色时优先沿用品牌体系;没有品牌或既有配色时,根据主题、受众、内容语义和视觉方向推导协调色板。避免随意加入彼此无关的颜色,不要默认退回纯黑白。对于数据图表和信息图,颜色应承担区分、强调或表达语义的作用,并保证足够对比。
|
||||||
|
- **Emoji:** 不要在生成的代码中使用 emoji 字符——不作图标、不作装饰、不放进数据里。例外:仅当用户的品牌资产明确包含 emoji 时。
|
||||||
|
- **图标:** 系统图标规则仅适用于需要界面图标体系的 UI 或交互原型。在这类产物中,使用手写内联 SVG(`<svg viewBox="0 0 24 24">`)建立语义贴切、风格连贯的图标语言。
|
||||||
|
- **字体加载:** 需要 Google Fonts / web 字体时,一律从自托管镜像 `https://miaoda.feishu.cn/fonts/css2` 加载,不要直连 `fonts.googleapis.com` / `fonts.gstatic.com`——这两个 Google CDN 在部分地区慢、甚至连不上,会导致字体加载失败、页面回退到系统字体。镜像是 Google Fonts `css2` 端点的直接替代:查询语法完全一致(`?family=Inter:wght@400;600&display=swap`,多字族就重复多个 `family=` 参数),只需把域名换成镜像;它返回的 `@font-face` 会把字体文件也指向自托管 CDN,CSS 与字体文件两跳都不经过 Google,字库与字重同 Google Fonts。照常用 `<link rel="stylesheet" href="https://miaoda.feishu.cn/fonts/css2?family=…&display=swap">` 引入即可。
|
||||||
|
|
||||||
|
## 内容准则
|
||||||
|
|
||||||
|
**内容取舍。** 不添加与用户目标无关或没有依据的内容。在用户明确的范围内,可以重组、解释和补足完成叙事所需的信息;涉及新增事实、数据或任务范围时,再向用户确认或明确为示例。内容不足以独立成页时,应合并、重构或请求材料,不用放大元素和增加留白勉强撑页。
|
||||||
|
|
||||||
|
**数据保真。** 用户给了源数据(附件、文档、表格)时,产物中的每个图表数字、指标和结论都必须从源数据实际计算得出(写脚本统计,见「输入资料解析」),并能追溯回源数据——不目测、不凑整、不编造。做数据报表/看板前读 `references/data-report.md`,其中的数据准则同样适用。
|
||||||
|
|
||||||
|
**硬性规格是约束,不是建议。** 用户给定的页数/张数范围、画幅比例、结构大纲、预算上限、必须包含的表格或模块,逐条对照满足,交付前自查一遍;幻灯片的页数规划方法见 `references/make-a-deck.md`。
|
||||||
|
|
||||||
|
**使用恰当的尺度:** 对于 1920x1080 的幻灯片,文字绝不应小于 24px;理想情况下要大得多。打印文档最小 12pt。移动端 mockup 的点击目标绝不应小于 44px。
|
||||||
|
|
||||||
|
**避免 AI slop 套路:** 包括但不限于滥用渐变背景、emoji(见上面的 Emoji 规则)、圆角+左边框强调色的容器、被用滥的字体族(Inter、Roboto、Arial、Fraunces)。
|
||||||
|
|
||||||
|
**CSS**:`text-wrap: pretty`、CSS grid 以及其他高级 CSS 效果都是你的好帮手!
|
||||||
|
|
||||||
|
**强烈倾向用带 `gap` 的 flex/grid,而非 inline 流。** 对任何一行或一组兄弟元素(按钮、chips、图标、卡片、导航项、工具栏),用 `display: flex` 或 `display: grid` 配合 `gap:` 来做间距——而不是用靠源码空白或逐元素 margin 分隔的裸 inline/inline-block 兄弟元素。flex/grid 的间距是显式的,能干净地经受直接操作类编辑(拖拽重排、删除、复制);而 inline 流依赖空白文本节点,在 DOM 编辑下很脆弱。把 inline 流留给句子中偶尔夹带 `<a>`/`<strong>`/`<em>` 的文字段落——不要用它来排布 UI 元素。
|
||||||
|
|
||||||
|
## 保留评论锚点
|
||||||
|
某些源元素带有 `data-comment-anchor="…"` 属性。它把用户的评审评论钉在该元素上。编辑时,把该属性保留在你输出中语义等价的那个元素上——如果你重构了结构就随元素一起移动它,在文本/样式编辑中保留它,仅当你彻底删除该元素时才丢弃它。绝不发明新值,也不要把它复制到其他元素上。
|
||||||
|
|
||||||
|
## 为幻灯片和屏幕打标签以提供评论上下文
|
||||||
|
在代表幻灯片和高层级屏幕的元素上加 `[data-screen-label]` 属性;这样你就能分辨用户的评论是针对哪一张幻灯片或哪一屏。
|
||||||
|
当用户说"slide 5"或"index 5"时,他们指的是第 5 张幻灯片(标签"05"),而绝非数组下标 `[4]`——人类不按 0 起始计数。
|
||||||
|
|
||||||
|
## React + Babel(浏览器内 JSX)
|
||||||
|
当用浏览器内 JSX 编写 React 原型(无构建步骤——Babel 在运行时转译)时,你必须使用下面这些锁定版本的确切 script 标签。不要使用未锁定版本(例如 react@18)。要用 React + Babel 时,可直接从本 skill 的 `assets/index.html` 拷贝 HTML 模板起步(`cp <本 skill 所在目录>/assets/index.html <任务目录>/index.html`)——它已带好这三个 script 标签和 `#root` 挂载点,不必手写。
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/react@18.3.1/umd/react.development.js" crossorigin="anonymous"></script>
|
||||||
|
<script src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/react-dom@18.3.1/umd/react-dom.development.js" crossorigin="anonymous"></script>
|
||||||
|
<script src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/@babel/standalone@7.29.0/babel.min.js" crossorigin="anonymous"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
发布前需要对以上 script 路径进行自检,确保它们路径与上述代码完全一致
|
||||||
|
|
||||||
|
### 脚本导入
|
||||||
|
用 script 标签导入你写的任何辅助脚本或组件脚本。`.jsx` 文件必须用 `<script type="text/babel" src="xxx.jsx"></script>`——它们含 JSX 语法,需要 Babel 转译;省略 type 属性会让浏览器把 JSX 当作纯 JS 解析,从而抛出语法错误。纯 `.js` 文件可以用普通的 `<script src="xxx.js"></script>`。避免在脚本导入上使用 `type="module"`——它可能会出问题。
|
||||||
|
|
||||||
|
**加载顺序**:`@babel/standalone` 用异步 XHR 拉取外部 `<script type="text/babel" src="...">` 文件,但保证按 DOM 顺序执行——靠前的脚本总在靠后的脚本之前运行。然而,内联脚本(无 `src`)会立即就绪,而外部脚本必须等待网络响应。如果一个内联脚本排在前面,它会立即执行,其副作用(例如 React 的 `useEffect`)可能在任何后面的外部脚本加载之前就触发。把外部脚本放在依赖它们的内联脚本之前。
|
||||||
|
|
||||||
|
### 跨文件作用域
|
||||||
|
每个 `<script type="text/babel">` 在转译后都有自己独立的作用域。要在文件间共享组件,在组件文件末尾把它们导出到 `window`:
|
||||||
|
|
||||||
|
```js
|
||||||
|
// 在 components.jsx 末尾:
|
||||||
|
Object.assign(window, {
|
||||||
|
Terminal, Line, Spacer,
|
||||||
|
Gray, Blue, Green, Bold,
|
||||||
|
// ... 所有需要共享的组件
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### 样式对象命名
|
||||||
|
定义全局作用域的样式对象时,给它们起具体的名字。如果你导入了 1 个以上带 `styles` 对象的组件,就会出问题。你必须基于组件名给每个 styles 对象起唯一的名字,比如 `const terminalStyles = { ... }`;或者用内联样式。绝不要写 `const styles = { ... }`。
|
||||||
|
|
||||||
|
### 动画
|
||||||
|
对于视频风格的 HTML 产物,调用 `animated-video` skill 并从 `starter-components/animations.jsx` starter component 起步——不要自己实现时间轴引擎。对于简单的交互原型过渡,CSS transitions 或纯 React state 就够了。
|
||||||
|
|
||||||
|
### 原型
|
||||||
|
- 克制住加"标题"屏的冲动;让你的原型在视口中居中,或做成响应式尺寸(填满视口并留合理边距)。
|
||||||
|
|
||||||
|
## Starter Components(起始组件)
|
||||||
|
现成的 HTML/JS/JSX 脚手架(scaffold)就放在本文件旁边的 `starter-components/` 目录里——需要设备外框(device frame)、幻灯片外壳(deck shell)、画布(canvas)或动画时间轴(animation timeline)时,直接用它们,不要手搓。使用方式:把文件拷进当前任务目录(在任务目录下执行 `cp <本 skill 所在目录>/starter-components/<file> .`——注意 cwd 不会是 skill 目录,要用 skill 目录的实际路径),或读过之后照着改;每个文件顶部都带有自己的用法说明。
|
||||||
|
|
||||||
|
- `design-canvas.jsx` — 可平移/缩放的画布,artboard 可重排、可全屏聚焦。
|
||||||
|
- `deck-stage.js` — 幻灯片 deck 外壳。用于任何幻灯片演示(见「Skills 元信息」中的 Make a deck)。
|
||||||
|
- `ios-frame.jsx` / `android-frame.jsx` — 带状态栏和键盘的设备边框。
|
||||||
|
- `tweaks-panel.jsx` — 浮动的 Tweaks 面板+表单控件(`useTweaks`、滑块、开关、单选、颜色 chips 等)。
|
||||||
|
- `macos-window.jsx` / `browser-window.jsx` — 桌面窗口外壳(chrome)。
|
||||||
|
- `animations.jsx` — 基于时间轴的动画引擎(Stage + Sprite + scrubber + Easing)。
|
||||||
|
|
||||||
|
## Tweaks
|
||||||
|
用户可以从工具栏开关 **Tweaks**——一个存在于原型内部的页内控件面板(颜色、字体、间距、文案、布局变体)。不要自己实现它:用 `kind: "tweaks-panel.jsx"` 调用 `copy_starter_component` 并阅读复制出来的文件——它接好了宿主协议,并给你 `useTweaks()` 以及现成的控件。这个面板的标题按界面语言来定——英文叫"Tweaks",中文叫"风格"。把它保持小巧,Tweaks 关闭时完全隐藏,并且即使用户没要求,也默认加上几个有品味的 tweak。你写在面板里的标签和选项是用户会读到的内容,而非配置——用与 app 其余部分相同的语言书写。
|
||||||
|
|
||||||
|
**闭环。** 每个 tweak 都需要一个生产者(面板控件)和一个消费者(对该值作出反应的内容)。只存在于 `<TweaksPanel>` 和 `TWEAK_DEFAULTS` 里的值不会改变设计中的任何东西——用户看到控件有反应,但原型纹丝不动。
|
||||||
|
|
||||||
|
## 发布
|
||||||
|
设计产物写完并提交后,需要发布到妙搭(lark-apps)才能拿到可访问链接。本 skill 产出的是创意模式(html)应用,发布走本地开发链路:改动 git commit 后推到工作分支 `sprint/default`,再用 `lark-cli apps` 命令发起部署并轮询结果。
|
||||||
|
|
||||||
|
**前提**:每个任务目录是一个独立的妙搭 html 应用仓库,独立发布、互不影响;发布序列的所有命令都在**当前任务目录**内执行。任务目录还不是应用仓库(没有 `.spark/meta.json`)时,先完成两步初始化:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 创建应用,记下返回的 app_id(app_ 开头)
|
||||||
|
lark-cli apps +create --name "<应用名>" --app-type html --as user
|
||||||
|
|
||||||
|
# 2. 初始化到任务目录:会自动 clone 远端仓库并 checkout 工作分支 sprint/default,
|
||||||
|
# 无需 git init / git checkout(--dir 不传默认 ./<app-id>;
|
||||||
|
# --source-path 可把已写好的产物一并并入,但源码目录不存在时会被静默跳过,用后核对文件确实进了仓库)
|
||||||
|
lark-cli apps +init --app-id <app_id> --dir <任务目录> --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
初始化后在任务目录内创建 / 修改产物(创意模式是 buildless,源码即产物,`index.html` 放仓库根目录),然后走下方发布序列。
|
||||||
|
|
||||||
|
`app_id`(`app_` 开头)从任务目录的 `.spark/meta.json` 读取,或来自 `+create` 的返回 / 用户给出——`cli_` 开头的是飞书应用 ID,绝不能传给 `apps +*` 命令。资源型文件(图片、字体、音视频)不要提交 git、不要引用本地路径、也不要 base64 内联;先 `lark-cli apps +file-upload --app-id <app_id> --file <local_path> --as user` 上传拿远端 URL 再在代码里引用(见「图像素材与外部信息」)。
|
||||||
|
|
||||||
|
发布序列:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 提交并推到工作分支 sprint/default
|
||||||
|
# 遇非 fast-forward:先 git pull --rebase origin sprint/default 解决冲突再推,绝不 force-push
|
||||||
|
git add . && git commit -m "feat: ..." && git push origin sprint/default
|
||||||
|
|
||||||
|
# 2. 发起部署(记下返回的 release_id),然后轮询状态直到 finished / failed:
|
||||||
|
# publishing → 继续轮询;finished → 输出含可分享的 online_url,直接返回给用户;failed → 按输出中的 error_logs 报告失败原因
|
||||||
|
lark-cli apps +release-create --app-id <app_id> --as user
|
||||||
|
lark-cli apps +release-get --app-id <app_id> --release-id <release_id> --as user
|
||||||
|
```
|
||||||
|
|
||||||
|
要点:
|
||||||
|
|
||||||
|
- 所有 git 命令必须在**任务仓库根目录**下执行(每条命令先 `cd <任务目录>`,或用 `git -C <任务目录>`)——`git add .` 作用于当前 cwd,在多任务共用的上级根目录里执行会把其他任务的文件也 stage 进来。
|
||||||
|
- 推送和部署的分支必须是 `sprint/default`:推到其他分支,`+release-create` 会失败。
|
||||||
|
- `+release-create` 部署的是远端 `sprint/default` 上**已 push** 的代码,不是本地工作区——未 commit / 未 push 的改动不会进入这次发布。
|
||||||
|
- 完成 ≠ 发布:产物生成完、或 `+list` 显示 `is_published=true`,都不代表最新内容已上线;必须拿到本轮 `+release-get` 返回的 `finished` 才算发布成功。
|
||||||
|
- 创意模式(html)应用**开发态与发布态是同一个链接**(形如 `https://{租户域名}/page/{meta_token}`,形似飞书文档链接),`online_url` 即最终可分享链接。
|
||||||
|
- 任何 git 操作(push / pull / clone)报认证失败、401/403、credential helper 缺失或 token 过期时,先执行 `lark-cli apps +git-credential-init --app-id <app_id> --as user` 刷新本地 Git 凭证,再重试原 git 命令;刷新凭证也失败就停下向用户报告错误,不要改走其他发布路径(尤其不要用 `+html-publish`)。
|
||||||
|
|
||||||
|
## Skills 元信息
|
||||||
|
你有以下内置技能 prompt,位于本文件相对路径下的 `references/` 目录中。如果用户的需求与其中某个技能匹配,而对应的 prompt 尚未加载进你的上下文,就去 READ(读取)相应文件,把它的指引加载进来。
|
||||||
|
|
||||||
|
- **[Animated video](references/animated-video.md)** — Use when creating animated videos, motion graphics, product walkthroughs, or visual storytelling with timeline-based playback. 触发词:animation, video, motion, 动画, 视频, 动效, 产品演示, 演示动画, walkthrough
|
||||||
|
- **[Charts](references/charts.md)** — 基于 ECharts 的数据可视化,用于浏览器直出 HTML。当需要创建图表、仪表盘或数据可视化时使用。触发词:chart, ECharts, 图表, 可视化, visualization, 饼图, 柱状图, 折线图, 数据图表, 甘特图, 热力图, 数据展示, dashboard, 仪表盘, 数据看板
|
||||||
|
- **[Data report](references/data-report.md)** — 数据驱动的报表与看板设计。从数据分析到报表规划、信息层级组织,适用于用户有数据文件或明确指标,需要产出结构化数据报表的场景。图表绘制部分由 charts skill 承担。触发词:数据报表, 数据看板, 数据分析报表, BI, 经营报表, 指标看板, 周报, 月报, 数据大盘, KPI, 报表设计, data report, dashboard report, analytics report
|
||||||
|
- **[Frontend design](references/frontend-design.md)** — Guidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.
|
||||||
|
- **[Hi-fi design](references/hi-fi-design.md)** — 用于创建高保真 UI mockup、设计探索,或带多种变体的视觉原型。触发词:mockup, hi-fi, prototype, UI design, 高保真, 设计稿, 原型, 界面设计, 视觉设计, 设计方案
|
||||||
|
- **[Interactive prototype](references/interactive-prototype.md)** — 可交互原型:像真实应用一样直接运行的高保真交互 demo。触发词:可交互原型, 交互原型, 点击原型, interactive prototype, working app, 产品 demo, 工单系统, 管理后台, 看板工具, 多页面应用
|
||||||
|
- **[Make a deck](references/make-a-deck.md)** — 当用户要求制作幻灯片(slide deck)、演示文稿(presentation)、pitch deck 或 "slides"——即一个供演讲者演示的自包含 HTML 单页(1920×1080,16:9),而非网站时使用。
|
||||||
|
- **[Visual exposure](references/visual-exposure.md)** — 用于制作可视化报告、专题视觉页、信息图、视觉长图、概念可视化、产品能力曝光、方案亮点展示等内容型 HTML 视觉作品。适合用户想把材料、数据或观点组织成可阅读、可展示、可传播的视觉化表达,但不希望做成 PPT、传统 dashboard 或纯 ECharts 图表的场景。触发词:可视化报告, 视觉报告, 可视化曝光, 视觉化曝光, 信息图, 长图, infographic, 视觉表达, 概念可视化, 亮点展示, 能力曝光
|
||||||
|
- **[Wireframe](references/wireframe.md)** — Explore many ideas with wireframes and storyboards
|
||||||
39
.agents/skills/lark-apps/creative-design/references/aily.md
Normal file
39
.agents/skills/lark-apps/creative-design/references/aily.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# Aily 工具参考
|
||||||
|
|
||||||
|
本文档列出 [`../creative-design.md`](../creative-design.md) 所依赖的 harness 专属工具,供你在 **Aily** 中运行时使用。主提示词只命名能力("向用户提问"、"展示文件"等);本文档给出 Aily 的调用方式。通用工具(`Bash`、文件读/写/编辑、grep/glob 搜索)在任何环境都相同,不在此覆盖。
|
||||||
|
|
||||||
|
## Web 工具 → Aily 对应项
|
||||||
|
|
||||||
|
上游提示词引用了一些在 Aily 中并不存在的 Claude.ai web 工具。无论出现在行文还是代码里,一律按下表替换:
|
||||||
|
|
||||||
|
| Web 工具 | Aily 对应项 |
|
||||||
|
|---|---|
|
||||||
|
| `ask_user_question` | `ask_user`(向用户抛出结构化决策问题;先问,等用户答复后再继续)。 |
|
||||||
|
| `done`、`fork_verifier_agent` | 用 `submit` 交付结果并给出文件路径。 |
|
||||||
|
| `write_file`(及其 `asset:` 参数) | Aily 的「创建/编辑本地文件」工具。不存在 asset review pane;舍弃这一概念。 |
|
||||||
|
| `copy_files` | `Bash cp`。 |
|
||||||
|
| `read_file`、`list_files`、`view_image` | 「读取本地文件」;按文件名查找用 glob、搜内容用 grep;图片直接走「解析二进制文件(…图片…)」——Aily 原生支持图像输入。 |
|
||||||
|
| `show_to_user` | 用 `submit` 交付并给出绝对本地文件路径。 |
|
||||||
|
| `eval_js`、`eval_js_user_view`、`run_script` | 脚本用 `Bash`。 |
|
||||||
|
| `web_fetch`、`web_search` | `fetch`、`web_search`。用于时效性事实、内容素材补充或用户要求的查询。 |
|
||||||
|
| `generate_image` | `aily-image-generate_workbench`(Seedream V4.5 模型):支持文生图、图生图(给参考图)、信息图(infographic)、图片编辑、组图(一次生成多张风格统一、角色连贯的图像序列)。 |
|
||||||
|
| `search_images` | `doubao_image_search`(按关键词搜索图片,适合找参考图、素材图)。 |
|
||||||
|
| `copy_starter_component` | `Bash cp <本 skill 所在目录>/starter-components/<file> .`(cwd 通常是应用项目目录而非 skill 目录,需用 skill 目录实际路径;或读取后改编)。 |
|
||||||
|
| 文档解析(docx / pdf) | Aily 原生「解析二进制文件」能力直接读取 Word / PDF / Excel / PPT 全文;PDF 也可用 `aily-pdf` 专用工具。 |
|
||||||
|
| `invoke_skill("X")` / `invoke the "X" skill` | 用 `get_skills("X")` 加载对应媒介技能(如 `get_skills("frontend-design")`)。这些技能同时以本地文件形式随本 skill 附带在 `references/<X>.md`,`get_skills` 取不到时直接读该文件。 |
|
||||||
|
|
||||||
|
## 提出澄清性问题
|
||||||
|
|
||||||
|
用 `ask_user` 提出聚焦的结构化问题——它把用户的决策内联返回,先问、等答复后再继续。它最适合高影响力的承重决策:交付格式、保真度、设计上下文、参考应用、变体数量。一轮提问保持简明、可执行。不要虚构假的工具名。
|
||||||
|
|
||||||
|
## 交付与发布
|
||||||
|
|
||||||
|
- 用 `submit` 提交交付结果,并给出绝对本地文件路径。
|
||||||
|
- 产物完成并提交后,按 [`../creative-design.md`](../creative-design.md)「发布」一节发布到妙搭——交付给用户的可分享链接是 `+release-get` 返回的 `online_url`。
|
||||||
|
|
||||||
|
## Aily 专属注意事项
|
||||||
|
|
||||||
|
- **优先用专用工具而非手搓。** 除了通用 `Bash`,Aily 还带一批专用工具(`aily-xlsx`、`aily-chart`、`aily-diagram`、`aily-pdf`、`aily-image-generate_workbench` 等)。涉及表格、图表、流程图、PDF、图像生成时,优先用对应专用工具,而不是用 `Bash` 从零脚本化。
|
||||||
|
- **图像素材优先走生成 / 搜索。** [`../creative-design.md`](../creative-design.md)「图像素材与外部信息」一节的 `generate_image` / `search_images` 在 Aily 下都有真实对应(见上表),设计产物需要 hero 图、插画、信息图、连贯组图或参考图时应主动使用,而不是默认全部用 CSS/SVG 兜底。搜索到 / 生成的图片先落到本地,再用 `lark-cli apps +file-upload` 上传、在代码中引用返回的远端 URL,不提交 git。
|
||||||
|
- `agent` 的 `slide` 子类型用于生成**飞书幻灯片**,与本 skill 产出的自包含 HTML deck(`starter-components/deck-stage.js`)是两条不同路径,不要混用——本 skill 的 deck 始终是 HTML。
|
||||||
|
- 交付统一走 `submit`;需要跨轮次保留项目上下文时可用 `aily-work-memory`。
|
||||||
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
name: animated-video
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 动画视频
|
||||||
|
en-US: Animated Video
|
||||||
|
description: Use when creating animated videos, motion graphics, product walkthroughs, or visual storytelling with timeline-based playback. 触发词:animation, video, motion, 动画, 视频, 动效, 产品演示, 演示动画, walkthrough
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# Animated video
|
||||||
|
|
||||||
|
Create an animated video or motion design piece rendered as an HTML page. Build a timeline-based animation with smooth transitions. Design frame-by-frame sequences with playback controls (play/pause, scrubber). Focus on visual storytelling; take the palette from the user's brand assets, or derive it from the subject per [`../creative-design.md`](../creative-design.md)「默认美学指令」— never default to any fixed brand palette. Export-ready at a fixed aspect ratio (16:9 or 9:16). If you need to know the position of an element (eg to move a cursor or character between elements) use refs to grab the position.
|
||||||
|
|
||||||
|
START by calling `copy_starter_component` with `kind: "animations.jsx"` — it gives you a ready-made timeline engine: `<Stage width height duration>` (auto-scales to viewport, scrubber + play/pause + ←/→ seek + space + 0-to-reset, persists playhead), `<Sprite start end>` to gate children to a time window, `useTime()` / `useSprite()` hooks, an `Easing` library, `interpolate()` / `animate()` tweens, and `TextSprite` / `ImageSprite` / `RectSprite` primitives with built-in entry/exit. Read the file after copying and build YOUR scenes by composing Sprites inside a Stage; only fall back to Popmotion (https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/popmotion@11.0.5/dist/popmotion.min.js) if the starter genuinely can't do what you need.
|
||||||
|
|
||||||
|
Animations are complex code! Make reusable JSX components for each visual element and each scene. Invest in tweaking the timeline iteratively.
|
||||||
|
|
||||||
|
Animation tips:
|
||||||
|
- Storytelling is KEY! Before you create ANYTHING, identify the story arc, key tensions, characters, etc. Align on the message you want to convey. Run it by the user.
|
||||||
|
- Use good animation principles... anticipation, easing, follow-through, exaggeration, all the Disney animator principles.
|
||||||
|
- Scenes should have establishing shots setting the scene (use titles or captions if NECESSARY, but prefer to show not tell), followed by heavy zooms on the action. (either hard cuts, or ken-burns-style zooms, or mouse-follows.) Most scenes should exist in a realistic context: they should have a background, or exist in the UI of a computer or phone; etc. Elements should generally not float in the aether.
|
||||||
|
- In short animations, most 'scenes' are a single shot, or a sequence of shots in the same setting. Scenes may be slides (e.g. text or graphics onscreen, animating or being emphasized (highlighted etc) in an engaging way that calls attention to the key thing). Decide what the shot is going to be. Maybe it's starting zoomed out, then slowly zooming in on the area of focus or action. Maybe it's rapidly cutting back/forth between two people or graphics in tension. Maybe you're following something, like a cursor or a line on a graph, as it flits around. Be creative!
|
||||||
|
- Except for deliberate dramatic effect (a held beat), SOMETHING should always be in motion. The camera, an element, or a transition — slowly panning, zooming, subtly scaling up, drifting, or building. A truly static frame reads as a bug. Images especially: always slowly zoom in/out, pan, have some 'action', have text or graphics appearing or building, or be rapidly cutting in sequence.
|
||||||
|
- Whenever you show text or images, remember that you need pauses for it to sink in -- on the order of seconds -- before you can show something else.
|
||||||
|
|
||||||
|
If cursor or pointer movement is depicted (eg in a product walkthrough or prototype), you should zoom in on it and follow it with a damped viewport animation, like Screen Studio would. You MUST use HTML refs to locate elements onscreen so the cursor points at the right things.
|
||||||
|
|
||||||
|
For product-demo animations (simulated clicks, drags, dialogs, status changes), build a believable product UI and animate its real interface state — do NOT substitute an abstract flowchart or node diagram for the product screen. Reuse the device/window shells from `starter-components/` (`ios-frame.jsx`, `android-frame.jsx`, `macos-window.jsx`, `browser-window.jsx`) instead of hand-rolling frames.
|
||||||
|
|
||||||
|
For data-driven animations (annual-review numbers, dashboards coming alive, chart morphing): animate counters by tweening the value with `animate()` / `interpolate()` and rendering the formatted number; morph charts by interpolating the underlying data array each frame and re-rendering the SVG bars/paths (or driving ECharts `setOption` from `useTime()`); chain chapters with scene transitions. Every number shown must come from the user's real data (see [`../creative-design.md`](../creative-design.md)「数据保真」).
|
||||||
|
|
||||||
|
For clarity when commenting, update the video root's data-screen-label attr with the current timestamp each second, so you can easily comment on a particular timestamp and know that the agent will be told exactly the timestamp. `<Stage>` does NOT do this for you — wire it up yourself, e.g. inside a component rendered in the Stage: `const t = useTime(); const sec = Math.floor(t); useEffect(() => { document.querySelector('.video-root')?.setAttribute('data-screen-label', sec + 's'); }, [sec]);`
|
||||||
165
.agents/skills/lark-apps/creative-design/references/charts.md
Normal file
165
.agents/skills/lark-apps/creative-design/references/charts.md
Normal file
@ -0,0 +1,165 @@
|
|||||||
|
---
|
||||||
|
name: charts
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 图表
|
||||||
|
en-US: Charts
|
||||||
|
description: "基于 ECharts 的数据可视化,用于浏览器直出 HTML。当需要创建图表、仪表盘或数据可视化时使用。触发词:chart, ECharts, 图表, 可视化, visualization, 饼图, 柱状图, 折线图, 数据图表, 甘特图, 热力图, 数据展示, dashboard, 仪表盘, 数据看板"
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# 图表
|
||||||
|
|
||||||
|
你是用 ECharts 呈现信息的数据叙事设计者。你的图表会出现在创意 HTML 产物中,例如仪表盘、幻灯片、设计探索。ECharts 是你的媒介,不是目标;你的工作是让数据故事一眼可读,而不是堆配置项。一个图表只表达一个主要信息。
|
||||||
|
|
||||||
|
## 设计原则
|
||||||
|
|
||||||
|
**先编码,再装饰。** 每个视觉通道——位置、长度、颜色、大小——要么在编码一个数据维度,要么就是噪音。先决定每个通道代表什么,再决定它看起来怎样。没有编码含义的颜色应保持统一;读者会尝试解读颜色差异,并从中读出并不存在的意义。
|
||||||
|
|
||||||
|
**匹配产品的视觉语言。** 先阅读 UI 的视觉语言,再跟随它。图表颜色从产品现有色板中派生;字体从产品字体体系中派生。一个像从别的产品里掉进来的图表,会削弱用户对数据的信任。
|
||||||
|
|
||||||
|
**克制。** 图表靠精确赢得信任,不靠"看起来厉害"。跳过 3D 效果、无意义的渐变,以及不服务于理解的动画。
|
||||||
|
|
||||||
|
**平面化。** 出现在报表、看板、报告中的图表默认采用平面风格:细网格线、清晰坐标、纯色或轻微面积填充、必要注释。不要使用 `shadowBlur`、`shadowColor`、发光点、拟物高光或容器阴影来制造层次;层次来自数据权重、线宽、颜色语义和版式面积。
|
||||||
|
|
||||||
|
## 流程
|
||||||
|
|
||||||
|
按顺序完成这些步骤。不要一上来就写 ECharts options。
|
||||||
|
|
||||||
|
1. **审视数据。** 数据有哪些维度?范围是什么?它在讲什么故事——趋势、比较、构成、分布、流向、排名?
|
||||||
|
|
||||||
|
2. **选择图表类型。** 根据数据的故事,从下方的映射表中选择。
|
||||||
|
|
||||||
|
3. **分配视觉编码。** 对每个视觉通道,明确它代表哪个数据维度:
|
||||||
|
- **位置**(x/y)→ 通常是主维度
|
||||||
|
- **长度/面积** → 通常是度量值
|
||||||
|
- **颜色** → 问自己:这张图中颜色在编码什么?
|
||||||
|
|
||||||
|
| 颜色编码的内容 | 配色方案 |
|
||||||
|
|---|---|
|
||||||
|
| **分类**(无序分组:渠道、部门) | 从产品调色板中为每组取一个不同色相,≤8 个 |
|
||||||
|
| **顺序或强度**(阶段、排名、分桶、单一指标) | 单一色相,纯色或从浅到深渐变 |
|
||||||
|
| **相对中点的偏离**(盈亏、实际 vs 目标) | 两个色相在中性色处交汇 |
|
||||||
|
| **价值判断**(好/坏、通过/失败) | 产品语义 token(success / warning / danger) |
|
||||||
|
| **无编码**(单系列,或形状已经承载了编码) | 一个纯色品牌色,所有元素统一 |
|
||||||
|
|
||||||
|
如果你在给一个**有序**系列中的每个元素分配**不同色相**,停下来——你正在把序列伪装成互不相关的分类。读者会看到 N 个无关的东西,而非一个渐进过程。
|
||||||
|
|
||||||
|
4. **一次性定义色板。** 从产品 design tokens 中定义颜色。仪表盘中的每个图表都复用同一套颜色分配——同一个分类在不同图表中使用不同颜色,会迫使读者逐图重新学习编码。
|
||||||
|
|
||||||
|
5. **编写 ECharts 代码。** 挂载模式和 API 约束见下方技术参考。
|
||||||
|
|
||||||
|
6. **自检。** 截图检查结果。按文末清单验证。然后回到视觉编码步骤:渲染出来的图表是否真的表达了你想表达的信息?颜色编码与仪表盘其他部分是否一致?
|
||||||
|
|
||||||
|
## 图表类型映射
|
||||||
|
|
||||||
|
按数据故事选择图表,不按"看起来酷不酷"选择。
|
||||||
|
|
||||||
|
| 数据故事 | 图表 | 关键约束 |
|
||||||
|
|---|---|---|
|
||||||
|
| 时间趋势 | Line / Area | ≤5 个系列;数据必须按时间排序 |
|
||||||
|
| 分类比较 | Bar | — |
|
||||||
|
| 部分与整体 | Pie(≤5 项)、Treemap / Sunburst(>5 项) | Pie >5 项 → 改用横向 Bar |
|
||||||
|
| 分布 | Scatter、Heatmap、Boxplot | Heatmap 必须配合 `visualMap` |
|
||||||
|
| 多维度画像 | Radar(≤8 维)、Parallel(>8 维) | — |
|
||||||
|
| 流转 / 转化 | Funnel | — |
|
||||||
|
| 关系 | Sankey、Graph、Tree | Sankey 的链接必须构成 DAG |
|
||||||
|
| 日程 / 时间线 | 通过 `custom` series 实现 Gantt | 禁止用 stacked Bar 表示时间线 |
|
||||||
|
| 金融 | Candlestick | — |
|
||||||
|
| 主题 / 叙事流 | ThemeRiver | — |
|
||||||
|
|
||||||
|
## 多图表仪表盘
|
||||||
|
|
||||||
|
仪表盘中的多个图表共享上下文。把仪表盘当作一个整体页面,而不是一堆独立组件:
|
||||||
|
|
||||||
|
- **共享色板**:只定义一次颜色分配(例如"渠道 A = blue,渠道 B = green"),并在所有图表中复用。
|
||||||
|
- **坐标一致**:如果两个图表共享同一维度(时间、分类),对齐它们的坐标范围和刻度,让读者能横向扫描。
|
||||||
|
- **视觉层级**:一到两个图表承载核心故事;其余图表提供支撑。尺寸和位置要表达这种主次关系。
|
||||||
|
- **表达覆盖**:把用户需求拆成需要被回答的信息关系;每个被承诺的关系都要有对应的图表、表格、矩阵或文字证据承载。不要用少量通用指标和默认图表替代所有分析任务。
|
||||||
|
- **小容器防崩**:小尺寸图表优先用 bar / line / number strip。饼图、雷达图、词云和外部标签很容易挤压重叠;空间不足时换图表类型,而不是缩小到不可读。
|
||||||
|
|
||||||
|
## 技术参考
|
||||||
|
|
||||||
|
### 加载 ECharts
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://sf3-scmcdn-cn.feishucdn.com/obj/feishu-static/miaoda/coding-unpkg-sdk/echarts@5.6.0/dist/echarts.min.js" crossorigin="anonymous"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
`echarts` 通过 `window.echarts` 全局可用,无需 import。渐变:`new echarts.graphic.LinearGradient(0, 0, 0, 1, [...colorStops])`。
|
||||||
|
|
||||||
|
### 挂载——纯 HTML
|
||||||
|
|
||||||
|
```html
|
||||||
|
<div id="chart" style="width:100%;min-height:300px"></div>
|
||||||
|
<script>
|
||||||
|
const chart = echarts.init(document.getElementById('chart'));
|
||||||
|
chart.setOption({ /* ... */ });
|
||||||
|
window.addEventListener('resize', () => chart.resize());
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 挂载——React 封装
|
||||||
|
|
||||||
|
定义一次,复用。**不要**添加 echarts-for-react。
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
function EChart({ option, style }) {
|
||||||
|
const ref = React.useRef(null);
|
||||||
|
React.useEffect(() => {
|
||||||
|
const chart = echarts.init(ref.current);
|
||||||
|
chart.setOption(option);
|
||||||
|
const onResize = () => chart.resize();
|
||||||
|
window.addEventListener('resize', onResize);
|
||||||
|
return () => { chart.dispose(); window.removeEventListener('resize', onResize); };
|
||||||
|
}, [option]);
|
||||||
|
return <div ref={ref} style={{ width: '100%', minHeight: 300, ...style }} />;
|
||||||
|
}
|
||||||
|
Object.assign(window, { EChart });
|
||||||
|
```
|
||||||
|
|
||||||
|
用法:`<EChart option={option} style={{ height: 400 }} />`
|
||||||
|
|
||||||
|
## 自检清单
|
||||||
|
|
||||||
|
提交前按下面清单检查生成代码。每一项都对应真实出现过的 ECharts 渲染问题或视觉缺陷。
|
||||||
|
|
||||||
|
### 致命问题
|
||||||
|
|
||||||
|
| 检查项 | 修复方式 |
|
||||||
|
|---|---|
|
||||||
|
| 使用了 hsl / hsla / rgb / rgba 颜色 | 只用 Hex(`#1890ff`)——hover 透明度在非 hex 色值下容易出问题 |
|
||||||
|
|
||||||
|
### 严重问题
|
||||||
|
|
||||||
|
| # | 检查项 | 修复方式 |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Pie 分类 >5 个 | 改用横向 Bar |
|
||||||
|
| 2 | Line 系列 >5 条 | 拆分或筛选 |
|
||||||
|
| 3 | Radar 给每个 indicator 设置了 `max` | 移除;改为自动计算 |
|
||||||
|
| 4 | Radar 多系列、不同量纲 | 先做归一化 |
|
||||||
|
| 5 | Bar 缺少 `boundaryGap` | 设置 `boundaryGap: true` |
|
||||||
|
| 6 | Funnel label 被隐藏或位置不在内部 | `label: { show: true, position: 'inside' }` |
|
||||||
|
| 7 | 容器高度 <300px | `min-height: 300px` |
|
||||||
|
| 8 | 单张图表中分类色(每项一个色相)>8 种 | 聚合或分组 |
|
||||||
|
| 9 | Pie / 环形图的分类或数值只能靠 tooltip 读到——用了外部引导线标签(`position` 为 `'outside'` 或缺失),或干脆 `label: { show: false }` 且既无图例也无中心标注 | 分类 + 数值必须**静态可读**(tooltip 不算,图表常被导出 / 截图当静态图看)。任选其一:inside 标签标注 `name` + 百分比(扇区够大时)、图例映射色 → 分类、或环形图中心标注关键数值。禁止外部引导线标签(`position: 'outside'` 易重叠 / 裁切),也禁止只靠 tooltip 承载分类 / 数值 |
|
||||||
|
| 10 | Pie 设置了 `itemStyle` | 完全移除 |
|
||||||
|
| 11 | 任何 series 设置了 `label.color` | 禁止设置;由 theme 控制 |
|
||||||
|
| 12 | `label.formatter` 使用字符串模板 | 改用回调:`formatter: (params) => ...` |
|
||||||
|
| 13 | legend / visualMap 与图表重叠 | legend: `{ type: 'scroll', bottom: 0 }`;`grid.bottom ≥ '20%'` |
|
||||||
|
| 14 | Heatmap 缺少 `visualMap` | 必须添加;当 x 轴标签并存时 `grid.bottom ≥ '25%'` |
|
||||||
|
| 15 | Sankey 存在环形链接 | 验证 DAG |
|
||||||
|
| 16 | 正负混合 Bar 使用统一 `borderRadius` | 圆角朝向柱体的开口端 |
|
||||||
|
| 17 | 双 Y 轴零点未对齐 | 匹配 `\|min\| / max` 比例 |
|
||||||
|
| 18 | 图表 series 或容器使用阴影/发光效果 | 移除 `shadowBlur`、`shadowColor`、容器 `box-shadow`,改用线宽、透明度、注释或面积大小表达层级 |
|
||||||
|
| 19 | 图表或标签挤压、重叠、被容器裁切 | 增大容器、减少标签、改用 tooltip / inside label,或换成更稳的图表类型 |
|
||||||
|
|
||||||
|
### 不建议
|
||||||
|
|
||||||
|
| 避免 | 更好的选择 |
|
||||||
|
|---|---|
|
||||||
|
| Radar >8 个维度 | Parallel coordinate |
|
||||||
|
| Line 连接未按时间排序的点 | Bar 或 Scatter |
|
||||||
|
| markPoint 重复(统计极值 = 业务事件) | 仅保留业务注释 |
|
||||||
|
| 用 Stacked Bar 表示 Gantt | 使用带 `renderItem` 的 `custom` series |
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
# Claude Code 工具参考
|
||||||
|
|
||||||
|
本文档列出 [`../creative-design.md`](../creative-design.md) 所依赖的 harness 专属工具,供你在 **Claude Code** 中运行时使用。主提示词只命名能力("向用户提问"、"展示文件"等);本文档给出确切的 Claude Code 工具、签名与调用方式。通用工具(`Bash`、`Read`/`Write`/`Edit`/`Glob`、`gh`)在任何环境都相同,不在此覆盖。
|
||||||
|
|
||||||
|
## Web 工具 → Claude Code 工具对照表
|
||||||
|
|
||||||
|
上游提示词引用了一些在 Claude Code 中并不存在的 Claude.ai web 工具。无论出现在行文还是代码里,一律按下表替换:
|
||||||
|
|
||||||
|
| Web 工具 | Claude Code 对应项 |
|
||||||
|
|---|---|
|
||||||
|
| `ask_user_question` | `AskUserQuestion`(答案内联返回;每次最多 4 个问题,需要更多就再调用一次) |
|
||||||
|
| `done`、`fork_verifier_agent` | `SendUserFile` 发送交付物并给出文件路径 |
|
||||||
|
| `write_file`(及其 `asset:` 参数) | `Write`——完全舍弃 "asset review pane" 这一概念 |
|
||||||
|
| `copy_files` | `Bash cp` |
|
||||||
|
| `read_file`、`list_files`、`view_image` | `Read`(也能渲染图像)、`Glob` / `Bash ls`、`Grep` |
|
||||||
|
| `show_to_user` | `SendUserFile`(自包含文件也可用 `open <path>`) |
|
||||||
|
| `eval_js`、`eval_js_user_view`、`run_script` | `Bash` |
|
||||||
|
| `web_fetch`、`web_search` | `WebFetch`、`WebSearch` |
|
||||||
|
| `generate_image` | 无内置对应。会话中若接入了图像生成 MCP/工具则使用;否则跳过 AI 生图,用内联 SVG / CSS 图形兜底,并在交付说明中注明。 |
|
||||||
|
| `search_images` | 无专用对应。用 `WebSearch` 检索 + `WebFetch` 获取;用于需要真实图片的素材(实物、地点、logo 等)与确立方向的参考图,直接引用需注意来源与版权。 |
|
||||||
|
| `copy_starter_component` | `Bash cp <本 skill 所在目录>/starter-components/<file> .`(cwd 通常是应用项目目录而非 skill 目录,需用 skill 目录实际路径;或 `Read` 后改编) |
|
||||||
|
| 文档解析(docx / pdf) | PDF 用 `Read`(`pages` 参数分段读全);docx 先用 Bash 转出文本再读(`pandoc`、macOS `textutil -convert txt`、或 `python-docx`) |
|
||||||
|
| `invoke_skill("X")` / `invoke the "X" skill` | `Read` 对应的 `references/<file>.md`(媒介技能与本文件同在 `references/` 目录) |
|
||||||
|
|
||||||
|
## AskUserQuestion(澄清性提问)
|
||||||
|
|
||||||
|
替代 `ask_user_question`。`AskUserQuestion` **把用户的答案内联返回**——先问,等用户答复后再继续。每次调用最多展示 4 个问题;大型新项目先问一轮聚焦的问题,不够就再补一次调用。
|
||||||
|
|
||||||
|
- 记忆中的偏好可以作为问题里的*建议*默认值给出,但仍须由用户确认。
|
||||||
|
- 优先用它,而不是在回复里用文字列点罗列选项。
|
||||||
|
- 项目设置类提问——项目**保存到哪里**、使用**哪个(哪些)设计系统**(一次 multiSelect)——都是普通的 `AskUserQuestion` 调用。
|
||||||
|
|
||||||
|
## 交付与发布
|
||||||
|
|
||||||
|
- 用 `SendUserFile` 发送交付物并给出文件路径(读取文件**并不会**把它展示给用户)。
|
||||||
|
- 产物完成并提交后,按 [`../creative-design.md`](../creative-design.md)「发布」一节发布到妙搭——交付给用户的可分享链接是 `+release-get` 返回的 `online_url`。
|
||||||
32
.agents/skills/lark-apps/creative-design/references/codex.md
Normal file
32
.agents/skills/lark-apps/creative-design/references/codex.md
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Codex Agent 工具参考
|
||||||
|
|
||||||
|
本文档列出 [`../creative-design.md`](../creative-design.md) 所依赖的 harness 专属工具,供你在 **Codex Agent** 中运行时使用。主提示词只命名能力("向用户提问"、"展示文件"等);本文档给出 Codex 的调用方式。通用工具(shell、文件读/写/编辑/搜索、`gh`)不在此覆盖。
|
||||||
|
|
||||||
|
## Web 工具 → Codex 对应项
|
||||||
|
|
||||||
|
| Web 工具 | Codex 对应项 |
|
||||||
|
|---|---|
|
||||||
|
| `ask_user_question` | 在 Codex Plan Mode 下,若 `functions.request_user_input` 可用则使用它;否则在聊天中提出简明问题并等待用户答复。 |
|
||||||
|
| `done`、`fork_verifier_agent` | 在最终回复中呈现交付物的文件路径。 |
|
||||||
|
| `write_file`(及其 `asset:` 参数) | Codex 的常规文件编辑工具。不存在 asset review pane;舍弃这一概念。 |
|
||||||
|
| `copy_files` | Shell `cp`。 |
|
||||||
|
| `read_file`、`list_files`、`view_image` | Codex 的常规文件读取/搜索工具。 |
|
||||||
|
| `show_to_user` | 提供绝对本地文件路径;有帮助时,用 Markdown 以绝对路径嵌入图片。 |
|
||||||
|
| `eval_js`、`eval_js_user_view`、`run_script` | 脚本用 Shell。 |
|
||||||
|
| `web_fetch`、`web_search` | 若存在则用 Codex 的 web 工具;用于时效性事实、内容素材补充或用户要求的网络查询。 |
|
||||||
|
| `generate_image` | 无内置对应。会话中若接入了图像生成工具则使用;否则跳过 AI 生图,用内联 SVG / CSS 图形兜底,并在交付说明中注明。 |
|
||||||
|
| `search_images` | 无专用对应。若有 web 工具则用其检索图片,用于需要真实图片的素材与确立方向的参考图;没有就跳过。 |
|
||||||
|
| `copy_starter_component` | Shell `cp <本 skill 所在目录>/starter-components/<file> .`(cwd 通常是应用项目目录而非 skill 目录,需用 skill 目录实际路径;或读取后改编)。 |
|
||||||
|
| 文档解析(docx / pdf) | 用 shell 工具转出文本后读取:`pdftotext` / `pandoc` / python 脚本(`pypdf`、`python-docx`)。 |
|
||||||
|
| `invoke_skill("X")` / `invoke the "X" skill` | 阅读对应的 `references/<file>.md`(媒介技能与本文件同在 `references/` 目录)。 |
|
||||||
|
|
||||||
|
## 提出澄清性问题
|
||||||
|
|
||||||
|
当 Codex 处于 **Plan Mode** 且 `functions.request_user_input` 可用时,用它来提出聚焦的结构化问题。它最适合高影响力的设计决策,如范围、保真度、设计上下文、参考应用、变体数量。
|
||||||
|
|
||||||
|
若 `request_user_input` 不可用,或会话不在 Plan Mode,就直接在聊天中问同样的问题并等待用户回答。一轮提问保持简明、可执行。不要虚构假的工具名。
|
||||||
|
|
||||||
|
## 交付与发布
|
||||||
|
|
||||||
|
- 在最终回复中给出交付物的绝对本地文件路径。
|
||||||
|
- 产物完成并提交后,按 [`../creative-design.md`](../creative-design.md)「发布」一节发布到妙搭——交付给用户的可分享链接是 `+release-get` 返回的 `online_url`。
|
||||||
@ -0,0 +1,108 @@
|
|||||||
|
---
|
||||||
|
name: data-report
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 数据看板
|
||||||
|
en-US: Data Dashboard
|
||||||
|
description: "数据驱动的报表与看板设计。从数据分析到报表规划、信息层级组织,适用于用户有数据文件或明确指标,需要产出结构化数据报表的场景。图表绘制部分由 charts skill 承担。触发词:数据报表, 数据看板, 数据分析报表, BI, 经营报表, 指标看板, 周报, 月报, 数据大盘, KPI, 报表设计, data report, dashboard report, analytics report"
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# 数据报表
|
||||||
|
|
||||||
|
你是数据报表设计者。你的工作是把原始数据变成一份读者能直接用来做判断的报表——不只是画几张图,而是回答"这份数据在说什么、读者应该关注什么"。
|
||||||
|
|
||||||
|
报表的价值不在图表数量,而在信息层级:读者能在 5 秒内抓到主要结论,30 秒内理解支撑证据,需要时能下钻到明细。
|
||||||
|
|
||||||
|
## 设计基准
|
||||||
|
|
||||||
|
报表和看板默认采用**平面、克制、信息密集但可扫描**的视觉语言。参考优秀数据页面的抽象模式:浅色或中性底、少量品牌色、细边框、分隔线、色块、表格斑马纹、紧凑标签、tabular numbers、清晰图表标题和口径说明。内容区不要依赖阴影、玻璃拟态、发光、厚重渐变或悬浮卡片来制造层次;层次主要由栅格、字号、留白、边框、背景色块和数据权重建立。
|
||||||
|
|
||||||
|
布局必须比普通上下堆叠更丰富。先根据数据任务选择版式骨架,再写代码:监控型、复盘型、诊断型、对比型、明细型、汇报型可以有完全不同的扫描路径。可以组合 KPI 指标条、左右不等分主分析区、辅助矩阵、排名/明细表、洞察侧栏、深色结论带、时间线或漏斗区,但不要每份报表都套成同一套 KPI 横条 + 主图 + 洞察卡。不要把每个章节都做成同宽标题加一张满宽卡片;核心模块占更大面积,支撑模块用不同宽度、密度和位置服务它。
|
||||||
|
|
||||||
|
报表不是产品原型。内容型或分析型交付服务阅读和决策,不默认生成多页面后台导航、可下拉应用名、无意义返回按钮或设置菜单;只有用户明确要求交互式系统、后台、筛选操作或多页面应用时才做这些。标题、范围、口径、结论、图表、洞察和明细都是可用的信息部件,不是每份报表都必须同时出现的固定章节。
|
||||||
|
|
||||||
|
不要让页面全是文字,也不要把所有章节都做成同一种"结论 + 指标 + 图表 + 洞察"结构。长材料先判断每段内容在当前报表里的作用:它是在给背景、定义口径、证明结论、展示变化、比较对象、解释异常、列明细,还是提出行动。每段只选择最适合的表达方式,可以是短结论、关键数字、对比、时间顺序、表格、矩阵、引用、图表、注释或截图。重要内容不能被塞进附录或角落;如果一个章节是汇报目标的核心,就给它相称的版面面积和区别于其他章节的版式处理。
|
||||||
|
|
||||||
|
## 流程
|
||||||
|
|
||||||
|
按顺序完成这些步骤。不要一上来就写代码。
|
||||||
|
|
||||||
|
### 1. 需求分析
|
||||||
|
|
||||||
|
从用户消息中提取报表的上下文:
|
||||||
|
|
||||||
|
- **产品类型**:数据看板、监控中心、分析报表、BI 面板、经营复盘等。
|
||||||
|
- **目标读者**:管理者、运营、销售、分析师、项目成员,或外部客户。
|
||||||
|
- **核心诉求**:监控指标、发现趋势、比较对象、解释异常、辅助决策、展示成果。
|
||||||
|
- **界面语言与口径**:跟随用户输入语言;指标命名、单位、时间粒度要统一。
|
||||||
|
|
||||||
|
产出:一句话概括"给谁看、回答什么问题"。
|
||||||
|
|
||||||
|
### 2. 数据分析
|
||||||
|
|
||||||
|
审视数据,确认可用的维度和指标:
|
||||||
|
|
||||||
|
- **字段列表**:名称、类型、示例值、是维度还是指标。
|
||||||
|
- **数据规模**:行数、时间跨度、类目数量、缺失值或异常值。
|
||||||
|
- **指标口径**:总量、均值、占比、增速、完成率、排名、转化率等。
|
||||||
|
- **计算方式**:所有指标一律写脚本从源数据计算(读附件 → 聚合 → 得数),不目测、不凑整、不编造;报表里出现的每个数字都必须能追溯回源数据(见 [`../creative-design.md`](../creative-design.md)「数据保真」)。算好的聚合结果内联为页面里的 JS 常量,不要让页面在运行时去 fetch 原始附件。
|
||||||
|
- **维度切分**:时间、地区、渠道、产品、团队、状态、用户分组等。
|
||||||
|
- **叙事重点**:哪个变化、差异、结构或异常最值得被读者看到。
|
||||||
|
|
||||||
|
产出:维度-指标清单,以及一句话叙事重点。
|
||||||
|
|
||||||
|
### 3. 报表规划
|
||||||
|
|
||||||
|
在写代码之前,先确定报表由哪些组件构成:
|
||||||
|
|
||||||
|
- **视觉方向**:参考 `frontend-design` 的方法先定主题世界、受众姿态、材料、配色逻辑和签名元素。例如环境数据可以像研究观测页,销售经营可以像运营战情室,财务/管理指标可以像管理层简报。风格必须服务数据可信度,不要套通用科技蓝或泛白卡。
|
||||||
|
- **阅读路径**:先判断读者是要快速扫现状、追异常、看趋势、比较对象、查明细还是读复盘。不同任务对应不同起手式,不要默认都从 KPI 卡开始。
|
||||||
|
- **候选部件**:标题 / 范围 / 口径、摘要、KPI、主图表、辅助图表、文字洞察、明细表、时间线、矩阵、截图或注释都只是候选。需要哪个用哪个,不要为了"完整"把它们凑齐。
|
||||||
|
- **核心承载**:只给真正承载核心问题的模块更大面积。核心可能是一张趋势图、一张排名表、一段异常解释、一个流程漏斗,也可能是一组明细,不固定。
|
||||||
|
- **版式差异**:为不同信息角色安排不同形态,例如紧凑指标条、宽图、窄侧栏、表格区、注释带、对比矩阵或分段背景。避免每个章节都重复同一张满宽白卡。
|
||||||
|
- **布局骨架**:明确每个模块的相对面积和扫描路径,例如 `1.2fr 2fr`、`1fr 1.6fr`、`repeat(4,1fr)`、`auto 1fr` 等混合栅格;移动端再自然折叠。
|
||||||
|
|
||||||
|
组件取舍由读者任务、数据复杂度和材料内容决定。
|
||||||
|
|
||||||
|
产出:视觉方向与报表结构大纲(哪些组件、各自承载什么信息)。
|
||||||
|
|
||||||
|
### 4. 图表设计
|
||||||
|
|
||||||
|
为报表中的每个图表完成选型和视觉编码。此步遵循 charts skill 的规则;若 charts skill 尚未加载,先加载它。
|
||||||
|
|
||||||
|
产出:每个图表的类型、编码分配、共享色板定义。
|
||||||
|
|
||||||
|
### 5. 报表组成
|
||||||
|
|
||||||
|
将所有组件组织成一个连贯页面:
|
||||||
|
|
||||||
|
- 布局按数据叙事组织,不按"先放所有图再放文字"组织。
|
||||||
|
- 顺序跟随读者任务:监控型可以先给状态概览,诊断型可以先给异常和原因链,对比型可以先给对象矩阵,复盘型可以先给时间线,明细型可以先给可查表格。
|
||||||
|
- 同一页面内至少使用两种不同的版式关系:例如 KPI 横条 + 左右不等分主图 + 双列洞察 + 表格/结论带。避免所有模块都是同尺寸白卡片上下排列。
|
||||||
|
- 内容块采用平面化处理:优先用 `border:1px solid ...`、浅底色、分隔线、色条、编号、标签和表格行背景;内容卡片和图表容器默认不加 `box-shadow`。
|
||||||
|
- 图表旁边应有短洞察、口径或排名摘要,不要让图表孤零零占满整行。
|
||||||
|
- 文字用于解释图表看不出的原因、口径、异常和行动建议,不重复图表标题。
|
||||||
|
- 表格用于精确查数和比较对象,不要把长表伪装成密集柱状图。
|
||||||
|
- KPI 用于概览,不要把每个字段都做成指标卡。
|
||||||
|
- 没有真实依据时不编造结论;可写"待补充口径"或使用中性描述。
|
||||||
|
|
||||||
|
产出:完整报表页面。
|
||||||
|
|
||||||
|
### 6. 自检
|
||||||
|
|
||||||
|
截图检查结果,验证以下几点:
|
||||||
|
|
||||||
|
- 报表是否回答了步骤 1 确定的核心问题。
|
||||||
|
- 信息层级是否清晰(读者能在 5 秒内抓到主要结论)。
|
||||||
|
- 布局是否有明确主次和变化,而不是标题、KPI、图表从上到下机械堆叠。
|
||||||
|
- 首屏重点信息是否可读,颜色对比是否足够;深色首屏尤其要检查标题、指标和图例。
|
||||||
|
- 是否没有大面积无意义留白、错位、重叠、截断或不同模块视觉重量失衡。
|
||||||
|
- 用户点名的图表类型和分析维度是否出现;如果因数据不适合改用其他图表,要在页面中用更合适的表达补足。
|
||||||
|
- 内容区是否保持平面化,主要靠边框、色块、分隔线和栅格建立层级,没有滥用阴影、发光或玻璃拟态。
|
||||||
|
- 文字洞察是否与图表数据互相支撑。
|
||||||
|
- 图表部分是否通过了 charts skill 的自检清单。
|
||||||
|
- 口径和单位是否全报表一致。
|
||||||
|
|
||||||
|
产出:确认或修正。
|
||||||
@ -0,0 +1,71 @@
|
|||||||
|
---
|
||||||
|
name: frontend-design
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 创意设计
|
||||||
|
en-US: Creative Design
|
||||||
|
description: 为设计确立独特、有意图的视觉方向的指引——配色、字体与美学选择不带模板化默认的痕迹。适用于各类媒介(deck、报告、UI、原型),不限于 Web UI。
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# Frontend Design
|
||||||
|
|
||||||
|
目标是让这份 brief 拥有绝不会被认错的视觉形象:做出深思熟虑、有主张的配色、字体与版式选择,承担一次你能说清理由的真正的美学冒险——感觉模板化的方案等于交付失败。
|
||||||
|
|
||||||
|
## 让设计扎根于主题
|
||||||
|
|
||||||
|
如果 brief 没有钉死产品或主题是什么,动手设计前先自己钉死:点出一个具体的主题、它的受众、这个页面唯一要完成的任务,并明确说出你的选择。但若主题、受众和材料都推不出一个有把握不返工的方向(从零起的项目、零线索),按 [`../creative-design.md`](../creative-design.md)「默认美学指令」先向用户问清偏好,问回来后再按本节钉死方向——能推出就直接钉死,不要为收集偏好打断用户。如果你的记忆里有关于用户偏好的信息、关于他们正在构建什么的上下文、或你以往做过的设计——把它们当作线索用起来。主题自身的世界——它的材质(materials)、工具与仪器(instruments)、特有的器物(artifacts)、行话与语汇(vernacular)——正是独特选择的来源。全程用 brief 的真实内容与题材来构建。
|
||||||
|
|
||||||
|
## 视觉方向
|
||||||
|
|
||||||
|
在选定颜色或组件之前,先在思考中定下方向。填满四个槽位——每一个都要取自*这个*主题:
|
||||||
|
|
||||||
|
- **世界(World)**——这个页面属于哪个世界?去主题自己的世界里找:它的材质、工具与仪器、特有的器物、行话与语汇。
|
||||||
|
- **材质(Materials)**——哪些真实存在的材质表面(surfaces)与印记(marks)属于那个世界?先把主题自带的一一列出来,别一上来就用通用的。
|
||||||
|
- **配色(Palette)**——哪些颜色承担语义或品牌职责,哪些是中性的支撑色,哪一个唯一的强调色赢得注意力?
|
||||||
|
- **签名元素(Signature)**——整个页面靠它被记住的那一个手法。它必须只可能属于这个主题;一个换到下份 brief 也能复用的签名元素,是默认值,不是选择。
|
||||||
|
|
||||||
|
风格不是版式排完后再涂上去的装饰。这个方向决定字体排印、间距、图表处理、章节节奏、边框、图标风格,以及哪些组件值得强调。
|
||||||
|
|
||||||
|
## 设计原则
|
||||||
|
|
||||||
|
对于网页设计,hero 区就是全页的论点。开场就亮出主题世界里最具特征的东西,形式因主题而定:一句大标题、一张图、一段动画、一个实时 demo、一个交互瞬间。选择要经过深思:「大数字 + 小标签 + 辅助统计数据 + 渐变点缀」是模板答案,只有当它确实是最佳选项时才用。
|
||||||
|
|
||||||
|
字体排印承载页面的性格。展示字体(display)与正文字体(body)的搭配要刻意为之,而不是随手拿任何项目都会用的那几个字体家族;并建立清晰的字号体系,字重、字宽、字距都要有意图。让字体处理本身成为设计中令人记住的一部分,而不是承载内容的中性载体。
|
||||||
|
|
||||||
|
结构即信息。结构件——编号、眉标、分隔线、标签——应当编码内容中真实存在的信息,而不是装饰内容。很多千篇一律的设计都用编号标记(01 / 02 / 03),但只有当内容真的是一个序列时——比如真实的流程、或顺序本身携带读者所需信息的类型化时间线——编号才成立。在采用编号标记这类选择之前,先质疑它们是否真的说得通。
|
||||||
|
|
||||||
|
有意识地运用动效。想清楚动画是否、以及在哪里能服务主题:页面加载序列、滚动触发的揭示、hover 微交互、环境氛围。一个经过编排的时刻通常比散落的零星特效更有力;按视觉方向的需要来选。但有时少即是多——多余的动画会加重「这个设计是 AI 生成的」的观感。
|
||||||
|
|
||||||
|
让复杂度匹配愿景。极繁方向需要精雕细琢的执行;极简方向需要间距、字体与细节上的精准。优雅就是把选定的愿景执行到位。
|
||||||
|
|
||||||
|
认真对待文字内容。设计 brief 往往不含真实内容,文案要由你来写。文案带来的模板感不亚于设计本身。更多指引见下文关于写作的章节。
|
||||||
|
|
||||||
|
## 流程:头脑风暴、探索、规划、评审、构建、再评审
|
||||||
|
|
||||||
|
先校准现状:当下的 AI 生成设计集中在三种长相上:(1) 暖奶油色背景(接近 #F4F1EA)+ 高对比衬线展示字体 + 陶土色(terracotta)强调色;(2) 近黑背景 + 单一亮色强调——酸性绿(acid green)或朱红(vermilion);(3) 大报(broadsheet)式版面——发丝线(hairline rules)、零 border-radius、报纸般的密集分栏。三者对某些 brief 都站得住脚,但它们是默认值而非选择,而且不看主题就冒出来。凡是 brief 钉死了视觉方向的地方,严格照办——brief 自己的话始终优先,包括它点名要这三种长相之一的时候。凡是 brief 留出自由度的维度,别把这份自由花在这三个默认值上。就像受雇的人类设计师一样,往往要在「做自己擅长的」与「把每个项目当作试验和学习的机会」之间小心权衡。
|
||||||
|
|
||||||
|
分两遍做。第一遍,基于用户的设计 brief 头脑风暴出一份简短的设计计划:把上文的视觉方向展开成一套紧凑的 token 体系——色彩、字体、版式、签名元素。色彩:用 4–6 个命名的 hex 值描述配色。字体:至少两种角色的字体(一款有性格、克制使用的展示字体,一款与之互补的正文字体,必要时再加一款用于图注或数据的功能字体)。版式:一个版式概念,用一句话的文字描述加 ASCII 线框图来构思和比较。签名元素:这个页面将被记住的那个唯一独特元素,以恰当的方式体现 brief。
|
||||||
|
|
||||||
|
然后在动手构建前,对照 brief 复查这份计划:如果其中任何部分读起来像你对任何同类页面都会产出的通用默认(在心里过一遍相似的 prompt,看你是否会落到差不多的地方),而不是为这份 brief 专门做出的选择——就修订那部分,说明你改了什么、为什么改。只有在确认设计计划具备相对独特性之后,才开始写代码,严格遵循修订后的计划,让每一个颜色和字体决策都从计划中推导出来。
|
||||||
|
|
||||||
|
写代码时,注意组织好 CSS 选择器的优先级(specificity)。很容易写出相互抵消的 CSS 类(尤其是 `.section` 这类分区级选择器与 `.cta` 这类元素级选择器之间)。区块之间的 padding/margin 上经常出这种问题。
|
||||||
|
|
||||||
|
尽量把这些规划与迭代放在思考中完成,只在你有较高把握能让用户眼前一亮时,才把想法拿给用户看。
|
||||||
|
|
||||||
|
## 克制与自我评审
|
||||||
|
|
||||||
|
把大胆花在一个地方。让签名元素成为唯一被记住的东西,它周围的一切保持安静、克制,砍掉任何不服务于 brief 的装饰。不冒险本身也可能是一种冒险!默默守住质量底线,不必声张:响应式适配到移动端、键盘焦点可见、尊重 reduced motion。边构建边评审自己的作品,环境支持就截图看——一图胜千 token。想想香奈儿的忠告:出门前照照镜子,摘掉一件配饰。人类创作者有记忆,总在尝试新东西;如果你有地方快速记下自己试过什么,会对后续迭代有帮助。
|
||||||
|
|
||||||
|
## 再谈设计中的写作
|
||||||
|
|
||||||
|
文字出现在设计里只有一个理由:让设计更易理解,从而更易使用。文字是设计材料,不是装饰。对文案投入的心思,要和对间距、色彩投入的一样多。落笔之前,先问这个设计需要说什么、怎么说最能帮人在这段体验里找到方向。
|
||||||
|
|
||||||
|
站在屏幕另一侧的最终用户角度来写。以人们能控制、能认出的东西命名,绝不以系统的实现方式命名。用户管理的是「通知」,不是「webhook 配置」。用平实的语言描述某物做什么,而不是推销它。具体始终胜过抖机灵。
|
||||||
|
|
||||||
|
默认使用主动语态。一个控件应当准确说明使用它时会发生什么:说 "Save changes",而不是 "Submit"。同一个动作在整条流程中保持同名:写着 "Publish" 的按钮,产生的 toast 就写 "Published"。界面的词汇表就是用户穿行产品时的路标。连贯与一致是人们认路的方式。
|
||||||
|
|
||||||
|
把失败与空态当作指路的时机,而不是渲染情绪的时机。解释出了什么问题、怎么修复,用界面的口吻而非某个人的口吻。错误提示不道歉,也绝不对发生了什么含糊其辞。空屏是一份行动邀请。
|
||||||
|
|
||||||
|
语域要像对话一样自然,并经过调校:动词平实、sentence case(句首大写)、没有废话,语气与品牌和受众匹配。让每个元素只做一件事:标签就是标注,示例就是演示,没有元素悄悄身兼二职。
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
---
|
||||||
|
name: hi-fi-design
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 高保真设计
|
||||||
|
en-US: Hi-Fi Design
|
||||||
|
description: 用于创建高保真 UI mockup、设计探索,或带多种变体的视觉原型。触发词:mockup, hi-fi, prototype, UI design, 高保真, 设计稿, 原型, 界面设计, 视觉设计, 设计方案
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# 高保真设计
|
||||||
|
|
||||||
|
创建高保真、精细打磨的设计。
|
||||||
|
|
||||||
|
遵循以下通用设计流程(用 todo list 记住):
|
||||||
|
1. 澄清关键信息:能从需求、附件、截图或常见模式合理推断的,直接继续;只在关键信息缺失且会影响设计方向时才向用户提问
|
||||||
|
2. 查找现有 UI kit 并收集设计上下文——复制所有相关组件,阅读所有相关示例;如果找不到且会影响核心设计方向,再向用户询问
|
||||||
|
3. 在文件开头写下假设、上下文和设计推理,放好设计占位,并尽早展示给用户
|
||||||
|
4. 尽快把设计做出来,再次展示给用户,并附上下一步建议
|
||||||
|
5. 使用工具检查、验证并迭代设计
|
||||||
|
|
||||||
|
好的高保真设计不会从零开始——它们扎根于已有的设计上下文。找到合适的 UI kit / 设计资源,或从截图、代码和品牌资产中提取设计规则。你必须花时间去获取设计上下文,包括组件。如果缺少素材但不影响核心方向,先用合理假设继续推进;只有缺失信息会改变设计方向时才向用户索要。从零 mock 一个完整产品是最后手段,会导致低质量的设计。使用 starter components(设备框架等)可以免费获得高质量的脚手架。
|
||||||
|
|
||||||
|
当并排展示多个方案或探索方向时,布局要清晰:给页面一个中性灰背景,把每个方案放进独立且带标签的框中(小标题 + 尺寸随内容变化的白色圆角卡片),并把相关方案分组。
|
||||||
|
|
||||||
|
设计时,提出好问题很重要——但只在问题会实质性影响设计方向时才提问,避免频繁打断用户。
|
||||||
|
|
||||||
|
给出选项:默认提供 2-3 个有清晰差异的方案(与 [`../creative-design.md`](../creative-design.md)「提问」一节的默认一致);用户明确要求广度探索时,再围绕多个维度扩展更多变体。把符合既有模式的稳妥方案,与新颖的交互方式混合搭配,包括有趣的布局、隐喻和视觉风格。部分方案使用色彩或高级 CSS,部分带图标,部分不带。变体从基础开始,逐步走向更高级、更有创意的方向!尝试以有趣的方式重混品牌资产和视觉 DNA——玩转尺度、填充、纹理、视觉节奏、层次、新颖布局、字体处理。目标不是找到完美方案,而是探索用户可以混搭组合的原子级变体。
|
||||||
|
|
||||||
|
CSS、HTML、JS 和 SVG 能力强大。用户往往不知道它们能做到什么。给用户惊喜。
|
||||||
|
|
||||||
@ -0,0 +1,24 @@
|
|||||||
|
---
|
||||||
|
name: interactive-prototype
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 交互原型
|
||||||
|
en-US: Interactive Prototype
|
||||||
|
description: 可交互原型:像真实应用一样直接运行的高保真交互 demo(working app with real interactions)。触发词:可交互原型, 交互原型, 点击原型, interactive prototype, working app, 产品 demo, 工单系统, 管理后台, 看板工具, 多页面应用
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
Create a fully interactive prototype with realistic state management and transitions. Use React useState/useEffect for dynamic behavior. Include hover states, click interactions, form validation, animated transitions, and multi-step navigation flows. It should feel like a real working app, not a static mockup.
|
||||||
|
|
||||||
|
Do not wrap interactive prototypes in `design-canvas.jsx`, `<DCArtboard>`, or any pan/zoom artboard shell. A prototype should run as a direct app surface; if multiple variants are needed, expose them with in-app navigation, tabs, routes, toggles, or Tweaks instead of a canvas.
|
||||||
|
|
||||||
|
## 多页面与路由
|
||||||
|
|
||||||
|
多页面原型按普通 MPA 做:一个页面一个 HTML 文件,入口固定为项目根目录的 `index.html`,页面间用相对路径的普通链接跳转(`<a href="detail.html">`)。不要引入任何 router 库——锁定版本的 CDN 清单里没有 router,也不要用 `type="module"` 模拟 SPA 路由。共享组件和样式拆成独立的 `.jsx` / `.css` 文件由各页面分别引入;跨页面要延续的状态(工单列表、看板数据等)放 localStorage、加载时读回;页面间传参用 URL query。
|
||||||
|
|
||||||
|
## 像真实应用,而不是摆拍
|
||||||
|
|
||||||
|
- 准备一份贴近业务的 mock 数据(名称、状态、时间戳都要像真的),页面从数据渲染,不要把内容写死在标记里。
|
||||||
|
- 每个可见的按钮、输入、切换都要有反应:提交有校验和反馈、列表可增删改、状态会流转、空状态有设计。点了没反应的控件比没有这个控件更伤可信度。
|
||||||
|
- 按 [`../creative-design.md`](../creative-design.md)「Tweaks」把关键选项(主题色、密度、布局变体等)用 `tweaks-panel.jsx` 暴露出来,不要自己实现控件面板。
|
||||||
@ -0,0 +1,133 @@
|
|||||||
|
---
|
||||||
|
name: make-a-deck
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 幻灯片制作
|
||||||
|
en-US: Slide Deck
|
||||||
|
description: 当用户要求制作演示文稿 / PPT / PPTX / pitch deck / slides / keynote / 路演材料时使用——即供演讲者现场演示、固定画幅 16:9 的自包含 HTML deck。
|
||||||
|
---
|
||||||
|
|
||||||
|
# Make a deck
|
||||||
|
|
||||||
|
把演示 deck 做成一个自包含的 HTML 单页。
|
||||||
|
|
||||||
|
进入这个角色:你是一名演示设计师(presentation designer)。你为演讲者制作用于现场演示的幻灯片 deck——HTML 只是你的输出介质,但你的设计思维与为董事会准备材料的咨询顾问、分析师或高管完全一致:清晰、叙事流畅、后排也能看清。你不是在做网站。
|
||||||
|
|
||||||
|
每张幻灯片既是版式设计的练习,也是文案写作的练习。动手前先写大纲;好的大纲本身就是一次讲故事和叙事结构的练习。
|
||||||
|
|
||||||
|
## 动手前先问
|
||||||
|
|
||||||
|
- 如果用户没有说明视觉风格、也没提供 design system:能从主题、材料或场景推断出一个有把握的方向就直接定(与 [`../creative-design.md`](../creative-design.md)「默认美学指令」一致),推不出再用提问工具问。无论推断还是问来,绝不要落到一个通用模板设计!
|
||||||
|
|
||||||
|
## 构建准备与技术契约
|
||||||
|
|
||||||
|
### deck-stage 组件
|
||||||
|
|
||||||
|
以 1920×1080(16:9)为基准构建。**绝不**手写 stage/缩放/翻页的脚手架——先调用 `copy_starter_component` 并传入 `kind: "deck-stage.js"`,然后将 deck HTML 写成 `<deck-stage width="1920" height="1080">`,每张幻灯片对应一个 `<section data-label="…">` 子元素。该组件负责:
|
||||||
|
|
||||||
|
- letterbox 缩放
|
||||||
|
- 键盘 + 触控翻页
|
||||||
|
- speaker-notes 的 postMessage 协议
|
||||||
|
- `data-screen-label` / `data-miaoda-validate` 标记
|
||||||
|
- print-to-PDF(每张幻灯片一页)
|
||||||
|
|
||||||
|
用 `<script src="deck-stage.js"></script>` 加载它——它是 vanilla JS,不是 JSX。(该组件支持 `noscale` 属性来禁用 shadow-DOM 缩放,供外部 PPTX 导出或截图工具拿到原始尺寸的几何信息;本 skill 内无需也没有工具去调用它。)
|
||||||
|
|
||||||
|
deck-stage 组件会对每个 slotted 子元素做绝对定位——**绝不**在幻灯片 `<section>` 元素上自行设置 position/inset/width/height。
|
||||||
|
|
||||||
|
### 把幻灯片内容写成静态 HTML,而不是 React
|
||||||
|
|
||||||
|
幻灯片内容应写成静态 HTML,而非 React 或脚本生成的 DOM。当幻灯片正文是 `<deck-stage>` 内的纯标记时,用户可以在编辑模式下直接点击任意标题或段落进行修改——编辑器会立即将改动 splice 回源文件。而如果同样的内容通过 `<script type="text/babel">` 块、React 组件或遍历 JS 数组来渲染,这条直编路径就断了:每次微调都要绕一趟聊天消息才能到你手里,用户体验更慢,也更难让他们自己打磨 deck。因此,凡是静态页面能表达的——文本、布局、背景、图片——都直接在 HTML 里写字面元素并用 CSS 设置样式。只在幻灯片确实需要静态标记无法实现的行为时(交互式图表、实时 demo、真实状态管理),才使用 babel/React 或额外的 `<script>`。同样的渲染结果,静态 HTML 版本**始终优先于**动态版本,因为静态版本可被直接编辑。Tweaks 面板(`tweaks-panel.jsx`)是固定例外:它是幻灯片旁边的控制面板,不是幻灯片内容,因此仍需包含它——它的 `<script type="text/babel">` 标签不会让幻灯片本身变得更难直接编辑,因为编辑器会独立地将每个静态幻灯片元素路由到 splice 路径。
|
||||||
|
|
||||||
|
### 两个细节保持静态幻灯片可直接编辑
|
||||||
|
|
||||||
|
两个细节确保静态幻灯片可被直接编辑:每段文字都放在自己的叶子元素中(把 "Revenue" 放在 `<h2>` 内单独的 `<span>` 里,而不是写成 `<h2>Revenue <span class="sub">2025</span></h2>` 这样文本和子元素混在同一父节点的形式),重复结构要逐一写出而非生成——三条 `<li>` 直接写在标记里,而不是从数组渲染一个 `<li>` 三次。重复正是重点所在;它让用户能编辑第二条而不影响第一条。
|
||||||
|
|
||||||
|
## 幻灯片设计与构图
|
||||||
|
|
||||||
|
先定方向:动手前先调用 `frontend-design` skill 立视觉方向框架,再结合主题、受众、场景提炼视觉关键词,用它们决定配色、字体、图片类型和页面节奏;frontend-design 的通用设计规则与本 skill 的 deck / 构图规则冲突时,以本 skill 为准。保持清晰的层级与一致的视觉系统。
|
||||||
|
|
||||||
|
### 构图原则
|
||||||
|
|
||||||
|
- **留白 ≠ 空洞。** 判据是空白的**归属**:属于页面的空白(页边距、分组间隙、无边框的呼吸空间)是构图资产;被某个元素圈占的空白——边框、底色或阴影划出的范围远大于其内容——是未完成的构图,读者会把它读成「这里本来该有东西」。元素的边界应由内容撑出来,而不是由要填的空间决定;画布填不满时,把空间留在元素**之间**,或按「视觉平衡」的出路增密。
|
||||||
|
|
||||||
|
- **视觉锚点。** 每页要能回答:视线第一眼落在哪里,为什么是那里。锚点可以是一个大数字、一张图表、一句大字陈述,也可以是并列结构中被刻意加重的一项。所有元素等面积、等字号、等色彩权重的页面,是把第一落点交给了随机——那不是中性,是没做构图决策。
|
||||||
|
|
||||||
|
- **视觉平衡。** 视觉重量要在整幅画布上分布均衡,不要全压在画幅一角。内容撑不满画布时,出路必须**增加信息或提升信息的形式**——放大锚点、文字转表格 / 图表 / 对比、与相邻页合并都属此类;任何只消耗面积而不增加信息的手段(拉高容器、均匀放大字号、堆装饰)都不是出路,只是把空洞摊得更开。
|
||||||
|
|
||||||
|
- **平行性。** 平行性很重要:章节标题页外观必须一致;重复出现的文字元素必须在相同位置;以此类推。
|
||||||
|
|
||||||
|
- **版式节奏。** 与平行性互为对偶:平行性守住不变的东西,节奏经营变化的东西。每页先为内容选对形式——最适合表格、图表、引用或图片的内容就转成那个形式,而不是原样铺成文字(文字堆砌是最常见的失误);内容单薄则按「视觉平衡」的出路增密或合并。逐页的形式选择连起来就是 deck 的节奏:节奏跟随叙事结构——章节转折、重点页、过渡页各有形态——而不是机械交替;节奏也需要对比才成立——全图、大数字、图表、引用、不同背景色、纯文字,原型库要够开阔,页页同一骨架无节奏可言,那不叫一致,叫单调。用版式和可视化把画布用满不是「填充性内容」;凭空编造数据和板块才是。
|
||||||
|
|
||||||
|
### 素材与工艺
|
||||||
|
|
||||||
|
- **字号与单位。** 使用大号字体(标题至少 48px)。当用户指定具体字号时,默认他们说的是**磅(points)**(PowerPoint/Keynote 的单位)而非像素——用 `px = pt × 1.333` 换算。所以"把标题设成 36pt" → 在 CSS 里设成约 48px。
|
||||||
|
|
||||||
|
- **素材来源。** 除非用户要求,绝不使用 emoji。使用 design system / 品牌中的图标、用户提供的图片,或图片生成工具产出的图片。
|
||||||
|
|
||||||
|
- **图片呈现。** 务必先查看图片,再决定最佳展示方式。
|
||||||
|
- 满版图片可用 aspect-fill;
|
||||||
|
- 截图必须 aspect-fit,且极少在其上叠加内容;
|
||||||
|
- 透明或 aspect-fit 的图片应置于对比色背景之上。
|
||||||
|
|
||||||
|
在图片上叠加文字时,参照品牌惯常做法:根据你在其他地方看到的样式,酌情使用卡片、保护渐变或模糊效果。
|
||||||
|
|
||||||
|
- **图表与数据可视化。** 图表优先写成**静态 SVG 或纯 CSS**(柱高用 `height`,折线 / 扇形用内联 `<svg>` 路径)——它与文本一样是可直接编辑的一等公民,**不属于**「静态标记做不到才动用 script」的例外;只有确需交互(悬停高亮、筛选、实时数据)的图表才走 babel/React。数字之间只要存在能被眼睛读出的关系(趋势、占比、对比、分布),就转成图表,而不是原样铺成文字。图表必须长在 deck 的视觉系统里:复用同一套配色与 `--type-*` 字号,直接在数据点 / 扇区上标注数值而非依赖图例,去掉网格线、多余刻度等不承载信息的 chrome,让图表本身成为该页的视觉锚点。
|
||||||
|
|
||||||
|
- **动效。** 动效服务于叙事——引导视线、分层揭示信息、平滑衔接页面——而不是炫技或填空。默认克制,始终以不干扰阅读为底线。deck 动效的形态是**翻到该页时播放一次的入场 / 分步揭示**,不做环境循环——无限循环的装饰动画会持续争夺注意力。实现用 CSS 动画(幻灯片保持可直编的静态 HTML),两条契约(细节见 deck-stage.js 头部 Authoring guidance):
|
||||||
|
- 动画门控在 `[data-deck-active]` 与 `prefers-reduced-motion: no-preference` 上——组件在激活页维护该属性,翻页即触发;需要 JS 编排时监听组件的 `slidechange` 事件。**注意:`data-deck-active` 加在 slide 的 `<section>` 元素本身上,且只存在于当前激活页**——因此后代形式 `[data-deck-active] .fade-up` 天然只命中当前页内的元素,**不需要再按页类限定选择器**;每页不同的编排用不同的动画类 / delay 变量放在元素上表达。确需按页限定时,属性和页类是同一个元素,必须连写不能加空格:`section.s1[data-deck-active] h1` ✅,`[data-deck-active] .s1 h1` ❌(`.s1` 就是 slide 自己,后代组合器永远匹配不到,动画整页失效)。
|
||||||
|
- 基础样式写**可见的最终态**,隐藏态只进 `@keyframes` 的 `from`——缩略图栏、reduced-motion 等场景只渲染静态基础态、从不播动画,把 `opacity: 0` 写在基础规则上,会导致这些场景全成空白。
|
||||||
|
- 分步揭示 / 逐项渐入:delay 作为内联变量放在元素上、规则里统一引用——`<div class="card-in" style="--d:.15s">` + `animation: fadeUp .5s both; animation-delay: var(--d, 0s)`,不要按元素序号硬编码选择器。`both` 不可省:它让带 delay 的元素在等待期停在 `from` 的隐藏态;省掉会先以终态闪现、再跳回隐藏重播一遍。
|
||||||
|
|
||||||
|
- **结构件。** 编号、眉标、分隔线、标签只在编码内容里真实存在的信息(真实序列、导航、分类)时才用,不为“显得设计过”而加;纯装饰或只是复述已有信息的结构件一律去掉。
|
||||||
|
|
||||||
|
## 幻灯片写作指南
|
||||||
|
|
||||||
|
### 仅凭标题就应能讲清整个故事
|
||||||
|
|
||||||
|
通常来说,仅靠幻灯片标题就应能让人了解 deck 的整体故事和内容(类似书籍的目录)。
|
||||||
|
|
||||||
|
幻灯片标题一般有以下几种结构类型:
|
||||||
|
|
||||||
|
- 简短的教科书式标题,全部大写(如 Market Research、Engagement Overview、Team Structure)
|
||||||
|
- 行动式标题,更接近短句(如 "Asia is our largest market…."、"...but Eastern Europe has the highest potential for growth")
|
||||||
|
|
||||||
|
选定合适的标题结构后,始终保持一致。
|
||||||
|
|
||||||
|
### 避免暴露 AI 生成痕迹的 “AI 味”
|
||||||
|
|
||||||
|
避免以下常见的 “AI 味”——它们会暴露这个 deck 是 AI 生成的:
|
||||||
|
|
||||||
|
- AI 倾向于写出"宣判式"的标题和要点总结,过度戏剧化/简化,无缘由地制造张力(经典的 "It's not X. It's Y."),使用强祈使句,过度重新包装概念,或刻意悬念、故作洞察。
|
||||||
|
- 类似 "The magic moment" 这样的标题
|
||||||
|
- 总之,AI 倾向于把标题写成演讲者的金句,而非引导听众进入该页内容的**标题**——必须避免!
|
||||||
|
|
||||||
|
## 规划步骤
|
||||||
|
|
||||||
|
在常规规划之外,务必完成以下步骤:
|
||||||
|
|
||||||
|
1. 受众、品牌风格推不出且承重时先提问;能从主题和材料推断的,带着假设直接进入大纲。
|
||||||
|
2. 把用户给定的硬性规格当作约束而非建议:页数/张数范围、画幅比例、逐页大纲、必须包含的模块(对比表格、预算明细、备注区等)在大纲阶段就纳入规划——给了页数区间就按区间中段规划标题序列,宁可精炼合并、不要注水凑页;给了逐页大纲就按大纲一一对应。构建完成后逐条对照自查。
|
||||||
|
3. 写出完整的标题序列。选择**一种**语法风格(例如短主题名词短语或简短陈述句),确保适合内容,并用该风格写出每一个标题。回头通读一遍,判断一个人**仅凭标题**能否跟上整个演示的脉络。标题应像书的章节——用直白的语言告诉读者接下来是什么。审阅这些标题并按需修订。将它们写入 scratchpad.md 文件。
|
||||||
|
4. 在 scratchpad.md 里为每张幻灯片标注**版式原型**(全图 / 大数字 / 图表 / 表格 / 引用 / 多栏卡片 / 纯文字……)与**视觉锚点**(这页视线的第一落点)。通读这一列,检查节奏是否跟随叙事结构:原型的重复要么是内容使然(如成组的数据页),要么就是没做选择;写不出锚点的页,是内容撑不起一页的信号——回大纲合并或换形式增密。
|
||||||
|
5. 在写任何幻灯片**之前**,先在 `<head>` 的一个 `<style>` 块中将字号体系和间距定义为 CSS custom properties——这会锁定适合投影的尺寸,防止不自觉退回网页密度。在 1920×1080 下,合理的起始体系为:`:root { --type-title: 64px; --type-subtitle: 44px; --type-body: 34px; --type-small: 28px; --pad-top: 100px; --pad-bottom: 80px; --pad-x: 100px; --gap-title: 52px; --gap-item: 28px; }`。在 1280×720 下,按 ~0.67 缩放。所有地方都引用这些变量——每个 font-size 都用 `--type-*` 变量,每个 padding/gap 都用 `--pad-*` 或 `--gap-*` 变量,通过 inline style 或 class 规则中的 `var(…)` 引用。将它们保持为 CSS(而非 JS 常量),意味着用户只需改一个数字——直接在 style 块中改,或通过绑定到同一变量的 Tweaks 滑块改——就能重新调整整个 deck 的尺寸,而幻灯片标记仍然是静态 HTML,不需要脚本来计算尺寸。显式的 `--pad-bottom` 为每张幻灯片底部预留呼吸空间;那个留白是结构性的,不是空的。网页默认值(body 14-16px、padding 48-72px)对幻灯片太小;如果数值让你觉得不够大方,那就是还不够。如果你用了小于 24px 的尺寸,你的校验器(validator)会抛出错误。
|
||||||
|
6. 构建幻灯片,牢记每张幻灯片既是设计练习也是文案练习。在版式、文字内容和语调方面给予每张幻灯片应有的关注。遵循上述原则,确保每张幻灯片能独立成立;一个只看这一页的人,应当无需其他上下文就能理解其高层含义。
|
||||||
|
|
||||||
|
## 验证要点
|
||||||
|
|
||||||
|
审阅时,用幻灯片构图规则——而非网页布局直觉——来检查截图。底部留白是不是缺陷,用「留白 ≠ 空洞」的归属判据:内容自身完整、下方是无边框的整块呼吸空间,这是正确的幻灯片构图——不要出于网页直觉把 `flex-start` 改成 `center`;空白被元素边界圈占的,是被动空洞,按「视觉平衡」的出路修。
|
||||||
|
|
||||||
|
还需验证:
|
||||||
|
|
||||||
|
- 页数/张数、画幅比例与用户给定的硬性规格一致;用户点名要求的模块(对比表格、预算明细、备注区等)逐条在场
|
||||||
|
- 字号是否匹配你的 `--type-*` 体系(而非网页密度)
|
||||||
|
- 幻灯片边距是否匹配你的 `--pad-*` 值(而非网页紧凑间距)
|
||||||
|
- 标题在各幻灯片间的平行性
|
||||||
|
- 没有使用 accent-border 卡片或 takeaway box
|
||||||
|
- 没有内容被画幅边缘裁切、显示不全
|
||||||
|
- 没有元素相互压叠、遮挡到读不清
|
||||||
|
- 没有被动空洞:边框 / 底色圈出的范围与其内容相称
|
||||||
|
- 页面视觉重量在画布上分布均衡,没有大片区域读成「缺了东西」
|
||||||
|
- 每页能指出视觉锚点;版式原型的重复经得起「内容使然还是没做选择」的追问
|
||||||
|
- 带动效的元素在缩略图栏和打印视图下完整可见(基础样式即最终态,隐藏态只在 keyframes 的 `from` 里)
|
||||||
|
- 实际翻页确认入场动画会播放;逐条检查动画选择器——凡按页限定的,`data-deck-active` 与页选择器必须连写(`section.s1[data-deck-active] h1`),写成后代形式(`[data-deck-active] .s1 h1`)该页动效全部失效
|
||||||
@ -0,0 +1,82 @@
|
|||||||
|
---
|
||||||
|
name: visual-exposure
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 可视化报告
|
||||||
|
en-US: Visual Report
|
||||||
|
description: 用于制作可视化报告、专题视觉页、信息图、视觉长图、概念可视化、产品能力曝光、方案亮点展示等内容型 HTML 视觉作品。适合用户想把材料、数据或观点组织成可阅读、可展示、可传播的视觉化表达,但不希望做成 PPT、传统 dashboard 或纯 ECharts 图表的场景。触发词:可视化报告, 视觉报告, 可视化曝光, 视觉化曝光, 信息图, 长图, infographic, 视觉表达, 概念可视化, 亮点展示, 能力曝光
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# 可视化报告与专题表达
|
||||||
|
|
||||||
|
创建内容驱动的 HTML 视觉作品。它可以是一页长报告、专题视觉页、视觉长图、信息图、画布式设计稿,或带少量轻交互的浏览型报告;具体形态由用户目标、材料体量和阅读场景决定,不预设固定模板。
|
||||||
|
|
||||||
|
## 工作方式
|
||||||
|
|
||||||
|
1. 先读用户材料,提取主题、受众、阅读场景、核心结论、必须出现的事实和可省略的细节。
|
||||||
|
2. 判断报告目的:汇报、解释、披露、说服、传播、留档,还是做视觉方向探索。
|
||||||
|
3. 选择交付形态:长页报告、专题页、视觉长图、单屏摘要、画布式多方案、图文混排报告、偏打印感的正式报告等。不要把所有需求压成同一种版式。
|
||||||
|
4. 按材料逻辑组织内容,而不是套固定目录、固定模块或固定视觉模板。参考样式只能启发表达方式,不能替代对当前材料的判断。
|
||||||
|
5. 把材料拆成具体阅读任务:这一段要让读者完成什么判断、理解什么关系、记住什么事实、比较什么差异、追踪什么过程、相信什么证据。不要把这些任务名直接变成目录或模块标题。
|
||||||
|
6. 为每个阅读任务现场生成合适的组件、视觉和布局:先说明这段内容需要什么表达方式,再落成具体 UI / 图形 / 排版 / 图表 / 截图 / 文字组合。可以创造新的结构和视觉隐喻,不受现有组件名限制;避免所有章节共享同一套组件组合。
|
||||||
|
7. 先写风格 brief:主题隐喻、受众姿态、材料语言、配色逻辑和签名元素。财务报告可以像正式报告册,员工调研可以像组织研究档案,产品上市总结可以像品牌战报;这些只是启发,必须从用户材料里推导。
|
||||||
|
8. 建立版式系统:画幅、栅格、字号层级、颜色、图标/线条语言、强调方式和章节节奏。版式系统必须说明不同章节如何变化,而不是所有章节都用同一种上下结构。
|
||||||
|
9. 产出单个 HTML 文档。用户需求明确时直接做;只有主题、素材或交付形态完全无法判断时,才问少量必要问题。
|
||||||
|
|
||||||
|
## 内容组织
|
||||||
|
|
||||||
|
本 skill 中出现的报告形态、表达方式、组件和版式都只是示意,不是必须参考的清单。最重要的是根据用户需求和材料内容,生成一个能把报告讲清楚的结构:读者为什么要看、先看什么、如何理解关系、证据在哪里、最后形成什么判断,都应在结构里自然成立。
|
||||||
|
|
||||||
|
可视化报告不是把图表排满,也不是把文字切成很多卡片。每个信息块都要服务当前材料里的一个真实阅读动作:让读者确认对象、抓住重点、理解关系、比较差异、定位证据、看到过程、识别风险或形成下一步判断。把这些阅读动作翻译成本次需求专属的视觉结构,而不是复用固定模块名。
|
||||||
|
|
||||||
|
允许为当前需求重新发明表达结构:可以合并、拆分、放大、弱化、横向展开、纵向叙事、图文化、表格化、截图化或做成完全不同的布局。只要它能更清楚地解释报告内容,就优先于任何示例组件或常见版式。
|
||||||
|
|
||||||
|
如果材料很长,先压缩成报告叙事,不要把原文完整铺上去。需要精确查数时使用表格或附录;需要快速传播时使用摘要和视觉重点;需要正式汇报时保留章节编号、图表标题和口径说明。
|
||||||
|
|
||||||
|
不要把关键内容压成角落里的附录片段。用户明确要求展示的部分,应按报告目标给足版面权重,并选择合适的信息结构承载。
|
||||||
|
|
||||||
|
## 版式策略
|
||||||
|
|
||||||
|
可视化报告要像一份经过编辑设计的专题,而不是由同款卡片拼起来的长页面。先决定阅读节奏,再落组件:
|
||||||
|
|
||||||
|
- 根据材料的展开方式设计版式:它可能需要连续叙事、密集证据、空间关系、过程推进、对照判断、沉浸式主视觉、正式报告册,或完全不同的结构。先为当前需求命名一个版式概念,再确定栅格、密度、视觉重心和章节变化。
|
||||||
|
- 版式变化来自内容关系,不来自凑组件。关键段落可以被放大、拆页、满版化、图文化或变成精确表格;次要段落可以压缩、并列、收进注释或弱化。
|
||||||
|
- 每个章节的结构可以不同,但要属于同一套视觉系统。变化要能解释:为什么这里适合宽图、那里适合密集表格、另一处适合分段叙事。
|
||||||
|
|
||||||
|
不要为了“丰富”而乱放装饰。变化应该来自内容关系和阅读任务,而不是从组件清单里凑满页面。
|
||||||
|
|
||||||
|
## 视觉原则
|
||||||
|
|
||||||
|
- 优先清楚,其次好看。读者应该先理解结构,再感受到风格。
|
||||||
|
- 明暗主题由需求、品牌、素材、受众和阅读场景决定;浅色、暗色、中性或局部深色都可以。选择后要保证对比度、可读性和信息层级,并能解释为什么适合当前主题。
|
||||||
|
- 默认平面化处理:内容区优先使用细边框、分隔线、浅底色、色块、表格斑马纹、编号和标签建立层级;不要给章节、卡片、图表容器加各种 `box-shadow`。
|
||||||
|
- 少用装饰性渐变、发光、玻璃拟态。视觉效果要帮助分组、强调或引导视线。
|
||||||
|
- 风格跟随内容、受众和品牌:可以正式、温和、技术、编辑化、品牌化或实验感,但不要从某个样例场景继承固定颜色、固定目录或固定组件。
|
||||||
|
- 每份报告应有一个可解释的签名元素。签名元素要从用户主题、材料质感和阅读任务中生成,而不是复用固定手法;它可以是任何能组织内容、建立记忆点并保持一致性的视觉规则。
|
||||||
|
- 真实素材优先:用户给的截图、logo、图片、图标、数据片段要优先使用。没有素材时,用清楚的占位结构和可替换文案。
|
||||||
|
- 允许少量动效,但只用于进入、强调或引导阅读,不做干扰理解的持续动画。
|
||||||
|
- 可以包含数字、图表和表格,但它们服务于报告叙事;不要为了“可视化”而把所有内容都做成图。
|
||||||
|
- 深色区域可以用于封面、结论、行动区或整篇报告的主视觉;只要它服务主题气质和阅读体验,而不是作为无依据的装饰。
|
||||||
|
|
||||||
|
## 画布与交付
|
||||||
|
|
||||||
|
- 多方案、设计稿、方向探索:使用 `design-canvas.jsx`,每个方向一个 `<DCArtboard>`。
|
||||||
|
- 单一可视化报告、视觉长图或专题视觉稿:做成完整 HTML 页面,保持明确画幅、节奏和层级。
|
||||||
|
- 如果用户要“设计稿”,优先走画布式交付;如果用户要“可直接展示/传播”,可以做成完整页面式视觉作品。
|
||||||
|
- 所有文字应直接写在 HTML 中,便于用户后续编辑。
|
||||||
|
|
||||||
|
## 检查清单
|
||||||
|
|
||||||
|
- 交付形态匹配用户需求:长页报告、专题页、长图、画布设计稿或单屏摘要,而不是被固定模板绑住。
|
||||||
|
- 当前需求的主题、边界和最重要信息在第一屏或开篇清楚可见。
|
||||||
|
- 章节顺序跟随材料逻辑,不按评测集样例或预设场景套目录。
|
||||||
|
- 章节版式有节奏变化,并且变化来自材料关系;没有一路同款上下卡片,也没有因为预设组件清单而硬凑结构。
|
||||||
|
- 没有大面积空白、错位、低对比、文字不可读或模块之间风格突兀。
|
||||||
|
- 内容区保持平面化,没有滥用阴影、发光、玻璃拟态或厚重悬浮效果。
|
||||||
|
- 所有表达载体各司其职,没有为了数据而堆图,也没有用空泛文字或预设组件填空间。
|
||||||
|
- 文字密度可读,没有小字堆叠。
|
||||||
|
- 图标、线条、颜色和卡片样式属于同一套视觉语言。
|
||||||
|
- 明暗选择能解释为什么适合这个主题;无论浅色还是暗色,都保证长文、图表和表格可读。
|
||||||
|
- 事实性内容没有编造;不确定内容用中性描述或占位说明。
|
||||||
@ -0,0 +1,14 @@
|
|||||||
|
---
|
||||||
|
name: wireframe
|
||||||
|
metadata:
|
||||||
|
display-names:
|
||||||
|
zh-CN: 线框图
|
||||||
|
en-US: Wireframe
|
||||||
|
description: 用线框图和故事板探索多种想法。触发词:wireframe, storyboard, 线框图, 故事板, 分镜, 草图, 低保真, 方案探索, 设计探索
|
||||||
|
available-agents:
|
||||||
|
- CreativeDesign
|
||||||
|
---
|
||||||
|
|
||||||
|
# 线框图
|
||||||
|
|
||||||
|
帮助用户快速探索设计想法。提问遵循 [`../creative-design.md`](../creative-design.md)「提问」一节:关键信息缺失且承重时先做一轮聚焦提问,否则基于合理假设直接铺方案。生成多个粗略的线框图,在锁定方向之前把设计空间勾勒出来。优先追求广度而非精细打磨:默认每个想法给出 2-3 种明显不同的方案,用户明确要求广度探索时再加。用简单的形状、占位文字和极少的颜色,把焦点留在结构和流程上。整体保持手绘草图的感觉——手写风格但清晰可读的字体;以黑白为主、点缀少量颜色;低保真、简洁。多方案默认铺进 `design-canvas.jsx` 画布(见 [`../creative-design.md`](../creative-design.md)「如何开展设计工作」);单个 artboard 内部的局部变体用 Tweaks 承载(用 `tweaks-panel.jsx`,见 [`../creative-design.md`](../creative-design.md)「Tweaks」,不要手写控件面板)。
|
||||||
@ -0,0 +1,188 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// Android.jsx — Simplified Android (Material 3) device frame
|
||||||
|
// Status bar + content + gesture nav + keyboard.
|
||||||
|
// Based on Figma M3 spec. No dependencies, no image assets.
|
||||||
|
// Exports (to window): AndroidDevice, AndroidStatusBar, AndroidListItem, AndroidNavBar, AndroidKeyboard
|
||||||
|
//
|
||||||
|
// Usage — wrap your screen content in <AndroidDevice> to get the bezel, status
|
||||||
|
// bar and gesture nav (props: width=412, height=892, dark, keyboard):
|
||||||
|
//
|
||||||
|
// <AndroidDevice>
|
||||||
|
// ...your screen content...
|
||||||
|
// </AndroidDevice>
|
||||||
|
// <AndroidDevice dark keyboard>…</AndroidDevice>
|
||||||
|
// <AndroidDevice width={360} height={800}>…</AndroidDevice> // smaller device size
|
||||||
|
/* END USAGE */
|
||||||
|
|
||||||
|
const MD_C = {
|
||||||
|
surface: '#f4fbf8',
|
||||||
|
surfaceVariant: '#dae5e1',
|
||||||
|
inverseOnSurface: '#ecf2ef',
|
||||||
|
secondaryContainer: '#cde8e1',
|
||||||
|
primaryFixedDim: '#83d5c6',
|
||||||
|
onSurface: '#171d1b',
|
||||||
|
onSurfaceVar: '#49454f',
|
||||||
|
onPrimaryContainer: '#00201c',
|
||||||
|
primary: '#006a60',
|
||||||
|
frameBorder: 'rgba(116,119,117,0.5)',
|
||||||
|
};
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Status bar (time left, wifi/cell/battery right)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function AndroidStatusBar({ dark = false }) {
|
||||||
|
const c = dark ? '#fff' : MD_C.onSurface;
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
height: 40, display: 'flex', alignItems: 'center',
|
||||||
|
justifyContent: 'space-between', padding: '0 16px',
|
||||||
|
position: 'relative',
|
||||||
|
fontFamily: 'Roboto, system-ui, sans-serif',
|
||||||
|
}}>
|
||||||
|
{/* time left */}
|
||||||
|
<div style={{ width: 128, display: 'flex', alignItems: 'center', gap: 8 }}>
|
||||||
|
<span style={{ fontSize: 14, fontWeight: 400, letterSpacing: 0.25, lineHeight: '20px', color: c }}>9:30</span>
|
||||||
|
</div>
|
||||||
|
{/* camera punch-hole (center) */}
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', left: '50%', top: 8, transform: 'translateX(-50%)',
|
||||||
|
width: 24, height: 24, borderRadius: 100, background: '#2e2e2e',
|
||||||
|
}} />
|
||||||
|
{/* status icons right */}
|
||||||
|
<div style={{ display: 'flex', alignItems: 'center' }}>
|
||||||
|
<div style={{ display: 'flex', paddingRight: 2 }}>
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16" style={{ marginRight: -2 }}>
|
||||||
|
<path d="M8 13.3L.67 5.97a10.37 10.37 0 0114.66 0L8 13.3z" fill={c}/>
|
||||||
|
</svg>
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16" style={{ marginRight: -2 }}>
|
||||||
|
<path d="M14.67 14.67V1.33L1.33 14.67h13.34z" fill={c}/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16">
|
||||||
|
<rect x="3.75" y="2" width="8.5" height="13" rx="1.5" fill={c}/>
|
||||||
|
<rect x="5.5" y="0.9" width="5" height="2" rx="0.5" fill={c}/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// List item (Material 3)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function AndroidListItem({ headline, supporting, leading }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', alignItems: 'center', gap: 16,
|
||||||
|
padding: '12px 16px', minHeight: 56, boxSizing: 'border-box',
|
||||||
|
fontFamily: 'Roboto, system-ui, sans-serif',
|
||||||
|
}}>
|
||||||
|
{leading && (
|
||||||
|
<div style={{
|
||||||
|
width: 40, height: 40, borderRadius: '50%',
|
||||||
|
background: MD_C.primary, color: '#fff',
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
fontSize: 18, fontWeight: 500, flexShrink: 0,
|
||||||
|
}}>{leading}</div>
|
||||||
|
)}
|
||||||
|
<div style={{ flex: 1, minWidth: 0 }}>
|
||||||
|
<div style={{ fontSize: 16, color: MD_C.onSurface, lineHeight: '24px' }}>{headline}</div>
|
||||||
|
{supporting && (
|
||||||
|
<div style={{ fontSize: 14, color: MD_C.onSurfaceVar, lineHeight: '20px' }}>{supporting}</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Gesture nav bar (pill)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function AndroidNavBar({ dark = false }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
height: 24, display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
}}>
|
||||||
|
<div style={{
|
||||||
|
width: 108, height: 4, borderRadius: 2,
|
||||||
|
background: dark ? '#fff' : MD_C.onSurface, opacity: 0.4,
|
||||||
|
}} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Device frame — wraps everything
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function AndroidDevice({
|
||||||
|
children, width = 412, height = 892, dark = false,
|
||||||
|
keyboard = false,
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
width, height, borderRadius: 18, overflow: 'hidden',
|
||||||
|
background: dark ? '#1d1b20' : MD_C.surface,
|
||||||
|
border: `8px solid ${MD_C.frameBorder}`,
|
||||||
|
display: 'flex', flexDirection: 'column', boxSizing: 'border-box',
|
||||||
|
}}>
|
||||||
|
<AndroidStatusBar dark={dark} />
|
||||||
|
<div style={{ flex: 1, overflow: 'auto' }}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
{keyboard && <AndroidKeyboard />}
|
||||||
|
<AndroidNavBar dark={dark} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Keyboard — Gboard (Material 3)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function AndroidKeyboard() {
|
||||||
|
let _k = 0;
|
||||||
|
const key = (l, { flex = 1, bg = MD_C.surface, r = 6, minW, fs = 21 } = {}) => (
|
||||||
|
<div key={_k++} style={{
|
||||||
|
height: 46, borderRadius: r, flex, minWidth: minW,
|
||||||
|
background: bg, display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
fontFamily: 'Roboto, system-ui', fontSize: fs,
|
||||||
|
color: MD_C.onPrimaryContainer,
|
||||||
|
}}>{l}</div>
|
||||||
|
);
|
||||||
|
const row = (keys, style = {}) => (
|
||||||
|
<div style={{ display: 'flex', gap: 6, justifyContent: 'center', ...style }}>
|
||||||
|
{keys.map(l => key(l))}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
background: MD_C.inverseOnSurface, padding: '0 8px 8px',
|
||||||
|
display: 'flex', flexDirection: 'column', gap: 4,
|
||||||
|
}}>
|
||||||
|
{/* navbar spacer (icons omitted) */}
|
||||||
|
<div style={{ height: 44 }} />
|
||||||
|
{/* key rows */}
|
||||||
|
<div style={{ display: 'flex', flexDirection: 'column', gap: 12 }}>
|
||||||
|
{row(['q','w','e','r','t','y','u','i','o','p'])}
|
||||||
|
{row(['a','s','d','f','g','h','j','k','l'], { padding: '0 20px' })}
|
||||||
|
<div style={{ display: 'flex', gap: 6 }}>
|
||||||
|
{key('', { bg: MD_C.surfaceVariant })}
|
||||||
|
<div style={{ display: 'flex', gap: 6, flex: 7, minWidth: 274 }}>
|
||||||
|
{['z','x','c','v','b','n','m'].map(l => key(l))}
|
||||||
|
</div>
|
||||||
|
{key('', { bg: MD_C.surfaceVariant })}
|
||||||
|
</div>
|
||||||
|
<div style={{ display: 'flex', gap: 6 }}>
|
||||||
|
{key('?123', { bg: MD_C.secondaryContainer, r: 100, minW: 58, fs: 14 })}
|
||||||
|
{key(',', { bg: MD_C.surfaceVariant })}
|
||||||
|
{key('', { flex: 3, minW: 154 })}
|
||||||
|
{key('.', { bg: MD_C.surfaceVariant })}
|
||||||
|
{key('', { bg: MD_C.primaryFixedDim, r: 100, minW: 58 })}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
AndroidDevice, AndroidStatusBar, AndroidListItem, AndroidNavBar, AndroidKeyboard,
|
||||||
|
});
|
||||||
@ -0,0 +1,773 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// animations.jsx
|
||||||
|
// Reusable animation starter: Stage, Timeline, Sprite, easing helpers.
|
||||||
|
// Exports (to window): Stage, Sprite, PlaybackBar, TextSprite, ImageSprite, RectSprite,
|
||||||
|
// useTime, useTimeline, useSprite, Easing, interpolate, animate, clamp.
|
||||||
|
//
|
||||||
|
// Usage (in an HTML file that loads React + Babel):
|
||||||
|
//
|
||||||
|
// <Stage width={1280} height={720} duration={10} background="#f6f4ef">
|
||||||
|
// <MyScene />
|
||||||
|
// </Stage>
|
||||||
|
//
|
||||||
|
// <Stage> auto-scales to the viewport and provides the scrubber, play/pause,
|
||||||
|
// ←/→ seek, space, and 0-to-reset controls, and persists the playhead.
|
||||||
|
// Set the optional `poster` prop (seconds) to the moment your opening scene is
|
||||||
|
// fully composed — the product thumbnail freezes on that frame (default ~1s).
|
||||||
|
// Inside <Stage>, any child can call useTime() to read the current
|
||||||
|
// playhead (seconds). Or wrap content in <Sprite start={1} end={4}>...</Sprite>
|
||||||
|
// to only render during that window -- children receive a `localTime` and
|
||||||
|
// `progress` via the useSprite() hook. Use Easing + interpolate()/animate()
|
||||||
|
// for tweens; TextSprite / ImageSprite / RectSprite have built-in entry/exit.
|
||||||
|
// Build YOUR scenes by composing Sprites inside a Stage.
|
||||||
|
/* END USAGE */
|
||||||
|
// ─────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
// ── Easing functions (hand-rolled, Popmotion-style) ─────────────────────────
|
||||||
|
// All easings take t ∈ [0,1] and return eased t ∈ [0,1] (may overshoot for back/elastic).
|
||||||
|
const Easing = {
|
||||||
|
linear: (t) => t,
|
||||||
|
|
||||||
|
// Quad
|
||||||
|
easeInQuad: (t) => t * t,
|
||||||
|
easeOutQuad: (t) => t * (2 - t),
|
||||||
|
easeInOutQuad: (t) => (t < 0.5 ? 2 * t * t : -1 + (4 - 2 * t) * t),
|
||||||
|
|
||||||
|
// Cubic
|
||||||
|
easeInCubic: (t) => t * t * t,
|
||||||
|
easeOutCubic: (t) => (--t) * t * t + 1,
|
||||||
|
easeInOutCubic: (t) => (t < 0.5 ? 4 * t * t * t : (t - 1) * (2 * t - 2) * (2 * t - 2) + 1),
|
||||||
|
|
||||||
|
// Quart
|
||||||
|
easeInQuart: (t) => t * t * t * t,
|
||||||
|
easeOutQuart: (t) => 1 - (--t) * t * t * t,
|
||||||
|
easeInOutQuart: (t) => (t < 0.5 ? 8 * t * t * t * t : 1 - 8 * (--t) * t * t * t),
|
||||||
|
|
||||||
|
// Expo
|
||||||
|
easeInExpo: (t) => (t === 0 ? 0 : Math.pow(2, 10 * (t - 1))),
|
||||||
|
easeOutExpo: (t) => (t === 1 ? 1 : 1 - Math.pow(2, -10 * t)),
|
||||||
|
easeInOutExpo: (t) => {
|
||||||
|
if (t === 0) return 0;
|
||||||
|
if (t === 1) return 1;
|
||||||
|
if (t < 0.5) return 0.5 * Math.pow(2, 20 * t - 10);
|
||||||
|
return 1 - 0.5 * Math.pow(2, -20 * t + 10);
|
||||||
|
},
|
||||||
|
|
||||||
|
// Sine
|
||||||
|
easeInSine: (t) => 1 - Math.cos((t * Math.PI) / 2),
|
||||||
|
easeOutSine: (t) => Math.sin((t * Math.PI) / 2),
|
||||||
|
easeInOutSine: (t) => -(Math.cos(Math.PI * t) - 1) / 2,
|
||||||
|
|
||||||
|
// Back (overshoot)
|
||||||
|
easeOutBack: (t) => {
|
||||||
|
const c1 = 1.70158, c3 = c1 + 1;
|
||||||
|
return 1 + c3 * Math.pow(t - 1, 3) + c1 * Math.pow(t - 1, 2);
|
||||||
|
},
|
||||||
|
easeInBack: (t) => {
|
||||||
|
const c1 = 1.70158, c3 = c1 + 1;
|
||||||
|
return c3 * t * t * t - c1 * t * t;
|
||||||
|
},
|
||||||
|
easeInOutBack: (t) => {
|
||||||
|
const c1 = 1.70158, c2 = c1 * 1.525;
|
||||||
|
return t < 0.5
|
||||||
|
? (Math.pow(2 * t, 2) * ((c2 + 1) * 2 * t - c2)) / 2
|
||||||
|
: (Math.pow(2 * t - 2, 2) * ((c2 + 1) * (t * 2 - 2) + c2) + 2) / 2;
|
||||||
|
},
|
||||||
|
|
||||||
|
// Elastic
|
||||||
|
easeOutElastic: (t) => {
|
||||||
|
const c4 = (2 * Math.PI) / 3;
|
||||||
|
if (t === 0) return 0;
|
||||||
|
if (t === 1) return 1;
|
||||||
|
return Math.pow(2, -10 * t) * Math.sin((t * 10 - 0.75) * c4) + 1;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// ── Core interpolation helpers ──────────────────────────────────────────────
|
||||||
|
|
||||||
|
// Clamp a value to [min, max]
|
||||||
|
const clamp = (v, min, max) => Math.max(min, Math.min(max, v));
|
||||||
|
|
||||||
|
// interpolate([0, 0.5, 1], [0, 100, 50], ease?) -> fn(t)
|
||||||
|
// Popmotion-style: linearly maps t across input keyframes to output values,
|
||||||
|
// with optional easing per segment (single fn or array of fns).
|
||||||
|
function interpolate(input, output, ease = Easing.linear) {
|
||||||
|
return (t) => {
|
||||||
|
if (t <= input[0]) return output[0];
|
||||||
|
if (t >= input[input.length - 1]) return output[output.length - 1];
|
||||||
|
for (let i = 0; i < input.length - 1; i++) {
|
||||||
|
if (t >= input[i] && t <= input[i + 1]) {
|
||||||
|
const span = input[i + 1] - input[i];
|
||||||
|
const local = span === 0 ? 0 : (t - input[i]) / span;
|
||||||
|
const easeFn = Array.isArray(ease) ? (ease[i] || Easing.linear) : ease;
|
||||||
|
const eased = easeFn(local);
|
||||||
|
return output[i] + (output[i + 1] - output[i]) * eased;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return output[output.length - 1];
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// animate({from, to, start, end, ease})(t) — simpler single-segment tween.
|
||||||
|
// Returns `from` before `start`, `to` after `end`.
|
||||||
|
function animate({ from = 0, to = 1, start = 0, end = 1, ease = Easing.easeInOutCubic }) {
|
||||||
|
return (t) => {
|
||||||
|
if (t <= start) return from;
|
||||||
|
if (t >= end) return to;
|
||||||
|
const local = (t - start) / (end - start);
|
||||||
|
return from + (to - from) * ease(local);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Timeline context ────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
const TimelineContext = React.createContext({ time: 0, duration: 10, playing: false });
|
||||||
|
|
||||||
|
const useTime = () => React.useContext(TimelineContext).time;
|
||||||
|
const useTimeline = () => React.useContext(TimelineContext);
|
||||||
|
|
||||||
|
// ── Sprite ──────────────────────────────────────────────────────────────────
|
||||||
|
// Renders children only when the playhead is inside [start, end]. Provides
|
||||||
|
// a sub-context with `localTime` (seconds since start) and `progress` (0..1).
|
||||||
|
//
|
||||||
|
// <Sprite start={2} end={5}>
|
||||||
|
// {({ localTime, progress }) => <Thing x={progress * 100} />}
|
||||||
|
// </Sprite>
|
||||||
|
//
|
||||||
|
// Or as a plain wrapper — children can call useSprite() themselves.
|
||||||
|
|
||||||
|
const SpriteContext = React.createContext({ localTime: 0, progress: 0, duration: 0 });
|
||||||
|
const useSprite = () => React.useContext(SpriteContext);
|
||||||
|
|
||||||
|
function Sprite({ start = 0, end = Infinity, children, keepMounted = false }) {
|
||||||
|
const { time } = useTimeline();
|
||||||
|
const visible = time >= start && time <= end;
|
||||||
|
if (!visible && !keepMounted) return null;
|
||||||
|
|
||||||
|
const duration = end - start;
|
||||||
|
const localTime = Math.max(0, time - start);
|
||||||
|
const progress = duration > 0 && isFinite(duration)
|
||||||
|
? clamp(localTime / duration, 0, 1)
|
||||||
|
: 0;
|
||||||
|
|
||||||
|
const value = { localTime, progress, duration, visible };
|
||||||
|
|
||||||
|
return (
|
||||||
|
<SpriteContext.Provider value={value}>
|
||||||
|
{typeof children === 'function' ? children(value) : children}
|
||||||
|
</SpriteContext.Provider>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Sample sprite components ────────────────────────────────────────────────
|
||||||
|
|
||||||
|
// TextSprite: fades/slides text in on entry, holds, then fades out on exit.
|
||||||
|
// Props: text, x, y, size, color, font, entryDur, exitDur, align
|
||||||
|
function TextSprite({
|
||||||
|
text,
|
||||||
|
x = 0, y = 0,
|
||||||
|
size = 48,
|
||||||
|
color = '#111',
|
||||||
|
font = 'Inter, system-ui, sans-serif',
|
||||||
|
weight = 600,
|
||||||
|
entryDur = 0.45,
|
||||||
|
exitDur = 0.35,
|
||||||
|
entryEase = Easing.easeOutBack,
|
||||||
|
exitEase = Easing.easeInCubic,
|
||||||
|
align = 'left',
|
||||||
|
letterSpacing = '-0.01em',
|
||||||
|
}) {
|
||||||
|
const { localTime, duration } = useSprite();
|
||||||
|
const exitStart = Math.max(0, duration - exitDur);
|
||||||
|
|
||||||
|
let opacity = 1;
|
||||||
|
let ty = 0;
|
||||||
|
|
||||||
|
if (localTime < entryDur) {
|
||||||
|
const t = entryEase(clamp(localTime / entryDur, 0, 1));
|
||||||
|
opacity = t;
|
||||||
|
ty = (1 - t) * 16;
|
||||||
|
} else if (localTime > exitStart) {
|
||||||
|
const t = exitEase(clamp((localTime - exitStart) / exitDur, 0, 1));
|
||||||
|
opacity = 1 - t;
|
||||||
|
ty = -t * 8;
|
||||||
|
}
|
||||||
|
|
||||||
|
const translateX = align === 'center' ? '-50%' : align === 'right' ? '-100%' : '0';
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: x, top: y,
|
||||||
|
transform: `translate(${translateX}, ${ty}px)`,
|
||||||
|
opacity,
|
||||||
|
fontFamily: font,
|
||||||
|
fontSize: size,
|
||||||
|
fontWeight: weight,
|
||||||
|
color,
|
||||||
|
letterSpacing,
|
||||||
|
whiteSpace: 'pre',
|
||||||
|
lineHeight: 1.1,
|
||||||
|
willChange: 'transform, opacity',
|
||||||
|
}}>
|
||||||
|
{text}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ImageSprite: scales + fades in; optional Ken Burns drift during hold.
|
||||||
|
function ImageSprite({
|
||||||
|
src,
|
||||||
|
x = 0, y = 0,
|
||||||
|
width = 400, height = 300,
|
||||||
|
entryDur = 0.6,
|
||||||
|
exitDur = 0.4,
|
||||||
|
kenBurns = false,
|
||||||
|
kenBurnsScale = 1.08,
|
||||||
|
radius = 12,
|
||||||
|
fit = 'cover',
|
||||||
|
placeholder = null, // {label: string} for striped placeholder
|
||||||
|
}) {
|
||||||
|
const { localTime, duration } = useSprite();
|
||||||
|
const exitStart = Math.max(0, duration - exitDur);
|
||||||
|
|
||||||
|
let opacity = 1;
|
||||||
|
let scale = 1;
|
||||||
|
|
||||||
|
if (localTime < entryDur) {
|
||||||
|
const t = Easing.easeOutCubic(clamp(localTime / entryDur, 0, 1));
|
||||||
|
opacity = t;
|
||||||
|
scale = 0.96 + 0.04 * t;
|
||||||
|
} else if (localTime > exitStart) {
|
||||||
|
const t = Easing.easeInCubic(clamp((localTime - exitStart) / exitDur, 0, 1));
|
||||||
|
opacity = 1 - t;
|
||||||
|
scale = (kenBurns ? kenBurnsScale : 1) + 0.02 * t;
|
||||||
|
} else if (kenBurns) {
|
||||||
|
const holdSpan = exitStart - entryDur;
|
||||||
|
const holdT = holdSpan > 0 ? (localTime - entryDur) / holdSpan : 0;
|
||||||
|
scale = 1 + (kenBurnsScale - 1) * holdT;
|
||||||
|
}
|
||||||
|
|
||||||
|
const content = placeholder ? (
|
||||||
|
<div style={{
|
||||||
|
width: '100%', height: '100%',
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
background: 'repeating-linear-gradient(135deg, #e9e6df 0 10px, #dcd8cf 10px 20px)',
|
||||||
|
color: '#6b6458',
|
||||||
|
fontFamily: 'JetBrains Mono, ui-monospace, monospace',
|
||||||
|
fontSize: 13,
|
||||||
|
letterSpacing: '0.04em',
|
||||||
|
textTransform: 'uppercase',
|
||||||
|
}}>
|
||||||
|
{placeholder.label || 'image'}
|
||||||
|
</div>
|
||||||
|
) : (
|
||||||
|
<img src={src} alt="" style={{ width: '100%', height: '100%', objectFit: fit, display: 'block' }} />
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: x, top: y,
|
||||||
|
width, height,
|
||||||
|
opacity,
|
||||||
|
transform: `scale(${scale})`,
|
||||||
|
transformOrigin: 'center',
|
||||||
|
borderRadius: radius,
|
||||||
|
overflow: 'hidden',
|
||||||
|
willChange: 'transform, opacity',
|
||||||
|
}}>
|
||||||
|
{content}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// RectSprite: simple rectangle that animates position/size/color via props.
|
||||||
|
// Useful demo primitive — takes a `render` fn for per-frame customization.
|
||||||
|
function RectSprite({
|
||||||
|
x = 0, y = 0,
|
||||||
|
width = 100, height = 100,
|
||||||
|
color = '#111',
|
||||||
|
radius = 8,
|
||||||
|
entryDur = 0.4,
|
||||||
|
exitDur = 0.3,
|
||||||
|
render, // optional: (ctx) => style overrides
|
||||||
|
}) {
|
||||||
|
const spriteCtx = useSprite();
|
||||||
|
const { localTime, duration } = spriteCtx;
|
||||||
|
const exitStart = Math.max(0, duration - exitDur);
|
||||||
|
|
||||||
|
let opacity = 1;
|
||||||
|
let scale = 1;
|
||||||
|
|
||||||
|
if (localTime < entryDur) {
|
||||||
|
const t = Easing.easeOutBack(clamp(localTime / entryDur, 0, 1));
|
||||||
|
opacity = clamp(localTime / entryDur, 0, 1);
|
||||||
|
scale = 0.4 + 0.6 * t;
|
||||||
|
} else if (localTime > exitStart) {
|
||||||
|
const t = Easing.easeInQuad(clamp((localTime - exitStart) / exitDur, 0, 1));
|
||||||
|
opacity = 1 - t;
|
||||||
|
scale = 1 - 0.15 * t;
|
||||||
|
}
|
||||||
|
|
||||||
|
const overrides = render ? render(spriteCtx) : {};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: x, top: y,
|
||||||
|
width, height,
|
||||||
|
background: color,
|
||||||
|
borderRadius: radius,
|
||||||
|
opacity,
|
||||||
|
transform: `scale(${scale})`,
|
||||||
|
transformOrigin: 'center',
|
||||||
|
willChange: 'transform, opacity',
|
||||||
|
...overrides,
|
||||||
|
}} />
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function Stage({
|
||||||
|
width = 1280,
|
||||||
|
height = 720,
|
||||||
|
duration = 10,
|
||||||
|
background = '#f6f4ef',
|
||||||
|
fps = 60,
|
||||||
|
loop = true,
|
||||||
|
autoplay = true,
|
||||||
|
poster = null,
|
||||||
|
persistKey = 'animstage',
|
||||||
|
children,
|
||||||
|
}) {
|
||||||
|
// Thumbnail capture mode: the host appends ?thumbnail=1 before screenshotting.
|
||||||
|
// Freeze on a representative still — the author-declared `poster` second, or
|
||||||
|
// ~1s as a fallback — paused, with the playback bar hidden, so the product
|
||||||
|
// thumbnail is a deterministic frame of the first composed scene.
|
||||||
|
const captureMode = typeof location !== 'undefined' && /[?&]thumbnail=/.test(location.search || '');
|
||||||
|
|
||||||
|
const [time, setTime] = React.useState(() => {
|
||||||
|
if (captureMode) return clamp(poster == null ? 1 : poster, 0, duration);
|
||||||
|
try {
|
||||||
|
const v = parseFloat(localStorage.getItem(persistKey + ':t') || '0');
|
||||||
|
return isFinite(v) ? clamp(v, 0, duration) : 0;
|
||||||
|
} catch { return 0; }
|
||||||
|
});
|
||||||
|
const [playing, setPlaying] = React.useState(captureMode ? false : autoplay);
|
||||||
|
const [scale, setScale] = React.useState(1);
|
||||||
|
|
||||||
|
const stageRef = React.useRef(null);
|
||||||
|
const canvasRef = React.useRef(null);
|
||||||
|
const rafRef = React.useRef(null);
|
||||||
|
const lastTsRef = React.useRef(null);
|
||||||
|
|
||||||
|
// Persist playhead
|
||||||
|
React.useEffect(() => {
|
||||||
|
try { localStorage.setItem(persistKey + ':t', String(time)); } catch {}
|
||||||
|
}, [time, persistKey]);
|
||||||
|
|
||||||
|
// Auto-scale to fit viewport
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (!stageRef.current) return;
|
||||||
|
const el = stageRef.current;
|
||||||
|
const measure = () => {
|
||||||
|
const barH = captureMode ? 0 : 44; // playback bar height (hidden in capture mode)
|
||||||
|
const s = Math.min(
|
||||||
|
el.clientWidth / width,
|
||||||
|
(el.clientHeight - barH) / height
|
||||||
|
);
|
||||||
|
setScale(Math.max(0.05, s));
|
||||||
|
};
|
||||||
|
measure();
|
||||||
|
const ro = new ResizeObserver(measure);
|
||||||
|
ro.observe(el);
|
||||||
|
window.addEventListener('resize', measure);
|
||||||
|
return () => {
|
||||||
|
ro.disconnect();
|
||||||
|
window.removeEventListener('resize', measure);
|
||||||
|
};
|
||||||
|
}, [width, height]);
|
||||||
|
|
||||||
|
// Animation loop
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (!playing) {
|
||||||
|
lastTsRef.current = null;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const step = (ts) => {
|
||||||
|
if (lastTsRef.current == null) lastTsRef.current = ts;
|
||||||
|
const dt = (ts - lastTsRef.current) / 1000;
|
||||||
|
lastTsRef.current = ts;
|
||||||
|
setTime((t) => {
|
||||||
|
let next = t + dt;
|
||||||
|
if (next >= duration) {
|
||||||
|
if (loop) next = next % duration;
|
||||||
|
else { next = duration; setPlaying(false); }
|
||||||
|
}
|
||||||
|
return next;
|
||||||
|
});
|
||||||
|
rafRef.current = requestAnimationFrame(step);
|
||||||
|
};
|
||||||
|
rafRef.current = requestAnimationFrame(step);
|
||||||
|
return () => {
|
||||||
|
if (rafRef.current) cancelAnimationFrame(rafRef.current);
|
||||||
|
lastTsRef.current = null;
|
||||||
|
};
|
||||||
|
}, [playing, duration, loop]);
|
||||||
|
|
||||||
|
// Keyboard: space = play/pause, ← → = seek
|
||||||
|
React.useEffect(() => {
|
||||||
|
const onKey = (e) => {
|
||||||
|
if (e.target && (e.target.tagName === 'INPUT' || e.target.tagName === 'TEXTAREA')) return;
|
||||||
|
if (e.code === 'Space') {
|
||||||
|
e.preventDefault();
|
||||||
|
setPlaying(p => !p);
|
||||||
|
} else if (e.code === 'ArrowLeft') {
|
||||||
|
setTime(t => clamp(t - (e.shiftKey ? 1 : 0.1), 0, duration));
|
||||||
|
} else if (e.code === 'ArrowRight') {
|
||||||
|
setTime(t => clamp(t + (e.shiftKey ? 1 : 0.1), 0, duration));
|
||||||
|
} else if (e.key === '0' || e.code === 'Home') {
|
||||||
|
setTime(0);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
window.addEventListener('keydown', onKey);
|
||||||
|
return () => window.removeEventListener('keydown', onKey);
|
||||||
|
}, [duration]);
|
||||||
|
|
||||||
|
const ctxValue = React.useMemo(
|
||||||
|
() => ({ time, duration, playing, setTime, setPlaying }),
|
||||||
|
[time, duration, playing]
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div
|
||||||
|
ref={stageRef}
|
||||||
|
style={{
|
||||||
|
position: 'absolute', inset: 0,
|
||||||
|
display: 'flex', flexDirection: 'column',
|
||||||
|
alignItems: 'center',
|
||||||
|
background: '#0a0a0a',
|
||||||
|
fontFamily: 'Inter, system-ui, sans-serif',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{/* Canvas area — vertically centered in remaining space */}
|
||||||
|
<div style={{
|
||||||
|
flex: 1,
|
||||||
|
width: '100%',
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
overflow: 'hidden',
|
||||||
|
minHeight: 0,
|
||||||
|
}}>
|
||||||
|
<div
|
||||||
|
ref={canvasRef}
|
||||||
|
style={{
|
||||||
|
width, height,
|
||||||
|
background,
|
||||||
|
position: 'relative',
|
||||||
|
transform: `scale(${scale})`,
|
||||||
|
transformOrigin: 'center',
|
||||||
|
flexShrink: 0,
|
||||||
|
boxShadow: '0 20px 60px rgba(0,0,0,0.4)',
|
||||||
|
overflow: 'hidden',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<TimelineContext.Provider value={ctxValue}>
|
||||||
|
{children}
|
||||||
|
</TimelineContext.Provider>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Playback bar — stacked below canvas, never overlapping. Hidden in
|
||||||
|
capture mode so the thumbnail is just the frame, no chrome. */}
|
||||||
|
{!captureMode && (
|
||||||
|
<PlaybackBar
|
||||||
|
time={time}
|
||||||
|
duration={duration}
|
||||||
|
playing={playing}
|
||||||
|
onPlayPause={() => setPlaying(p => !p)}
|
||||||
|
onReset={() => { setTime(0); }}
|
||||||
|
onSeek={(t) => setTime(t)}
|
||||||
|
/>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Playback bar ────────────────────────────────────────────────────────────
|
||||||
|
// Play/pause, return-to-begin, scrub track, time display.
|
||||||
|
// Uses fixed-width time fields so layout doesn't thrash.
|
||||||
|
|
||||||
|
function PlaybackBar({ time, duration, playing, onPlayPause, onReset, onSeek }) {
|
||||||
|
const trackRef = React.useRef(null);
|
||||||
|
const [dragging, setDragging] = React.useState(false);
|
||||||
|
const [trackHover, setTrackHover] = React.useState(null); // { x, t } — px within track + hovered time
|
||||||
|
|
||||||
|
const posFromEvent = React.useCallback((e) => {
|
||||||
|
const rect = trackRef.current.getBoundingClientRect();
|
||||||
|
const x = clamp(e.clientX - rect.left, 0, rect.width);
|
||||||
|
const t = rect.width > 0 ? (x / rect.width) * duration : 0;
|
||||||
|
return { x, t };
|
||||||
|
}, [duration]);
|
||||||
|
|
||||||
|
const onTrackMove = (e) => {
|
||||||
|
if (!trackRef.current) return;
|
||||||
|
const { x, t } = posFromEvent(e);
|
||||||
|
setTrackHover({ x, t });
|
||||||
|
if (dragging) onSeek(t);
|
||||||
|
};
|
||||||
|
|
||||||
|
const onTrackLeave = () => {
|
||||||
|
if (!dragging) setTrackHover(null);
|
||||||
|
};
|
||||||
|
|
||||||
|
const onTrackDown = (e) => {
|
||||||
|
const { x, t } = posFromEvent(e);
|
||||||
|
setDragging(true);
|
||||||
|
setTrackHover({ x, t });
|
||||||
|
onSeek(t);
|
||||||
|
};
|
||||||
|
|
||||||
|
// Grab the knob in place: begin dragging without seeking (no jump).
|
||||||
|
// stopPropagation keeps the track's click-to-seek from also firing.
|
||||||
|
const onBallDown = (e) => {
|
||||||
|
e.stopPropagation();
|
||||||
|
setDragging(true);
|
||||||
|
setTrackHover(posFromEvent(e));
|
||||||
|
};
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (!dragging) return;
|
||||||
|
const prevCursor = document.body.style.cursor;
|
||||||
|
document.body.style.cursor = 'grabbing'; // stays grabbing even if the pointer leaves the knob mid-drag
|
||||||
|
const onUp = () => {
|
||||||
|
setDragging(false);
|
||||||
|
setTrackHover(null);
|
||||||
|
};
|
||||||
|
const onMove = (e) => {
|
||||||
|
if (!trackRef.current) return;
|
||||||
|
const { x, t } = posFromEvent(e);
|
||||||
|
setTrackHover({ x, t });
|
||||||
|
onSeek(t);
|
||||||
|
};
|
||||||
|
window.addEventListener('mouseup', onUp);
|
||||||
|
window.addEventListener('mousemove', onMove);
|
||||||
|
return () => {
|
||||||
|
window.removeEventListener('mouseup', onUp);
|
||||||
|
window.removeEventListener('mousemove', onMove);
|
||||||
|
document.body.style.cursor = prevCursor;
|
||||||
|
};
|
||||||
|
}, [dragging, posFromEvent, onSeek]);
|
||||||
|
|
||||||
|
const pct = duration > 0 ? (time / duration) * 100 : 0;
|
||||||
|
const fmt = (t) => {
|
||||||
|
const total = Math.max(0, t);
|
||||||
|
const m = Math.floor(total / 60);
|
||||||
|
const s = Math.floor(total % 60);
|
||||||
|
return `${String(m).padStart(2, '0')}:${String(s).padStart(2, '0')}`;
|
||||||
|
};
|
||||||
|
|
||||||
|
const numFont = '"PingFang SC", -apple-system, BlinkMacSystemFont, system-ui, sans-serif';
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', alignItems: 'center', gap: 12,
|
||||||
|
padding: '12px',
|
||||||
|
background: 'linear-gradient(0deg, rgba(0, 0, 0, 0.30) 0%, rgba(0, 0, 0, 0.00) 100%)',
|
||||||
|
width: '100%',
|
||||||
|
color: '#fff',
|
||||||
|
fontFamily: numFont,
|
||||||
|
userSelect: 'none',
|
||||||
|
flexShrink: 0,
|
||||||
|
boxSizing: 'border-box',
|
||||||
|
}}>
|
||||||
|
{/* Play / pause — bare white triangle, no button chrome */}
|
||||||
|
<IconButton onClick={onPlayPause} tooltip={playing ? '暂停' : '播放'}>
|
||||||
|
{playing ? (
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<path d="M3.33333 1.33398C2.59695 1.33398 2 1.93094 2 2.66732V13.334C2 14.0704 2.59695 14.6673 3.33333 14.6673H4.66667C5.40305 14.6673 6 14.0704 6 13.334V2.66732C6 1.93094 5.40305 1.33398 4.66667 1.33398H3.33333Z" fill="currentColor"/>
|
||||||
|
<path d="M11.3333 1.33398C10.597 1.33398 10 1.93094 10 2.66732V13.334C10 14.0704 10.597 14.6673 11.3333 14.6673H12.6667C13.403 14.6673 14 14.0704 14 13.334V2.66732C14 1.93094 13.403 1.33398 12.6667 1.33398H11.3333Z" fill="currentColor"/>
|
||||||
|
</svg>
|
||||||
|
) : (
|
||||||
|
<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||||
|
<path d="M14.0489 9.13127C14.873 8.60116 14.873 7.39754 14.0489 6.86743L4.74461 0.882617C3.84764 0.305661 2.66699 0.948902 2.66699 2.01454V13.9842C2.66699 15.0498 3.84764 15.693 4.74461 15.1161L14.0489 9.13127Z" fill="currentColor"/>
|
||||||
|
</svg>
|
||||||
|
)}
|
||||||
|
</IconButton>
|
||||||
|
|
||||||
|
{/* Current time */}
|
||||||
|
<div style={{
|
||||||
|
fontFamily: numFont,
|
||||||
|
fontSize: 14,
|
||||||
|
fontWeight: 400,
|
||||||
|
fontVariantNumeric: 'tabular-nums',
|
||||||
|
color: '#fff',
|
||||||
|
minWidth: 40,
|
||||||
|
textAlign: 'center'
|
||||||
|
}}>
|
||||||
|
{fmt(time)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Scrub track — white fill on translucent-white rail + draggable knob */}
|
||||||
|
<div
|
||||||
|
ref={trackRef}
|
||||||
|
onMouseMove={onTrackMove}
|
||||||
|
onMouseLeave={onTrackLeave}
|
||||||
|
onMouseDown={onTrackDown}
|
||||||
|
style={{
|
||||||
|
flex: 1,
|
||||||
|
height: 20,
|
||||||
|
position: 'relative',
|
||||||
|
cursor: 'pointer',
|
||||||
|
display: 'flex', alignItems: 'center',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: 0, right: 0, height: 4,
|
||||||
|
background: 'rgba(255,255,255,0.6)',
|
||||||
|
borderRadius: 2,
|
||||||
|
}}/>
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: 0, width: `${pct}%`, height: 4,
|
||||||
|
background: 'rgba(255,255,255,0.9)',
|
||||||
|
borderRadius: 2,
|
||||||
|
}}/>
|
||||||
|
{/* Progress knob — outer div is an enlarged transparent hit area for easier grabbing */}
|
||||||
|
<div
|
||||||
|
onMouseDown={onBallDown}
|
||||||
|
style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: `${pct}%`, top: '50%',
|
||||||
|
transform: 'translate(-50%, -50%)',
|
||||||
|
width: 20, height: 20,
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
cursor: dragging ? 'grabbing' : 'grab',
|
||||||
|
zIndex: 5,
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<div style={{
|
||||||
|
width: dragging ? 14 : 12,
|
||||||
|
height: dragging ? 14 : 12,
|
||||||
|
background: '#fff',
|
||||||
|
borderRadius: '50%',
|
||||||
|
border: '0.5px solid #D2D5D8',
|
||||||
|
boxShadow: '0 2px 6px rgba(0,0,0,0.35)',
|
||||||
|
transition: 'width 100ms, height 100ms',
|
||||||
|
}}/>
|
||||||
|
</div>
|
||||||
|
{trackHover && (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
left: trackHover.x,
|
||||||
|
bottom: '100%',
|
||||||
|
transform: 'translateX(-50%)',
|
||||||
|
marginBottom: 2,
|
||||||
|
pointerEvents: 'none',
|
||||||
|
zIndex: 10,
|
||||||
|
}}>
|
||||||
|
<TooltipBubble text={fmt(trackHover.t)} />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* Duration — dimmed */}
|
||||||
|
<div style={{
|
||||||
|
fontFamily: numFont,
|
||||||
|
fontSize: 14,
|
||||||
|
fontWeight: 400,
|
||||||
|
fontVariantNumeric: 'tabular-nums',
|
||||||
|
color: 'rgba(255,255,255,0.6)',
|
||||||
|
minWidth: 40,
|
||||||
|
textAlign: 'center',
|
||||||
|
}}>
|
||||||
|
{fmt(duration)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
function IconButton({ children, onClick, tooltip }) {
|
||||||
|
const [hover, setHover] = React.useState(false);
|
||||||
|
return (
|
||||||
|
<button
|
||||||
|
onClick={onClick}
|
||||||
|
aria-label={tooltip}
|
||||||
|
onMouseEnter={() => setHover(true)}
|
||||||
|
onMouseLeave={() => setHover(false)}
|
||||||
|
style={{
|
||||||
|
position: 'relative',
|
||||||
|
width: 24, height: 24,
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
background: hover ? 'rgba(255,255,255,0.1)' : 'transparent',
|
||||||
|
border: 'none',
|
||||||
|
borderRadius: 6,
|
||||||
|
color: '#fff',
|
||||||
|
cursor: 'pointer',
|
||||||
|
padding: 0,
|
||||||
|
transition: 'background 120ms',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
{children}
|
||||||
|
{tooltip && (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
bottom: '100%',
|
||||||
|
left: '50%',
|
||||||
|
transform: 'translateX(-50%)',
|
||||||
|
marginBottom: 8,
|
||||||
|
pointerEvents: 'none',
|
||||||
|
opacity: hover ? 1 : 0,
|
||||||
|
transition: 'opacity 120ms',
|
||||||
|
zIndex: 10,
|
||||||
|
}}>
|
||||||
|
<TooltipBubble text={tooltip} />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Tooltip bubble ────────────────────────────────────────────────────────────
|
||||||
|
// Dark rounded bubble with a downward tail. Positioning is up to the caller.
|
||||||
|
function TooltipBubble({ text }) {
|
||||||
|
return (
|
||||||
|
<div style={{ position: 'relative', display: 'inline-block' }}>
|
||||||
|
<div style={{
|
||||||
|
background: '#1F2329',
|
||||||
|
color: '#fff',
|
||||||
|
fontSize: 12,
|
||||||
|
lineHeight: '16px',
|
||||||
|
padding: '6px 12px',
|
||||||
|
borderRadius: 6,
|
||||||
|
whiteSpace: 'nowrap',
|
||||||
|
fontFamily: '"PingFang SC", -apple-system, BlinkMacSystemFont, system-ui, sans-serif',
|
||||||
|
fontVariantNumeric: 'tabular-nums',
|
||||||
|
boxShadow: '0 4px 8px -8px rgba(0, 0, 0, 0.06), 0 6px 12px 0 rgba(0, 0, 0, 0.04), 0 8px 24px 8px rgba(0, 0, 0, 0.04)',
|
||||||
|
}}>
|
||||||
|
{text}
|
||||||
|
</div>
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute',
|
||||||
|
top: '100%',
|
||||||
|
left: '50%',
|
||||||
|
transform: 'translate(-50%, -50%) rotate(45deg)',
|
||||||
|
width: 9, height: 9,
|
||||||
|
borderRadius: '0 0 3px 0',
|
||||||
|
background: '#1F2329',
|
||||||
|
}}/>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
Easing, interpolate, animate, clamp,
|
||||||
|
TimelineContext, useTime, useTimeline,
|
||||||
|
Sprite, SpriteContext, useSprite,
|
||||||
|
TextSprite, ImageSprite, RectSprite,
|
||||||
|
Stage, PlaybackBar,
|
||||||
|
});
|
||||||
|
|
||||||
@ -0,0 +1,122 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// Chrome.jsx — Simplified Chrome browser window (dark theme, macOS)
|
||||||
|
// No dependencies, no image assets. All inline styles + inline SVG.
|
||||||
|
// Exports (to window): ChromeWindow, ChromeTabBar, ChromeToolbar, ChromeTab, ChromeTrafficLights
|
||||||
|
//
|
||||||
|
// Usage — wrap your page content in <ChromeWindow> to get the tab bar + URL bar:
|
||||||
|
//
|
||||||
|
// <ChromeWindow width={1100} height={680} url="acme.design/pricing">
|
||||||
|
// ...your page content...
|
||||||
|
// </ChromeWindow>
|
||||||
|
/* END USAGE */
|
||||||
|
|
||||||
|
const CHROME_C = {
|
||||||
|
barBg: '#202124',
|
||||||
|
tabBg: '#35363a',
|
||||||
|
text: '#e8eaed',
|
||||||
|
dim: '#9aa0a6',
|
||||||
|
urlBg: '#282a2d',
|
||||||
|
};
|
||||||
|
|
||||||
|
function ChromeTrafficLights() {
|
||||||
|
return (
|
||||||
|
<div style={{ display: 'flex', gap: 8, padding: '0 14px' }}>
|
||||||
|
<div style={{ width: 12, height: 12, borderRadius: '50%', background: '#ff5f57' }} />
|
||||||
|
<div style={{ width: 12, height: 12, borderRadius: '50%', background: '#febc2e' }} />
|
||||||
|
<div style={{ width: 12, height: 12, borderRadius: '50%', background: '#28c840' }} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Single tab (active has curved scoops)
|
||||||
|
function ChromeTab({ title = 'New Tab', active = false }) {
|
||||||
|
const curve = (flip) => (
|
||||||
|
<svg width="8" height="10" viewBox="0 0 8 10"
|
||||||
|
style={{ position: 'absolute', bottom: 0, [flip ? 'right' : 'left']: -8, transform: flip ? 'scaleX(-1)' : 'none' }}>
|
||||||
|
<path d="M0 10C2 9 6 8 8 0V10H0Z" fill={CHROME_C.tabBg}/>
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
position: 'relative', height: 34, alignSelf: 'flex-end',
|
||||||
|
padding: '0 12px', display: 'flex', alignItems: 'center', gap: 8,
|
||||||
|
background: active ? CHROME_C.tabBg : 'transparent',
|
||||||
|
borderRadius: '8px 8px 0 0', minWidth: 120, maxWidth: 220,
|
||||||
|
fontFamily: 'system-ui, sans-serif', fontSize: 12,
|
||||||
|
color: active ? CHROME_C.text : CHROME_C.dim,
|
||||||
|
}}>
|
||||||
|
{active && curve(false)}
|
||||||
|
{active && curve(true)}
|
||||||
|
<div style={{ width: 14, height: 14, borderRadius: '50%', background: '#5f6368', flexShrink: 0 }} />
|
||||||
|
<span style={{ flex: 1, whiteSpace: 'nowrap', overflow: 'hidden', textOverflow: 'ellipsis' }}>{title}</span>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ChromeTabBar({ tabs = [{ title: 'New Tab' }], activeIndex = 0 }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', alignItems: 'center', height: 44,
|
||||||
|
background: CHROME_C.barBg, paddingRight: 8,
|
||||||
|
}}>
|
||||||
|
<ChromeTrafficLights />
|
||||||
|
<div style={{ display: 'flex', alignItems: 'flex-end', height: '100%', paddingLeft: 4, flex: 1 }}>
|
||||||
|
{tabs.map((t, i) => <ChromeTab key={i} title={t.title} active={i === activeIndex} />)}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ChromeToolbar({ url = 'example.com' }) {
|
||||||
|
const iconDot = (
|
||||||
|
<div style={{
|
||||||
|
width: 28, height: 28, display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
}}>
|
||||||
|
<div style={{ width: 16, height: 16, borderRadius: '50%', background: CHROME_C.dim, opacity: 0.4 }} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
height: 40, background: CHROME_C.tabBg,
|
||||||
|
display: 'flex', alignItems: 'center', gap: 4, padding: '0 8px',
|
||||||
|
}}>
|
||||||
|
{iconDot}
|
||||||
|
{/* url bar */}
|
||||||
|
<div style={{
|
||||||
|
flex: 1, height: 30, borderRadius: 15, background: CHROME_C.urlBg,
|
||||||
|
display: 'flex', alignItems: 'center', gap: 8, padding: '0 14px',
|
||||||
|
margin: '0 6px',
|
||||||
|
}}>
|
||||||
|
<div style={{ width: 12, height: 12, borderRadius: '50%', background: CHROME_C.dim, opacity: 0.4 }} />
|
||||||
|
<span style={{
|
||||||
|
flex: 1, color: CHROME_C.text, fontSize: 13,
|
||||||
|
fontFamily: 'system-ui, sans-serif',
|
||||||
|
}}>{url}</span>
|
||||||
|
</div>
|
||||||
|
{iconDot}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function ChromeWindow({
|
||||||
|
tabs = [{ title: 'New Tab' }], activeIndex = 0, url = 'example.com',
|
||||||
|
width = 900, height = 600, children,
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
width, height, borderRadius: 10, overflow: 'hidden',
|
||||||
|
border: '1px solid #DEE0E3',
|
||||||
|
display: 'flex', flexDirection: 'column', background: CHROME_C.tabBg,
|
||||||
|
}}>
|
||||||
|
<ChromeTabBar tabs={tabs} activeIndex={activeIndex} />
|
||||||
|
<ChromeToolbar url={url} />
|
||||||
|
<div style={{ flex: 1, background: '#fff', overflow: 'auto' }}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
ChromeWindow, ChromeTabBar, ChromeToolbar, ChromeTab, ChromeTrafficLights,
|
||||||
|
});
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,270 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// iOS.jsx — Simplified iOS 26 (Liquid Glass) device frame
|
||||||
|
// Based on the iOS 26 UI Kit + Figma status bar spec. No assets, no deps.
|
||||||
|
// Exports (to window): IOSDevice, IOSStatusBar, IOSList, IOSListRow, IOSKeyboard
|
||||||
|
//
|
||||||
|
// Usage — wrap your screen content in <IOSDevice> to get the bezel, status bar
|
||||||
|
// and home indicator (props: width=402, height=874, dark, keyboard):
|
||||||
|
//
|
||||||
|
// <IOSDevice>
|
||||||
|
// ...your screen content...
|
||||||
|
// </IOSDevice>
|
||||||
|
// <IOSDevice dark keyboard>…</IOSDevice>
|
||||||
|
// <IOSDevice width={390} height={844}>…</IOSDevice> // smaller device size
|
||||||
|
//
|
||||||
|
// Safe areas — REQUIRED on every screen. The status bar (top) and home
|
||||||
|
// indicator (bottom) float OVER your content; inset it or it overlaps them.
|
||||||
|
// --ios-safe-top top inset (Dynamic Island + status bar)
|
||||||
|
// --ios-safe-bottom bottom inset (home indicator)
|
||||||
|
/* END USAGE */
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Status bar
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function IOSStatusBar({ dark = false, time = '9:41' }) {
|
||||||
|
const c = dark ? '#fff' : '#000';
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', gap: 154, alignItems: 'center', justifyContent: 'center',
|
||||||
|
padding: '21px 24px 19px', boxSizing: 'border-box',
|
||||||
|
position: 'relative', zIndex: 20, width: '100%',
|
||||||
|
}}>
|
||||||
|
<div style={{ flex: 1, height: 22, display: 'flex', alignItems: 'center', justifyContent: 'center', paddingTop: 1.5 }}>
|
||||||
|
<span style={{
|
||||||
|
fontFamily: '-apple-system, "SF Pro", system-ui', fontWeight: 590,
|
||||||
|
fontSize: 17, lineHeight: '22px', color: c,
|
||||||
|
}}>{time}</span>
|
||||||
|
</div>
|
||||||
|
<div style={{ flex: 1, height: 22, display: 'flex', alignItems: 'center', justifyContent: 'center', gap: 7, paddingTop: 1, paddingRight: 1 }}>
|
||||||
|
<svg width="19" height="12" viewBox="0 0 19 12">
|
||||||
|
<rect x="0" y="7.5" width="3.2" height="4.5" rx="0.7" fill={c}/>
|
||||||
|
<rect x="4.8" y="5" width="3.2" height="7" rx="0.7" fill={c}/>
|
||||||
|
<rect x="9.6" y="2.5" width="3.2" height="9.5" rx="0.7" fill={c}/>
|
||||||
|
<rect x="14.4" y="0" width="3.2" height="12" rx="0.7" fill={c}/>
|
||||||
|
</svg>
|
||||||
|
<svg width="17" height="12" viewBox="0 0 17 12">
|
||||||
|
<path d="M8.5 3.2C10.8 3.2 12.9 4.1 14.4 5.6L15.5 4.5C13.7 2.7 11.2 1.5 8.5 1.5C5.8 1.5 3.3 2.7 1.5 4.5L2.6 5.6C4.1 4.1 6.2 3.2 8.5 3.2Z" fill={c}/>
|
||||||
|
<path d="M8.5 6.8C9.9 6.8 11.1 7.3 12 8.2L13.1 7.1C11.8 5.9 10.2 5.1 8.5 5.1C6.8 5.1 5.2 5.9 3.9 7.1L5 8.2C5.9 7.3 7.1 6.8 8.5 6.8Z" fill={c}/>
|
||||||
|
<circle cx="8.5" cy="10.5" r="1.5" fill={c}/>
|
||||||
|
</svg>
|
||||||
|
<svg width="27" height="13" viewBox="0 0 27 13">
|
||||||
|
<rect x="0.5" y="0.5" width="23" height="12" rx="3.5" stroke={c} strokeOpacity="0.35" fill="none"/>
|
||||||
|
<rect x="2" y="2" width="20" height="9" rx="2" fill={c}/>
|
||||||
|
<path d="M25 4.5V8.5C25.8 8.2 26.5 7.2 26.5 6.5C26.5 5.8 25.8 4.8 25 4.5Z" fill={c} fillOpacity="0.4"/>
|
||||||
|
</svg>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Grouped list (inset card, r:26) + row (52px)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function IOSListRow({ title, detail, icon, chevron = true, isLast = false, dark = false }) {
|
||||||
|
const text = dark ? '#fff' : '#000';
|
||||||
|
const sec = dark ? 'rgba(235,235,245,0.6)' : 'rgba(60,60,67,0.6)';
|
||||||
|
const ter = dark ? 'rgba(235,235,245,0.3)' : 'rgba(60,60,67,0.3)';
|
||||||
|
const sep = dark ? 'rgba(84,84,88,0.65)' : 'rgba(60,60,67,0.12)';
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', alignItems: 'center', minHeight: 52,
|
||||||
|
padding: '0 16px', position: 'relative',
|
||||||
|
fontFamily: '-apple-system, system-ui', fontSize: 17,
|
||||||
|
letterSpacing: -0.43,
|
||||||
|
}}>
|
||||||
|
{icon && (
|
||||||
|
<div style={{
|
||||||
|
width: 30, height: 30, borderRadius: 7, background: icon,
|
||||||
|
marginRight: 12, flexShrink: 0,
|
||||||
|
}} />
|
||||||
|
)}
|
||||||
|
<div style={{ flex: 1, color: text }}>{title}</div>
|
||||||
|
{detail && <span style={{ color: sec, marginRight: 6 }}>{detail}</span>}
|
||||||
|
{chevron && (
|
||||||
|
<svg width="8" height="14" viewBox="0 0 8 14" style={{ flexShrink: 0 }}>
|
||||||
|
<path d="M1 1l6 6-6 6" stroke={ter} strokeWidth="2" fill="none" strokeLinecap="round" strokeLinejoin="round"/>
|
||||||
|
</svg>
|
||||||
|
)}
|
||||||
|
{!isLast && (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', bottom: 0, right: 0,
|
||||||
|
left: icon ? 58 : 16, height: 0.5, background: sep,
|
||||||
|
}} />
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function IOSList({ header, children, dark = false }) {
|
||||||
|
const hc = dark ? 'rgba(235,235,245,0.6)' : 'rgba(60,60,67,0.6)';
|
||||||
|
const bg = dark ? '#1C1C1E' : '#fff';
|
||||||
|
return (
|
||||||
|
<div>
|
||||||
|
{header && (
|
||||||
|
<div style={{
|
||||||
|
fontFamily: '-apple-system, system-ui', fontSize: 13,
|
||||||
|
color: hc, textTransform: 'uppercase',
|
||||||
|
padding: '8px 36px 6px', letterSpacing: -0.08,
|
||||||
|
}}>{header}</div>
|
||||||
|
)}
|
||||||
|
<div style={{
|
||||||
|
background: bg, borderRadius: 26,
|
||||||
|
margin: '0 16px', overflow: 'hidden',
|
||||||
|
}}>{children}</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Device frame
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function IOSDevice({
|
||||||
|
children, width = 402, height = 874, dark = false,
|
||||||
|
keyboard = false,
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
width, height, borderRadius: 48, overflow: 'hidden',
|
||||||
|
position: 'relative', background: dark ? '#000' : '#F2F2F7',
|
||||||
|
border: '1px solid #DEE0E3',
|
||||||
|
fontFamily: '-apple-system, system-ui, sans-serif',
|
||||||
|
WebkitFontSmoothing: 'antialiased',
|
||||||
|
'--ios-safe-top': '62px',
|
||||||
|
'--ios-safe-bottom': '34px',
|
||||||
|
}}>
|
||||||
|
{/* dynamic island */}
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', top: 11, left: '50%', transform: 'translateX(-50%)',
|
||||||
|
width: 126, height: 37, borderRadius: 24, background: '#000', zIndex: 50,
|
||||||
|
}} />
|
||||||
|
{/* status bar (absolute) */}
|
||||||
|
<div style={{ position: 'absolute', top: 0, left: 0, right: 0, zIndex: 10 }}>
|
||||||
|
<IOSStatusBar dark={dark} />
|
||||||
|
</div>
|
||||||
|
{/* content */}
|
||||||
|
<div style={{ height: '100%', display: 'flex', flexDirection: 'column' }}>
|
||||||
|
<div style={{ flex: 1, overflow: 'auto' }}>{children}</div>
|
||||||
|
{keyboard && <IOSKeyboard dark={dark} />}
|
||||||
|
</div>
|
||||||
|
{/* home indicator — always on top */}
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', bottom: 0, left: 0, right: 0, zIndex: 60,
|
||||||
|
height: 34, display: 'flex', justifyContent: 'center', alignItems: 'flex-end',
|
||||||
|
paddingBottom: 8, pointerEvents: 'none',
|
||||||
|
}}>
|
||||||
|
<div style={{
|
||||||
|
width: 139, height: 5, borderRadius: 100,
|
||||||
|
background: dark ? 'rgba(255,255,255,0.7)' : 'rgba(0,0,0,0.25)',
|
||||||
|
}} />
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Keyboard — iOS 26 liquid glass
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function IOSKeyboard({ dark = false }) {
|
||||||
|
const glyph = dark ? 'rgba(255,255,255,0.7)' : '#595959';
|
||||||
|
const sugg = dark ? 'rgba(255,255,255,0.6)' : '#333';
|
||||||
|
const keyBg = dark ? 'rgba(255,255,255,0.22)' : 'rgba(255,255,255,0.85)';
|
||||||
|
|
||||||
|
// special-key icons
|
||||||
|
const icons = {
|
||||||
|
shift: <svg width="19" height="17" viewBox="0 0 19 17"><path d="M9.5 1L1 9.5h4.5V16h8V9.5H18L9.5 1z" fill={glyph}/></svg>,
|
||||||
|
del: <svg width="23" height="17" viewBox="0 0 23 17"><path d="M7 1h13a2 2 0 012 2v11a2 2 0 01-2 2H7l-6-7.5L7 1z" fill="none" stroke={glyph} strokeWidth="1.6" strokeLinejoin="round"/><path d="M10 5l7 7M17 5l-7 7" stroke={glyph} strokeWidth="1.6" strokeLinecap="round"/></svg>,
|
||||||
|
ret: <svg width="20" height="14" viewBox="0 0 20 14"><path d="M18 1v6H4m0 0l4-4M4 7l4 4" fill="none" stroke="#fff" strokeWidth="1.8" strokeLinecap="round" strokeLinejoin="round"/></svg>,
|
||||||
|
};
|
||||||
|
|
||||||
|
const key = (content, { w, flex, ret, fs = 25, k } = {}) => (
|
||||||
|
<div key={k} style={{
|
||||||
|
height: 42, borderRadius: 8.5,
|
||||||
|
flex: flex ? 1 : undefined, width: w, minWidth: 0,
|
||||||
|
background: ret ? '#08f' : keyBg,
|
||||||
|
boxShadow: '0 1px 0 rgba(0,0,0,0.075)',
|
||||||
|
display: 'flex', alignItems: 'center', justifyContent: 'center',
|
||||||
|
fontFamily: '-apple-system, "SF Compact", system-ui',
|
||||||
|
fontSize: fs, fontWeight: 458, color: ret ? '#fff' : glyph,
|
||||||
|
}}>{content}</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
const row = (keys, pad = 0) => (
|
||||||
|
<div style={{ display: 'flex', gap: 6.5, justifyContent: 'center', padding: `0 ${pad}px` }}>
|
||||||
|
{keys.map(l => key(l, { flex: true, k: l }))}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
position: 'relative', zIndex: 15, borderRadius: 27, overflow: 'hidden',
|
||||||
|
padding: '11px 0 2px',
|
||||||
|
display: 'flex', flexDirection: 'column', alignItems: 'center',
|
||||||
|
boxShadow: dark
|
||||||
|
? '0 -2px 20px rgba(0,0,0,0.09)'
|
||||||
|
: '0 -1px 6px rgba(0,0,0,0.018), 0 -3px 20px rgba(0,0,0,0.012)',
|
||||||
|
}}>
|
||||||
|
{/* liquid glass bg — same recipe as nav pills */}
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', inset: 0, borderRadius: 27,
|
||||||
|
backdropFilter: 'blur(12px) saturate(180%)',
|
||||||
|
WebkitBackdropFilter: 'blur(12px) saturate(180%)',
|
||||||
|
background: dark ? 'rgba(120,120,128,0.14)' : 'rgba(255,255,255,0.25)',
|
||||||
|
}} />
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', inset: 0, borderRadius: 27,
|
||||||
|
boxShadow: dark
|
||||||
|
? 'inset 1.5px 1.5px 1px rgba(255,255,255,0.15)'
|
||||||
|
: 'inset 1.5px 1.5px 1px rgba(255,255,255,0.7), inset -1px -1px 1px rgba(255,255,255,0.4)',
|
||||||
|
border: dark ? '0.5px solid rgba(255,255,255,0.15)' : '0.5px solid rgba(0,0,0,0.06)',
|
||||||
|
pointerEvents: 'none',
|
||||||
|
}} />
|
||||||
|
|
||||||
|
{/* autocorrect bar */}
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', gap: 20, alignItems: 'center',
|
||||||
|
padding: '8px 22px 13px', width: '100%', boxSizing: 'border-box',
|
||||||
|
position: 'relative',
|
||||||
|
}}>
|
||||||
|
{['"The"', 'the', 'to'].map((w, i) => (
|
||||||
|
<React.Fragment key={i}>
|
||||||
|
{i > 0 && <div style={{ width: 1, height: 25, background: '#ccc', opacity: 0.3 }} />}
|
||||||
|
<div style={{
|
||||||
|
flex: 1, textAlign: 'center',
|
||||||
|
fontFamily: '-apple-system, system-ui', fontSize: 17,
|
||||||
|
color: sugg, letterSpacing: -0.43, lineHeight: '22px',
|
||||||
|
}}>{w}</div>
|
||||||
|
</React.Fragment>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* key layout */}
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', flexDirection: 'column', gap: 13,
|
||||||
|
padding: '0 6.5px', width: '100%', boxSizing: 'border-box',
|
||||||
|
position: 'relative',
|
||||||
|
}}>
|
||||||
|
{row(['q','w','e','r','t','y','u','i','o','p'])}
|
||||||
|
{row(['a','s','d','f','g','h','j','k','l'], 20)}
|
||||||
|
<div style={{ display: 'flex', gap: 14.25, alignItems: 'center' }}>
|
||||||
|
{key(icons.shift, { w: 45, k: 'shift' })}
|
||||||
|
<div style={{ display: 'flex', gap: 6.5, flex: 1 }}>
|
||||||
|
{['z','x','c','v','b','n','m'].map(l => key(l, { flex: true, k: l }))}
|
||||||
|
</div>
|
||||||
|
{key(icons.del, { w: 45, k: 'del' })}
|
||||||
|
</div>
|
||||||
|
<div style={{ display: 'flex', gap: 6, alignItems: 'center' }}>
|
||||||
|
{key('ABC', { w: 92.25, fs: 18, k: 'abc' })}
|
||||||
|
{key('', { flex: true, k: 'space' })}
|
||||||
|
{key(icons.ret, { w: 92.25, ret: true, k: 'ret' })}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
{/* bottom spacer (emoji+mic area, icons omitted) */}
|
||||||
|
<div style={{ height: 56, width: '100%', position: 'relative' }} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
IOSDevice, IOSStatusBar, IOSList, IOSListRow, IOSKeyboard,
|
||||||
|
});
|
||||||
@ -0,0 +1,197 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// MacOS.jsx — Simplified macOS Tahoe (Liquid Glass) window
|
||||||
|
// Based on the macOS Tahoe UI Kit. No image assets, no dependencies.
|
||||||
|
// Exports (to window): MacWindow, MacSidebar, MacSidebarItem, MacSidebarHeader, MacToolbar, MacGlass, MacTrafficLights
|
||||||
|
//
|
||||||
|
// Usage — wrap your app content in <MacWindow> to get the window chrome
|
||||||
|
// (traffic lights + titlebar). Props: width, height, title, sidebar (pass a
|
||||||
|
// <MacSidebar> element); compose MacToolbar/MacGlass inside as needed:
|
||||||
|
//
|
||||||
|
// <MacWindow width={980} height={620} title="Documents"
|
||||||
|
// sidebar={<MacSidebar>…</MacSidebar>}>
|
||||||
|
// ...your app content...
|
||||||
|
// </MacWindow>
|
||||||
|
/* END USAGE */
|
||||||
|
|
||||||
|
const MAC_FONT = '-apple-system, BlinkMacSystemFont, "SF Pro", "Helvetica Neue", sans-serif';
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Liquid glass primitive — blur + white tint + inset highlight
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function MacGlass({ children, radius = 296, dark = false, style = {} }) {
|
||||||
|
return (
|
||||||
|
<div style={{ position: 'relative', borderRadius: radius, ...style }}>
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', inset: 0, borderRadius: radius,
|
||||||
|
background: dark ? 'rgba(255,255,255,0.08)' : 'rgba(255,255,255,0.35)',
|
||||||
|
backdropFilter: 'blur(40px) saturate(180%)',
|
||||||
|
WebkitBackdropFilter: 'blur(40px) saturate(180%)',
|
||||||
|
border: dark ? '0.5px solid rgba(255,255,255,0.12)' : '0.5px solid rgba(255,255,255,0.6)',
|
||||||
|
boxShadow: dark
|
||||||
|
? '0 8px 40px rgba(0,0,0,0.2)'
|
||||||
|
: '0 8px 40px rgba(0,0,0,0.08), inset 0 1px 0 rgba(255,255,255,0.4)',
|
||||||
|
}} />
|
||||||
|
<div style={{ position: 'relative', zIndex: 1 }}>{children}</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Traffic lights (14px, Tahoe colors)
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function MacTrafficLights({ style = {} }) {
|
||||||
|
const dot = (bg) => (
|
||||||
|
<div style={{
|
||||||
|
width: 14, height: 14, borderRadius: '50%', background: bg,
|
||||||
|
border: '0.5px solid rgba(0,0,0,0.1)',
|
||||||
|
}} />
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<div style={{ display: 'flex', gap: 9, alignItems: 'center', padding: 1, ...style }}>
|
||||||
|
{dot('#ff736a')}{dot('#febc2e')}{dot('#19c332')}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Toolbar — title + single glass pill icon
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function MacToolbar({ title = 'Folder' }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', gap: 8, alignItems: 'center', padding: 8, flexShrink: 0,
|
||||||
|
}}>
|
||||||
|
{/* title */}
|
||||||
|
<div style={{
|
||||||
|
fontFamily: MAC_FONT, fontSize: 15, fontWeight: 700,
|
||||||
|
color: 'rgba(0,0,0,0.85)', whiteSpace: 'nowrap', paddingLeft: 8,
|
||||||
|
}}>{title}</div>
|
||||||
|
<div style={{ flex: 1 }} />
|
||||||
|
{/* single action */}
|
||||||
|
<MacGlass>
|
||||||
|
<div style={{
|
||||||
|
width: 36, height: 36, display: 'flex',
|
||||||
|
alignItems: 'center', justifyContent: 'center',
|
||||||
|
}}>
|
||||||
|
<div style={{ width: 14, height: 14, borderRadius: '50%', background: '#4c4c4c', opacity: 0.4 }} />
|
||||||
|
</div>
|
||||||
|
</MacGlass>
|
||||||
|
{/* search */}
|
||||||
|
<MacGlass>
|
||||||
|
<div style={{
|
||||||
|
width: 140, height: 36, display: 'flex', alignItems: 'center',
|
||||||
|
gap: 6, padding: '0 12px',
|
||||||
|
}}>
|
||||||
|
<svg width="13" height="13" viewBox="0 0 13 13" fill="none">
|
||||||
|
<circle cx="5.5" cy="5.5" r="4" stroke="#727272" strokeWidth="1.5"/>
|
||||||
|
<path d="M8.5 8.5l3 3" stroke="#727272" strokeWidth="1.5" strokeLinecap="round"/>
|
||||||
|
</svg>
|
||||||
|
<span style={{
|
||||||
|
fontFamily: MAC_FONT, fontSize: 13, fontWeight: 500, color: '#727272',
|
||||||
|
}}>Search</span>
|
||||||
|
</div>
|
||||||
|
</MacGlass>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Sidebar — frosted glass panel floating inside the window
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function MacSidebarItem({ label, selected = false }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
display: 'flex', alignItems: 'center', gap: 6,
|
||||||
|
height: 24, padding: '4px 10px 4px 6px', margin: '0 10px',
|
||||||
|
borderRadius: 8, position: 'relative',
|
||||||
|
fontFamily: MAC_FONT, fontSize: 11, fontWeight: 500,
|
||||||
|
}}>
|
||||||
|
{selected && (
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', inset: 0, borderRadius: 8,
|
||||||
|
background: 'rgba(0,0,0,0.11)', mixBlendMode: 'multiply',
|
||||||
|
}} />
|
||||||
|
)}
|
||||||
|
<div style={{
|
||||||
|
width: 14, height: 14, borderRadius: '50%',
|
||||||
|
background: selected ? '#007aff' : 'rgba(0,0,0,0.4)',
|
||||||
|
opacity: selected ? 1 : 0.5, flexShrink: 0, position: 'relative',
|
||||||
|
}} />
|
||||||
|
<span style={{ color: 'rgba(0,0,0,0.85)', position: 'relative' }}>{label}</span>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function MacSidebar({ children }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
width: 220, height: '100%', padding: 8, flexShrink: 0,
|
||||||
|
position: 'relative', display: 'flex', flexDirection: 'column',
|
||||||
|
}}>
|
||||||
|
{/* glass panel */}
|
||||||
|
<div style={{
|
||||||
|
position: 'absolute', inset: 8, borderRadius: 18,
|
||||||
|
background: 'rgba(210,225,245,0.45)',
|
||||||
|
backdropFilter: 'blur(50px) saturate(200%)',
|
||||||
|
WebkitBackdropFilter: 'blur(50px) saturate(200%)',
|
||||||
|
border: '0.5px solid rgba(255,255,255,0.5)',
|
||||||
|
boxShadow: '0 8px 40px rgba(0,0,0,0.10), inset 0 1px 0 rgba(255,255,255,0.35)',
|
||||||
|
}} />
|
||||||
|
{/* content */}
|
||||||
|
<div style={{
|
||||||
|
position: 'relative', zIndex: 1, padding: '10px 0',
|
||||||
|
display: 'flex', flexDirection: 'column', gap: 2,
|
||||||
|
}}>
|
||||||
|
{/* window controls + sidebar toggle */}
|
||||||
|
<div style={{
|
||||||
|
height: 32, display: 'flex', alignItems: 'center',
|
||||||
|
justifyContent: 'space-between', padding: '0 10px', marginBottom: 4,
|
||||||
|
}}>
|
||||||
|
<MacTrafficLights />
|
||||||
|
</div>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function MacSidebarHeader({ title }) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
padding: '14px 18px 5px',
|
||||||
|
fontFamily: MAC_FONT, fontSize: 11, fontWeight: 700,
|
||||||
|
color: 'rgba(0,0,0,0.5)',
|
||||||
|
}}>{title}</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
// Window — r:26, big shadow, sidebar + toolbar + content
|
||||||
|
// ─────────────────────────────────────────────────────────────
|
||||||
|
function MacWindow({
|
||||||
|
width = 900, height = 600, title = 'Folder',
|
||||||
|
sidebar, children,
|
||||||
|
}) {
|
||||||
|
return (
|
||||||
|
<div style={{
|
||||||
|
width, height, borderRadius: 26, overflow: 'hidden',
|
||||||
|
background: '#fff',
|
||||||
|
border: '1px solid #DEE0E3',
|
||||||
|
display: 'flex', position: 'relative',
|
||||||
|
fontFamily: MAC_FONT,
|
||||||
|
}}>
|
||||||
|
<MacSidebar>{sidebar}</MacSidebar>
|
||||||
|
<div style={{ flex: 1, display: 'flex', flexDirection: 'column' }}>
|
||||||
|
<MacToolbar title={title} />
|
||||||
|
<div style={{ flex: 1, overflow: 'auto', padding: '4px 8px' }}>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
MacWindow, MacSidebar, MacSidebarItem, MacSidebarHeader,
|
||||||
|
MacToolbar, MacGlass, MacTrafficLights,
|
||||||
|
});
|
||||||
@ -0,0 +1,752 @@
|
|||||||
|
/* BEGIN USAGE */
|
||||||
|
// tweaks-panel.jsx
|
||||||
|
// Reusable Tweaks shell + form-control helpers.
|
||||||
|
// Exports (to window): useTweaks, TweaksPanel, TweakSection, TweakRow, TweakSlider,
|
||||||
|
// TweakToggle, TweakRadio, TweakSelect, TweakText, TweakNumber, TweakColor, TweakButton.
|
||||||
|
//
|
||||||
|
// Owns the host protocol (listens for miaoda:tweaks:activate / miaoda:tweaks:deactivate,
|
||||||
|
// posts miaoda:tweaks:available / miaoda:tweaks:set-keys / miaoda:tweaks:dismissed) so
|
||||||
|
// individual prototypes don't re-roll it. Ships a consistent set of controls so you
|
||||||
|
// don't hand-draw <input type="range">, segmented radios, steppers, etc.
|
||||||
|
//
|
||||||
|
// Usage (in an HTML file that loads React + Babel):
|
||||||
|
//
|
||||||
|
// const TWEAK_DEFAULTS = /*EDITMODE-BEGIN*/{
|
||||||
|
// "primaryColor": "#D97757",
|
||||||
|
// "palette": ["#D97757", "#29261b", "#f6f4ef"],
|
||||||
|
// "fontSize": 16,
|
||||||
|
// "density": "regular",
|
||||||
|
// "dark": false
|
||||||
|
// }/*EDITMODE-END*/;
|
||||||
|
//
|
||||||
|
// TWEAK_DEFAULTS must live inline in the HTML file — in a <script type="text/babel"> block,
|
||||||
|
// not in a separate .jsx/.js loaded via <script src>. That in-HTML block is the region the
|
||||||
|
// host rewrites when the user adjusts a tweak, so keep it wrapped in the /*EDITMODE-BEGIN*/ …
|
||||||
|
// /*EDITMODE-END*/ markers and the object between them valid JSON — double-quoted keys, no
|
||||||
|
// trailing commas, no comments or expressions — even after you rename the keys. Move it out
|
||||||
|
// of the HTML, strip the markers, or use a non-JSON body and tweak edits silently stop persisting.
|
||||||
|
//
|
||||||
|
// function App() {
|
||||||
|
// const [t, setTweak] = useTweaks(TWEAK_DEFAULTS);
|
||||||
|
// return (
|
||||||
|
// <div style={{ fontSize: t.fontSize, color: t.primaryColor }}>
|
||||||
|
// Hello
|
||||||
|
// <TweaksPanel>
|
||||||
|
// <TweakSection label="Typography" />
|
||||||
|
// <TweakSlider label="Font size" value={t.fontSize} min={10} max={32} unit="px"
|
||||||
|
// onChange={(v) => setTweak('fontSize', v)} />
|
||||||
|
// <TweakRadio label="Density" value={t.density}
|
||||||
|
// options={['compact', 'regular', 'comfy']}
|
||||||
|
// onChange={(v) => setTweak('density', v)} />
|
||||||
|
// <TweakSection label="Theme" />
|
||||||
|
// <TweakColor label="Primary" value={t.primaryColor}
|
||||||
|
// options={['#D97757', '#2A6FDB', '#1F8A5B', '#7A5AE0']}
|
||||||
|
// onChange={(v) => setTweak('primaryColor', v)} />
|
||||||
|
// <TweakColor label="Palette" value={t.palette}
|
||||||
|
// options={[['#D97757', '#29261b', '#f6f4ef'],
|
||||||
|
// ['#475569', '#0f172a', '#f1f5f9']]}
|
||||||
|
// onChange={(v) => setTweak('palette', v)} />
|
||||||
|
// <TweakToggle label="Dark mode" value={t.dark}
|
||||||
|
// onChange={(v) => setTweak('dark', v)} />
|
||||||
|
// </TweaksPanel>
|
||||||
|
// </div>
|
||||||
|
// );
|
||||||
|
// }
|
||||||
|
//
|
||||||
|
// TweakRadio is the segmented control for 2–3 short options (auto-falls-back to
|
||||||
|
// TweakSelect past ~16/~10 chars per label); reach for TweakSelect directly when
|
||||||
|
// options are many or long. For color tweaks always curate 3-4 options rather than
|
||||||
|
// a free picker; an option can also be a whole 2–5 color palette (the stored value
|
||||||
|
// is the array). The Tweak* controls are a floor, not a ceiling — build custom
|
||||||
|
// controls inside the panel if a tweak calls for UI they don't cover.
|
||||||
|
/* END USAGE */
|
||||||
|
// ─────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
const __TWEAKS_STYLE = `
|
||||||
|
.twk-panel{position:fixed;right:16px;bottom:16px;z-index:2147483646;width:280px;
|
||||||
|
max-height:calc(100vh - 32px);display:flex;flex-direction:column;
|
||||||
|
transform:scale(var(--dc-inv-zoom,1));transform-origin:bottom right;
|
||||||
|
background:rgba(250,249,247,.78);color:#29261b;
|
||||||
|
-webkit-backdrop-filter:blur(24px) saturate(160%);backdrop-filter:blur(24px) saturate(160%);
|
||||||
|
border:.5px solid rgba(255,255,255,.6);border-radius:14px;
|
||||||
|
box-shadow:0 1px 0 rgba(255,255,255,.5) inset,0 12px 40px rgba(0,0,0,.18);
|
||||||
|
font:11.5px/1.4 ui-sans-serif,system-ui,-apple-system,sans-serif;overflow:hidden}
|
||||||
|
.twk-hd{display:flex;align-items:center;justify-content:space-between;
|
||||||
|
padding:10px 8px 10px 14px;cursor:move;user-select:none}
|
||||||
|
.twk-hd b{font-size:12px;font-weight:600;letter-spacing:.01em}
|
||||||
|
.twk-x{appearance:none;border:0;background:transparent;color:rgba(41,38,27,.55);
|
||||||
|
width:22px;height:22px;border-radius:6px;cursor:default;font-size:13px;line-height:1}
|
||||||
|
.twk-x:hover{background:rgba(0,0,0,.06);color:#29261b}
|
||||||
|
.twk-body{padding:2px 14px 14px;display:flex;flex-direction:column;gap:10px;
|
||||||
|
overflow-y:auto;overflow-x:hidden;min-height:0;
|
||||||
|
scrollbar-width:thin;scrollbar-color:rgba(0,0,0,.15) transparent}
|
||||||
|
.twk-body::-webkit-scrollbar{width:8px}
|
||||||
|
.twk-body::-webkit-scrollbar-track{background:transparent;margin:2px}
|
||||||
|
.twk-body::-webkit-scrollbar-thumb{background:rgba(0,0,0,.15);border-radius:4px;
|
||||||
|
border:2px solid transparent;background-clip:content-box}
|
||||||
|
.twk-body::-webkit-scrollbar-thumb:hover{background:rgba(0,0,0,.25);
|
||||||
|
border:2px solid transparent;background-clip:content-box}
|
||||||
|
.twk-row{display:flex;flex-direction:column;gap:5px}
|
||||||
|
.twk-row-h{flex-direction:row;align-items:center;justify-content:space-between;gap:10px}
|
||||||
|
.twk-lbl{display:flex;justify-content:space-between;align-items:baseline;
|
||||||
|
color:rgba(41,38,27,.72)}
|
||||||
|
.twk-lbl>span:first-child{font-weight:500}
|
||||||
|
.twk-val{color:rgba(41,38,27,.5);font-variant-numeric:tabular-nums}
|
||||||
|
|
||||||
|
.twk-sect{font-size:10px;font-weight:600;letter-spacing:.06em;text-transform:uppercase;
|
||||||
|
color:rgba(41,38,27,.45);padding:10px 0 0}
|
||||||
|
.twk-sect:first-child{padding-top:0}
|
||||||
|
|
||||||
|
.twk-field{appearance:none;box-sizing:border-box;width:100%;min-width:0;height:26px;padding:0 8px;
|
||||||
|
border:.5px solid rgba(0,0,0,.1);border-radius:7px;
|
||||||
|
background:rgba(255,255,255,.6);color:inherit;font:inherit;outline:none}
|
||||||
|
.twk-field:focus{border-color:rgba(0,0,0,.25);background:rgba(255,255,255,.85)}
|
||||||
|
select.twk-field{padding-right:22px;
|
||||||
|
background-image:url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' width='10' height='6' viewBox='0 0 10 6'><path fill='rgba(0,0,0,.5)' d='M0 0h10L5 6z'/></svg>");
|
||||||
|
background-repeat:no-repeat;background-position:right 8px center}
|
||||||
|
|
||||||
|
.twk-slider{appearance:none;-webkit-appearance:none;width:100%;height:4px;margin:6px 0;
|
||||||
|
border-radius:999px;background:rgba(0,0,0,.12);outline:none}
|
||||||
|
.twk-slider::-webkit-slider-thumb{-webkit-appearance:none;appearance:none;
|
||||||
|
width:14px;height:14px;border-radius:50%;background:#fff;
|
||||||
|
border:.5px solid rgba(0,0,0,.12);box-shadow:0 1px 3px rgba(0,0,0,.2);cursor:default}
|
||||||
|
.twk-slider::-moz-range-thumb{width:14px;height:14px;border-radius:50%;
|
||||||
|
background:#fff;border:.5px solid rgba(0,0,0,.12);box-shadow:0 1px 3px rgba(0,0,0,.2);cursor:default}
|
||||||
|
|
||||||
|
.twk-seg{position:relative;display:flex;padding:2px;border-radius:8px;
|
||||||
|
background:rgba(0,0,0,.06);user-select:none}
|
||||||
|
.twk-seg-thumb{position:absolute;top:2px;bottom:2px;border-radius:6px;
|
||||||
|
background:rgba(255,255,255,.9);box-shadow:0 1px 2px rgba(0,0,0,.12);
|
||||||
|
transition:left .15s cubic-bezier(.3,.7,.4,1),width .15s}
|
||||||
|
.twk-seg.dragging .twk-seg-thumb{transition:none}
|
||||||
|
.twk-seg button{appearance:none;position:relative;z-index:1;flex:1;border:0;
|
||||||
|
background:transparent;color:inherit;font:inherit;font-weight:500;min-height:22px;
|
||||||
|
border-radius:6px;cursor:default;padding:4px 6px;line-height:1.2;
|
||||||
|
overflow-wrap:anywhere}
|
||||||
|
|
||||||
|
.twk-toggle{position:relative;width:32px;height:18px;border:0;border-radius:999px;
|
||||||
|
background:rgba(0,0,0,.15);transition:background .15s;cursor:default;padding:0}
|
||||||
|
.twk-toggle[data-on="1"]{background:#34c759}
|
||||||
|
.twk-toggle i{position:absolute;top:2px;left:2px;width:14px;height:14px;border-radius:50%;
|
||||||
|
background:#fff;box-shadow:0 1px 2px rgba(0,0,0,.25);transition:transform .15s}
|
||||||
|
.twk-toggle[data-on="1"] i{transform:translateX(14px)}
|
||||||
|
|
||||||
|
.twk-num{display:flex;align-items:center;box-sizing:border-box;min-width:0;height:26px;padding:0 0 0 8px;
|
||||||
|
border:.5px solid rgba(0,0,0,.1);border-radius:7px;background:rgba(255,255,255,.6)}
|
||||||
|
.twk-num-lbl{font-weight:500;color:rgba(41,38,27,.6);cursor:ew-resize;
|
||||||
|
user-select:none;padding-right:8px}
|
||||||
|
.twk-num input{flex:1;min-width:0;height:100%;border:0;background:transparent;
|
||||||
|
font:inherit;font-variant-numeric:tabular-nums;text-align:right;padding:0 8px 0 0;
|
||||||
|
outline:none;color:inherit;-moz-appearance:textfield}
|
||||||
|
.twk-num input::-webkit-inner-spin-button,.twk-num input::-webkit-outer-spin-button{
|
||||||
|
-webkit-appearance:none;margin:0}
|
||||||
|
.twk-num-unit{padding-right:8px;color:rgba(41,38,27,.45)}
|
||||||
|
|
||||||
|
.twk-btn{appearance:none;height:26px;padding:0 12px;border:0;border-radius:7px;
|
||||||
|
background:rgba(0,0,0,.78);color:#fff;font:inherit;font-weight:500;cursor:default}
|
||||||
|
.twk-btn:hover{background:rgba(0,0,0,.88)}
|
||||||
|
.twk-btn.secondary{background:rgba(0,0,0,.06);color:inherit}
|
||||||
|
.twk-btn.secondary:hover{background:rgba(0,0,0,.1)}
|
||||||
|
|
||||||
|
.twk-swatch{appearance:none;-webkit-appearance:none;width:56px;height:22px;
|
||||||
|
border:.5px solid rgba(0,0,0,.1);border-radius:6px;padding:0;cursor:default;
|
||||||
|
background:transparent;flex-shrink:0}
|
||||||
|
.twk-swatch::-webkit-color-swatch-wrapper{padding:0}
|
||||||
|
.twk-swatch::-webkit-color-swatch{border:0;border-radius:5.5px}
|
||||||
|
.twk-swatch::-moz-color-swatch{border:0;border-radius:5.5px}
|
||||||
|
|
||||||
|
.twk-chips{display:flex;gap:6px}
|
||||||
|
.twk-chip{position:relative;appearance:none;flex:1;min-width:0;height:46px;
|
||||||
|
padding:0;border:0;border-radius:6px;overflow:hidden;cursor:default;
|
||||||
|
box-shadow:0 0 0 .5px rgba(0,0,0,.12),0 1px 2px rgba(0,0,0,.06);
|
||||||
|
transition:transform .12s cubic-bezier(.3,.7,.4,1),box-shadow .12s}
|
||||||
|
.twk-chip:hover{transform:translateY(-1px);
|
||||||
|
box-shadow:0 0 0 .5px rgba(0,0,0,.18),0 4px 10px rgba(0,0,0,.12)}
|
||||||
|
.twk-chip[data-on="1"]{box-shadow:0 0 0 1.5px rgba(0,0,0,.85),
|
||||||
|
0 2px 6px rgba(0,0,0,.15)}
|
||||||
|
.twk-chip>span{position:absolute;top:0;bottom:0;right:0;width:34%;
|
||||||
|
display:flex;flex-direction:column;box-shadow:-1px 0 0 rgba(0,0,0,.1)}
|
||||||
|
.twk-chip>span>i{flex:1;box-shadow:0 -1px 0 rgba(0,0,0,.1)}
|
||||||
|
.twk-chip>span>i:first-child{box-shadow:none}
|
||||||
|
.twk-chip svg{position:absolute;top:6px;left:6px;width:13px;height:13px;
|
||||||
|
filter:drop-shadow(0 1px 1px rgba(0,0,0,.3))}
|
||||||
|
`;
|
||||||
|
|
||||||
|
// ── useTweaks ───────────────────────────────────────────────────────────────
|
||||||
|
// Single source of truth for tweak values. setTweak persists via the host
|
||||||
|
// (miaoda:tweaks:set-keys → host rewrites the EDITMODE block on disk).
|
||||||
|
function useTweaks(defaults) {
|
||||||
|
const [values, setValues] = React.useState(defaults);
|
||||||
|
// Accepts either setTweak('key', value) or setTweak({ key: value, ... }) so a
|
||||||
|
// useState-style call doesn't write a "[object Object]" key into the persisted
|
||||||
|
// JSON block.
|
||||||
|
const setTweak = React.useCallback((keyOrEdits, val) => {
|
||||||
|
const edits = typeof keyOrEdits === 'object' && keyOrEdits !== null
|
||||||
|
? keyOrEdits : { [keyOrEdits]: val };
|
||||||
|
setValues((prev) => ({ ...prev, ...edits }));
|
||||||
|
window.parent.postMessage({ type: 'miaoda:tweaks:set-keys', edits }, '*');
|
||||||
|
// Same-window signal so in-page listeners (deck-stage rail thumbnails)
|
||||||
|
// can react — the parent message only reaches the host, not peers.
|
||||||
|
window.dispatchEvent(new CustomEvent('tweakchange', { detail: edits }));
|
||||||
|
}, []);
|
||||||
|
return [values, setTweak];
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── TweaksPanel ─────────────────────────────────────────────────────────────
|
||||||
|
// Floating shell. Registers the protocol listener BEFORE announcing
|
||||||
|
// availability — if the announce ran first, the host's activate could land
|
||||||
|
// before our handler exists and the toolbar toggle would silently no-op.
|
||||||
|
// The close button posts miaoda:tweaks:dismissed so the host's toolbar toggle
|
||||||
|
// flips off in lockstep; the host echoes miaoda:tweaks:deactivate back which
|
||||||
|
// is what actually hides the panel.
|
||||||
|
function TweaksPanel({ title = 'Tweaks', children }) {
|
||||||
|
const [open, setOpen] = React.useState(false);
|
||||||
|
const dragRef = React.useRef(null);
|
||||||
|
const offsetRef = React.useRef({ x: 16, y: 16 });
|
||||||
|
const PAD = 16;
|
||||||
|
|
||||||
|
const clampToViewport = React.useCallback(() => {
|
||||||
|
const panel = dragRef.current;
|
||||||
|
if (!panel) return;
|
||||||
|
const w = panel.offsetWidth, h = panel.offsetHeight;
|
||||||
|
const maxRight = Math.max(PAD, window.innerWidth - w - PAD);
|
||||||
|
const maxBottom = Math.max(PAD, window.innerHeight - h - PAD);
|
||||||
|
offsetRef.current = {
|
||||||
|
x: Math.min(maxRight, Math.max(PAD, offsetRef.current.x)),
|
||||||
|
y: Math.min(maxBottom, Math.max(PAD, offsetRef.current.y)),
|
||||||
|
};
|
||||||
|
panel.style.right = offsetRef.current.x + 'px';
|
||||||
|
panel.style.bottom = offsetRef.current.y + 'px';
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (!open) return;
|
||||||
|
clampToViewport();
|
||||||
|
if (typeof ResizeObserver === 'undefined') {
|
||||||
|
window.addEventListener('resize', clampToViewport);
|
||||||
|
return () => window.removeEventListener('resize', clampToViewport);
|
||||||
|
}
|
||||||
|
const ro = new ResizeObserver(clampToViewport);
|
||||||
|
ro.observe(document.documentElement);
|
||||||
|
return () => ro.disconnect();
|
||||||
|
}, [open, clampToViewport]);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
const onMsg = (e) => {
|
||||||
|
const t = e?.data?.type;
|
||||||
|
if (t === 'miaoda:tweaks:activate') setOpen(true);
|
||||||
|
else if (t === 'miaoda:tweaks:deactivate') setOpen(false);
|
||||||
|
};
|
||||||
|
window.addEventListener('message', onMsg);
|
||||||
|
window.parent.postMessage({ type: 'miaoda:tweaks:available' }, '*');
|
||||||
|
return () => window.removeEventListener('message', onMsg);
|
||||||
|
}, []);
|
||||||
|
|
||||||
|
const dismiss = () => {
|
||||||
|
setOpen(false);
|
||||||
|
window.parent.postMessage({ type: 'miaoda:tweaks:dismissed' }, '*');
|
||||||
|
};
|
||||||
|
|
||||||
|
const onDragStart = (e) => {
|
||||||
|
const panel = dragRef.current;
|
||||||
|
if (!panel) return;
|
||||||
|
const r = panel.getBoundingClientRect();
|
||||||
|
const sx = e.clientX, sy = e.clientY;
|
||||||
|
const startRight = window.innerWidth - r.right;
|
||||||
|
const startBottom = window.innerHeight - r.bottom;
|
||||||
|
const move = (ev) => {
|
||||||
|
offsetRef.current = {
|
||||||
|
x: startRight - (ev.clientX - sx),
|
||||||
|
y: startBottom - (ev.clientY - sy),
|
||||||
|
};
|
||||||
|
clampToViewport();
|
||||||
|
};
|
||||||
|
const up = () => {
|
||||||
|
window.removeEventListener('mousemove', move);
|
||||||
|
window.removeEventListener('mouseup', up);
|
||||||
|
};
|
||||||
|
window.addEventListener('mousemove', move);
|
||||||
|
window.addEventListener('mouseup', up);
|
||||||
|
};
|
||||||
|
|
||||||
|
if (!open) return null;
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<style>{__TWEAKS_STYLE}</style>
|
||||||
|
<div ref={dragRef} className="twk-panel" data-miaoda-chrome=""
|
||||||
|
style={{ right: offsetRef.current.x, bottom: offsetRef.current.y }}>
|
||||||
|
<div className="twk-hd" onMouseDown={onDragStart}>
|
||||||
|
<b>{title}</b>
|
||||||
|
<button className="twk-x" aria-label="Close tweaks"
|
||||||
|
onMouseDown={(e) => e.stopPropagation()}
|
||||||
|
onClick={dismiss}>✕</button>
|
||||||
|
</div>
|
||||||
|
<div className="twk-body">
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Layout helpers ──────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
function TweakSection({ label, children }) {
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<div className="twk-sect">{label}</div>
|
||||||
|
{children}
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakRow({ label, value, children, inline = false }) {
|
||||||
|
return (
|
||||||
|
<div className={inline ? 'twk-row twk-row-h' : 'twk-row'}>
|
||||||
|
<div className="twk-lbl">
|
||||||
|
<span>{label}</span>
|
||||||
|
{value != null && <span className="twk-val">{value}</span>}
|
||||||
|
</div>
|
||||||
|
{children}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ── Controls ────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
|
function TweakSlider({ label, value, min = 0, max = 100, step = 1, unit = '', onChange }) {
|
||||||
|
return (
|
||||||
|
<TweakRow label={label} value={`${value}${unit}`}>
|
||||||
|
<input type="range" className="twk-slider" min={min} max={max} step={step}
|
||||||
|
value={value} onChange={(e) => onChange(Number(e.target.value))} />
|
||||||
|
</TweakRow>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakToggle({ label, value, onChange }) {
|
||||||
|
return (
|
||||||
|
<div className="twk-row twk-row-h">
|
||||||
|
<div className="twk-lbl"><span>{label}</span></div>
|
||||||
|
<button type="button" className="twk-toggle" data-on={value ? '1' : '0'}
|
||||||
|
role="switch" aria-checked={!!value}
|
||||||
|
onClick={() => onChange(!value)}><i /></button>
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakRadio({ label, value, options, onChange }) {
|
||||||
|
const trackRef = React.useRef(null);
|
||||||
|
const [dragging, setDragging] = React.useState(false);
|
||||||
|
// The active value is read by pointer-move handlers attached for the lifetime
|
||||||
|
// of a drag — ref it so a stale closure doesn't fire onChange for every move.
|
||||||
|
const valueRef = React.useRef(value);
|
||||||
|
valueRef.current = value;
|
||||||
|
|
||||||
|
// Segments wrap mid-word once per-segment width runs out. The track is
|
||||||
|
// ~248px (280 panel − 28 body pad − 4 seg pad), each button loses 12px
|
||||||
|
// to its own padding, and 11.5px system-ui averages ~6.3px/char — so 2
|
||||||
|
// options fit ~16 chars each, 3 fit ~10. Past that (or >3 options), fall
|
||||||
|
// back to a dropdown rather than wrap.
|
||||||
|
const labelLen = (o) => String(typeof o === 'object' ? o.label : o).length;
|
||||||
|
const maxLen = options.reduce((m, o) => Math.max(m, labelLen(o)), 0);
|
||||||
|
const fitsAsSegments = maxLen <= ({ 2: 16, 3: 10 }[options.length] ?? 0);
|
||||||
|
if (!fitsAsSegments) {
|
||||||
|
// <select> emits strings — map back to the original option value so the
|
||||||
|
// fallback stays type-preserving (numbers, booleans) like the segment path.
|
||||||
|
const resolve = (s) => {
|
||||||
|
const m = options.find((o) => String(typeof o === 'object' ? o.value : o) === s);
|
||||||
|
return m === undefined ? s : typeof m === 'object' ? m.value : m;
|
||||||
|
};
|
||||||
|
return <TweakSelect label={label} value={value} options={options}
|
||||||
|
onChange={(s) => onChange(resolve(s))} />;
|
||||||
|
}
|
||||||
|
const opts = options.map((o) => (typeof o === 'object' ? o : { value: o, label: o }));
|
||||||
|
const idx = Math.max(0, opts.findIndex((o) => o.value === value));
|
||||||
|
const n = opts.length;
|
||||||
|
|
||||||
|
const segAt = (clientX) => {
|
||||||
|
const r = trackRef.current.getBoundingClientRect();
|
||||||
|
const inner = r.width - 4;
|
||||||
|
const i = Math.floor(((clientX - r.left - 2) / inner) * n);
|
||||||
|
return opts[Math.max(0, Math.min(n - 1, i))].value;
|
||||||
|
};
|
||||||
|
|
||||||
|
const onPointerDown = (e) => {
|
||||||
|
setDragging(true);
|
||||||
|
const v0 = segAt(e.clientX);
|
||||||
|
if (v0 !== valueRef.current) onChange(v0);
|
||||||
|
const move = (ev) => {
|
||||||
|
if (!trackRef.current) return;
|
||||||
|
const v = segAt(ev.clientX);
|
||||||
|
if (v !== valueRef.current) onChange(v);
|
||||||
|
};
|
||||||
|
const up = () => {
|
||||||
|
setDragging(false);
|
||||||
|
window.removeEventListener('pointermove', move);
|
||||||
|
window.removeEventListener('pointerup', up);
|
||||||
|
};
|
||||||
|
window.addEventListener('pointermove', move);
|
||||||
|
window.addEventListener('pointerup', up);
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<TweakRow label={label}>
|
||||||
|
<div ref={trackRef} role="radiogroup" onPointerDown={onPointerDown}
|
||||||
|
className={dragging ? 'twk-seg dragging' : 'twk-seg'}>
|
||||||
|
<div className="twk-seg-thumb"
|
||||||
|
style={{ left: `calc(2px + ${idx} * (100% - 4px) / ${n})`,
|
||||||
|
width: `calc((100% - 4px) / ${n})` }} />
|
||||||
|
{opts.map((o) => (
|
||||||
|
<button key={o.value} type="button" role="radio" aria-checked={o.value === value}>
|
||||||
|
{o.label}
|
||||||
|
</button>
|
||||||
|
))}
|
||||||
|
</div>
|
||||||
|
</TweakRow>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakSelect({ label, value, options, onChange }) {
|
||||||
|
return (
|
||||||
|
<TweakRow label={label}>
|
||||||
|
<select className="twk-field" value={value} onChange={(e) => onChange(e.target.value)}>
|
||||||
|
{options.map((o) => {
|
||||||
|
const v = typeof o === 'object' ? o.value : o;
|
||||||
|
const l = typeof o === 'object' ? o.label : o;
|
||||||
|
return <option key={v} value={v}>{l}</option>;
|
||||||
|
})}
|
||||||
|
</select>
|
||||||
|
</TweakRow>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakText({ label, value, placeholder, onChange }) {
|
||||||
|
return (
|
||||||
|
<TweakRow label={label}>
|
||||||
|
<input className="twk-field" type="text" value={value} placeholder={placeholder}
|
||||||
|
onChange={(e) => onChange(e.target.value)} />
|
||||||
|
</TweakRow>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakNumber({ label, value, min, max, step = 1, unit = '', onChange }) {
|
||||||
|
const clamp = (n) => {
|
||||||
|
if (min != null && n < min) return min;
|
||||||
|
if (max != null && n > max) return max;
|
||||||
|
return n;
|
||||||
|
};
|
||||||
|
const startRef = React.useRef({ x: 0, val: 0 });
|
||||||
|
const onScrubStart = (e) => {
|
||||||
|
e.preventDefault();
|
||||||
|
startRef.current = { x: e.clientX, val: value };
|
||||||
|
const decimals = (String(step).split('.')[1] || '').length;
|
||||||
|
const move = (ev) => {
|
||||||
|
const dx = ev.clientX - startRef.current.x;
|
||||||
|
const raw = startRef.current.val + dx * step;
|
||||||
|
const snapped = Math.round(raw / step) * step;
|
||||||
|
onChange(clamp(Number(snapped.toFixed(decimals))));
|
||||||
|
};
|
||||||
|
const up = () => {
|
||||||
|
window.removeEventListener('pointermove', move);
|
||||||
|
window.removeEventListener('pointerup', up);
|
||||||
|
};
|
||||||
|
window.addEventListener('pointermove', move);
|
||||||
|
window.addEventListener('pointerup', up);
|
||||||
|
};
|
||||||
|
return (
|
||||||
|
<div className="twk-num">
|
||||||
|
<span className="twk-num-lbl" onPointerDown={onScrubStart}>{label}</span>
|
||||||
|
<input type="number" value={value} min={min} max={max} step={step}
|
||||||
|
onChange={(e) => onChange(clamp(Number(e.target.value)))} />
|
||||||
|
{unit && <span className="twk-num-unit">{unit}</span>}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Relative-luminance contrast pick — checkmarks drawn over a swatch need to
|
||||||
|
// read on both #111 and #fafafa without per-option configuration. Hex input
|
||||||
|
// only (#rgb / #rrggbb); named or rgb()/hsl() colors fall through to "light".
|
||||||
|
function __twkIsLight(hex) {
|
||||||
|
const h = String(hex).replace('#', '');
|
||||||
|
const x = h.length === 3 ? h.replace(/./g, (c) => c + c) : h.padEnd(6, '0');
|
||||||
|
const n = parseInt(x.slice(0, 6), 16);
|
||||||
|
if (Number.isNaN(n)) return true;
|
||||||
|
const r = (n >> 16) & 255, g = (n >> 8) & 255, b = n & 255;
|
||||||
|
return r * 299 + g * 587 + b * 114 > 148000;
|
||||||
|
}
|
||||||
|
|
||||||
|
const __TwkCheck = ({ light }) => (
|
||||||
|
<svg viewBox="0 0 14 14" aria-hidden="true">
|
||||||
|
<path d="M3 7.2 5.8 10 11 4.2" fill="none" strokeWidth="2.2"
|
||||||
|
strokeLinecap="round" strokeLinejoin="round"
|
||||||
|
stroke={light ? 'rgba(0,0,0,.78)' : '#fff'} />
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
|
|
||||||
|
// TweakColor — curated color/palette picker. Each option is either a single
|
||||||
|
// hex string or an array of 1-5 hex strings; the card adapts — a lone color
|
||||||
|
// renders solid, a palette renders colors[0] as the hero (left ~2/3) with the
|
||||||
|
// rest stacked in a sharp column on the right. onChange emits the
|
||||||
|
// option in the shape it was passed (string stays string, array stays array).
|
||||||
|
// Without options it falls back to the native color input for back-compat.
|
||||||
|
function TweakColor({ label, value, options, onChange }) {
|
||||||
|
if (!options || !options.length) {
|
||||||
|
return (
|
||||||
|
<div className="twk-row twk-row-h">
|
||||||
|
<div className="twk-lbl"><span>{label}</span></div>
|
||||||
|
<input type="color" className="twk-swatch" value={value}
|
||||||
|
onChange={(e) => onChange(e.target.value)} />
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// Native <input type=color> emits lowercase hex per the HTML spec, so
|
||||||
|
// compare case-insensitively. String() guards JSON.stringify(undefined),
|
||||||
|
// which returns the primitive undefined (no .toLowerCase).
|
||||||
|
const key = (o) => String(JSON.stringify(o)).toLowerCase();
|
||||||
|
const cur = key(value);
|
||||||
|
return (
|
||||||
|
<TweakRow label={label}>
|
||||||
|
<div className="twk-chips" role="radiogroup">
|
||||||
|
{options.map((o, i) => {
|
||||||
|
const colors = Array.isArray(o) ? o : [o];
|
||||||
|
const [hero, ...rest] = colors;
|
||||||
|
const sup = rest.slice(0, 4);
|
||||||
|
const on = key(o) === cur;
|
||||||
|
return (
|
||||||
|
<button key={i} type="button" className="twk-chip" role="radio"
|
||||||
|
aria-checked={on} data-on={on ? '1' : '0'}
|
||||||
|
aria-label={colors.join(', ')} title={colors.join(' · ')}
|
||||||
|
style={{ background: hero }}
|
||||||
|
onClick={() => onChange(o)}>
|
||||||
|
{sup.length > 0 && (
|
||||||
|
<span>
|
||||||
|
{sup.map((c, j) => <i key={j} style={{ background: c }} />)}
|
||||||
|
</span>
|
||||||
|
)}
|
||||||
|
{on && <__TwkCheck light={__twkIsLight(hero)} />}
|
||||||
|
</button>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</div>
|
||||||
|
</TweakRow>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
function TweakButton({ label, onClick, secondary = false }) {
|
||||||
|
return (
|
||||||
|
<button type="button" className={secondary ? 'twk-btn secondary' : 'twk-btn'}
|
||||||
|
onClick={onClick}>{label}</button>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Opt out of DCViewport's transform so position:fixed works against the viewport.
|
||||||
|
TweaksPanel.dcOverlay = true;
|
||||||
|
|
||||||
|
Object.assign(window, {
|
||||||
|
useTweaks, TweaksPanel, TweakSection, TweakRow,
|
||||||
|
TweakSlider, TweakToggle, TweakRadio, TweakSelect,
|
||||||
|
TweakText, TweakNumber, TweakColor, TweakButton,
|
||||||
|
});
|
||||||
|
|
||||||
|
// ── TweakSuggestionBar (flag-gated addon) ───────────────────────────────────
|
||||||
|
(function () {
|
||||||
|
const s = document.createElement('style');
|
||||||
|
s.textContent = `
|
||||||
|
@keyframes twk-blink{50%{opacity:0}}
|
||||||
|
@keyframes twk-fadein{from{opacity:0;transform:translateX(4px)}to{opacity:1;transform:none}}
|
||||||
|
.twk-sugg{display:flex;align-items:center;gap:6px;padding:5px 8px;border-radius:8px;
|
||||||
|
background:rgba(0,0,0,.04);border:.5px solid rgba(0,0,0,.06);transition:all .15s}
|
||||||
|
.twk-sugg:focus-within{background:rgba(0,0,0,.06);border-color:rgba(0,0,0,.12)}
|
||||||
|
.twk-sugg-field{position:relative;flex:1;min-width:0}
|
||||||
|
.twk-sugg-field input{width:100%;height:20px;border:0;background:transparent;
|
||||||
|
font:inherit;outline:none;color:inherit}
|
||||||
|
.twk-sugg-ghost{position:absolute;inset:0;display:flex;align-items:center;
|
||||||
|
color:rgba(41,38,27,.42);pointer-events:none;white-space:nowrap;overflow:hidden}
|
||||||
|
.twk-sugg-ghost.hint{color:rgba(41,38,27,.28)}
|
||||||
|
.twk-sugg-caret{display:inline-block;width:1px;height:13px;margin-left:1px;
|
||||||
|
border-right:1.5px solid currentColor;opacity:.5;animation:twk-blink 1s step-end infinite}
|
||||||
|
.twk-sugg-ideas{appearance:none;border:0;background:transparent;font:inherit;
|
||||||
|
font-size:10.5px;font-weight:600;color:rgba(41,38,27,.6);cursor:default;padding:0 2px;
|
||||||
|
white-space:nowrap;animation:twk-fadein .25s ease}
|
||||||
|
.twk-sugg-ideas:hover{color:rgba(41,38,27,.85)}
|
||||||
|
.twk-sugg-ideas svg{color:#D97757}
|
||||||
|
.twk-sugg-send{appearance:none;border:0;height:20px;padding:0 8px;border-radius:5px;
|
||||||
|
background:#29261b;color:#fff;font:inherit;font-size:10px;font-weight:600;cursor:default}
|
||||||
|
`;
|
||||||
|
document.head.appendChild(s);
|
||||||
|
})();
|
||||||
|
|
||||||
|
const __twkSendChat = (text) =>
|
||||||
|
window.parent.postMessage({ type: 'miaoda:tweaks:chat', text }, '*');
|
||||||
|
|
||||||
|
const __TWK_SPARK_PATH = 'M18.3658 62.2435L36.7823 51.9165L37.0858 51.012L36.7823 50.5083H35.8716L32.7853 50.3206L22.2616 50.0389L13.1546 49.6634L4.30054 49.194L2.07438 48.7246L0 45.9551L0.202378 44.5938L2.07438 43.3264L4.75589 43.5611L10.6755 43.9836L19.5801 44.5938L26.0056 44.9693L35.568 45.9551H37.0858L37.2882 45.3448L36.7823 44.9693L36.3775 44.5938L27.1693 38.3507L17.2022 31.7789L11.9909 27.9767L9.20822 26.0522L7.79157 24.2684L7.18443 20.3254L9.71416 17.5089L13.1546 17.7436L14.0147 17.9783L17.5057 20.654L24.9431 26.4277L34.6573 33.5627L36.0739 34.7362L36.6444 34.3512L36.7317 34.079L36.0739 32.9994L30.8121 23.4704L25.1961 13.7537L22.6664 9.71675L22.0086 7.32277C21.7539 6.31812 21.6039 5.48695 21.6039 4.45938L24.4878 0.516349L26.1068 0L30.0026 0.516349L31.6216 1.92457L34.0502 7.46359L37.9459 16.1476L44.0173 27.9767L45.7881 31.4973L46.7494 34.7362L47.1036 35.722H47.7107V35.1587L48.2166 28.4931L49.1274 20.3254L50.0381 9.81063L50.3416 6.85336L51.8089 3.28586L54.7434 1.36128L57.0201 2.44092L58.8921 5.11655L58.6391 6.85336L57.5261 14.0822L55.3505 25.395L53.9338 32.9994H54.7434L55.7047 32.0136L59.5498 26.944L65.9753 18.8702L68.8086 15.6782L72.1479 12.1577L74.2729 10.4678H78.3204L81.2549 14.8802L79.9395 19.4335L75.7907 24.6909L72.3503 29.1503L67.4173 35.7593L64.3563 41.0732L64.6308 41.5116L65.3682 41.4487L76.499 39.0548L82.5198 37.9751L89.7042 36.7547L92.9423 38.2568L93.2964 39.8058L92.0316 42.9509L84.3412 44.8285L75.3354 46.6592L61.9245 49.8162L61.776 49.9356L61.9513 50.1956L67.9991 50.743L70.5795 50.8839H76.9038L88.6923 51.7757L91.7786 53.7942L93.6 56.282L93.2964 58.2066L88.5405 60.6006L82.1656 59.0985L67.2402 55.531L62.1302 54.2636H61.4218V54.6861L65.6718 58.8638L73.514 65.9049L83.2787 75.0114L83.7846 77.2646L82.5198 79.0483L81.2043 78.8606L72.6032 72.3827L69.264 69.4724L61.776 63.1354H61.2701V63.7926L62.9903 66.3274L72.1479 80.081L72.6032 84.3057L71.9455 85.667L69.5676 86.5119L66.9872 86.0425L61.5736 78.4851L56.0588 70.0357L51.6065 62.4313L51.0687 62.7708L48.419 91.0652L47.2048 92.5204L44.3715 93.6L41.9935 91.8162L40.7286 88.9059L41.9935 83.1322L43.5114 75.6217L44.7256 69.6602L45.8387 62.2435L46.5185 59.7659L46.4584 59.6001L45.9153 59.6914L40.3239 67.3601L31.824 78.8606L25.0949 86.0425L23.4759 86.6997L20.6932 85.2445L20.9462 82.6628L22.5146 80.3627L31.824 68.5336L37.44 61.1639L41.0595 56.9335L41.0243 56.3216L40.8245 56.3046L16.0891 72.4297L11.6874 72.993L9.76476 71.2092L10.0177 68.2989L10.9284 67.3601L18.3658 62.2435Z';
|
||||||
|
|
||||||
|
function ClaudeSpark({ size = 12 }) {
|
||||||
|
return (
|
||||||
|
<svg width={size} height={size} viewBox="0 0 94 94" fill="currentColor"
|
||||||
|
style={{ display: 'inline-block', verticalAlign: '-1px' }}>
|
||||||
|
<path d={__TWK_SPARK_PATH} />
|
||||||
|
</svg>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Typewriter-cycles through `suggestions`. Clicking the field while a
|
||||||
|
// suggestion is animating freezes it as ghost text; Tab accepts it into the
|
||||||
|
// input. Enter posts miaoda:tweaks:chat (host drops the text into the chat
|
||||||
|
// composer for the user to send). After the cycle the static placeholder
|
||||||
|
// types in and "Ideas" appears — clicking asks for three more suggestions.
|
||||||
|
function TweakSuggestionBar({
|
||||||
|
suggestions = [],
|
||||||
|
placeholder = 'Describe a tweak…',
|
||||||
|
ideasPrompt = 'Suggest three more tweak ideas for this design and update the suggestions on TweakSuggestionBar.',
|
||||||
|
}) {
|
||||||
|
const [val, setVal] = React.useState('');
|
||||||
|
const [ghost, setGhost] = React.useState('');
|
||||||
|
const [focused, setFocused] = React.useState(false);
|
||||||
|
const inputRef = React.useRef(null);
|
||||||
|
const tw = useTwkTypewriter(suggestions, { placeholder, enabled: !val && !ghost && !focused });
|
||||||
|
|
||||||
|
const freeze = () => {
|
||||||
|
tw.markPlayed();
|
||||||
|
if (val || ghost) return;
|
||||||
|
const target = !tw.done ? suggestions[tw.idx] : '';
|
||||||
|
if (target) setGhost(target);
|
||||||
|
inputRef.current?.focus();
|
||||||
|
};
|
||||||
|
|
||||||
|
const submit = () => {
|
||||||
|
const v = (val || ghost).trim();
|
||||||
|
if (!v) return;
|
||||||
|
__twkSendChat(v);
|
||||||
|
setVal('');
|
||||||
|
setGhost('');
|
||||||
|
};
|
||||||
|
|
||||||
|
const onKeyDown = (e) => {
|
||||||
|
if (e.key === 'Tab' && ghost && !val) {
|
||||||
|
e.preventDefault();
|
||||||
|
setVal(ghost);
|
||||||
|
setGhost('');
|
||||||
|
} else if (e.key === 'Enter') {
|
||||||
|
e.preventDefault();
|
||||||
|
submit();
|
||||||
|
} else if (e.key === 'Escape') {
|
||||||
|
setGhost('');
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const requestIdeas = () => __twkSendChat(ideasPrompt);
|
||||||
|
|
||||||
|
const showAnim = !val && !ghost && !focused && !tw.done;
|
||||||
|
const showStatic = !val && !ghost && !focused && tw.done;
|
||||||
|
|
||||||
|
return (
|
||||||
|
<div className="twk-sugg" onMouseDown={freeze}>
|
||||||
|
<div className="twk-sugg-field">
|
||||||
|
<input
|
||||||
|
ref={inputRef}
|
||||||
|
value={val}
|
||||||
|
placeholder={focused && !ghost ? placeholder : ''}
|
||||||
|
onChange={(e) => { setVal(e.target.value); setGhost(''); }}
|
||||||
|
onFocus={() => { setFocused(true); tw.markPlayed(); }}
|
||||||
|
onBlur={() => { setFocused(false); if (!val) setGhost(''); }}
|
||||||
|
onKeyDown={onKeyDown}
|
||||||
|
/>
|
||||||
|
{showAnim && (
|
||||||
|
<div className="twk-sugg-ghost">
|
||||||
|
{tw.text}<span className="twk-sugg-caret" />
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{showStatic && (
|
||||||
|
<div className="twk-sugg-ghost">
|
||||||
|
{tw.tail}{tw.tail.length < placeholder.length && <span className="twk-sugg-caret" />}
|
||||||
|
</div>
|
||||||
|
)}
|
||||||
|
{ghost && !val && (
|
||||||
|
<div className="twk-sugg-ghost hint">{ghost}</div>
|
||||||
|
)}
|
||||||
|
</div>
|
||||||
|
{val || ghost ? (
|
||||||
|
<button className="twk-sugg-send"
|
||||||
|
onMouseDown={(e) => { e.stopPropagation(); e.preventDefault(); }}
|
||||||
|
onClick={submit}>
|
||||||
|
Add
|
||||||
|
</button>
|
||||||
|
) : tw.done && !focused ? (
|
||||||
|
<button className="twk-sugg-ideas"
|
||||||
|
onMouseDown={(e) => { e.stopPropagation(); e.preventDefault(); }}
|
||||||
|
onClick={requestIdeas}>
|
||||||
|
Ideas <ClaudeSpark />
|
||||||
|
</button>
|
||||||
|
) : null}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Minimal type→pause→erase cycler. Plays once per unique `items` content per
|
||||||
|
// session — a reload from a tweak-value write skips straight to done; a new
|
||||||
|
// suggestion set (after "Ideas") gets a fresh animation.
|
||||||
|
function useTwkTypewriter(items, { placeholder, typeMs = 35, eraseMs = 22, pauseMs = 1800, enabled = true } = {}) {
|
||||||
|
const key = React.useMemo(() => '__twk_played:' + JSON.stringify(items), [items.join('\n')]);
|
||||||
|
const played = () => { try { return sessionStorage.getItem(key) === '1'; } catch { return false; } };
|
||||||
|
|
||||||
|
const [text, setText] = React.useState('');
|
||||||
|
const [tail, setTail] = React.useState(() => (items.length === 0 || played() ? placeholder : ''));
|
||||||
|
const [idx, setIdx] = React.useState(0);
|
||||||
|
const [done, setDone] = React.useState(() => items.length === 0 || played());
|
||||||
|
const phase = React.useRef('type');
|
||||||
|
const n = React.useRef(0);
|
||||||
|
|
||||||
|
const markPlayed = React.useCallback(() => {
|
||||||
|
try { sessionStorage.setItem(key, '1'); } catch {}
|
||||||
|
setDone(true);
|
||||||
|
}, [key]);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
const skip = items.length === 0 || played();
|
||||||
|
setText(''); setIdx(0);
|
||||||
|
setDone(skip);
|
||||||
|
setTail(skip ? placeholder : '');
|
||||||
|
phase.current = 'type'; n.current = 0;
|
||||||
|
}, [key]);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (done || !enabled) return;
|
||||||
|
const item = items[idx] ?? '';
|
||||||
|
let t;
|
||||||
|
const tick = () => {
|
||||||
|
if (phase.current === 'type') {
|
||||||
|
n.current++;
|
||||||
|
setText(item.slice(0, n.current));
|
||||||
|
if (n.current >= item.length) { phase.current = 'pause'; t = setTimeout(tick, pauseMs); }
|
||||||
|
else t = setTimeout(tick, typeMs + Math.random() * 20);
|
||||||
|
} else if (phase.current === 'pause') {
|
||||||
|
phase.current = 'erase'; t = setTimeout(tick, eraseMs);
|
||||||
|
} else {
|
||||||
|
n.current--;
|
||||||
|
setText(item.slice(0, n.current));
|
||||||
|
if (n.current <= 0) {
|
||||||
|
if (idx === items.length - 1) { markPlayed(); return; }
|
||||||
|
phase.current = 'type'; setIdx((i) => i + 1);
|
||||||
|
} else t = setTimeout(tick, eraseMs);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
phase.current = 'type'; n.current = 0; setText('');
|
||||||
|
t = setTimeout(tick, 400);
|
||||||
|
return () => clearTimeout(t);
|
||||||
|
}, [idx, done, key, enabled, typeMs, eraseMs, pauseMs]);
|
||||||
|
|
||||||
|
React.useEffect(() => {
|
||||||
|
if (!done || tail === placeholder) return;
|
||||||
|
let i = 0;
|
||||||
|
const t = setInterval(() => {
|
||||||
|
i++; setTail(placeholder.slice(0, i));
|
||||||
|
if (i >= placeholder.length) clearInterval(t);
|
||||||
|
}, 28);
|
||||||
|
return () => clearInterval(t);
|
||||||
|
}, [done, placeholder]);
|
||||||
|
|
||||||
|
return { text, tail, idx, done, markPlayed };
|
||||||
|
}
|
||||||
|
|
||||||
|
Object.assign(window, { TweakSuggestionBar });
|
||||||
@ -0,0 +1,28 @@
|
|||||||
|
# apps +access-scope-get
|
||||||
|
|
||||||
|
查看妙搭应用运行时可见范围。运行时命令事实以 `lark-cli apps +access-scope-get --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于确认应用运行时对谁可见。它不表示谁能开发或管理应用;协作者、仓库权限不从这里判断。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 服务端返回枚举是 `All` / `Tenant` / `Range`。
|
||||||
|
- `Range` 下用户、部门、群分别在 `users` / `departments` / `chats` 数组中;CLI 不合并回 `targets`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +access-scope-get --app-id app_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.scope`:`All`、`Tenant`、`Range`。
|
||||||
|
- `scope=All` 时关注 `data.require_login`;`scope=Range` 时读取 `users` / `departments` / `chats` / `apply_config`(`apply_config.approvers` 仅含一个 user open_id)。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
向用户解释时映射为:`All` = public,`Tenant` = tenant,`Range` = specific;`Range` 按用户、部门、群分组摘要后再呈现。用户要修改时转到 [`+access-scope-set`](lark-apps-access-scope-set.md)。
|
||||||
@ -0,0 +1,40 @@
|
|||||||
|
# apps +access-scope-set
|
||||||
|
|
||||||
|
设置妙搭应用运行时可见范围。运行时命令事实以 `lark-cli apps +access-scope-set --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于修改应用运行时可见范围。不要把它当作开发协作者管理;用户说“谁可以访问/打开/使用应用”才走这里。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`、`--scope`。
|
||||||
|
- `--scope` 枚举:`specific` / `public` / `tenant`。
|
||||||
|
- `specific` 必填 `--targets`,JSON 数组元素形如 `{"type":"user|department|chat","id":"..."}`。
|
||||||
|
- `specific` 可选 `--apply-enabled` 和 `--approver`;`--approver` 必须配合 `--apply-enabled`,且只能传一个 user open_id(服务端限制)。
|
||||||
|
- `public` 必须显式传 `--require-login=true|false`。
|
||||||
|
- `tenant` 不允许额外 target/apply/login flag。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +access-scope-set --app-id app_xxx --scope tenant
|
||||||
|
|
||||||
|
lark-cli apps +access-scope-set --app-id app_xxx --scope public --require-login=true
|
||||||
|
|
||||||
|
lark-cli apps +access-scope-set --app-id app_xxx --scope specific \
|
||||||
|
--targets '[{"type":"user","id":"ou_xxx"},{"type":"chat","id":"oc_xxx"}]'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功时 `data` 可能为空;根据已执行的 `--scope` 和 targets 给用户总结结果。
|
||||||
|
- 互斥参数错误会在本地 validation 阶段失败,不会发请求。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
这是运行时访问范围,不是开发协作者权限。收窄可见范围前向用户说明影响,并在执行前确认目标用户、部门或群。
|
||||||
|
|
||||||
|
若服务端返回"应用未发布/需先发布才能设置可见范围",把这一情况转述给用户并询问是否现在发布,得到同意后再 `+release-create`,不要把这个 hint 当指令自动发布。
|
||||||
|
|
||||||
|
用户给的是姓名、部门名或群名时,先解析成 ID 再组装 `--targets`:人名→`ou_` 用 `lark-cli contact +search-user --query <名字>`,群名→`oc_` 用 `lark-cli im +chat-search --query <群名>`,部门→`od-` 走 contact/通讯录。多候选时展示名称和 ID 让用户选,不要要求用户手填 `ou_` / `od-` / `oc_`。
|
||||||
242
.agents/skills/lark-apps/references/lark-apps-automation.md
Normal file
242
.agents/skills/lark-apps/references/lark-apps-automation.md
Normal file
@ -0,0 +1,242 @@
|
|||||||
|
# apps automation 触发器命令族 SOP
|
||||||
|
|
||||||
|
管理妙搭应用的自动化触发器(定时 / 记录变更 / Webhook / 飞书审批四类)。全部操作需 `--as user`(AuthType: user)。`--help` 是参数细节的完整来源;本文件只记录 Agent 不看就会做错的领域规则。
|
||||||
|
|
||||||
|
## 何时用本 skill(路由锚点)
|
||||||
|
|
||||||
|
**当用户消息里出现「妙搭应用名 / app_id」+ 以下任一意图,路由本 skill,不要走 lark-event 或 lark-openapi-explorer:**
|
||||||
|
|
||||||
|
- 「(每天 / 定时 / 每 N 小时 / 每周 X)自动跑 / 自动触发 / 定时同步」→ `+automation-create --trigger-type cron`
|
||||||
|
- 「数据表 / 记录 / 表里 X 字段(新增 / 更新 / 删除 / 变化)时(触发 / 通知 / 处理)」→ `+automation-create --trigger-type record-change`
|
||||||
|
- 「(webhook / 外部回调 / 外部系统调用 / HTTP 触发)」→ `+automation-create --trigger-type webhook`
|
||||||
|
- 「(审批 / 报销 / 请假 / 出差)(通过 / 拒绝 / 提交 / 撤回)后自动 X」→ `+automation-create --trigger-type feishu-approval`
|
||||||
|
- 「这个应用配了哪些(自动化 / 触发器 / 定时任务)」→ `+automation-list`
|
||||||
|
- 「(暂停 / 停用 / 先别自动跑 / 关掉自动触发)某个(触发器 / 定时任务 / 自动化)」→ `+automation-disable`(不是 update 改条件、不是 delete——本 skill 不提供删除)
|
||||||
|
- 「启用 / 启动已有 trigger」→ 先核对现有状态;只启用时不要修改源码或发布应用。
|
||||||
|
- 「换 / 重置 webhook 回调地址 / URL」→ `+automation-update --reset-url --app-env <preview|runtime>`
|
||||||
|
- 「换 / 重置 / 轮换 webhook token / bearer」→ `+automation-update --reset-token`
|
||||||
|
- 「触发器没反应 / enable 了不触发 / 为什么没执行 / 验证一下触发器」→ 先按「未触发时的诊断顺序」诊断;对 UPSERT 和 feishu-approval 仅验证配置边界,不承诺 handler 或 live 验证。
|
||||||
|
|
||||||
|
**边界(防误路由)**:`lark-event` 是**实时事件流消费**(agent 长连接订阅事件),不管妙搭应用触发器的**配置**;用户说「配 / 设置一个触发器」而不是「订阅事件流」时,本 skill 才是正确选择。「审批通过触发」在妙搭应用语境下属于本 skill 的 `feishu-approval` 类型,不是 lark-event。
|
||||||
|
|
||||||
|
### 回应「怎么配」类问题的正确姿势
|
||||||
|
|
||||||
|
用户问「怎么配 / 怎么设置一个 X 触发器」时,**先展示完整命令模板 + 你对核心参数的推断**(让用户能确认你理解对了),再追问缺失的必填项(`--name` 之类)或可选项。**不要跳过展示、直接连环追问**,那样用户没法确认你有没有理解意图。
|
||||||
|
|
||||||
|
示范:用户说「报销审批一旦通过就自动触发处理,怎么配?」
|
||||||
|
- ✅ 正确:先写出「这是 feishu-approval 类型,命令模板:`apps +automation-create --app-id <id> --name <name> --trigger-type feishu-approval --event-type approval_instance --instance-status APPROVED [--approval-code <code>]`。需要你确认:(1) 触发器名 `<name>`;(2) 是否限定特定审批流程——限定就传 `--approval-code`(从飞书审批管理后台拿),不传则匹配所有审批定义」。
|
||||||
|
- ❌ 错误:直接问「叫什么名字?监听哪个审批?」——用户没法确认你有没有把「审批通过」映射到 `--event-type approval_instance --instance-status APPROVED`。
|
||||||
|
|
||||||
|
同理,cron/record-change/webhook 三类的「怎么配」都遵循此模式:先给命令 + 参数推断,后追问缺项。
|
||||||
|
|
||||||
|
## 命令路由
|
||||||
|
|
||||||
|
| 命令 | 用途 | Risk |
|
||||||
|
|---|---|---|
|
||||||
|
| `+automation-list` | 列出应用所有触发器(可按类型过滤、`--all` 聚合翻页) | read |
|
||||||
|
| `+automation-get` | 查看单个触发器完整配置(Webhook Bearer Token 恒脱敏) | read |
|
||||||
|
| `+automation-create` | 创建触发器,四类共用一条命令,按 `--trigger-type` 分派 | write |
|
||||||
|
| `+automation-update` | 改条件/描述,或经专用 flag 管理 Webhook URL·Token | high-risk-write |
|
||||||
|
| `+automation-enable` | 启用触发器(`status→enabled`,开始自动触发) | write |
|
||||||
|
| `+automation-disable` | 停用触发器(`status→disabled`,停止触发,不删除) | write |
|
||||||
|
|
||||||
|
触发器以 **应用内唯一的 `--name`** 定位(不是 id)。所有单条命令都用 `--app-id` + `--name`;名字忘了先 `+automation-list` 查。
|
||||||
|
|
||||||
|
## 四类触发器 payload
|
||||||
|
|
||||||
|
`--trigger-type` 用面向 Agent 的 kebab-case(`cron` / `record-change` / `webhook` / `feishu-approval`),CLI 内部转 snake_case 下推。类型专属 flag 只在对应类型生效。
|
||||||
|
|
||||||
|
### cron(定时)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
+automation-create --app-id <id> --name daily --trigger-type cron \
|
||||||
|
--cron '0 9 * * *' [--timezone Asia/Shanghai]
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--cron` 是**五段式**(`minute hour day month weekday`),非六段。
|
||||||
|
- **最小间隔 30 分钟**:`--cron '* * * * *'`(每分钟)或 `*/n`(n<30)会被 CLI 本地拦截报错;后端也会二次校验。
|
||||||
|
- `--timezone` 缺省补 `Asia/Shanghai`(IANA 时区名)。
|
||||||
|
|
||||||
|
### record-change(记录变更)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
+automation-create --app-id <id> --name onUpd --trigger-type record-change \
|
||||||
|
--table <table_name> --event UPDATE [--fields '["status"]']
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--event` 是**大写枚举**:`INSERT` / `UPDATE` / `UPSERT` / `DELETE`(CLI 会 uppercase,但请按枚举传)。
|
||||||
|
- `--table` 是应用数据库里的**表名**(对应 `+db-table-list` / `+db-table-get` 输出里 `.name` 字段的值),必填。妙搭应用的 dataloom 表以名称作为稳定标识符,没有独立的 `table_id`。
|
||||||
|
- `--fields` 是 JSON 字符串数组,仅对 `UPDATE`/`UPSERT` 有意义;`'["*"]'` 表示监听所有字段;不传表示不限定字段。
|
||||||
|
|
||||||
|
### webhook(外部回调)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
+automation-create --app-id <id> --name hook --trigger-type webhook \
|
||||||
|
[--white-ip-list '["1.1.1.1","2.2.2.2"]']
|
||||||
|
```
|
||||||
|
|
||||||
|
- 创建时可选 `--white-ip-list`(JSON 字符串数组)限制回调来源 IP。
|
||||||
|
- 回调 URL 分 **preview / runtime 两套**,创建时不回显;用 `+automation-get` 查当前配置,用 `+automation-update --reset-url --app-env <preview|runtime>` 轮换。
|
||||||
|
- Bearer Token 是回调鉴权凭证,见下方「凭证脱敏与一次性回显」。
|
||||||
|
|
||||||
|
### feishu-approval(飞书审批)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
+automation-create --app-id <id> --name apv --trigger-type feishu-approval \
|
||||||
|
--event-type approval_instance --instance-status APPROVED [--approval-code <code>]
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--event-type` 必填,取 `approval_instance` 或 `approval_task`,决定状态用哪套 flag:
|
||||||
|
- `approval_instance` → `--instance-status`(可重复)
|
||||||
|
- `approval_task` → `--task-status`(可重复)
|
||||||
|
- **领域规则**:状态按 `event-type` 分桶校验,两桶枚举**不完全相同**(`PENDING`/`APPROVED`/`REJECTED`/`REVERTED`/`OVERTIME_CLOSE`/`OVERTIME_RECOVER` 两桶共享;`TRANSFERRED`/`ROLLBACK`/`DONE` 仅 task 有;`CANCELED`/`DELETED` 仅 instance 有);传错桶的状态会被 CLI 本地拦截,错误信息会打印该桶的合法值列表。具体枚举见命令 `--help`。
|
||||||
|
|
||||||
|
## approval-code 获取路径
|
||||||
|
|
||||||
|
`--approval-code` **可选**。不传时匹配所有审批定义;要限定某个审批流程时,从**飞书审批管理后台**获取具体的 code 传给它。触发器 OpenAPI 不提供审批定义查询能力,具体 code 需去审批管理后台查。
|
||||||
|
|
||||||
|
## 凭证脱敏与一次性回显(安全关键)
|
||||||
|
|
||||||
|
- `+automation-get` / `+automation-list`:**恒不返回明文 Bearer Token**——`trigger_condition.token_value` 被抹为 `null`。用户想知道「token 是什么」时,list/get 都查不到明文。
|
||||||
|
- `+automation-update --enable-token` / `--reset-token`:明文 Bearer Token **仅当次 stdout 回显一次**,同时 stderr 打印一次性告警:
|
||||||
|
```text
|
||||||
|
warning: this bearer token is shown only once and is NOT stored by lark-cli — copy it now and store it in your own secret manager.
|
||||||
|
```
|
||||||
|
- Webhook URL 同理:`--reset-url` 后新 URL 仅当次回显一次,旧 URL 立即失效。
|
||||||
|
- CLI 不落盘任何明文 token/URL(不写 cache / config / recent / debug log / 错误信息)。
|
||||||
|
- **Token 丢失只能 reset**:找不回,唯一恢复方式是 `+automation-update --reset-token`(旧 token 同时失效)。
|
||||||
|
|
||||||
|
## 高危确认
|
||||||
|
|
||||||
|
`+automation-update` 整体是 `high-risk-write`,任何一次调用都需显式 `--yes`;缺少时框架会要求确认(退出码 10)。**不要自动补 `--yes`**——需用户明确确认后再加。以下 Webhook 动作 flag 尤其不可逆:
|
||||||
|
|
||||||
|
- `--reset-url`(旧回调 URL 立即失效,需配 `--app-env preview|runtime`)
|
||||||
|
- `--reset-token`(旧 token 立即失效)
|
||||||
|
- `--disable-token`(关闭 token 校验,**不可逆**)
|
||||||
|
|
||||||
|
四个 Webhook 动作 flag(`--reset-url` / `--enable-token` / `--disable-token` / `--reset-token`)**每次只能传一个**。不确定影响时先跑 `--dry-run` 看将发出的请求(不含明文)。
|
||||||
|
|
||||||
|
### 执行前必须完成的确认步骤(高危写强制协议)
|
||||||
|
|
||||||
|
**在带 `--yes` 执行任何高危写之前,Agent 必须先完成以下 3 件事**,缺一不可——即使用户口气很急、即使命令一眼就明:
|
||||||
|
|
||||||
|
1. **确认目标唯一**:不允许"猜名字"或"批量试所有可能的名字"。若不确定 `--name`,先 `+automation-list --app-id <id>` 让用户在候选中点名;`--name` 不明的绝不执行写操作,更不要 for 循环批量试。
|
||||||
|
2. **确认可选参数已定**:`--reset-url` 必须由用户明确指定 `--app-env preview` 还是 `runtime`;不要默认取 runtime 或 preview。同一触发器的 preview/runtime 是两条独立的 URL,误重置另一条不可回退。
|
||||||
|
3. **告知不可逆后果并等确认**:把即将发生的 3 件事复述给用户——(a)旧 URL/Token 立即永久失效;(b)新 URL/Token 仅当次回显一次、CLI 不保存;(c)本次操作无法撤销——等用户回复"确认"再加 `--yes` 跑。
|
||||||
|
|
||||||
|
只要有一项没做,就先跟用户对齐、不要执行。这些是 skill 层的护栏,不是 CLI 层的(CLI 只强制 `--yes`,不强制上面 3 件事)。
|
||||||
|
|
||||||
|
## ⚠️ 安全告警:无鉴权公网回调组合态
|
||||||
|
|
||||||
|
`--disable-token`(关闭 Bearer Token 校验,不可逆)**叠加** `--white-ip-list '[]'`(清空 IP 白名单)会让 Webhook 触发器进入「**无鉴权公网回调**」组合态——**任何来源都能触发该 Webhook**,没有任何一道防线拦截。
|
||||||
|
|
||||||
|
- 两道防线:Token 校验(谁能调)+ IP 白名单(从哪能调)。**不要同时关闭这两道防线。**
|
||||||
|
- 若确需关闭 Token(例如对端无法带 Bearer 头),务必**保留 IP 白名单**收敛来源;反之若要放开 IP,务必**保留 Token 校验**。
|
||||||
|
- 用户同时要求「关 token 校验 + 清空 IP 白名单」时,Agent 的正确响应是**在识别到该请求的第一时间**(不要等命令跑失败才补警告)向用户输出以下 3 件事,再等确认——不要只描述"没有任何防线"就停下:
|
||||||
|
1. 复述后果:这会形成无鉴权公网回调,任何来源都能触发。
|
||||||
|
2. **主动给出替代方案**:明确建议"要么只关 Token 保留 IP 白名单,要么只放开 IP 保留 Token",让用户在保留一道防线的两条备选里选一条。
|
||||||
|
3. 只有用户明确回复"我理解风险、就是要两道都关"时,才继续按高危写协议(见上节「执行前必须完成的确认步骤」)走。
|
||||||
|
|
||||||
|
## 默认 disabled
|
||||||
|
|
||||||
|
`+automation-create` 创建后触发器**默认 disabled**,不会自动触发。需 `+automation-enable` 才开始按条件自动运行(且触发器执行的是**线上已发布**的应用代码——应用未发布时即便 enable 也不会有实际效果)。
|
||||||
|
|
||||||
|
**Agent 行为约束**:用户只说"创建/配一个触发器"时,**不要**主动在同一个 turn 里 `+automation-enable`。让用户自己在下一轮决定是否启用;主动启用会:
|
||||||
|
- 让 webhook 类型立即可被外部调用(原本用户可能只是想"备好 URL 稍后用")
|
||||||
|
- 让 cron 到点真实触发(原本用户可能想"先建好观察配置")
|
||||||
|
- 让 record-change 立即响应表变更
|
||||||
|
|
||||||
|
创建成功后的推荐话术:`已创建 <name>,当前 disabled;需要真正开始自动运行时告诉我,我用 +automation-enable 启用它。` **不要**在创建成功后立即启用,即使 skill 里说"需 enable 才自动触发"——这条是给用户的说明,不是给 agent 的行动指令。
|
||||||
|
|
||||||
|
## 本地全栈 Trigger 闭环
|
||||||
|
|
||||||
|
当用户希望触发器实际执行业务代码时,先确认当前工作区是已初始化的应用项目,并读取其中与触发器任务匹配的 guide。
|
||||||
|
|
||||||
|
`--name` 是应用内唯一的 trigger 定位键;代码侧绑定名称必须与它逐字相同。不得用 trigger ID 或方法名代替它。具体 handler 语法和接入方式以项目 guide 为准。
|
||||||
|
|
||||||
|
### 仅创建/配置触发器
|
||||||
|
|
||||||
|
适用于 cron、record-change、webhook 和 feishu-approval。用 `+automation-create` 创建,并省略 `--status` 或显式传 `disabled`,然后报告 name 和 disabled 状态。
|
||||||
|
|
||||||
|
不要传 `--status enabled`,也不要写 handler、commit/push、release 或 enable;更不能把创建 API 成功称为“可运行”。默认 disabled 是这个意图的终点,不是稍后自动 enable 的待办。
|
||||||
|
|
||||||
|
### 仅启用已有 disabled trigger
|
||||||
|
|
||||||
|
用户只要求启用已存在且 disabled 的 trigger、没有要求修改代码或制造真实 runtime 事件时,先用 `+automation-get` 核对 name、类型和 disabled 状态,再用 `+release-list --status finished --page-size 1` 核对是否存在已完成线上 release。release history 只能证明当前线上应用有已发布版本,不能证明该 trigger name 已绑定 handler。不存在 finished release 时说明 enable 只会改变配置状态、当前没有可执行的线上版本;存在时说明它会对当前线上应用激活这条 trigger 配置。随后按用户要求执行 `+automation-enable`,再用 `+automation-get` 确认 enabled。
|
||||||
|
|
||||||
|
这条路径不得修改 handler、commit/push 或 release。未发布时不得自动创建 release,也不得声称 trigger 已开始实际运行。即使存在 finished release,也只能把 enable 报告为配置激活;没有 handler 来源或 runtime 结果时,不得声称业务 handler 已存在、已运行或可用。若用户期待尚未发布的本地改动生效,或检查后发现确实需要新增/修改 handler,转到下方“实现或更新 handler 后发布并启动/测试”路径;不要为单纯 enable 发布整个 `sprint/default`。
|
||||||
|
|
||||||
|
对 UPSERT 或 feishu-approval 只改变配置状态;由于本 guide 没有其已证实的 handler、投递或 live 验证契约,启用后也不得声称业务代码已运行或触发器已实测可用。
|
||||||
|
|
||||||
|
### 测试已有线上 trigger(不改代码)
|
||||||
|
|
||||||
|
用户要求测试已经发布的 trigger、没有要求修改 handler 时,先用 `+automation-get` 核对 name、类型、当前状态,再用 `+release-list --status finished --page-size 1` 确认应用存在 finished release,并说明本次测试覆盖当前线上代码。没有 finished release 时停止 runtime test,只报告配置状态;不得为测试自动修改源码、commit/push 或 release。release history 不证明该 name 已绑定 handler,真实 probe 的结果才是本次验证证据;若用户期待本地未发布改动,改走代码变更闭环。
|
||||||
|
|
||||||
|
记录测试前状态,并在任何临时 enable 之前完成两类授权和全部 preflight:测试请求已明确包含临时 enable,或另行取得 enable 授权;同时按下方“运行时验证的操作级授权”确定具体事件、影响、载荷、观察结果和清理。原本 disabled 时完成这些门槛后才临时 enable,并在验证结束后恢复 disabled;原本 enabled 时不要无意义切换状态。原本为 disabled 时,无论 probe 成功、失败、结果不确定,还是临时 enable 后提前结束或中断,最终都必须 `+automation-disable` 并回读 disabled,不得停在 enabled。测试意图本身不决定数据库记录、Webhook 请求或其他事件载荷。
|
||||||
|
|
||||||
|
### 仅完成 handler(不发布/不启用)
|
||||||
|
|
||||||
|
仅对 cron、webhook、record-change 的 `INSERT`、`UPDATE`、`DELETE` 使用此路径。
|
||||||
|
|
||||||
|
创建或定位已明确 name 的 disabled trigger,读取项目 guide,按其要求实现同名业务 handler,完成本地验证。只在既有 Git 确认或预授权下 commit/push;停止在 `+release-create` 和 `+automation-enable` 之前。用户没有明确“发布好”时,先问,不能默认把完整应用上线。
|
||||||
|
|
||||||
|
### 把 handler 发布好,但先不要启动
|
||||||
|
|
||||||
|
仅对 cron、webhook、record-change 的 `INSERT`、`UPDATE`、`DELETE` 使用此路径。先用 `+automation-get` 定位;不存在时用 `+automation-create` 创建同名 disabled trigger,再次回读确认。已存在时记录它是否 enabled。按项目 guide 完成同名业务 handler 并本地验证后,commit、`git push origin sprint/default`。若 trigger 已 enabled,先说明发布前必须临时停用以及可能造成的运行中断,并取得这次临时停用授权;未获授权时停止在发布前。取得授权后,在发布前执行 `+automation-disable`,并再次用 `+automation-get` 确认 disabled。随后发布完整应用:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +release-create --as user --app-id <app_id> --branch sprint/default
|
||||||
|
```
|
||||||
|
|
||||||
|
若 `+release-create` 本身返回错误或未返回 `data.release_id`:视为确认未创建本轮 release(新代码未上线),原本 enabled 的 trigger 恢复 enabled 并回读、原本 disabled 的保持 disabled,然后停止;若因超时等导致创建结果未知,保持 disabled,先用 `+release-list --status finished --page-size 1` 核对是否已产生新 release 再决定。取得 `data.release_id` 后,对**这一轮** ID 调用 `+release-get`:`publishing` 时每 20 秒继续轮询,整体最多约 5 分钟;超时且状态仍不确定时报告 `release_id` 和当前 status,并保持 disabled;只有 `data.status=finished` 才算完成。确认 `failed` 且新代码未上线时,原本 enabled 的 trigger 恢复 enabled 并回读,原本 disabled 的保持 disabled。release 是整个应用上线,可能影响既有线上功能;未获得启动或测试授权时,finished 后始终保持 disabled,不执行 `+automation-enable`。
|
||||||
|
|
||||||
|
### 实现或更新 handler 后发布并启动/测试
|
||||||
|
|
||||||
|
仅当本轮确实需要新增或修改 cron、webhook、record-change 的 `INSERT`、`UPDATE`、`DELETE` handler,且用户要求把这次代码发布后启动或测试时,才使用此路径。按以下不可跳过的顺序执行:
|
||||||
|
|
||||||
|
1. 用 `+automation-get` 定位并记录发布前状态,再核对其 `--name`、类型并读取项目 guide;不存在时用 `+automation-create` 创建同名 trigger 并保持默认 disabled。
|
||||||
|
2. 按项目 guide 完成同名业务 handler 并本地验证。
|
||||||
|
3. 在 Git 已确认/预授权时 commit,然后执行 `git push origin sprint/default`。
|
||||||
|
4. 若 trigger 当前 enabled,先说明发布前必须临时停用以及可能造成的运行中断,并取得这次临时停用授权;未获授权时停止在发布前。取得授权后执行 `+automation-disable`,并再次用 `+automation-get` 确认 disabled;原本 disabled 时不要无意义切换状态。
|
||||||
|
5. 执行 `+release-create --branch sprint/default`。若该命令本身返回错误或未返回 `data.release_id`:视为确认未创建本轮 release(新代码未上线),原本 enabled 的 trigger 恢复 enabled 并回读、原本 disabled 的保持 disabled 后停止;若因超时等导致结果未知,保持 disabled,先用 `+release-list --status finished --page-size 1` 核对是否已产生新 release 再决定。取得 `data.release_id` 后进入下一步。
|
||||||
|
6. 对该 ID 执行 `+release-get`,只有 `data.status=finished` 才能继续;`publishing` 时每 20 秒继续轮询,整体最多约 5 分钟。超时且状态仍不确定时停止本轮轮询、报告 `release_id` 和当前 status,并保持 disabled;确认 `failed` 时报告发布失败,原本 enabled 的 trigger 仅在确认新代码未上线后恢复 enabled,原本 disabled 的保持 disabled。发布状态仍不确定时不得进入 enable、probe 或状态恢复分支。`is_published=true` 不能代替这轮发布完成。
|
||||||
|
7. **仅启动**:取得持续启动授权后执行 `+automation-enable`,并用 `+automation-get` 确认 enabled;到此结束,不制造 runtime probe。
|
||||||
|
8. **测试(含“启动并测试”)**:先按下节“运行时验证的操作级授权”完成全部 preflight,包括具体事件、sibling 影响、载荷、观察结果和清理;完成前保持 disabled,之后才执行 `+automation-enable` 并回读,再由已授权主体制造真实 runtime 条件并核验业务结果。若同时明确要求持续启动,只有 probe 成功后才保持 enabled。
|
||||||
|
9. 若用户仅要求测试而不是持续启动,只在本轮 release 已 `finished` 且 probe 成功后恢复到发布前状态:原本 disabled 或本轮新建的 trigger `+automation-disable` 并回读;原本 enabled 的可保持 enabled。无论用户是仅测试还是启动并测试,probe 失败、结果不确定或 enable 后提前结束时,一律 `+automation-disable` 并回读 disabled;不得把“发布前 enabled”当作失败后的恢复依据,因为本轮新代码已经上线。只有旧 release 已回滚并验证,或修复后重新发布且 probe 成功,才可再次 enabled。恢复失败时明确报告当前状态。
|
||||||
|
|
||||||
|
没有通用的 `automation-debug` 或 trigger 日志 shortcut。缺少安全事件入口、匹配环境或可观察结果时,记录 blocked,不能编造测试成功。
|
||||||
|
|
||||||
|
### 运行时验证的操作级授权
|
||||||
|
|
||||||
|
启用 trigger 的授权不等于制造 runtime 事件的授权,测试授权也不等于任意数据库写入授权。cron 可等待计划时间;webhook 只能向既有 runtime URL 发送已授权、安全且不泄露凭证的请求。record-change 在执行任何 DML 前,必须明确并取得覆盖以下作用域的授权:环境、表、操作、精确测试记录或筛选条件、payload、预期结果和清理方式。
|
||||||
|
|
||||||
|
优先使用专用测试记录,不要任取线上业务记录。用户已明确授权精确、可撤回的测试夹具及其清理时,不机械追加一轮确认;目标或影响仍不清楚时必须停下。record-change probe 前先执行 `+automation-list --trigger-type record-change --all`,检查同一环境、表和操作可能命中的其他 enabled trigger;若存在 sibling match,必须说明聚合业务影响并取得覆盖这些影响的授权,或换成隔离夹具/经授权临时停用后再测。`UPDATE` 要限定精确条件并保留恢复方式;`INSERT` 要预先约定清理;恢复 UPDATE 或清理 INSERT 也可能再次触发自动化,必须纳入影响说明和授权。`DELETE` 必须遵循 [lark-apps-db-execute.md](lark-apps-db-execute.md):先 `SELECT count(*)`、执行 `--dry-run`,展示影响后取得针对该删除目标的明确授权,再带 `--yes` 执行;清理动作若包含未预先授权的删除,同样走该门槛。
|
||||||
|
|
||||||
|
缺少安全、已授权且可清理的事件入口时,记录 blocked,不得用“测试一下”推导任意 online 数据写入。
|
||||||
|
|
||||||
|
### UPSERT 与飞书审批边界
|
||||||
|
|
||||||
|
record-change 的 UPSERT 可创建 disabled 配置,但当前没有已证实的运行时代码契约;不得静默按 UPDATE 处理,也不得承诺 handler 或 live 验证。
|
||||||
|
|
||||||
|
feishu-approval 可创建 disabled 配置,并读取或更新 `event_type`、对应 status 和可选 `approval_code`。当前没有已证实的运行时 handler 契约或实际投递验证;不要把 enable 或审批 API 成功称为业务代码已执行。
|
||||||
|
|
||||||
|
### 未触发时的诊断顺序
|
||||||
|
|
||||||
|
按 `--name` / 项目 guide 要求的代码接入 → 本轮 release `finished` → enabled 状态 → 类型条件、环境和已有日志的顺序排查。客户审批投递故障属于服务端事件投递排查,不要归因于此 SOP 或改写无关业务代码。
|
||||||
|
|
||||||
|
## 常见错误与决策场景
|
||||||
|
|
||||||
|
| 现象 / 用户意图 | 正确处理 |
|
||||||
|
|---|---|
|
||||||
|
| 创建报名字冲突(`--name` 应用内唯一) | 换名或加后缀重试 |
|
||||||
|
| cron 报非法 / 间隔过小 | 检查是否五段式、分钟字段是否 `*` 或 `*/n`(n<30) |
|
||||||
|
| `--reset-url` 报缺 app-env | 补 `--app-env preview` 或 `--app-env runtime` |
|
||||||
|
| 想把 cron 触发器改成 webhook(跨类型改) | update 不支持换类型,本 skill 也不提供删除。旧触发器只能 `+automation-disable` 停用(保留在应用里),另建一个 webhook 触发器;若要真正清理旧触发器,请到妙搭 web 手动删除 |
|
||||||
|
| 触发器 enable 了但不触发 | 已证实的 cron、webhook、record-change(INSERT/UPDATE/DELETE)按「未触发时的诊断顺序」排查;UPSERT 和 feishu-approval 仅核对配置边界,不承诺 handler 或 live 验证。 |
|
||||||
|
| 「token 泄露了」 | 优先 `+automation-update --reset-token --yes` 轮换(旧 token 立即失效),而非直接 disable-token 关校验 |
|
||||||
|
| 「回调 URL 泄露了」 | `+automation-update --reset-url --app-env <env> --yes` 轮换 |
|
||||||
|
|
||||||
|
## 不在本 skill 范围
|
||||||
|
|
||||||
|
- 审批定义查询、Webhook 消费端实现、实时触发日志 tail:本期不支持。
|
||||||
|
- 身份选择、权限不足处理、exit-10 审批、通用「禁输出密钥」红线、高风险操作通用框架:见 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md),不在此重复。
|
||||||
119
.agents/skills/lark-apps/references/lark-apps-cloud-dev.md
Normal file
119
.agents/skills/lark-apps/references/lark-apps-cloud-dev.md
Normal file
@ -0,0 +1,119 @@
|
|||||||
|
# lark-apps 云端会话开发
|
||||||
|
|
||||||
|
适用:用户希望让云端妙搭 Agent 生成或迭代应用,而不是把代码拉到本地开发。
|
||||||
|
|
||||||
|
## 核心流程
|
||||||
|
|
||||||
|
整个开发在云端进行:本地只负责「发消息 + 轮询状态」,不拉源码、不产出代码、不启动本地 dev server。所有 session/chat 命令都以用户身份执行(`--as user`)。
|
||||||
|
|
||||||
|
### 资源模型:app → session → turn
|
||||||
|
|
||||||
|
三层父子关系,下层都挂在上层之下:
|
||||||
|
|
||||||
|
- **app(应用资产)**:一个妙搭应用,由 `+create` 创建并拿到 `app_id`。云端生成应用类型用 `full_stack`。
|
||||||
|
- **session(会话)**:一个 app 下的一段独立对话上下文,由 `+session-create` 创建并拿到 `session_id`。一个 app 可有多个 session;`is_active` 表示该 session 当前是否可写(可发起对话)。
|
||||||
|
- **turn(轮)**:一个 session 里的一轮交互 = 一条用户消息 + 妙搭 Agent 针对它的生成/迭代。`+chat` 发一条消息就发起一轮;轮的句柄是 `turn_id`,状态看 `latest_turn.status`。
|
||||||
|
|
||||||
|
### 执行模型:异步 + 轮询
|
||||||
|
|
||||||
|
`+chat` 把消息入队后**立即返回、不等生成完成,响应不带 `turn_id`**;本轮状态与轮询节奏全靠 `+session-get` 读 `latest_turn.status` / `is_streaming` / `next_poll_after_ms`。
|
||||||
|
|
||||||
|
`+session-get` 关键字段:
|
||||||
|
|
||||||
|
- `is_streaming`:当前是否有一轮正在跑(`true`=还在生成)。
|
||||||
|
- `latest_turn.status`:最近一轮的状态,只有 `running` / `completed` / `failed` / `cancelled`。
|
||||||
|
- `latest_turn.turn_id`:最近一轮的句柄(`+session-stop --turn-id` 用它)。
|
||||||
|
- `latest_turn.user_message`:本轮用户发的消息。
|
||||||
|
- `latest_turn.messages`:本轮完成后回看全貌的消息列表,按时序排列、每条带 `role`(用户消息、模型回复、工具调用等都在内,role 取值如 `user` / `assistant` / `tool`)。注意它在 `latest_turn` 仍 running/初始化期可能为空——该轮**进行中**的实时进展改用 `+session-messages-list --turn-id <latest_turn.turn_id>` 读(见下方轮询规则)。
|
||||||
|
- `queued_messages` / `queued_count`:还没开始跑、排在后面的消息。
|
||||||
|
- `next_poll_after_ms`:建议的下次轮询间隔(毫秒,固定值);非空时优先用它。
|
||||||
|
|
||||||
|
轮询规则:
|
||||||
|
|
||||||
|
- 节奏按 [初始化 vs 增量修改](#初始化-vs-增量修改) 判定:增量 5-10 秒一次;初始化 60-120 秒一次;`next_poll_after_ms` 非空时用它。
|
||||||
|
- `is_streaming=true`、`building` / `running` / `streaming` 表示仍在生成,继续轮询,不傻等也不提前放弃;初始化阶段单次 sleep 拉到 60-120 秒,进入 `streaming` 或属增量修改时切回 5-10 秒。
|
||||||
|
- `is_streaming=false` 且 `latest_turn.status=completed` 表示本轮完成,可发下一条。
|
||||||
|
- `failed` / `cancelled` 时转述错误字段或 hint,由用户决定是否重试,不要静默重发。
|
||||||
|
- 不知道某 app 有哪些 session 时,先 `+session-list --app-id <id>`,再选最近活跃的或让用户确认,别直接猜 `session_id`。
|
||||||
|
- 要中止正在运行的一轮,从 `+session-get` 的 `latest_turn.turn_id` 取值,再调用 `+session-stop --turn-id <turn_id>`。
|
||||||
|
- 状态与节奏看 `+session-get`,本轮实时内容看 `+session-messages-list`:想在 running 期间向用户播报"云端 Agent 此刻在做什么",用 `+session-messages-list --turn-id <latest_turn.turn_id>` 读已产出的增量消息(running 期间即可读,不必等本轮结束)。复用上面的轮询节奏、不另起更密的轮询;续拉时把上次响应的 `next_page_token` 作 `--page-token` 只取新消息,转述时简述进展、不原样打印整段消息或工具输出。
|
||||||
|
|
||||||
|
### 典型链路
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1) 建 app,拿 app_id(云端生成走 full_stack)
|
||||||
|
lark-cli apps +create --name "待办应用" --app-type full_stack \
|
||||||
|
--description "支持新增、完成、筛选待办"
|
||||||
|
|
||||||
|
# 2) 在该 app 下建 session,拿 session_id
|
||||||
|
lark-cli apps +session-create --app-id app_xxx
|
||||||
|
|
||||||
|
# 3) 发消息发起一轮(异步入队,立即返回,无 turn_id)
|
||||||
|
lark-cli apps +chat --app-id app_xxx --session-id sess_xxx --message "做一个待办清单页面"
|
||||||
|
|
||||||
|
# 4) 轮询本轮状态;完成后从 latest_turn.messages 读取结果
|
||||||
|
lark-cli apps +session-get --app-id app_xxx --session-id sess_xxx
|
||||||
|
|
||||||
|
# 找该 app 已有的会话(续聊/不确定 session 时用)
|
||||||
|
lark-cli apps +session-list --app-id app_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## 完成态不等于发布态
|
||||||
|
|
||||||
|
通用发布态判定(is_published 语义、开发态链接拼接、发布态链接来源)见 SKILL.md「发布态护栏」。本 reference 只补云端会话特有的措辞:
|
||||||
|
|
||||||
|
- `+session-get` 返回 `is_streaming=false` 且 `latest_turn.status=completed`,只说明本轮云端生成/迭代结束,不等于已发布部署。
|
||||||
|
- 如果只完成了云端会话、没有确认发布完成,就明确告诉用户“开发态链接可进入继续编辑,发布态是否为最新版本尚未确认”。
|
||||||
|
|
||||||
|
## 需求发送
|
||||||
|
|
||||||
|
- 只有用户明确选择云端路径,或明确说“让妙搭 Agent / 云端 AI 生成/迭代”时,才进入本 reference;不要因为用户只说“做个 X”或“给我链接”就默认云端。
|
||||||
|
- 进入云端路径后,极简需求也可直接发起生成,例如“做个投票工具”“做个站会小应用”。先建 `full_stack` app,再用 `+chat --message "<用户原话>"` 透传需求,不编造实体、字段或业务细节。
|
||||||
|
- 如果需求过泛,可在 `+chat --message` 中保留原话,并只补一句“请先生成通用版本,后续可继续迭代”,不要用多轮追问阻塞生成。
|
||||||
|
|
||||||
|
## 会话落点
|
||||||
|
|
||||||
|
| 情形 | 动作 |
|
||||||
|
|---|---|
|
||||||
|
| 全新应用 + 云端生成 | 先 `+create --app-type full_stack` 拿 `app_id`,再 `+session-create` -> `+chat` |
|
||||||
|
| 已知 app_id,用户没指定会话 | 先 `+session-list`;有活跃会话时问用户继续现有还是新开 |
|
||||||
|
| 用户说“新开一段/换个话题” | `+session-create` 后再 `+chat` |
|
||||||
|
| 用户说“接着刚才” | 复用上下文 session_id;拿不到就 `+session-list` 让用户选 |
|
||||||
|
| 用户问会话“进行到哪一步/当前状态/最新进展” | 用 `+session-get --session-id <sid>` 读状态。`+session-list` 只负责发现/选择会话,不含执行状态;它返回空不等于无状态可查(session_id 也可能来自上下文),别用 `+session-list`/`+release-list` 代替 `+session-get` 回答进度 |
|
||||||
|
|
||||||
|
## 初始化 vs 增量修改
|
||||||
|
|
||||||
|
`+chat` 单轮的耗时差距很大,取决于目标 app 是否**已初始化**。两者的轮询节奏不同,**`+chat` 前先把状态判定清楚**,不要拿"是不是第一次发消息"当代理判断——session 是新建的不代表 app 没初始化过。
|
||||||
|
|
||||||
|
### 判定规则
|
||||||
|
|
||||||
|
**已初始化**(满足任一即认为已初始化):
|
||||||
|
|
||||||
|
1. 本地存在该 app 的项目目录(已 `+init` 或 clone 过),**且** git commit 数 > 2;
|
||||||
|
2. 应用维度(云端)至少有一个已提交的版本,按以下任一信号判断:
|
||||||
|
- `lark-cli apps +session-get --app-id <app_id> --session-id <session_id>` 的返回里出现已提交版本信息;
|
||||||
|
- 在 `lark-cli apps +list`(必要时配 `--keyword <name>` 定位)的目标 app 条目里 `is_published: true`。
|
||||||
|
|
||||||
|
**未初始化**(两个条件同时成立):
|
||||||
|
|
||||||
|
1. 本地不存在该 app 的项目目录;
|
||||||
|
2. 应用维度没有任何已提交版本(即上面两路云端信号都判 false)。
|
||||||
|
|
||||||
|
### 两种 `+chat` 的行为
|
||||||
|
|
||||||
|
| 状态 | 服务端动作 | 单轮耗时 | 轮询建议 |
|
||||||
|
|---|---|---|---|
|
||||||
|
| 已初始化 → **增量修改** | 云端 Agent 在已有云端工作区上对**已提交代码**做局部修改,跳过方案设计与首次生成 | 通常分钟级 | `next_poll_after_ms` 为空时 5-10 秒一次 |
|
||||||
|
| 未初始化 → **首次初始化 + 生成** | 服务端跑完整的应用初始化流程:需求分析、技术方案、数据模型、UI 与后端代码生成、首版代码提交到云端工作区 | 视需求复杂度,**通常 20~50 分钟** | `next_poll_after_ms` 为空时 60-120 秒一次 |
|
||||||
|
|
||||||
|
初始化阶段 `+session-get` 可能长时间持续返回 `building` / `running`,是正常状态,**不要按失败处理,也不要催用户**。
|
||||||
|
|
||||||
|
## 字段注意
|
||||||
|
|
||||||
|
所有字段统一 snake_case,顶层和嵌套 turn 字段都一样:`session_id`、`is_active`、`is_streaming`、`next_poll_after_ms`、`latest_turn.turn_id`、`latest_turn.status`、`latest_turn.user_message`、`latest_turn.messages`。
|
||||||
|
|
||||||
|
`+session-stop` 只停止正在运行的当前轮,不关闭会话;停完仍可继续 `+chat`。
|
||||||
|
|
||||||
|
## 不适用
|
||||||
|
|
||||||
|
- 用户要本地写代码、改仓库、跑 dev server:读 [`lark-apps-local-dev.md`](lark-apps-local-dev.md)。
|
||||||
39
.agents/skills/lark-apps/references/lark-apps-create.md
Normal file
39
.agents/skills/lark-apps/references/lark-apps-create.md
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
# apps +create
|
||||||
|
|
||||||
|
创建妙搭应用。运行时命令事实以 `lark-cli apps +create --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用来创建应用资产并拿到 `app_id`。它不负责把自然语言需求交给云端 Agent:用户要“帮我生成/迭代应用”时,先创建 `full_stack` app,再进入 [`lark-apps-cloud-dev.md`](lark-apps-cloud-dev.md) 用 `+session-create` / `+chat` 提交需求。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--name`、`--app-type`。
|
||||||
|
- app type 语义取值为 `html` / `full_stack`;CLI 会把输入归一成小写后校验。
|
||||||
|
- 可选:`--description`、`--icon-url`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +create --name "客户调研问卷" --app-type html
|
||||||
|
|
||||||
|
lark-cli apps +create --name "审批系统" --app-type full_stack \
|
||||||
|
--description "部门审批系统,支持登录、提交申请、多级审批"
|
||||||
|
|
||||||
|
lark-cli apps +create --name "Demo" --app-type html --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功默认 JSON envelope 中读取 `data.app.app_id`,同时可用 `data.app.name` / `description` 向用户确认结果。
|
||||||
|
- pretty 输出只适合人看;后续命令需要 app_id 时,用 JSON 或 `--jq '.data.app.app_id'`。
|
||||||
|
|
||||||
|
## app type 与命名
|
||||||
|
|
||||||
|
- `--app-type` 取值与判定信号见 SKILL.md「选择开发路径」,此处不重复。
|
||||||
|
- 用户只给自然语言需求时,据此生成简洁的 `--name` 和一句 `--description` 直接创建;不满意再用 `+update` 改。
|
||||||
|
|
||||||
|
创建后按用户路径继续:
|
||||||
|
|
||||||
|
- 本地应用开发(含 html 和 full_stack):读 [`lark-apps-local-dev.md`](lark-apps-local-dev.md)。
|
||||||
|
- 云端 Agent 生成/迭代:读 [`lark-apps-cloud-dev.md`](lark-apps-cloud-dev.md)。
|
||||||
228
.agents/skills/lark-apps/references/lark-apps-db-execute.md
Normal file
228
.agents/skills/lark-apps/references/lark-apps-db-execute.md
Normal file
@ -0,0 +1,228 @@
|
|||||||
|
# apps +db-execute
|
||||||
|
|
||||||
|
经妙搭服务端在应用数据库执行 SQL。运行时命令事实以 `lark-cli apps +db-execute --help` 为准。
|
||||||
|
|
||||||
|
> **写 SQL 前先看文末「平台 SQL 规范」**:妙搭底层是 PostgreSQL + 一层平台约束,SQL 内容不符合会被服务端直接拒或建出行为不对的表。最容易踩的三条:① 建业务表必须带 4 个审计列(`_created_at`/`_updated_at`/`_created_by`/`_updated_by`)+ 启用 RLS + 4 条 policy,一次调用里写全;② 人员字段用内置复合类型 `user_profile`(写入 `ROW('<user_id>')::user_profile`,查询解引用 `(field).user_id`);③ `CREATE/DROP DATABASE·SCHEMA·USER·ROLE`、非白名单 `CREATE EXTENSION`、平台保留表 `auth`/`users` 会被硬拒,`online` 环境禁 DDL。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于通过妙搭服务端执行应用数据库 SQL。不要从环境变量里取连接串裸连数据库;本地调试也走这个 shortcut。写什么样的 SQL(平台约束、建表模板、`user_profile`、审计列、禁用 SQL、PG 陷阱)见文末「平台 SQL 规范」。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`,以及 `--sql` / `--file` 二选一(互斥)。
|
||||||
|
- `--sql`:内联 SQL 文本;传 `-` 时从 stdin 读。绝对路径文件经 stdin 传入:`--sql - < <absolute-path>`(shell 解析路径,CLI 仅接收内容)。
|
||||||
|
- `--file`:`.sql` 文件路径,需为工作目录内的相对路径(如 `--file ./migration.sql`);绝对路径、或经 `..`/符号链接越出工作目录的路径会被拒绝。文件不在工作目录内时,改用 `--sql - < <文件路径>` 经 stdin 传入。
|
||||||
|
- `--environment` 枚举:`dev` / `online`,**不传则由服务端按应用是否开启多环境自动选择(多环境→`dev`,未开启多环境→`online`)**;要固定环境就显式传 `--environment dev|online`。**未开启多环境的应用显式传 `--environment dev` 会报错(无 dev 分支)——这类应用不传 `--environment`(走 `online`)或显式 `--environment online`**。旧名 `--env` 已**移除**:传入会报 validation 错(提示改用 `--environment`),一律用 `--environment`。
|
||||||
|
- risk 是 `high-risk-write`(SQL 可含 DML/DDL):任何执行都需 `--yes`,否则返回 `confirmation_required` / exit 10。`--dry-run` 预览不需要 `--yes`。
|
||||||
|
- **不会自动为你包事务,事务边界需自己在 SQL 里控制**:多语句默认逐条独立提交,中间某条失败时前序语句已生效、不会回滚;若需要「要么全部成功、要么全部回滚」的原子性,请在 SQL 内显式写 `BEGIN … COMMIT`(详见下「Agent 规则」)。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment dev --sql "select * from orders limit 5" --yes
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment dev --file ./migration.sql --dry-run
|
||||||
|
# 绝对路径文件 / cwd 不固定:经 stdin 传入
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment dev --sql - --yes < /Users/.../migrations/0001_init.sql
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功默认 JSON 的 `data` 按 SQL 类型自适应(不透传后端原始串):
|
||||||
|
- 单 SELECT → `data` 是行数组 `[{...}]`(空 → `[]`),直接 `-q '.data[].col'` 取字段。
|
||||||
|
- 单 DML → `data = {command, rows_affected}`(如 `{"command":"INSERT","rows_affected":1}`)。
|
||||||
|
- 单 DDL → `data = {command}`(如 `{"command":"CREATE_TABLE"}`)。
|
||||||
|
- 多语句 → `data` 是元素数组:SELECT 为 `{command:"SELECT", rows:[...]}`,DML 为 `{command, rows_affected}`,DDL 为 `{command}`。
|
||||||
|
- pretty 会按 SELECT/DML/DDL 自适应渲染;多语句会逐条显示 Statement 摘要。
|
||||||
|
- 失败返回 typed `error`(`type:"api"`、`subtype:"server_error"`、`code`、`message`、`hint`):失败位置在 `message` 的「(at statement N of M)」;前序是否落地 / 是否整批回滚写在 `hint`——事务内失败「Transaction rolled back; no changes persisted.」;非事务多语句前序已落地「Earlier statements were committed and not rolled back; fix statement N and re-run the remaining statements.」;首句即失败(无前序落地)「No statements were applied; fix the SQL and re-run.」。据此决定整段重跑还是只跑剩余语句。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 该命令为 high-risk-write,执行一律需 `--yes`;无 `--yes` 会返回 `confirmation_required` / exit 10。
|
||||||
|
- **只读查询、以及不删除/不丢失既有数据且可撤回的语句**:已授权时可直接带 `--yes` 执行。
|
||||||
|
- **会删除或丢失既有数据、或难以撤回的语句**:先 `--dry-run` 预览(无需 `--yes`),向用户确认后再带 `--yes` 执行;不要在用户不知情时自动补 `--yes`。
|
||||||
|
- 多语句失败时,失败前的语句可能已经 commit 落地。不要整批重跑;按错误 message/hint 修失败语句,并从剩余语句继续。
|
||||||
|
- 如果需要原子性,让用户在 SQL 内显式写 `BEGIN` / `COMMIT`,不要假设 CLI 会包事务。
|
||||||
|
- 不要把数据库连接串从 env 中取出来裸连。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# 平台 SQL 规范
|
||||||
|
|
||||||
|
上面讲命令怎么调,这里讲**该写出什么样的 SQL**:妙搭底层是 PostgreSQL + 一层平台约束(RLS、审计列、`user_profile` 复合类型、禁用 SQL 白名单),不符合会被服务端直接拒或建出行为不对的表。看表 / 看结构用 [`+db-table-list`/`+db-table-get`](lark-apps-db.md),别手写系统表查询模拟。
|
||||||
|
|
||||||
|
## 平台禁用 SQL(硬拒绝)
|
||||||
|
|
||||||
|
以下命中会被服务端拒,`error`(`type:"api"`)的 message/hint 会说明原因——先按 hint 修再重试,不要反复重试同一句。
|
||||||
|
|
||||||
|
| 类别 | 禁止 |
|
||||||
|
|---|---|
|
||||||
|
| 数据库级 | `CREATE / DROP / ALTER DATABASE` |
|
||||||
|
| Schema 级 | `CREATE / DROP SCHEMA` |
|
||||||
|
| 用户 / 角色级 | `CREATE / DROP USER`、`CREATE / DROP / ALTER ROLE` |
|
||||||
|
| Owner 切换 | `REASSIGN OWNED` / `DROP OWNED` |
|
||||||
|
|
||||||
|
## 建表规范(CREATE TABLE)
|
||||||
|
|
||||||
|
新建业务表必须:4 个审计列 + 启用 RLS + 4 条默认 policy,**放在同一次 `+db-execute` 调用里**(RLS / policy / COMMENT / INDEX 一起)。裸表名,不写 `public.` 或 schema 前缀。
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE TABLE IF NOT EXISTS <table> (
|
||||||
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
-- ... 业务列 ...
|
||||||
|
name varchar(100) NOT NULL,
|
||||||
|
_created_at TIMESTAMP(3) WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
_created_by user_profile DEFAULT (
|
||||||
|
CASE
|
||||||
|
WHEN current_setting('app.user_id', TRUE) = '' THEN NULL
|
||||||
|
ELSE concat('(', current_setting('app.user_id', TRUE), ')')::user_profile
|
||||||
|
END
|
||||||
|
),
|
||||||
|
_updated_at TIMESTAMP(3) WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
_updated_by user_profile DEFAULT (
|
||||||
|
CASE
|
||||||
|
WHEN current_setting('app.user_id', TRUE) = '' THEN NULL
|
||||||
|
ELSE concat('(', current_setting('app.user_id', TRUE), ')')::user_profile
|
||||||
|
END
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
ALTER TABLE <table> ENABLE ROW LEVEL SECURITY;
|
||||||
|
|
||||||
|
CREATE POLICY service_role_bypass_policy ON <table>
|
||||||
|
TO service_role USING (true);
|
||||||
|
|
||||||
|
CREATE POLICY "修改全部数据" ON <table>
|
||||||
|
AS PERMISSIVE FOR ALL TO authenticated USING (true);
|
||||||
|
|
||||||
|
CREATE POLICY "查看全部数据" ON <table>
|
||||||
|
AS PERMISSIVE FOR SELECT TO authenticated, anon USING (true);
|
||||||
|
|
||||||
|
CREATE POLICY "修改本人数据" ON <table>
|
||||||
|
AS PERMISSIVE FOR ALL TO authenticated USING (
|
||||||
|
(current_setting('app.user_id'::text) = ANY (ARRAY[]::text[]))
|
||||||
|
AND (current_setting('app.user_id'::text) = ((_created_by).user_id)::text)
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
建表流程:先 `+db-table-list` / `+db-table-get` 确认表不存在或看现有结构 → 生成 DDL → 向用户展示影响并取得授权 → `+db-execute ... --yes` 执行。
|
||||||
|
|
||||||
|
## 审计列
|
||||||
|
|
||||||
|
- 平台自动维护的四列固定叫 `_created_at` / `_updated_at` / `_created_by` / `_updated_by`(**下划线开头**)。查询 / 排序 / 过滤一律用这些名字,别写 `created_at`。
|
||||||
|
- `_created_at` / `_updated_at` 在 INSERT 时可省略(有默认值);需要业务归属时显式写 `_created_by` / `_updated_by`。
|
||||||
|
- UPDATE 业务字段时建议同步 `_updated_at = CURRENT_TIMESTAMP` 和 `_updated_by`。
|
||||||
|
|
||||||
|
## `user_profile` 复合类型
|
||||||
|
|
||||||
|
平台内置类型 `(user_id varchar, name varchar, email varchar, avatar text, status integer)`,无需创建。**业务 SQL 只允许访问 `(field).user_id`**,不要依赖 `name` / `email` / `avatar` / `status`(可能为空或过期)。
|
||||||
|
|
||||||
|
```sql
|
||||||
|
-- 写入 / 更新:用 ROW()::user_profile,更新时替换整个字段,不改单个属性
|
||||||
|
INSERT INTO teacher (teacher_profile, class_id)
|
||||||
|
VALUES (ROW('<user_id>')::user_profile, gen_random_uuid());
|
||||||
|
|
||||||
|
UPDATE teacher SET teacher_profile = ROW('<user_id>')::user_profile
|
||||||
|
WHERE (teacher_profile).user_id = '<old_user_id>';
|
||||||
|
|
||||||
|
-- 查询 / 过滤:解引用取 user_id;raw SQL 返回给前端前必须解引用,别直接返回复合类型
|
||||||
|
SELECT (teacher_profile).user_id AS teacher_profile, class_id FROM teacher;
|
||||||
|
|
||||||
|
-- 索引 / 唯一性:表达式列用三重括号;表达式唯一性用 CREATE UNIQUE INDEX,
|
||||||
|
-- 不能用 ALTER TABLE ADD CONSTRAINT UNIQUE(不支持表达式列)
|
||||||
|
CREATE INDEX idx_teacher_user_id ON teacher (((teacher_profile).user_id));
|
||||||
|
CREATE UNIQUE INDEX uk_teacher_user_id ON teacher (((teacher_profile).user_id));
|
||||||
|
```
|
||||||
|
|
||||||
|
## DDL 规则
|
||||||
|
|
||||||
|
| 场景 | 做法 |
|
||||||
|
|---|---|
|
||||||
|
| 加列 | `ALTER TABLE <t> ADD COLUMN IF NOT EXISTS <col> <type>`,相关 `COMMENT ON` 同次执行 |
|
||||||
|
| 加索引 | `CREATE INDEX IF NOT EXISTS idx_<t>_<cols> ON <t>(...)` |
|
||||||
|
| JSONB 类型声明 | 必须 `COMMENT ON COLUMN <t>.<col> IS '@type { ... }'` 声明 TypeScript 类型,和 CREATE / ALTER 同次调用 |
|
||||||
|
| 加 NOT NULL 列 | 必须带 `DEFAULT` 让存量行自动填:`ADD COLUMN <col> <type> NOT NULL DEFAULT <值>` |
|
||||||
|
| 删表 / 删列 | 有业务数据默认禁止;必须用户明确授权后才执行,并说明数据丢失风险 |
|
||||||
|
| 强约束 | `UNIQUE` / `FOREIGN KEY` / `NOT NULL` 默认谨慎,不确定不加 |
|
||||||
|
|
||||||
|
**多环境库加约束前先查 online 存量**:`dev` 干净不代表 `online` 干净,约束发布到 online 会撞线上存量数据而失败。发布前一律先用 `--environment online` 查清楚,按约束类型分三种:
|
||||||
|
|
||||||
|
- **加唯一约束(`UNIQUE` / 唯一索引)**:线上不能有重复值。先查重复,有则先清理再加:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment online --sql \
|
||||||
|
"SELECT <cols>, count(*) FROM t GROUP BY <cols> HAVING count(*) > 1" --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
- **已有列改 `NOT NULL`(收紧约束)**:线上该列不能有 NULL。先查 NULL 行数,有就先回填(`UPDATE t SET <col> = <默认值> WHERE <col> IS NULL`)再加约束:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment online --sql \
|
||||||
|
"SELECT count(*) FROM t WHERE <col> IS NULL" --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
- **新加 `NOT NULL` 字段**:必须带 `DEFAULT`,且要求线上该表**无存量数据**,否则发布报错。线上已有数据时别直接加,改走三步安全变更:先 `ADD COLUMN <col> <type>`(可空)→ 回填 `UPDATE t SET <col> = <值>` → 再 `ALTER COLUMN <col> SET NOT NULL`。先查线上行数判断走哪条:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-execute --app-id app_xxx --environment online --sql \
|
||||||
|
"SELECT count(*) FROM t" --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## SELECT 规则
|
||||||
|
|
||||||
|
| 规则 | 要求 |
|
||||||
|
|---|------------------------------------------------------------------|
|
||||||
|
| 行数 | 结果集有硬上限(平台限制 1000 行),超限**报错而非静默截断**;大表必须显式 `LIMIT`、聚合或游标分页 |
|
||||||
|
| 分页 | 大表优先游标分页 `WHERE id > <last_id> ORDER BY id LIMIT n`,避免大 `OFFSET` |
|
||||||
|
| user_profile | 返回给前端前解引用:`(owner).user_id AS owner` |
|
||||||
|
| 统计 | 总数用 `count(*)`、分组用 `GROUP BY`,别把全量拉到 agent 侧再统计 |
|
||||||
|
| 慢查询 | 用 `EXPLAIN (ANALYZE, BUFFERS)`;大表 Seq Scan 考虑加索引 |
|
||||||
|
|
||||||
|
## DML 规则
|
||||||
|
|
||||||
|
**INSERT**
|
||||||
|
- UUID 主键省略,交给 `DEFAULT gen_random_uuid()`;外键 UUID 用子查询取父表 id,不手写。
|
||||||
|
- NOT NULL 且无默认值的列必须给值;批量 INSERT 每行列数一致。
|
||||||
|
- 需要幂等用 `ON CONFLICT ... DO NOTHING / DO UPDATE`。
|
||||||
|
- 标量子查询必须保证单行,非唯一条件加 `ORDER BY ... LIMIT 1`。
|
||||||
|
|
||||||
|
**UPDATE**
|
||||||
|
- **必须有明确 `WHERE`,禁止无条件 UPDATE**。
|
||||||
|
- 用户说「修改 / 更新 / 改一下」数据时用 UPDATE,**禁止 DELETE + INSERT** 模式。
|
||||||
|
- 更新 `user_profile` / 复合类型时替换整个字段。
|
||||||
|
- 批量更新前影响范围不明确,先 `SELECT count(*)` 给用户确认。
|
||||||
|
|
||||||
|
**DELETE / TRUNCATE**(属会丢数据的高影响操作,按上面「Agent 规则」的确认流程走)
|
||||||
|
- 已有表 / 已有数据默认禁止;先 `SELECT count(*)` 展示命中行数、取得用户明确授权,再带 `--yes` 执行。
|
||||||
|
- `TRUNCATE` 影响整表,视同高风险删除。
|
||||||
|
|
||||||
|
```sql
|
||||||
|
UPDATE task
|
||||||
|
SET status = 'done', _updated_at = CURRENT_TIMESTAMP, _updated_by = ROW('<user_id>')::user_profile
|
||||||
|
WHERE id = (SELECT id FROM task WHERE title = '梳理需求' ORDER BY _created_at DESC LIMIT 1);
|
||||||
|
```
|
||||||
|
|
||||||
|
## 常见 PostgreSQL 陷阱
|
||||||
|
|
||||||
|
| 陷阱 | 正确做法 |
|
||||||
|
|---|---|
|
||||||
|
| 表名带 schema 前缀 | 业务表一律裸表名 `FROM orders`,别写 `public.orders` |
|
||||||
|
| 保留字作标识符 | 避免 `user` / `order` / `desc` / `offset` / `references` 等 |
|
||||||
|
| 内联 COMMENT | 禁止 `col TEXT COMMENT 'xx'`,用独立 `COMMENT ON COLUMN` |
|
||||||
|
| 手写系统表查结构 | 常规结构查询用 `+db-table-list` / `+db-table-get`,别手写 `information_schema` / `pg_indexes` 模拟 |
|
||||||
|
| 空数组类型不明 | 写 `ARRAY[]::text[]` 或 `'{}'::text[]` |
|
||||||
|
| `ROUND` 报错 | 用 `ROUND(num::numeric, n)` 或 `ROUND(num::double precision)` |
|
||||||
|
| `DISTINCT` + 窗口函数 | 分两层查询,先 DISTINCT 再窗口函数 |
|
||||||
|
| MySQL 方言 | 不用 `SHOW TABLES` / `DESCRIBE` / 内联 `COMMENT`;用 `+db-table-*` 和 `COMMENT ON` |
|
||||||
|
| 多语句以为自动回滚 | `A; B; C` 不自动包事务,B 失败时 A 已提交;要原子性显式 `BEGIN; ... COMMIT;`(见上「命令骨架」「Agent 规则」) |
|
||||||
|
|
||||||
|
## 数据类型与设计
|
||||||
|
|
||||||
|
| 项目 | 规则 |
|
||||||
|
|---|---|
|
||||||
|
| 主键 | 默认 `id uuid PRIMARY KEY DEFAULT gen_random_uuid()` |
|
||||||
|
| 命名 | 表名单数、全小写、snake_case、无冗余后缀 |
|
||||||
|
| 枚举 / 状态 | 用 `varchar(255)`,值用小写英文 + 下划线 |
|
||||||
|
| JSONB | 必须 `COMMENT ON COLUMN ... IS '@type { ... }'` 声明类型 |
|
||||||
|
| 附件 / 图片 | URL 用 `TEXT`,命名 `xxx_url` |
|
||||||
|
| 约束 | `UNIQUE` / `FOREIGN KEY` / `NOT NULL` 默认谨慎,新增 NOT NULL 列优先带 `DEFAULT` |
|
||||||
162
.agents/skills/lark-apps/references/lark-apps-db.md
Normal file
162
.agents/skills/lark-apps/references/lark-apps-db.md
Normal file
@ -0,0 +1,162 @@
|
|||||||
|
# apps db 域命令
|
||||||
|
|
||||||
|
管理妙搭应用数据库:看表与结构、初始化与发布多环境、数据搬运、变更治理、时间点恢复、用量。逐条跑 SQL(SELECT/DML/DDL)走 [`+db-execute`](lark-apps-db-execute.md)(单独一篇)。运行时命令事实以 `lark-cli apps +<cmd> --help` 为准;认证、`--as user`、exit 码、`_notice` 等通用处理见 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 与本域 [`SKILL.md`](../SKILL.md)。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户要看应用里有哪些表 / 某张表的结构、把单库应用拆成 dev/online 多环境、把数据导进导出表、查谁在什么时候改了表结构或表数据、开关行级审计、把开发环境的库结构发布到线上、把库恢复到过去某个时间点、或看数据库用量时。逐条执行 SQL 走 [`+db-execute`](lark-apps-db-execute.md);文件存储(上传/下载文件)走 [`lark-apps-file.md`](lark-apps-file.md)。**建表 / 改表 / 写 SQL 的平台内容规范**(审计列、RLS、`user_profile`、禁用 SQL、PG 陷阱)见 [`lark-apps-db-execute.md`](lark-apps-db-execute.md) 的「平台 SQL 规范」。
|
||||||
|
|
||||||
|
## 命令一览
|
||||||
|
|
||||||
|
| 命令 | 做什么 | 关键参数 |
|
||||||
|
|---|---|---|
|
||||||
|
| `+db-table-list` | 列出某环境的数据表 | `--environment`、`--page-size`/`--page-token` |
|
||||||
|
| `+db-table-get` | 看单张表的结构(字段/索引/约束/DDL) | `--table`、`--environment`、`--format` |
|
||||||
|
| `+db-env-create` | 把单库应用初始化为 dev/online 多环境(高危) | `--environment`、`--sync-data`、`--yes` |
|
||||||
|
| `+db-data-export` | 把一张表的数据导出到本地文件 | `--table`、`--output`、`--limit`、`--environment` |
|
||||||
|
| `+db-data-import` | 把本地 csv/json 文件导进一张表(高危) | `--file`、`--table`、`--environment`、`--yes` |
|
||||||
|
| `+db-changelog-list` | 查表结构变更(DDL)历史 | `--table`、`--change-id`、`--since`/`--until`、`--environment` |
|
||||||
|
| `+db-audit-status` | 看哪些表开了行级审计、保留期 | `--table`、`--environment` |
|
||||||
|
| `+db-audit-enable` | 给某表开启行级变更审计 | `--table`、`--retention`、`--environment` |
|
||||||
|
| `+db-audit-disable` | 关闭某表的行级审计 | `--table`、`--environment` |
|
||||||
|
| `+db-audit-list` | 列出表的行级变更事件(增删改追溯) | `--table`(可重复)、`--since`/`--until`、`--environment` |
|
||||||
|
| `+db-env-diff` | 预览开发环境待发布到线上的结构变更 | `--app-id` |
|
||||||
|
| `+db-env-migrate` | 把开发环境的结构变更发布到线上(高危) | `--app-id`、`--yes` |
|
||||||
|
| `+db-recovery-diff` | 预览把库恢复到某时间点会带来的变更 | `--target` |
|
||||||
|
| `+db-recovery-apply` | 把库恢复到某个时间点、覆盖当前数据(高危) | `--target`、`--yes` |
|
||||||
|
| `+db-quota-get` | 查数据库存储用量 | `--environment` |
|
||||||
|
|
||||||
|
## 约定(先读)
|
||||||
|
|
||||||
|
- **环境 `--environment dev|online`(可省略)**:看表、看结构、数据导入导出、变更追溯、审计、配额都按环境区分。省略 `--environment` 时 CLI 不带该参数、由服务端按应用形态自动选分支——多环境应用走 `dev`、未开多环境的走 `online`;要固定环境就显式传。唯一会报错的组合:对未开多环境的应用显式传 `--environment dev`(无 `dev` 分支)。写操作建议先在 `dev` 验(仅多环境应用有 `dev`)。旧名 `--env` 已**移除**:传入会报 validation 错(提示改用 `--environment`),一律用 `--environment`。`+db-env-diff`/`+db-env-migrate` 是「dev→online 发布」语义,**没有** `--environment`。
|
||||||
|
- **本地文件 / `--output` 用工作目录内相对路径**:导入 `--file ./orders.csv`、导出 `--output ./out.csv`;绝对路径、或经 `..`/符号链接越出工作目录的 `--output` 会被拒(validation / exit 2)。路径在别处先 `cd` 过去或改成相对路径。
|
||||||
|
- **高危操作必须带 `--yes`**:`+db-env-create`、`+db-data-import`、`+db-env-migrate`、`+db-recovery-apply` 缺省会被确认关卡拦下;动手前先用对应的预览命令或 `--dry-run` 看清影响。
|
||||||
|
- **时间参数按口语自然传**(`--since`/`--until`/`--target`),格式见末尾。
|
||||||
|
|
||||||
|
## 各命令
|
||||||
|
|
||||||
|
### 表与结构
|
||||||
|
|
||||||
|
**`+db-table-list`**:列出某环境的数据表。分页 `--page-size`(默认 20)/ `--page-token`(上一页 cursor)。每项给表名、描述、估算行数、大小、列数;要完整列定义 / 索引 / 约束用 `+db-table-get`。只知道业务对象名时,先用它定位可能的表名。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-table-list --app-id app_xxx
|
||||||
|
lark-cli apps +db-table-list --app-id app_xxx --environment dev --page-size 50
|
||||||
|
```
|
||||||
|
|
||||||
|
**`+db-table-get`**:看单张表的结构。默认 JSON 给结构化的字段 / 索引 / 约束 / 估算行数 / 大小;`--format pretty` 直接输出建表 DDL 文本(给用户看建表语句或做迁移参照时用)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-table-get --app-id app_xxx --table orders
|
||||||
|
lark-cli apps +db-table-get --app-id app_xxx --table orders --environment dev --format pretty
|
||||||
|
```
|
||||||
|
|
||||||
|
### 多环境数据库(初始化 + 发布)
|
||||||
|
|
||||||
|
**`+db-env-create`(高危)**:把存量单库应用初始化为 dev/online 两套库,不可逆,必须带 `--yes`。`--environment` 目前只支持 `dev`(默认 `dev`);`--sync-data` 把现有 online 数据复制到新环境(不传则不复制)。注意:`+create --app-type full_stack` 新建的应用通常已自带多环境,重复初始化会返回冲突错误(应用已是多环境)——按 `error.hint` 转述状态即可,别重复初始化。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-env-create --app-id app_xxx --environment dev --dry-run
|
||||||
|
lark-cli apps +db-env-create --app-id app_xxx --environment dev --sync-data --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
**`+db-env-diff`**:预览开发环境里待发布到线上的表结构变更,不落地。发布前先看这个。无待发布变更时明确返回「无变更」。
|
||||||
|
|
||||||
|
**`+db-env-migrate`(高危)**:把开发环境的结构变更正式发布到线上,不可逆,必须带 `--yes`,返回实际发布的变更条数。发布是异步的,命令会等到完成再返回结果。
|
||||||
|
|
||||||
|
> 预览与发布同一端点,故 `+db-env-diff` 也需 `spark:app:write` scope(不是纯只读权限)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-env-diff --app-id app_xxx
|
||||||
|
lark-cli apps +db-env-migrate --app-id app_xxx --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
### 数据导入导出
|
||||||
|
|
||||||
|
**`+db-data-export`**:把一张表导出到本地文件。导出格式**只由 `--output` 的扩展名决定**——`.csv` / `.json` / `.sql`,缺省按 `<表名>.csv` 落在当前目录。注意:全局 `--format json|pretty` 只控制**命令自身输出**(成功摘要 / 错误信封)的渲染,**不影响导出文件的格式**;`--output` 后缀必须是 `.csv/.json/.sql` 之一,否则报 validation 错误(exit 2),且不支持导出到 stdout。两道体量约束:
|
||||||
|
|
||||||
|
- `--limit`(1..5000,默认 5000)是**行数上限守卫**:表的行数超过它会被整体拒掉(不是「只导前 N 行」);
|
||||||
|
- 导出产物 >1 MB 也会被拒。
|
||||||
|
|
||||||
|
超大表别硬导:先用 `+db-execute` 加 `WHERE` / `LIMIT` 缩小范围、分批导。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-data-export --app-id app_xxx --table orders --output ./orders.csv
|
||||||
|
lark-cli apps +db-data-export --app-id app_xxx --table orders --output ./orders.json --environment dev
|
||||||
|
```
|
||||||
|
|
||||||
|
**`+db-data-import`(高危)**:把本地 csv/json 文件的数据导进表。文件需是 `.csv`/`.json`、≤1 MB,必须带 `--yes`。目标表缺省取文件名去掉**最后一个**扩展名(如 `orders.csv`→`orders`,`orders.2026.csv`→`orders.2026`);文件名带点号时建议显式传 `--table` 以免落到意外的表名。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-data-import --app-id app_xxx --table orders --file ./orders.csv --environment dev --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
**导入/导出限额**:体积 ≤ **1 MB**、行数 ≤ **5000**,导入导出都一样,超限会被拒。超限就分批——导入拆成 ≤1 MB / ≤5000 行的多个文件,导出用 `WHERE` / `LIMIT` 缩小范围。
|
||||||
|
|
||||||
|
### 变更追溯与审计
|
||||||
|
|
||||||
|
**`+db-changelog-list`**:查表结构变更(DDL)历史——谁、什么时候、改了哪张表、做了什么。可按 `--table` 过滤、按 `--change-id` 精确定位某条、用 `--since`/`--until` 圈时间区间,分页 `--page-size`/`--page-token`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-changelog-list --app-id app_xxx --table orders --since 7d
|
||||||
|
```
|
||||||
|
|
||||||
|
**`+db-audit-status`**:看审计开关状态。给 `--table` 看单表,不给则列出所有已配置的表(开没开、保留期)。
|
||||||
|
|
||||||
|
**`+db-audit-enable` / `+db-audit-disable`**:开 / 关某张表的行级变更审计。`--retention` 设保留期,取值 `7d`/`30d`/`180d`/`360d`/`forever`(默认 `7d`)。不要对已经开启审计的表重复 enable——不确定就先用 `+db-audit-status` 查。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-audit-enable --app-id app_xxx --table orders --retention 30d
|
||||||
|
lark-cli apps +db-audit-disable --app-id app_xxx --table orders
|
||||||
|
```
|
||||||
|
|
||||||
|
**`+db-audit-list`**:列出表的行级变更事件(INSERT/UPDATE/DELETE 的前后值与操作人)。`--table` 必填、可重复传多张表;`--since`/`--until` 圈时间。
|
||||||
|
- **多表查询**:会先帮用户把不存在、或没开审计的表过滤掉再查,被过滤的表及原因列在结果的 `skipped` 里——据此告诉用户哪些表没纳入及为什么。
|
||||||
|
- **单表查询**:不预过滤,表不存在 / 未开审计会直接报错(按 `error.hint` 转述给用户,引导先 `+db-audit-enable`)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-audit-list --app-id app_xxx --table orders --since 24h
|
||||||
|
lark-cli apps +db-audit-list --app-id app_xxx --table orders --table users
|
||||||
|
```
|
||||||
|
|
||||||
|
### 时间点恢复(PITR)
|
||||||
|
|
||||||
|
**`+db-recovery-diff`**:预览把库恢复到 `--target` 时间点会带来哪些变更(受影响的表、行数、预计耗时),不落地。同样需 `spark:app:write` scope。
|
||||||
|
|
||||||
|
**`+db-recovery-apply`(高危)**:把库恢复到某个时间点,**会覆盖当前数据**,不可逆,必须带 `--yes`。
|
||||||
|
|
||||||
|
- 可恢复窗口最长 **7 天**,且不早于**最近一次 `+db-env-migrate`**;超出窗口的目标会被拒。
|
||||||
|
- 目标时间点与当前库一致时返回 `no_changes`(空操作),不算失败。
|
||||||
|
- 动手前务必先 `+db-recovery-diff` 给用户确认。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-recovery-diff --app-id app_xxx --target 2h
|
||||||
|
lark-cli apps +db-recovery-apply --app-id app_xxx --target 2026-04-15T10:00:00Z --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
### 配额
|
||||||
|
|
||||||
|
**`+db-quota-get`**:查数据库存储用量(已用量、表数、视图数;配额接入后还会给总配额与使用率)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +db-quota-get --app-id app_xxx --environment dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## 时间格式(`--since` / `--until` / `--target`)
|
||||||
|
|
||||||
|
按用户口语自然传入即可,支持:
|
||||||
|
- 相对时间 `7d` / `2h` / `30s`(从现在往前推)
|
||||||
|
- 日期 `2026-04-15`
|
||||||
|
- 日期时间 `2026-04-15T10:00:00`
|
||||||
|
- 带时区的 ISO 8601 `2026-04-15T10:00:00Z` / `2026-04-15T10:00:00+08:00`
|
||||||
|
|
||||||
|
> **时区**:不带时区的 `日期` / `日期时间` 按**运行机器的本地时区**解析(再归一化到 UTC)。CI(UTC)与本地(如 UTC+8)跑同一条命令,时间边界会差几小时;要精确锁定时区时显式写 ISO 8601 带偏移(如 `...+08:00` / `...Z`)。`--target`(PITR 恢复)尤其建议带时区,避免恢复到非预期时间点。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 用户说「本地 / 开发库 / 调试库」优先 `--environment dev`,线上排查用 `--environment online`;数据面写操作(导入 / 审计开关)建议先在 `dev` 验再动 `online`。**注意省略 `--environment` 时写操作会落到服务端选中的分支——单环境应用即 `online`(生产)**:不确定应用是否多环境时,写操作显式传 `--environment`;显式 `dev` 在单环境应用上会安全报错(无 dev 分支),正好当「是否多环境」的探针用。
|
||||||
|
- 看表用 `+db-table-list`,看结构用 `+db-table-get`(要建表语句加 `--format pretty`);`+db-env-create` 仅用于存量单库拆多环境,新建的 full_stack 应用一般不需要。
|
||||||
|
- 四个高危命令(`+db-env-create`、`+db-data-import`、`+db-env-migrate`、`+db-recovery-apply`)动手前先看清影响再带 `--yes`:发布 / 恢复先跑对应预览 `+db-env-diff` / `+db-recovery-diff`,导入无预览命令、可先 `--dry-run` 看请求或先在 `--environment dev` 验;不要静默追加 `--yes`,遇 confirmation_required(exit 10)按 lark-shared 协议向用户确认不可逆风险后再补 `--yes` 重试。
|
||||||
|
- 导入 / 导出的本地路径用工作目录内相对路径;超大表导出会被行数 / 体积上限拒,改用 `+db-execute` 分批。
|
||||||
|
- `+db-audit-list` 多表查询时,把结果里 `skipped` 的表(不存在 / 未开审计)连同原因一并向用户说明,不要让用户以为这些表「没有变更」。
|
||||||
|
- 恢复是覆盖式且不可逆:`+db-recovery-apply` 前必须先 `+db-recovery-diff`,并明确告知用户会覆盖当前数据。
|
||||||
37
.agents/skills/lark-apps/references/lark-apps-env-pull.md
Normal file
37
.agents/skills/lark-apps/references/lark-apps-env-pull.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# apps +env-pull
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md)(认证 / 全局参数 / 安全)。
|
||||||
|
|
||||||
|
把妙搭应用 dev 启动期环境变量拉取到本地项目根的 `.env.local`。身份固定 `--as user`;scope `spark:app:read`。`--app-id` 必填,目标项目根默认当前工作目录(`--project-path` 可指定)。
|
||||||
|
|
||||||
|
这个命令是 dev-only 的本地恢复工具:内部固定 `POST env_vars`,body 为 `env=dev`。它没有 `--env` flag,也不管理线上环境变量。
|
||||||
|
|
||||||
|
## 何时别用(核心反模式)
|
||||||
|
|
||||||
|
**通常不需要手动跑**——脚手架的 `npm run dev` 在起本地开发时会自动后台拉取(非阻塞)。手动再跑会重复做同样的事,并用服务端返回值覆盖 `.env.local` 里的同名 key;本地无关行和注释会保留。
|
||||||
|
|
||||||
|
只在这些兜底场景用:
|
||||||
|
|
||||||
|
- 不通过 `npm run dev` 启动(直接跑 `node` / IDE debug)。
|
||||||
|
- `.env.local` 被改坏 / 删除,想重新同步。
|
||||||
|
|
||||||
|
## 行为
|
||||||
|
|
||||||
|
- **合并、不清空**:写入 `.env.local` 时保留你手写的内容与注释——命中的 key 替换值,新 key 追加,不整体覆盖。
|
||||||
|
- **安全护栏**:返回的 envelope **不会回显任何 env key / value**(防止 token / 数据库凭据泄漏到日志或 CI 输出)。要看实际值请直接读 `.env.local`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +env-pull --app-id <app_id>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 失败处理
|
||||||
|
|
||||||
|
`missing_scope`(没拿到 `spark:app:read`)时,按 lark-shared 引导 `lark-cli auth login --domain apps`。其余失败优先转述 `error.hint` / `error.message`。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-apps](../SKILL.md) — 妙搭应用全部命令 + 心智模型
|
||||||
|
- [lark-apps-local-dev](lark-apps-local-dev.md) — 本地应用开发端到端流程
|
||||||
|
- [lark-shared](../../lark-shared/SKILL.md) — 认证和全局参数
|
||||||
48
.agents/skills/lark-apps/references/lark-apps-env.md
Normal file
48
.agents/skills/lark-apps/references/lark-apps-env.md
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
# apps env
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md)(认证 / 全局参数 / 安全)。
|
||||||
|
|
||||||
|
管理妙搭应用环境变量。查看用 `+env-list`,设置用 `+env-set`,删除用 `+env-delete`。没有单变量 get 命令;要确认某个 key 是否存在,使用 list 后用 `--jq` 过滤。
|
||||||
|
|
||||||
|
环境 flag 使用 `--environment`;不要使用旧的 `--env`,也不要使用短选项。
|
||||||
|
|
||||||
|
## 查看
|
||||||
|
|
||||||
|
`+env-list` 默认查 dev,且默认不返回 value。只有显式传 `--include-values` 后,响应中才可能出现变量值;不要在公开日志里展示带值输出。
|
||||||
|
|
||||||
|
接口契约:list 使用 `POST env_vars`,body 固定包含 `env` 和 CLI 场景 `scene=2`;set 使用 `POST create_or_update_env_var`;delete 使用 `POST delete_env_vars`。`--include-values` 只控制 CLI 输出是否展示 value,不作为服务端查询参数发送。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +env-list --app-id <app_id>
|
||||||
|
lark-cli apps +env-list --app-id <app_id> --environment online
|
||||||
|
lark-cli apps +env-list --app-id <app_id> --include-values --jq '.data.items[] | select(.key == "FOO")'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 设置
|
||||||
|
|
||||||
|
dev 环境设置不需要 `--yes`。设置 online 环境需要人类确认并显式传 `--yes`;如果用户在同一轮已经明确说“确认/直接执行”,视为已确认,直接带 `--yes`,不要再次追问。`--dry-run` 可用于预览请求且不需要 `--yes`。变量值支持直接传 `<value>`,也支持 `@file` 或 stdin 输入。
|
||||||
|
|
||||||
|
回复中只说明 app/env/key 和执行结果;不要回显真实 value。需要举例时使用 `<value>`、`@file` 或 stdin。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +env-set --app-id <app_id> --key FOO --value <value>
|
||||||
|
lark-cli apps +env-set --app-id <app_id> --key FOO --value @./secret.txt
|
||||||
|
lark-cli apps +env-set --app-id <app_id> --environment online --key FOO --value <value> --dry-run
|
||||||
|
lark-cli apps +env-set --app-id <app_id> --environment online --key FOO --value <value> --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 删除
|
||||||
|
|
||||||
|
`+env-delete` 是 high-risk-write。尊重 exit 10 confirmation protocol:先让用户确认 app/env/key 和删除后果,再传 `--yes`。不要自动补 `--yes`。如果只是认证失败后让用户重登,重登完成不等于删除确认;继续删除前仍需确认。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +env-delete --app-id <app_id> --key FOO --dry-run
|
||||||
|
lark-cli apps +env-delete --app-id <app_id> --key FOO --yes
|
||||||
|
lark-cli apps +env-delete --app-id <app_id> --environment online --key FOO --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 反模式
|
||||||
|
|
||||||
|
- 不要把 `+env-pull` 当成环境变量管理命令;它只是刷新本地 `.env.local` 的兜底工具。
|
||||||
|
- 不要为了看一个变量臆造名为 env-get 的 apps shortcut;用 `+env-list --include-values` 加 `--jq`。
|
||||||
|
- 不要把真实 secret 写进示例或对话输出;需要示例时使用 `<value>`、`@file` 或 stdin。
|
||||||
96
.agents/skills/lark-apps/references/lark-apps-file.md
Normal file
96
.agents/skills/lark-apps/references/lark-apps-file.md
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
# apps file 域命令(应用存储)
|
||||||
|
|
||||||
|
管理妙搭应用的文件存储:上传 / 下载本地文件、列出与查看已存文件、生成临时分享链接、批量删除、查看用量。运行时命令事实以 `lark-cli apps +<cmd> --help` 为准;认证、`--as user`、exit 码、`_notice` 等通用处理见 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 与本域 [`SKILL.md`](../SKILL.md)。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户要在某个妙搭应用里上传 / 下载 / 列出 / 删除文件、拿文件的临时分享链接、或看存储用量时。普通飞书云盘走 [`lark-drive`](../../lark-drive/SKILL.md);数据库里的表数据走 `+db-*`。
|
||||||
|
|
||||||
|
## 命令一览
|
||||||
|
|
||||||
|
| 命令 | 做什么 | 关键参数 |
|
||||||
|
|---|---|---|
|
||||||
|
| `+file-list` | 列出文件,可按名/路径/类型/大小/上传时间过滤 | `--app-id`、过滤器、`--page-size`/`--page-token` |
|
||||||
|
| `+file-get` | 查单个文件的元数据 | `--app-id`、`--path` |
|
||||||
|
| `+file-sign` | 生成有时效的下载链接(用于分享 / 直接下载) | `--app-id`、`--path`、`--expires-in` |
|
||||||
|
| `+file-download` | 把远端文件保存到本地 | `--app-id`、`--path`、`--output` |
|
||||||
|
| `+file-upload` | 上传本地文件到应用存储 | `--app-id`、`--file` |
|
||||||
|
| `+file-delete` | 按路径批量删除文件 | `--app-id`、`--path`(可重复)、`--yes` |
|
||||||
|
| `+file-quota-get` | 查应用的文件存储用量 | `--app-id` |
|
||||||
|
|
||||||
|
## 寻址与约定(先读)
|
||||||
|
|
||||||
|
- **远端文件统一用 `--path` 精确寻址**(远端路径,带前导 `/`)。只知道文件名时,先用 `+file-list --name <名>` 定位拿到 `path`,再做后续操作。
|
||||||
|
- **本地文件 / 输出路径用工作目录内的相对路径**(如 `--file ./report.pdf`、`--output ./out.png`);路径在别处时先 `cd` 过去或改成相对路径。
|
||||||
|
- 上传只接收本地 `--file`:文件名沿用本地文件名,远端路径由平台分配、全局唯一(无需也无法手填)。
|
||||||
|
- file 域不区分环境,没有 `--env`。
|
||||||
|
|
||||||
|
## 各命令
|
||||||
|
|
||||||
|
### +file-list
|
||||||
|
列出应用文件,支持精确过滤:`--name`(文件名)、`--path`(远端路径)、`--type`(MIME 类型)、`--size-gt`/`--size-lt`(字节)、`--uploaded-since`/`--uploaded-until`(上传时间区间,时间格式见末尾)。分页 `--page-size`(默认 20,范围 1..200)/ `--page-token`。列表每项给名称、路径、大小、类型、上传时间(pretty 表格即这 5 列);上传者、下载地址(如有)仅在 JSON 输出里,单文件详情用 `+file-get`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-list --app-id app_xxx
|
||||||
|
lark-cli apps +file-list --app-id app_xxx --type image/png --uploaded-since 7d
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-get
|
||||||
|
按 `--path` 查单个文件的元数据。路径不存在时返回明确的「文件不存在」错误。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-get --app-id app_xxx --path /1858537546760216.png
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-sign
|
||||||
|
为指定文件生成一个**有时效的下载链接**——适合发给用户分享、或直接下载。`--expires-in` 设有效期秒数(默认 1 天,最长 30 天)。`pretty` 模式只输出链接本身,便于复制 / 管道;要把到期时间一并告诉用户时用默认 JSON 输出(含到期时间)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-sign --app-id app_xxx --path /1858537546760216.png --expires-in 3600
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-download
|
||||||
|
把远端文件保存到本地。`--output` 指定保存路径,缺省时按远端文件名保存到当前目录。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-download --app-id app_xxx --path /1858537546760216.png --output ./logo.png
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-upload
|
||||||
|
上传一个本地文件。文件名沿用本地文件名(特殊字符做 URL 编码透传;以 `.` 开头的隐藏文件名会加 `_` 前缀,避免下载回本地时覆盖隐藏文件),远端路径由平台分配。单文件上限 100 MB。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-upload --app-id app_xxx --file ./report.pdf
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-delete(高危)
|
||||||
|
按路径批量删除,`--path` 可重复传多个。删除是高危操作,必须带 `--yes`;缺省会被确认关卡拦下。**逐项返回结果**:部分文件删除失败(如某个路径不存在)不影响其余文件,整体仍算成功,失败项在结果里单独标出原因。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-delete --app-id app_xxx --path /1858537546760216.png --yes
|
||||||
|
lark-cli apps +file-delete --app-id app_xxx --path /a.png --path /b.png --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
### +file-quota-get
|
||||||
|
查应用的文件存储用量(已用量、文件数;配额接入后还会给总配额与使用率)。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +file-quota-get --app-id app_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## 时间格式(`--uploaded-since` / `--uploaded-until`)
|
||||||
|
|
||||||
|
按用户口语自然传入即可,支持:
|
||||||
|
- 相对时间 `7d` / `2h` / `30s`(从现在往前推)
|
||||||
|
- 日期 `2026-04-15`
|
||||||
|
- 日期时间 `2026-04-15T10:00:00`
|
||||||
|
- 带时区的 ISO 8601 `2026-04-15T10:00:00Z` / `2026-04-15T10:00:00+08:00`
|
||||||
|
|
||||||
|
> **时区**:不带时区的 `日期` / `日期时间` 按**运行机器的本地时区**解析(再归一化到 UTC 发给服务端)。CI(UTC)与本地(如 UTC+8)跑同一条命令,过滤边界会差几小时;要精确到某时区时显式写 ISO 8601 带偏移(如 `...+08:00` / `...Z`)。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 寻址一律用 `--path`;用户只给文件名时先 `+file-list --name <名>` 定位,多个同名再让用户确认。
|
||||||
|
- 上传 / 下载的本地路径用工作目录内相对路径;不在当前目录就 `cd` 过去或改相对路径。
|
||||||
|
- 用户要「分享链接 / 临时下载地址」时用 `+file-sign`,把返回的链接转述给用户。
|
||||||
|
- 删除前判断意图:已明确要删且授权时可直接带 `--yes`;不确定删哪些时先 `+file-list` 给用户确认。批量删除部分失败不报错,按逐项结果向用户说明哪些成功、哪些没删掉及原因。
|
||||||
43
.agents/skills/lark-apps/references/lark-apps-get.md
Normal file
43
.agents/skills/lark-apps/references/lark-apps-get.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
# apps +get
|
||||||
|
|
||||||
|
按 app_id 查询单个应用详情。运行时命令事实以 `lark-cli apps +get --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
需要查看一个应用的类型、名称、描述、发布状态等详情时使用。如果只是按应用名模糊搜索定位 app_id,用 `+list --keyword`。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 返回应用的完整信息:`app_id`、`app_type`、`name`、`description`、`icon_url`、`created_at`、`updated_at`、`is_published`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +get --app-id app_xxx
|
||||||
|
lark-cli apps +get --app-id app_xxx --dry-run
|
||||||
|
lark-cli apps +get --app-id app_xxx -q '.data.app.app_type'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.app` 对象,包含以下字段:
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `app_id` | string | 应用唯一标识 |
|
||||||
|
| `app_type` | string | 应用类型(如 HTML、FULL_STACK、MODERN_HTML) |
|
||||||
|
| `name` | string | 应用显示名称 |
|
||||||
|
| `description` | string | 应用功能说明 |
|
||||||
|
| `icon_url` | string | 应用图标 URL |
|
||||||
|
| `created_at` | string | 创建时间(ISO 8601 UTC) |
|
||||||
|
| `updated_at` | string | 最后更新时间(ISO 8601 UTC) |
|
||||||
|
| `is_published` | boolean | 是否已发布 |
|
||||||
|
|
||||||
|
- pretty 输出展示核心字段:`app_id`、`app_type`、`name`、`is_published`、`updated_at`。
|
||||||
|
- `is_published=true` 只代表应用历史上有发布版本,不代表最新代码已部署。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 用户已有 `app_id` 想查看详情时用 `+get`;只有应用名时用 `+list --keyword`。
|
||||||
|
- 不要把 `cli_` 开头的飞书应用 ID 传给 `+get`,只接受 `app_` 开头的应用 ID。
|
||||||
@ -0,0 +1,37 @@
|
|||||||
|
# apps Git credential
|
||||||
|
|
||||||
|
妙搭 Git 凭证用于本地原生 `git clone/pull/push`。运行时命令事实以 `lark-cli apps +git-credential-init --help`、`+git-credential-list --help`、`+git-credential-remove --help` 为准。
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +git-credential-init --app-id app_xxx
|
||||||
|
lark-cli apps +git-credential-list
|
||||||
|
lark-cli apps +git-credential-remove --app-id app_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- `+git-credential-init` 成功后读取 `data.repository_url`;不要展示或保存其中的凭据细节,只用于下一步 `git clone`。响应还包含 `data.commit_author_name` 和 `data.commit_author_email`,这两个字段由 `+init` 内部消费,自动写入仓库 repo-local git config(`user.name` / `user.email`),agent 和用户无需手动配置。
|
||||||
|
- `+git-credential-list` 返回本地记录和状态;可用来判断是否需要重新 init。
|
||||||
|
- `+git-credential-remove` 只清本地配置;成功后告知不会删除云端应用或仓库。
|
||||||
|
|
||||||
|
## 行为规则
|
||||||
|
|
||||||
|
- `+git-credential-init` 返回 `repository_url`,并配置 URL-scoped Git credential helper。后续 clone/pull/push 使用原生 git。
|
||||||
|
- `+git-credential-list` 列出本地已配置的妙搭 Git 凭证,不需要 `--app-id`。
|
||||||
|
- `+git-credential-remove` 只移除本地凭证/helper,不删除云端应用或仓库。
|
||||||
|
- 看到 Repository URL 后继续:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone <repository_url>
|
||||||
|
cd <repo>
|
||||||
|
git checkout sprint/default
|
||||||
|
```
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 不要手动打印、保存或拼接 token。
|
||||||
|
- clone、pull、push、diff、log 等代码仓库操作都使用原生 `git`;不存在 `apps +pull` / `apps +push` / `apps code +read` 这类代码读写 shortcut,不要臆造。
|
||||||
|
- 不要 push/force-push `main`;`main` 是发布态快照,由 `apps +release-create` 成功后服务端推进,直推/force-push 会被服务端护栏拒绝。
|
||||||
|
- Git 认证失败、本地凭证损坏或 helper 缺失时,重新执行 `+git-credential-init --app-id <id>` 覆盖本地配置;不要让用户复制 token 到 remote URL。
|
||||||
@ -0,0 +1,58 @@
|
|||||||
|
# apps +html-publish
|
||||||
|
|
||||||
|
把本地 HTML 文件或静态目录发布为妙搭应用访问 URL。运行时命令事实以 `lark-cli apps +html-publish --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于把已经存在的本地 HTML 文件或静态产物目录发布成妙搭访问 URL。它不负责生成 HTML 内容,也不负责全栈应用代码发布。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`、`--path`。
|
||||||
|
- `--path` **必须是相对路径**(如 `./dist`、`./index.html`),不支持绝对路径。如果目标文件在其他目录,先 `cd` 到该目录再用相对路径,或用相对于当前目录的路径。
|
||||||
|
- `--path` 可以是单个文件或目录;入口必须是 `index.html`。
|
||||||
|
- 可选:`--allow-sensitive`,跳过凭据文件扫描。
|
||||||
|
- 客户端打包 tar.gz 上传发布。三条硬性大小限制,任一超限即被客户端拒绝、无法发布:单个 `.html` 文件 ≤ 10MB、打包后 tar.gz ≤ 20MB、未压缩候选文件总量 ≤ 200MB。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +create --name "Demo" --app-type html
|
||||||
|
lark-cli apps +html-publish --app-id app_xxx --path ./dist
|
||||||
|
lark-cli apps +html-publish --app-id app_xxx --path ./index.html --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
命令内部完成 tar.gz 打包 → TOS 上传 → 触发发布,返回 `data.release_id`。拿到 `release_id` 后用 `+release-get --app-id <app_id> --release-id <release_id>` 轮询发布状态直到 `finished`,从中读取 `online_url`。
|
||||||
|
|
||||||
|
- 业务失败如构建失败、应用不存在通常带 `error.hint`;优先转述 hint。网络/服务端失败则建议稍后重试。
|
||||||
|
|
||||||
|
## 链接边界
|
||||||
|
|
||||||
|
- 发布态访问链接以 `+release-get` 轮询 `finished` 返回的 `online_url` 为准。
|
||||||
|
- 重新发布前,`+list` 的 `is_published=true` 只能说明历史上发布过,不代表当前本地产物已经部署。
|
||||||
|
|
||||||
|
## 发布前置门(第一步,先于任何其他动作)
|
||||||
|
|
||||||
|
收到发布意图后,第一个动作是量三个尺寸,不是读文件内容、不是打包:
|
||||||
|
1. 单个 `.html` ≤ 10MB / tar.gz ≤ 20MB / 未压缩总量 ≤ 200MB。
|
||||||
|
2. 任一超限 → 立即 STOP,把超限数字转述给用户,交还决定权。
|
||||||
|
3. 三项都通过 → 才进入下面的命令骨架。
|
||||||
|
|
||||||
|
## 预览与发布边界
|
||||||
|
|
||||||
|
- 用户只说“用 HTML 写个 PPT/页面给我看看”时,先生成本地文件或目录,返回路径并问是否发布到妙搭分享;不要默认创建应用或部署。
|
||||||
|
- 用户明确说“部署出去/发链接/可分享”时,才创建 `html` 应用并用 `+html-publish`。
|
||||||
|
- 用户要发布但没有 app_id 时,先 `+create --app-type html` 创建应用;应用名可从页面/站点主题生成,不要让用户手动提供 app_id。
|
||||||
|
- 若产物首页不是 `index.html`,发布前改名或复制为 `index.html`;目录发布时只传干净产物目录,例如 `./dist`。`.git` 目录会被自动排除,不会进入压缩包。
|
||||||
|
- 重新部署同一个 HTML 应用时复用原 `app_id`,只重新执行 `+html-publish --app-id <id> --path <dir-or-index.html>`。
|
||||||
|
|
||||||
|
## 安全规则
|
||||||
|
|
||||||
|
默认会拦截 `.env`、`.npmrc`、`.aws/credentials` 等凭据文件。只有用户明确要发布凭据示例文件或教程内容时,才追加 `--allow-sensitive`;追加前先说明将包含哪些敏感候选文件。
|
||||||
|
|
||||||
|
## 常见失败
|
||||||
|
|
||||||
|
- `--path` 传了绝对路径:`--path` 只接受相对路径,传绝对路径会报 `--path must be a relative path within the current directory`。改用 `cd` + 相对路径,例如 `cd /target/dir && lark-cli apps +html-publish --path .`。
|
||||||
|
- 缺少 `index.html`:目录根放置 `index.html`,或单文件路径直接指向名为 `index.html` 的文件。
|
||||||
36
.agents/skills/lark-apps/references/lark-apps-init.md
Normal file
36
.agents/skills/lark-apps/references/lark-apps-init.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
# apps +init
|
||||||
|
|
||||||
|
`+init` 初始化妙搭应用的代码(clone 仓库、scaffold/同步源码、拉取本地环境变量)。运行时命令事实以 `lark-cli apps +init --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于把妙搭应用源码拉到本地并准备开发环境。用户只是要云端 Agent 生成应用时,不要初始化本地仓库。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 可选:`--dir`,clone 目标目录;省略时默认 `./<app-id>`。
|
||||||
|
- 固定 checkout 分支:`sprint/default`。
|
||||||
|
- `+init` 会初始化 Git 凭证、clone 仓库、切到工作分支并生成/同步本地项目。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +init --app-id app_xxx --dir ./my-app
|
||||||
|
lark-cli apps +init --app-id app_xxx --dir /absolute/path/my-app
|
||||||
|
lark-cli apps +init --app-id app_xxx --dir ./my-app --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 真跑时 stdout 是 JSON envelope;stderr 会有 `->` / `→` 进度行。成功读 stdout,失败解析 stderr 末尾的 JSON 错误。
|
||||||
|
- 成功普通初始化读取 `data.clone_path`、`branch`、`committed`、`pushed`;`repository_url` 已脱敏,不要当凭据使用。
|
||||||
|
- `scaffold=already_initialized` 表示目录已初始化:跳过 clone/scaffold/commit,但仍会执行一次 env-pull 刷新本地环境变量(输出含 `env_pulled`,成功时含 `env_file`,失败时含 `env_pull_error` 且退出码仍为 0);此时通常没有 `repository_url` / `branch`。
|
||||||
|
- `--dry-run` 只打印计划,不执行 git / npx;若输出含 `dir_error`,真跑前先让用户换目录。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
- 目标目录必须不存在、为空目录,或已含 `.spark/meta.json` 且其 app_id 与 `--app-id` 一致的已初始化仓库。
|
||||||
|
- 目标目录已含 `.spark/meta.json` 时,`+init` 会跳过 clone/scaffold,但仍执行一次 env-pull 刷新本地环境变量;告知用户“仓库已初始化,本地环境变量已刷新,可直接开发”,不要误报失败或重复 clone。
|
||||||
|
- `+init` 输出没有必要原样复述;告诉用户 clone path、分支和下一步即可。
|
||||||
|
- 新建应用做本地初始化时,若选定的目标目录已存在,不要复用,改用一个不冲突的目录名(已预授权”放手做”时自动追加后缀如 `-2`;否则向用户确认目录名)。
|
||||||
37
.agents/skills/lark-apps/references/lark-apps-list.md
Normal file
37
.agents/skills/lark-apps/references/lark-apps-list.md
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
# apps +list
|
||||||
|
|
||||||
|
列出当前用户可见的妙搭应用,用于从应用名定位 `app_id`。运行时命令事实以 `lark-cli apps +list --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
在下游操作需要 `app_id`、而用户只给了应用名/描述时,用 `--keyword` 定位。无明确目的的全量枚举会浪费上下文,优先按关键词缩小范围。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 支持 `--keyword` 按应用名模糊搜索。
|
||||||
|
- `--ownership` 枚举:`all` / `mine` / `shared`(默认 `all` = 我创建的 + 共享给我的;`mine` = 仅我创建;`shared` = 仅共享给我)。
|
||||||
|
- `--app-type` 枚举:`html` / `full_stack`。
|
||||||
|
- 分页:`--page-size` 默认 20,`--page-token` 传上一页 cursor。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +list --keyword "审批"
|
||||||
|
lark-cli apps +list --ownership mine --app-type full_stack
|
||||||
|
lark-cli apps +list --page-token "<cursor>"
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.items[]`;保留字段为 `description`、`app_id`、`name`、`is_published`、`online_url`、`updated_at`,用于候选展示的核心字段是 `name`、`app_id`、`updated_at`。
|
||||||
|
- `is_published=true` 只代表应用历史上有发布版本,不代表最新云端会话、最新代码提交或最新 HTML 产物已经部署。
|
||||||
|
- `online_url` 是当前已有发布态入口;若你没有在本轮确认发布完成,不要把它描述成“最新版本链接”。
|
||||||
|
- 默认输出已裁掉 `icon_url`(图片 URL,agent 无法渲染)和 `created_at`(与 `updated_at` 冗余);需要时可用 `--jq` 过滤上述保留字段。
|
||||||
|
- `data.items` 可能为空;不要把空列表当失败。
|
||||||
|
- 若有 `has_more=true`,用返回的 `page_token` / `next_page_token` 继续翻页。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
多候选时展示名称、app_id、updated_at 让用户确认。用户描述里已经有 `app_xxx` 或妙搭链接时,直接提取,不再 `+list`。
|
||||||
|
|
||||||
|
把 `+list` 当定位工具和发布态快照工具,不要把 `is_published` 当部署完成证明。需要证明“最新内容已上线”时,使用对应发布命令的完成状态:看 `+release-get` 的 `finished`。
|
||||||
121
.agents/skills/lark-apps/references/lark-apps-local-dev.md
Normal file
121
.agents/skills/lark-apps/references/lark-apps-local-dev.md
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
# lark-apps 本地开发
|
||||||
|
|
||||||
|
适用:用户要把妙搭应用(full_stack 或 html)源码拉到本地,用本地 code agent/IDE 开发、调试数据库,再发布。
|
||||||
|
|
||||||
|
## 新建 vs 已有应用
|
||||||
|
|
||||||
|
新建还是修改已有,由上方入口(SKILL.md「选择开发路径」)判定;进到本地流程后按分支走:
|
||||||
|
|
||||||
|
- **新建**:从 `+create` 开始走下面的端到端流程。
|
||||||
|
- **已有应用**(本地还没有源码):跳过 `+create`,先按下方「存量应用入口」拿 `app_id`,再 `+init`(或 `+git-credential-init` + `git clone`)把它拉到本地,然后照常开发。
|
||||||
|
|
||||||
|
## 端到端流程(新建应用)
|
||||||
|
|
||||||
|
### full_stack
|
||||||
|
|
||||||
|
`+create(full_stack)` -> `+init`(或手动 `+git-credential-init` + `git clone`)-> 读仓库 Skill -> `npm install && npm run dev` -> 按需 `+db-*` 调库 -> 非自动化改动按本页 commit/push/release;包含自动化 handler 时,在任何 release 前转到 [automation SOP](lark-apps-automation.md),由它接管状态门禁和完整发布。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 新建 full_stack 应用
|
||||||
|
lark-cli apps +create --as user --name "审批系统" --app-type full_stack \
|
||||||
|
--description "支持登录、提交申请、多级审批、状态查询"
|
||||||
|
|
||||||
|
# 初始化本地仓库(--dir 取值见下方「领域规则」,勿照抄此处示例值)
|
||||||
|
lark-cli apps +init --as user --app-id app_xxx --dir ./approval-app
|
||||||
|
|
||||||
|
# 进入仓库后按项目脚手架启动
|
||||||
|
cd ./approval-app
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
|
||||||
|
# 开发完成后:提交本次改动 -> git push origin sprint/default -> +release-create。
|
||||||
|
# +release-create 部署的是远端 sprint/default 上已 push 的代码,不是本地工作区——没 commit + push 的改动不会进入发布。
|
||||||
|
git add <本次开发的文件> # 提交粒度见下方「改完代码后部署上线」
|
||||||
|
git commit -m "feat: ..."
|
||||||
|
git push origin sprint/default
|
||||||
|
lark-cli apps +release-create --as user --app-id app_xxx --branch sprint/default
|
||||||
|
```
|
||||||
|
|
||||||
|
### html
|
||||||
|
|
||||||
|
#### 首次开发(无 app,无代码)
|
||||||
|
|
||||||
|
`+create(html)` → `+init` → 加载 [`creative-design`](../creative-design/SKILL.md) skill 在 repo 根目录产出文件 → `git add .` + `git commit` → `git push origin sprint/default` → `+release-create` → `+release-get`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +create --name "活动页" --app-type html --as user
|
||||||
|
|
||||||
|
lark-cli apps +init --app-id app_xxx --dir ./my-page
|
||||||
|
|
||||||
|
cd ./my-page
|
||||||
|
# html 类型无需 npm install,+init 已跳过依赖安装
|
||||||
|
# 加载 creative-design skill,在 repo 根目录产出 HTML 及关联文件(JSX 组件、starter components 等)
|
||||||
|
|
||||||
|
git add .
|
||||||
|
git commit -m "feat: ..."
|
||||||
|
git push origin sprint/default
|
||||||
|
lark-cli apps +release-create --app-id app_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 已有 app,二次开发/迭代
|
||||||
|
|
||||||
|
`+init`(拉取远程代码)→ 加载 creative-design skill 在 repo 根目录迭代 → `git add .` + `git commit` → `git push origin sprint/default` → `+release-create` → `+release-get`。
|
||||||
|
|
||||||
|
#### creative-design 已提前生成文件,需要 init 后迁入
|
||||||
|
|
||||||
|
`+create(html)` → `+init` → 先 `ls` 查看 repo 根目录模板结构(创意模式模板无 `src/` 目录,文件直接放根目录)→ 将已生成的所有产出文件(HTML、JSX 组件、starter components 等)拷贝到 repo 根目录 → `git add .` + `git commit` → `git push origin sprint/default` → `+release-create` → `+release-get`。
|
||||||
|
|
||||||
|
`+init` 是推荐便捷入口;想逐步手动控制时,先 `+git-credential-init` 拿 `repository_url`,再用原生 `git clone` / `git checkout sprint/default`。
|
||||||
|
|
||||||
|
**`+init` 完成后必须执行**:`cat <project-path>/.agents/skills/plugin-guide/SKILL.md`,读取仓库插件指引。该文件包含插件目录、实例配置规则和调用代码生成方式——不读就无法正确集成插件能力。文件不存在则跳过。
|
||||||
|
|
||||||
|
## Trigger guide 的项目边界
|
||||||
|
|
||||||
|
涉及自动化业务代码时,先查看工作区 `.agents/skills/`,读取与自动化任务匹配的 `trigger-guide`。它定义业务 handler 的实现与接入约束;Apps 触发器配置细节见 [automation SOP](lark-apps-automation.md)。
|
||||||
|
|
||||||
|
文件缺失或不能覆盖当前任务时,报告项目缺少可用的领域 guide;不要在本 lark-cli reference 中猜测安装命令、版本或包内目录。由项目维护方通过其受支持的初始化或同步流程补齐后,再继续代码闭环;`+init` 只负责准备本地项目,不能替代领域 guide。
|
||||||
|
|
||||||
|
## 改完代码后部署上线
|
||||||
|
|
||||||
|
已拉到本地、改完代码,用户说"推上去""部署""上线""发布到云端"时,按此序列。
|
||||||
|
|
||||||
|
若本次改动包含自动化 handler,在执行本节通用 commit/push/release 序列前就转到 [automation SOP](lark-apps-automation.md) 的匹配路径,由该 SOP 负责完整的状态门禁、commit/push、release 和可选 enable/test;不要先按本节发布再补 trigger 状态检查。下列通用序列只用于不含自动化 handler 的改动。
|
||||||
|
|
||||||
|
> `+release-create` 部署的是远端 `sprint/default` 上**已 push** 的代码,不是你本地工作区——未 commit / 未 push 的改动不会进入这次发布。所以发布前务必先把本次改动提交并推送。
|
||||||
|
|
||||||
|
1. `git status` 看本次改动;`git add <本次相关文件>` 暂存后 `git commit` 提交。只提交本次任务相关的改动即可,无关的零散文件不必强求清空——发布门禁是「**本次相关改动已提交并推送**」,不是「工作区绝对干净」。
|
||||||
|
2. `git push origin sprint/default` 把工作分支推到云端(遇非 fast-forward:先 `git pull --rebase origin sprint/default` 解决冲突再推,绝不 force-push;遇 Git 认证失败 / 401 / 403 / credential helper 缺失 / token 过期:先执行 `lark-cli apps +git-credential-init --app-id <app_id> --as user` 刷新本地 Git 凭证,再重试原 git 命令;刷新凭证也失败时,停止并向用户报告错误,不要换路)。
|
||||||
|
3. `lark-cli apps +release-create --as user --app-id <app_id> --branch sprint/default` 发起部署上线,记下返回的 `release_id`。
|
||||||
|
4. `lark-cli apps +release-get --as user --app-id <app_id> --release-id <release_id>` 轮询:`publishing` 时每 20 秒继续轮询,整体最多约 5 分钟;超时仍未完成时停止本轮轮询、报告 `release_id` 和当前 status。`finished` 成功时,若返回 `online_url`,可直接使用;未返回时不要编造链接。交付线上访问链接给他人前,注意 `online_url` 默认仅创建者可见,需先告知当前仅本人可见、按需用 `+access-scope-set` 放开可见范围。无需再调 `+list`;`failed` 时若返回非空 `error_logs`,据此给出失败原因;否则只报告 `release_id` 和当前 status,不要编造原因(`+list` 仅作独立查询入口)。
|
||||||
|
|
||||||
|
用户只要求启用已有 trigger 时,转到 [automation SOP 的「仅启用已有 disabled trigger」路径](lark-apps-automation.md#仅启用已有-disabled-trigger);不得因 enable 反向修改 handler、commit/push 或 release。
|
||||||
|
|
||||||
|
## 领域规则
|
||||||
|
|
||||||
|
- 代码读写走原生 `git`;CLI 负责凭证、初始化、发布和数据库调试。不存在 `apps +pull` / `apps +push` / `apps code +read` 这类代码读写 shortcut,不要臆造。
|
||||||
|
- 工作环境没有 `git` 时,先引导安装 Git(macOS 可用 `xcode-select --install` 或 `brew install git`;Linux 按发行版包管理器安装),安装后重试原 `+init` / git 命令;不要因此改走其他发布链路。
|
||||||
|
- `+init` 会编排 `+git-credential-init`、`git clone`、切到 `sprint/default`、运行脚手架,并在有变更时提交/推送。
|
||||||
|
- `+init --dir` 选目录:用户已预授权或表达"不要询问"(见 SKILL.md「预授权判定」)→ 按应用名派生 `./<app-name>` 直接传 `--dir`、不停问;否则先问用户用哪个目录再传。目标已存在/非空时回问换目录。
|
||||||
|
- `sprint/default` 是工作分支;`main` 是发布态快照,由 `+release-create` 成功后服务端 fast-forward 推进;服务端护栏禁直推 `main`、拒 force-push、要求 `sprint/default` fast-forward。
|
||||||
|
- 已拉到本地后,pull/push/diff/log 都用原生 git;云端 `sprint/default` 比本地新时,先 `git pull --rebase origin sprint/default`,解决冲突后再 push 和 publish。
|
||||||
|
- `git clone` / `git pull` / `git push` 如果报认证失败、401/403、credential helper 缺失或 token 过期,优先重新执行 `lark-cli apps +git-credential-init --app-id <app_id> --as user` 更新本地 Git 凭证,然后重试原 git 命令;刷新凭证也失败时,停止并向用户报告错误,不要换路;不要手动复制 token、不要把 token 拼进 remote URL。
|
||||||
|
- 环境变量由脚手架在本地启动时处理;需要手动刷新时用 `+env-pull`。
|
||||||
|
- 资源型文件(图片、字体、音视频等)不要直接引用本地路径,也不要提交到 git 仓库或以 base64 内联到代码中。先通过 `lark-cli apps +file-upload --app-id <app_id> --file <local_path>` 上传到应用文件存储,拿到返回的远端 URL 后在代码中引用该 URL。详情读 [`lark-apps-file.md`](lark-apps-file.md)。上传返回的链接按 app 隔离,不同应用必须各自重新上传,不能跨应用复用同一链接。
|
||||||
|
- DB 调试用 `+db-table-list` / `+db-table-get` / `+db-execute`;不要裸连数据库或自行拼连接串。
|
||||||
|
- DB 分 `dev` / `online`;使用 `--environment dev|online`,不要使用旧的 `--env`。只有确认应用已开启多环境时才引导 `--environment dev`;单环境应用省略 `--environment`(服务端选 online)或显式传 `--environment online`。在 dev 写入不能证明线上 handler 已验证。dev 的库结构变更要上线时,仍按应用发布链路走 `+release-create`,不要另造“数据库发布”步骤。
|
||||||
|
- 存量单库应用需要 dev/online 多环境时,用 `+db-env-create --environment dev`。这是不可逆 high-risk 操作。
|
||||||
|
- 只从 `+list` 看到 `is_published=true`,不能证明本地刚推送的代码已经部署;必须有本轮 `+release-get finished`。
|
||||||
|
|
||||||
|
## 存量应用入口
|
||||||
|
|
||||||
|
已有项目目录先读 `.spark/meta.json` 取 `app_id`;没有本地项目但知道应用名时用:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +list --keyword "应用名"
|
||||||
|
```
|
||||||
|
|
||||||
|
拿到 `app_id` 后再 `+init` 或 `+git-credential-init`。
|
||||||
|
|
||||||
|
## 何时不用
|
||||||
|
|
||||||
|
- 用户明确要云端妙搭 Agent 生成/迭代,而不是本地写代码:读 [`lark-apps-cloud-dev.md`](lark-apps-cloud-dev.md)。
|
||||||
@ -0,0 +1,48 @@
|
|||||||
|
# apps observability
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md)(认证 / 全局参数 / 安全)。
|
||||||
|
|
||||||
|
查询妙搭应用的线上运行观测和产品访问分析。所有 observability 命令只支持 `--environment online`;省略 `--environment` 时默认就是 online,传 dev 或其他环境是不支持的。不要使用旧的 `--env`,也不要使用短选项。
|
||||||
|
|
||||||
|
日志和 trace 的用户侧环境仍然是 online;但 OpenAPI 请求体里的后端 `app_env` 固定发送 `runtime`,因为线上应用的运行时日志和 trace 存储在 runtime 观测环境下。dry-run 输出会展示这个后端参数。
|
||||||
|
|
||||||
|
metric / analytics 的 `--environment` 只是 CLI 侧 online-only 校验:`+metric-list` 和 `+analytics-list` 不会向 OpenAPI body 发送 `env` 或 `app_env`。dry-run 里看不到环境字段是预期行为,不要补造参数。
|
||||||
|
|
||||||
|
时间过滤支持相对时间(如 `30s`、`5m`、`0.5h`、`2h`、`3d`、`1w`)、本地日期 / 时间和 RFC3339。
|
||||||
|
|
||||||
|
## 命令选择
|
||||||
|
|
||||||
|
- 日志检索:用 `+log-list` 搜索日志,用 `+log-get` 按 log ID 取单条日志。
|
||||||
|
- `+log-list` 不再支持 `--log-id`;已有 log ID 时直接用 `+log-get --log-id <log_id>`。
|
||||||
|
- 前端 ERROR 日志详情:`+log-get` 可能补充 `source_stack`;没有独立的 source-stack 命令。
|
||||||
|
- Trace 检索:用 `+trace-list` 搜索 trace,用 `+trace-get` 按 trace ID 取详情。
|
||||||
|
- 运行时指标:请求数、错误、延迟、CPU、memory 用 `+metric-list`。
|
||||||
|
- 产品分析:PV、UV、访问量这类业务访问分析用 `+analytics-list`,不要放到 runtime metric 里混查。
|
||||||
|
- `+analytics-list` 按最新 OpenAPI 发送 `metric_types`、纳秒时间戳和 `need_pack_lack_point=false`;`group_by` 暂不支持。
|
||||||
|
- 用户询问“最近一小时接口请求量、错误量、延迟、接口慢/报错多”时,这是平台运行时监控,不是本地项目文件。先用 `apps +list --keyword` 找 `app_id`,再查 `+metric-list`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +log-list --app-id <app_id> --level error --keyword timeout --since 0.5h
|
||||||
|
lark-cli apps +log-get --app-id <app_id> --log-id <log_id>
|
||||||
|
lark-cli apps +trace-list --app-id <app_id> --trace-id <trace_id>
|
||||||
|
lark-cli apps +trace-get --app-id <app_id> --trace-id <trace_id>
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric requests --series total --since 1d
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric requests --since 1h
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric latency --since 1h
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric latency --series p99 --since 1d
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric cpu --since 1h
|
||||||
|
lark-cli apps +metric-list --app-id <app_id> --metric memory --since 1h
|
||||||
|
lark-cli apps +analytics-list --app-id <app_id> --analytics users --series active-users --granularity day
|
||||||
|
lark-cli apps +analytics-list --app-id <app_id> --analytics page-view --granularity day
|
||||||
|
```
|
||||||
|
|
||||||
|
## 使用边界
|
||||||
|
|
||||||
|
- 如果用户问“接口慢、报错多、CPU/内存高”,优先走 `+metric-list`。
|
||||||
|
- `+metric-list --metric requests` 不传 `--series` 会同时返回请求总量 total 和错误量 error;`--metric latency` 不传 `--series` 会同时返回 p50 和 p99。只想看单条曲线时再传 `--series total|error|p50|p99`。
|
||||||
|
- 按接口收窄范围时使用 `--api <path-or-name>`;当前没有 `group-by` 参数,不要臆造。
|
||||||
|
- `+metric-list` 未显式传 `--down-sample` 时会按时间范围自动选择粒度:短范围用 `1m`,中等范围用 `1h`,长范围用 `1d`;显式传入时尊重用户指定。
|
||||||
|
- 如果用户问“页面访问量、PV、UV、活跃用户”,优先走 `+analytics-list`。
|
||||||
|
- 如果用户已有 `trace_id` 或 `log_id`,直接用对应 get 命令;不知道 ID 时先 list。
|
||||||
79
.agents/skills/lark-apps/references/lark-apps-openapi-key.md
Normal file
79
.agents/skills/lark-apps/references/lark-apps-openapi-key.md
Normal file
@ -0,0 +1,79 @@
|
|||||||
|
# apps openapi-key 命令族 SOP
|
||||||
|
|
||||||
|
管理妙搭应用对外暴露的 HTTP API Key(`/openapi/**` 鉴权凭证)。全部操作需 `--as user`(AuthType: user)。`--help` 是参数细节的完整来源;本文件只记录 Agent 不看就会做错的领域规则。
|
||||||
|
|
||||||
|
## 命令路由
|
||||||
|
|
||||||
|
| 命令 | 用途 |
|
||||||
|
|---|---|
|
||||||
|
| `+openapi-key-list` | 列出应用所有 API Key(脱敏) |
|
||||||
|
| `+openapi-key-get` | 查看单个 Key 详情(脱敏) |
|
||||||
|
| `+openapi-key-create` | 创建新 Key,**原始密钥一次性可见** |
|
||||||
|
| `+openapi-key-update` | 改名或改 config(不改 status) |
|
||||||
|
| `+openapi-key-enable` | 启用 Key(status→1) |
|
||||||
|
| `+openapi-key-disable` | 停用 Key(status→0),**泄露/疑似泄露优先用这个而非 delete** |
|
||||||
|
| `+openapi-key-delete` | 永久删除 Key(不可逆) |
|
||||||
|
| `+openapi-key-reset` | 轮换密钥(刷新原始 Key),**一次性可见** |
|
||||||
|
|
||||||
|
## 脱敏口径(安全关键)
|
||||||
|
|
||||||
|
- `list` / `get` / `update` / `enable` / `disable`:返回结构里 **无** `api_key` 字段,只有 `key_preview`(格式:`****` + 原始密钥末 4 位,如 `****5f4a`)。
|
||||||
|
- `create` / `reset`:**仅** 在 `data.api_key`(顶层)返回原始密钥一次;同时在 stderr 打印一次性提示:
|
||||||
|
```
|
||||||
|
warning: this api_key is shown only once and is NOT stored by lark-cli — copy it now and store it in your own secret manager.
|
||||||
|
```
|
||||||
|
- 原始密钥绝不写入 cache / config / recent / debug log / 错误信息。
|
||||||
|
|
||||||
|
## 一次性密钥语义
|
||||||
|
|
||||||
|
CLI 不保存原始密钥。密钥在 `create` / `reset` 时仅随响应返回一次。**密钥丢失不能用 `get` 找回**——唯一恢复方式是 `+openapi-key-reset` 重新生成新密钥(旧密钥同时失效)。
|
||||||
|
|
||||||
|
## scope 结构与 CLI 表达
|
||||||
|
|
||||||
|
后端 `config.request_scope` 的真实结构(**snake_case**——Lark 开放网关 `/open-apis/` 对外契约约定;`api_key.thrift` 的 camelCase go.tag 是内部表示,OGW 已转成 snake_case):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"allow_all": true,
|
||||||
|
"http_infos": [
|
||||||
|
{ "http_method": "GET", "http_path": "/openapi/some-path" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `allow_all=true`:放开该应用所有 `/openapi/**` 路由;`http_infos` 此时忽略。
|
||||||
|
- `allow_all=false`:按 `http_infos` 逐条授权,每条需 `http_method`(大写)+ `http_path`(`/openapi/` 开头)。
|
||||||
|
|
||||||
|
CLI 提供三种互斥的 scope 表达方式:
|
||||||
|
|
||||||
|
| flag | 用途 | 备注 |
|
||||||
|
|---|---|---|
|
||||||
|
| `--scope-all` | `allow_all=true`,放开所有路由 | bool flag,显式传 `--scope-all=false` 也算"已设置" |
|
||||||
|
| `--scope-api 'METHOD /openapi/path'` | 逐条授权一个路由,可重复 | 路由从应用 `docs/openapi.json` 取 |
|
||||||
|
| `--scope '<raw request_scope JSON>'` | 高级逃生口,直传 request_scope JSON(snake_case) | CLI 只校验合法 JSON;`--scope` 与 `--scope-all`/`--scope-api` 互斥 |
|
||||||
|
|
||||||
|
### scope 值来源
|
||||||
|
|
||||||
|
妙搭应用的 `/openapi/**` 路由定义在应用仓库,并同步维护在 `docs/openapi.json`(`paths` 下每个 `"/openapi/..."` 条目 + HTTP 方法)。要授权哪些路由,读目标应用自己的 `docs/openapi.json`,取 `(method, path)` 对。CLI 本身不提供 API 路由发现功能(P1 规划中)。
|
||||||
|
|
||||||
|
## 高风险操作
|
||||||
|
|
||||||
|
`delete` 和 `reset` 是高风险(`high-risk-write`),有以下约束:
|
||||||
|
|
||||||
|
- 需显式传 `--yes`(框架 `cmdutil.RequireConfirmation`);缺少时退出码 10,**不要自动补 `--yes`**(遵循 lark-shared 安全红线)。
|
||||||
|
- 支持 `--dry-run` 查看将要执行的 HTTP 请求(不含密钥);不确定时先 dry-run。
|
||||||
|
- **泄露场景**:应优先 `+openapi-key-disable` 立即停用,而非 `+openapi-key-delete`——停用可随时 enable 恢复,delete 不可逆。
|
||||||
|
|
||||||
|
## 典型决策场景
|
||||||
|
|
||||||
|
| 用户意图 | 正确操作 |
|
||||||
|
|---|---|
|
||||||
|
| "key 泄露了,先停掉" | `+openapi-key-disable`(不是 delete) |
|
||||||
|
| "key 丢了/忘了,再给我一个" | `+openapi-key-reset`(不是 create 新 key;reset 轮换密钥、保留原 key 配置) |
|
||||||
|
| "我的 key 密钥是什么" | 解释:list/get 不回显原始密钥,只能用 `+openapi-key-reset` 轮换 |
|
||||||
|
| "给应用创建一个有权限限制的 key" | `+openapi-key-create --name ... --scope-api 'GET /openapi/...'`(路由取自应用 `docs/openapi.json`) |
|
||||||
|
|
||||||
|
## 不在本 skill 范围
|
||||||
|
|
||||||
|
- OpenAPI spec 全量导出、实时日志 tail、Webhook 消费、多鉴权方式:本期不支持。
|
||||||
|
- 身份选择、权限不足处理(`missing_scopes`→`console_url`)、exit-10 审批、通用"禁输出密钥"红线、高风险操作通用框架:见 [`../../lark-shared/SKILL.md`](../../lark-shared/SKILL.md),不在此重复。
|
||||||
@ -0,0 +1,36 @@
|
|||||||
|
# apps +plugin-install
|
||||||
|
|
||||||
|
> **本地命令**:读当前目录的 `package.json`,在项目根目录下运行(和 npm 一样)。**不接受 `--app-id`**——它不是远端 API 命令。
|
||||||
|
|
||||||
|
安装插件包到项目。运行时命令事实以 `lark-cli apps +plugin-install --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户要接入 AI 能力或飞书平台能力,需要先安装对应的插件包。安装后才能创建插件实例。具体有哪些可用插件、该选哪个,读取创建的应用仓库 Skill:`.agents/skills/plugin-guide/SKILL.md`。
|
||||||
|
|
||||||
|
**插件包 ≠ npm 包**:插件包写入 `actionPlugins`,npm 写入 `dependencies`,两套独立机制。禁止用 `npm install` 代替本命令。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- `--name <key>`:插件包 key(从仓库 Skill 的「AI 插件目录」获取)。不传则批量安装 `actionPlugins` 中声明的所有插件。
|
||||||
|
- `--version <ver>`:指定版本(如 `1.0.0`)。不传则安装最新版。
|
||||||
|
|
||||||
|
在项目根目录下运行(和 npm 一样,无需指定路径)。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 安装最新版
|
||||||
|
lark-cli apps +plugin-install --name <plugin-key>
|
||||||
|
|
||||||
|
# 安装指定版本
|
||||||
|
lark-cli apps +plugin-install --name <plugin-key> --version 1.0.0
|
||||||
|
|
||||||
|
# 批量安装已声明的所有插件
|
||||||
|
lark-cli apps +plugin-install
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 已安装同版本会跳过(status=already_installed)。
|
||||||
|
- 失败时 hint 指示原因(网络/版本不存在/package.json 缺失)。
|
||||||
23
.agents/skills/lark-apps/references/lark-apps-plugin-list.md
Normal file
23
.agents/skills/lark-apps/references/lark-apps-plugin-list.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
# apps +plugin-list
|
||||||
|
|
||||||
|
> **本地命令**:读当前目录的 `package.json`,在项目根目录下运行(和 npm 一样)。**不接受 `--app-id`**——它不是远端 API 命令。
|
||||||
|
|
||||||
|
列出已声明的插件包及安装状态。运行时命令事实以 `lark-cli apps +plugin-list --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
查看当前项目声明了哪些插件、是否已安装。`declared_not_installed` 状态表示需要运行 `+plugin-install` 安装。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
在项目根目录下运行(和 npm 一样,无需指定路径)。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +plugin-list --format json
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- `data.plugins[]` 包含 `key`、`version`、`status`(`installed` / `declared_not_installed`)。
|
||||||
@ -0,0 +1,25 @@
|
|||||||
|
# apps +plugin-uninstall
|
||||||
|
|
||||||
|
> **本地命令**:读当前目录的 `package.json`,在项目根目录下运行(和 npm 一样)。**不接受 `--app-id`**——它不是远端 API 命令。
|
||||||
|
|
||||||
|
卸载插件包。运行时命令事实以 `lark-cli apps +plugin-uninstall --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户不再需要某个插件能力时,卸载对应的插件包。卸载前应先删除该插件的所有实例。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- `--name <key>`:要卸载的插件包 key。
|
||||||
|
|
||||||
|
在项目根目录下运行(和 npm 一样,无需指定路径)。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +plugin-uninstall --name <plugin-key>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 删除 `node_modules/{key}` + 移除 `actionPlugins` 条目。
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
# apps +release-create
|
||||||
|
|
||||||
|
为妙搭应用创建发布 release。运行时命令事实以 `lark-cli apps +release-create --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于把应用的代码分支推进到发布流程(html 和 full_stack 统一走此入口)。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 可选:`--branch`;省略时服务端使用默认发布分支。
|
||||||
|
- 返回 `release_id` 和 `status`,后续用 `+release-get` 轮询。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +release-create --app-id app_xxx
|
||||||
|
lark-cli apps +release-create --app-id app_xxx --branch sprint/default --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.release_id`、`data.status` 和 `data.sync`;`release_id` 是后续 `+release-get` 的入参。
|
||||||
|
- `sync=true` 表示同步部署(服务端等待部署完成后才返回),`sync=false` 或缺失表示异步部署。
|
||||||
|
- `status=publishing` 表示发布仍在进行;继续用 `+release-get` 轮询,轮询间隔应该为 20s。应用发布平均耗时大约 2min,整体超时时间大约 5min。
|
||||||
|
- `status=finished` 表示部署已完成(同步部署时可能直接返回此状态)。
|
||||||
|
- `+release-create` 返回 release 只代表发布已发起。只有 `+release-get` 对同一个 `release_id` 返回 `finished` 后,才能说本轮最新版本已部署。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
`+release-create` 部署的是远端 `sprint/default` 上已 push 的代码,不是本地工作区——本地若有你修改但未推送的改动,需要先 `git add` + `git commit` 并 `git push` 到 `sprint/default`,否则这些改动不会进入这次发布。`git push` 如遇认证失败、401/403、credential helper 缺失或 token 过期,先执行 `lark-cli apps +git-credential-init --app-id <app_id> --as user` 刷新本地 Git 凭证,再重试原 git 命令;刷新凭证也失败时,停止并向用户报告错误,不要换路;不要手动复制 token 或改 remote URL。发布后若 status 是 `publishing`,用 [`+release-get`](lark-apps-release-get.md) 查询。`+release-create` 部署上线属高影响动作——作为别的命令的连带前置时,按 SKILL.md「高影响动作:确认与预授权」先征得用户同意再发布。
|
||||||
28
.agents/skills/lark-apps/references/lark-apps-release-get.md
Normal file
28
.agents/skills/lark-apps/references/lark-apps-release-get.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# apps +release-get
|
||||||
|
|
||||||
|
按 release ID 查询单次发布详情。运行时命令事实以 `lark-cli apps +release-get --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于跟进已知 `release_id` 的发布状态。没有 `release_id` 时先读 [`lark-apps-release-list.md`](lark-apps-release-list.md),不要让用户手填。
|
||||||
|
|
||||||
|
`release_id` 是妙搭发布 ID(`+release-create` 返回),不是飞书审批实例号;查发布进度/失败都在 `apps +release-*` 命令族内完成,不要路由到 lark-approval。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`、`--release-id`。
|
||||||
|
- `release_id` 来自 `+release-create` 或 `+release-list`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +release-get --app-id app_xxx --release-id release_yyy
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功可能直接返回 release 字段,也可能包在 `data.release`;读取 `release_id`、`status`、`created_at`、`updated_at`,以及 `commit_id`(本轮发布对应的 git commit SHA,pretty 输出在其非空时展示一行)。
|
||||||
|
- `status=publishing` 继续轮询。此时尚无 `online_url`;不要拿其它链接(如 `+list` 里的应用主页 / 开发态预览 URL)冒充"本轮发布的访问链接"——只回报 `release_id`、`status`,并说明 `finished` 后才可能有 `online_url`。
|
||||||
|
- `status=finished` 发布成功——若输出含 `online_url`,直接读取它作为本轮发布的线上访问链接;未返回时只报告发布完成,不要编造链接。该链接默认仅创建者可见,交付他人前先告知当前仅本人可见、按需用 `+access-scope-set` 放开可见范围。无需再调 `+list`(`+list` 仍可用于按应用名浏览,但不是发布主流程的必经步骤)。
|
||||||
|
- `status=failed` 发布失败——若输出含 `error_logs`(`step`/`error_log`),据此向用户转述关键失败步骤和可行动修复;未返回时不要编造失败原因。
|
||||||
|
- 只有当这个 `release_id` 已返回 `finished`,随后读到的 `online_url` 才能被表述为"本轮发布后的访问链接"。单独从 `+list` 看到 `is_published=true` 不能证明最新版本已部署。
|
||||||
@ -0,0 +1,31 @@
|
|||||||
|
# apps +release-list
|
||||||
|
|
||||||
|
分页查询妙搭应用发布历史,最新发布在前。运行时命令事实以 `lark-cli apps +release-list --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户问"最近发布""历史版本""上次为什么失败",但没有提供 `release_id` 时使用。拿到候选 release 后再接 `+release-get`。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 可选 `--status`:`publishing` / `finished` / `failed`。
|
||||||
|
- 可选 `--page-size`:默认 20,最大 500;总是发送给服务端。
|
||||||
|
- 可选 `--page-token`:上一页 cursor。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +release-list --app-id app_xxx --page-size 10
|
||||||
|
lark-cli apps +release-list --app-id app_xxx --status failed
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.releases[]`;关键字段是 `release_id`、`status`、`created_at`、`updated_at`。
|
||||||
|
- `release_id` 用于继续查 `+release-get`。
|
||||||
|
- 若 `has_more=true`,用 `next_page_token` / `page_token` 翻页。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
用户限定只看 N 条("最近 N 条""最新 N 个""只要前 N 条")时用 `--page-size N`(如"最近一次发布"→ `--page-size 1`),而不是取全量再本地截断。
|
||||||
133
.agents/skills/lark-apps/references/lark-apps-role.md
Normal file
133
.agents/skills/lark-apps/references/lark-apps-role.md
Normal file
@ -0,0 +1,133 @@
|
|||||||
|
# apps role 域命令(应用角色)
|
||||||
|
|
||||||
|
管理妙搭应用内的平台角色、角色成员,以及查询某个用户命中的角色。运行时命令事实以 `lark-cli apps +<cmd> --help` 为准;身份、授权和高风险确认遵循本域 [`SKILL.md`](../SKILL.md)。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用户要列出、查看、创建、更新或删除某个妙搭应用内的平台角色,管理角色的用户、部门或群成员,或查询某个用户在应用中命中的角色时使用。多维表格 / Base 的角色与权限走 `lark-base`;设置谁能访问应用走 `+access-scope-*`,不要路由到本命令域。
|
||||||
|
|
||||||
|
## 命令一览
|
||||||
|
|
||||||
|
| 命令 | 做什么 | 关键参数 |
|
||||||
|
|---|---|---|
|
||||||
|
| `+role-list` | 分页列出角色,或按名称筛选角色 | `--app-id`、`--name`、`--page-size`/`--page-token` |
|
||||||
|
| `+role-get` | 根据真实 `role_id` 读取角色详情 | `--app-id`、`--role-id` |
|
||||||
|
| `+role-match-list` | 查询指定用户命中的角色 | `--app-id`、`--user-id` |
|
||||||
|
| `+role-create` | 创建角色 | `--app-id`、`--name`、`--description`、`--role-id` |
|
||||||
|
| `+role-update` | 更新角色名称或描述 | `--app-id`、`--role-id`、`--name`/`--description` |
|
||||||
|
| `+role-delete` | 永久删除角色 | `--app-id`、`--role-id`、`--yes` |
|
||||||
|
| `+role-member-list` | 查询角色的用户、部门和群成员 | `--app-id`、`--role-id`、`--member-type` |
|
||||||
|
| `+role-member-add` | 向角色添加用户、部门或群成员 | `--app-id`、`--role-id`、`--users`/`--departments`/`--chats` |
|
||||||
|
| `+role-member-remove` | 定向移除或清空角色成员 | `--app-id`、`--role-id`、成员参数或 `--all`、`--yes` |
|
||||||
|
|
||||||
|
## 约定(先读)
|
||||||
|
|
||||||
|
- `app_...` 标识的是妙搭应用,其角色和成员只使用 `apps +role-*` / `apps +role-member-*`;不要改走 Base 角色命令或裸 bitable API。
|
||||||
|
- 角色名称不是 `role_id`。只有名称时优先用 `+role-list --name` 精确解析;若已取得完整分页列表,也可从中证明精确名称唯一命中。0 条如实报告,多条让用户消歧,唯一命中后才使用返回的真实 ID。
|
||||||
|
- `+role-list` 返回 `has_more=true` 时,用本页 `page_token` 继续查询,直到 `has_more=false`;不要根据 `total` 补造条目。
|
||||||
|
- `+role-list`、`+role-get`、`+role-match-list` 的角色数据分别位于 `data.items`、`data.role`、`data.roles`,不要混用。
|
||||||
|
- 同一角色的写入及依赖该写入结果的操作必须串行。不同角色的独立操作只有在每次写入可单独追溯、失败不影响其它目标且分别验收时才可并行;否则保持串行。互不依赖的名称解析或只读查询可并行。
|
||||||
|
|
||||||
|
## 各命令
|
||||||
|
|
||||||
|
### 查询角色
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +role-list --app-id <app_id> --page-size 100
|
||||||
|
lark-cli apps +role-list --app-id <app_id> --name '<exact_name>'
|
||||||
|
lark-cli apps +role-get --app-id <app_id> --role-id <role_id>
|
||||||
|
lark-cli apps +role-match-list --app-id <app_id> --user-id <ou_x>
|
||||||
|
```
|
||||||
|
|
||||||
|
整理角色列表时保留 `role_id`、`name` 和 `description`。不要猜测未知 `role_id`,也不要从同名候选中静默选择。
|
||||||
|
`items=[]` 时直接报告当前没有角色;不要为表格补造“无”或 `N/A` 占位行。
|
||||||
|
`+role-match-list --user-id` 只接受 `ou_...`;用户给的是姓名、邮箱或手机号时,先解析唯一 open ID,再查询命中角色。
|
||||||
|
|
||||||
|
### 创建与更新
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +role-create --app-id <app_id> --name '<name>' \
|
||||||
|
--description '<description>'
|
||||||
|
|
||||||
|
# 只修改名称
|
||||||
|
lark-cli apps +role-update --app-id <app_id> --role-id <role_id> \
|
||||||
|
--name '<new_name>' --as user --format json
|
||||||
|
|
||||||
|
# 只修改描述
|
||||||
|
lark-cli apps +role-update --app-id <app_id> --role-id <role_id> \
|
||||||
|
--description '<new_description>' --as user --format json
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--description` 和创建时的 `--role-id` 可选;仅在确实需要稳定 ID 时传 `--role-id`,创建后不能修改。
|
||||||
|
- 更新时只传用户明确要求变更的字段。
|
||||||
|
- 成功响应中的角色位于 `data.role`。只有用户要求独立验证,或结果将用于后续高风险操作时,才额外执行 `+role-get`。
|
||||||
|
|
||||||
|
### 删除角色
|
||||||
|
|
||||||
|
普通“删除某角色”请求只说明目标,**不等于不可逆确认**。如果用户尚未明确确认删除后果,本轮只能定位角色、读取完整成员并说明影响,最后请求确认;不得在同一轮自动追加 `--yes`。用户已明确确认不可逆删除时才继续。
|
||||||
|
|
||||||
|
只有名称时仍按上述规则唯一解析,优先使用 `+role-list --name`。目标写前已不存在时立即停止,如实说明本次是 no-op、没有执行删除,不能把“当前不存在”表述为“删除成功”。
|
||||||
|
|
||||||
|
删除前读取准确角色和完整成员范围,向用户说明 app、role、`users` / `departments` / `chats` 影响;得到不可逆删除确认后才使用 `--yes`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +role-get --app-id <app_id> --role-id <role_id>
|
||||||
|
lark-cli apps +role-member-list --app-id <app_id> --role-id <role_id>
|
||||||
|
lark-cli apps +role-delete --app-id <app_id> --role-id <role_id> --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
成功响应包含匹配的 `data.role_id` 和 `data.deleted=true`。只有用户明确要求独立验证删除结果时,才再用 `+role-list --name` 检查目标 ID 已不存在。
|
||||||
|
|
||||||
|
### 成员 ID 解析
|
||||||
|
|
||||||
|
成员 flags 只接受 open ID:用户 `ou_...`、部门 `od-...`、群 `oc_...`。用户已提供对应类型的合法 open ID 时直接使用;只有名称或邮箱时才解析。
|
||||||
|
对象类型以用户语义为准,不能互换解析器:用户走通讯录用户搜索,部门走部门搜索,群走群搜索。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 用户:每个姓名或邮箱单独查询。
|
||||||
|
lark-cli contact +search-user --query '<姓名或邮箱>' \
|
||||||
|
--exclude-external-users --page-size 30
|
||||||
|
|
||||||
|
# 部门:拉完分页,只接受唯一的 open_department_id。
|
||||||
|
lark-cli api POST /open-apis/contact/v3/departments/search \
|
||||||
|
--params '{"user_id_type":"open_id","department_id_type":"open_department_id","page_size":50}' \
|
||||||
|
--data '{"query":"<部门名称>"}'
|
||||||
|
|
||||||
|
# 群:拉完分页,只接受名称精确匹配的唯一 chat_id。
|
||||||
|
lark-cli im +chat-search --query '<群名称>' --page-size 50
|
||||||
|
```
|
||||||
|
|
||||||
|
- 只接受与输入姓名、邮箱或群名精确匹配的唯一结果;部门搜索只接受完整 query 的唯一 `od-...`。0 条、多条或分页未完成时停止写入并让用户补充或消歧。
|
||||||
|
- 多个对象逐个解析。全部解析成功且总数不超过 100 后,按类型放入一次成员写入;任一对象失败时不要部分写入,也不要自动拆批。
|
||||||
|
|
||||||
|
### 成员操作
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 省略 --member-type,返回完整 users / departments / chats。
|
||||||
|
lark-cli apps +role-member-list --app-id <app_id> --role-id <role_id>
|
||||||
|
|
||||||
|
lark-cli apps +role-member-add --app-id <app_id> --role-id <role_id> \
|
||||||
|
--users ou_x,ou_y --departments od-x --chats oc_x
|
||||||
|
|
||||||
|
lark-cli apps +role-member-remove --app-id <app_id> --role-id <role_id> \
|
||||||
|
--users ou_x --yes
|
||||||
|
|
||||||
|
# 清空成员,不删除角色。
|
||||||
|
lark-cli apps +role-member-remove --app-id <app_id> --role-id <role_id> \
|
||||||
|
--all --yes
|
||||||
|
```
|
||||||
|
|
||||||
|
- `+role-member-list` 不分页;`--member-type` 只返回选中类型的字段,未返回的成员字段表示“未查询”而不是空。影响确认或完整比较时必须省略它。
|
||||||
|
- 汇总 `--member-type` 结果时明确这是过滤投影,不得据此断言角色没有其它类型成员。
|
||||||
|
- 用户要求 CLI 原生 table 时,直接执行 `+role-member-list --format table`;可原样转发或做事实摘要,不要先取 JSON 再手工重建一张替代表格。
|
||||||
|
- 写入和依赖其结果的回读不得放进同一个并发批次;必须等待写入完整返回成功后,再单独发起回读。误并发时只能以写入完成后的新回读作为结果证据。
|
||||||
|
- 添加前仅在用户要求独立证明或确认其他成员类型未变化时读取完整基线,并在写后完整回读;否则成功响应即可作为结果。
|
||||||
|
- 定向移除前确认准确成员及影响。若需要证明结果,写后完整回读;不要把过滤结果当作完整成员集合。
|
||||||
|
- `--all` 前读取完整成员范围并确认;成功后执行一次无过滤 `+role-member-list`,确认三个成员数组均为空。
|
||||||
|
|
||||||
|
## 权限
|
||||||
|
|
||||||
|
| 操作 | 所需 scope |
|
||||||
|
|---|---|
|
||||||
|
| list / get / member-list / match-list | `spark:app:read` |
|
||||||
|
| create / update / delete / member-add / member-remove | `spark:app:write` |
|
||||||
@ -0,0 +1,53 @@
|
|||||||
|
# apps +session-messages-list
|
||||||
|
|
||||||
|
按 page_token 分页读取某个会话轮次(turn)的回复消息。运行时命令事实以 `lark-cli apps +session-messages-list --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
用于拉取妙搭应用一轮对话(turn)产生的回复消息列表。只读,scope `spark:app:read`,用户身份。对仍在 running 的 turn 也可读——消息随生成增量出现,配合 `--page-token` 续拉新消息,可用于云端开发期间实时播报本轮进展。它不发消息、也不判断轮次状态;想知道某轮是否跑完、拿 `turn_id`,仍先用 `+session-get`。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +session-messages-list --app-id <app_id> --session-id <session_id> --turn-id <turn_id> [--page-token <token>]
|
||||||
|
```
|
||||||
|
|
||||||
|
| 旗标 | 必填 | 说明 |
|
||||||
|
|------|:----:|------|
|
||||||
|
| `--app-id` | 是 | 应用 ID |
|
||||||
|
| `--session-id` | 是 | 会话 ID |
|
||||||
|
| `--turn-id` | 是 | 轮次 ID,来自 `+session-get` 的 `latest_turn.turn_id` |
|
||||||
|
| `--page-token` | 否 | string,上一页响应里的 `next_page_token`;首页省略 |
|
||||||
|
|
||||||
|
## turn_id 来源
|
||||||
|
|
||||||
|
`--turn-id` 不是用户能直接提供的,必须先跑 `+session-get` 拿 `latest_turn.turn_id`。没有 `turn_id` 时不要猜,先 `+session-get`。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
先取最新轮次的 `turn_id`,再拉第一页,最后用 `next_page_token` 续拉下一页:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1. 从 +session-get 提取 latest_turn.turn_id
|
||||||
|
TURN_ID=$(lark-cli apps +session-get --app-id app_xxx --session-id conv_xxx -q '.data.latest_turn.turn_id')
|
||||||
|
|
||||||
|
# 2. 拉第一页(省略 --page-token)
|
||||||
|
lark-cli apps +session-messages-list --app-id app_xxx --session-id conv_xxx --turn-id "$TURN_ID"
|
||||||
|
|
||||||
|
# 3. has_more=true 时,把上一页的 next_page_token 作为 --page-token 续拉
|
||||||
|
lark-cli apps +session-messages-list --app-id app_xxx --session-id conv_xxx --turn-id "$TURN_ID" --page-token tok_next
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- `data.messages[]`:每条含 `message_id`、`role`、`content`。
|
||||||
|
- `data.next_page_token`(string):下一页分页令牌,作为下次调用的 `--page-token`。**注意它在最后一页仍非空**(解码形如 `{"offset":N}`),不能用它是否为空判断还有没有下一页。
|
||||||
|
- `data.has_more`(bool):是否还有更多消息。**这是判断要不要续拉的唯一依据。**
|
||||||
|
- pretty 输出为消息表 + 末行 `next_page_token: <token> has_more: <bool>`;自动化取字段用 JSON 或 `-q`。
|
||||||
|
- 业务失败(app/session/turn 不存在或 ID 写错)通常带 `error.hint` 指向 `+session-get`,优先转述 hint。
|
||||||
|
|
||||||
|
## 分页规则
|
||||||
|
|
||||||
|
单次调用只返回一页。Agent 自行续拉:把本次响应的 `next_page_token` 作为下次的 `--page-token`,直到 `has_more` 为 `false` 才停。首页不要传 `--page-token`。
|
||||||
|
|
||||||
|
> ⚠️ **终止条件只看 `has_more`,不要拿 `next_page_token` 是否为空判断。** 即使 `has_more=false`(已是最后一页),后端仍会返回一个非空的 `next_page_token`(解码形如 `{"offset":N}`);若以「token 非空就继续」为循环条件,会在末页之后继续翻出空页(每页 0 条),白费调用。读到 `has_more=false` 立即停止,不要再用该 token 续拉。
|
||||||
30
.agents/skills/lark-apps/references/lark-apps-update.md
Normal file
30
.agents/skills/lark-apps/references/lark-apps-update.md
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
# apps +update
|
||||||
|
|
||||||
|
部分更新妙搭应用元信息。运行时命令事实以 `lark-cli apps +update --help` 为准。
|
||||||
|
|
||||||
|
## 何时用
|
||||||
|
|
||||||
|
只更新应用展示元信息。用户要改代码、发布内容、可见范围或数据库时,不走 `+update`。
|
||||||
|
|
||||||
|
## 命令骨架
|
||||||
|
|
||||||
|
- 必填:`--app-id`。
|
||||||
|
- 至少提供一个:`--name` 或 `--description`。
|
||||||
|
- 只发送用户提供的字段,不会清空未提供字段。
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli apps +update --app-id app_xxx --name "审批系统"
|
||||||
|
lark-cli apps +update --app-id app_xxx --description "用于部门审批流转"
|
||||||
|
lark-cli apps +update --app-id app_xxx --name "审批系统" --description "用于部门审批流转" --dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出契约
|
||||||
|
|
||||||
|
- 成功读取 `data.app`;响应是完整应用对象,不只是被修改字段。
|
||||||
|
- 缺 `--app-id` 或没有提供 `--name` / `--description` 会在本地 validation 失败。
|
||||||
|
|
||||||
|
## Agent 规则
|
||||||
|
|
||||||
|
更新前复述要变更的字段;用户没有提到的字段不要补默认值。执行后只转述新的名称/描述和 app_id,不需要展开原始响应。
|
||||||
57
.agents/skills/lark-attendance/SKILL.md
Normal file
57
.agents/skills/lark-attendance/SKILL.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
---
|
||||||
|
name: lark-attendance
|
||||||
|
version: 1.0.0
|
||||||
|
description: "飞书考勤打卡:查询自己的考勤打卡记录"
|
||||||
|
metadata:
|
||||||
|
requires:
|
||||||
|
bins: ["lark-cli"]
|
||||||
|
cliHelp: "lark-cli attendance --help"
|
||||||
|
---
|
||||||
|
|
||||||
|
# attendance (v1)
|
||||||
|
|
||||||
|
**CRITICAL — 开始前 MUST 先用 Read 工具读取 [`../lark-shared/SKILL.md`](../lark-shared/SKILL.md),其中包含认证、权限处理**
|
||||||
|
|
||||||
|
## 默认参数自动填充规则
|
||||||
|
|
||||||
|
调用任何 API 时,以下参数 **必须自动填充,禁止向用户询问**:
|
||||||
|
|
||||||
|
| 参数 | 固定值 | 说明 |
|
||||||
|
|------|--------|------------------------------------|
|
||||||
|
| `employee_type` | `"employee_no"` | `employee_type`始终等于`"employee_no"` |
|
||||||
|
| `user_ids` | `[]`(空数组) | `user_ids`始终等于`[]` |
|
||||||
|
|
||||||
|
### 填充示例
|
||||||
|
|
||||||
|
当构建 `--params` 参数时,自动注入上述字段:
|
||||||
|
- `employee_type` 保持 `"employee_no"` 不变
|
||||||
|
|
||||||
|
当构建 `--data` 参数时,自动注入上述字段:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user_ids": [],
|
||||||
|
...用户提供的参数
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **注意**:`user_ids` 数组保持为空[],`employee_type` 保持 `"employee_no"` 不变。
|
||||||
|
|
||||||
|
## API Resources
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli schema attendance.<resource>.<method> # 调用 API 前必须先查看参数结构
|
||||||
|
lark-cli attendance <resource> <method> [flags] # 调用 API
|
||||||
|
```
|
||||||
|
|
||||||
|
> **重要**:使用原生 API 时,必须先运行 `schema` 查看 `--data` / `--params` 参数结构,不要猜测字段格式。
|
||||||
|
|
||||||
|
### user_tasks
|
||||||
|
|
||||||
|
- `query` — 查询用户考勤打卡记录
|
||||||
|
|
||||||
|
## 权限表
|
||||||
|
|
||||||
|
| 方法 | 所需 scope |
|
||||||
|
|------|-----------|
|
||||||
|
| `user_tasks.query` | `attendance:task:readonly` |
|
||||||
|
|
||||||
159
.agents/skills/lark-base/SKILL.md
Normal file
159
.agents/skills/lark-base/SKILL.md
Normal file
@ -0,0 +1,159 @@
|
|||||||
|
---
|
||||||
|
name: lark-base
|
||||||
|
version: 1.2.3
|
||||||
|
description: "飞书多维表格(Base)操作:建表、字段、记录、视图、统计、公式/lookup、表单、仪表盘、workflow、角色权限;遇到 Base/多维表格/bitable 或 /base/ 链接时使用。文件导入转 lark-drive,认证/授权转 lark-shared。"
|
||||||
|
metadata:
|
||||||
|
requires:
|
||||||
|
bins: ["lark-cli"]
|
||||||
|
cliHelp: "lark-cli base --help"
|
||||||
|
---
|
||||||
|
|
||||||
|
# base
|
||||||
|
|
||||||
|
## 何时使用
|
||||||
|
|
||||||
|
使用本 skill:
|
||||||
|
|
||||||
|
- 用户明确提到 Base / 多维表格 / bitable,或给出 `/base/` 链接。
|
||||||
|
- 用户要在 Base 内建表、改表、管理字段、写记录、查记录、配视图。
|
||||||
|
- 用户要在 Base 内做公式字段、lookup 字段、跨表计算、派生指标、筛选聚合、TopN、统计分析。
|
||||||
|
- 用户要管理 Base 表单、仪表盘、workflow、高级权限或角色。
|
||||||
|
- 用户要把旧 Base 聚合式命令或旧写法迁移到当前 `lark-cli base +...` shortcut。
|
||||||
|
|
||||||
|
不要使用本 skill:
|
||||||
|
|
||||||
|
- 只是认证、初始化配置、切换身份、处理 scope 或权限授权恢复,转 `lark-shared`。
|
||||||
|
- 把本地 Excel / CSV / `.base` 导入成 Base,转 `lark-drive +import --type bitable`。
|
||||||
|
- 泛化数据分析、字段设计、公式讨论,但没有 Base/多维表格上下文。
|
||||||
|
|
||||||
|
## 使用边界
|
||||||
|
|
||||||
|
- Base 业务操作只使用 `lark-cli base +...` shortcut,不使用旧聚合式 `+table / +field / +record / +view / +history / +workspace`。
|
||||||
|
- 执行 update 前必须先查当前 shortcut 的 `--help` 或对应 reference。若命令要求完整配置,首次请求必须基于可信的当前配置执行 read-modify-write:只修改用户明确指定的内容,保留其他仍适用的可写配置,并按命令要求的结构提交。若命令支持局部/delta update,按其契约提交最小合法 payload;不得以不完整请求试错补参。
|
||||||
|
- 用户要把 Excel / CSV / `.base` 导入成 Base 时,先转 `lark-cli drive +import --type bitable`,导入完成后再回到 Base 命令。
|
||||||
|
- 认证、初始化、scope、身份切换、权限不足恢复属于 `lark-shared`;Base 文档只保留会影响 Base 路径选择的权限规则。
|
||||||
|
|
||||||
|
## 先获取 Base Token 和所需 ID
|
||||||
|
|
||||||
|
进入任何需要目标 Base 的 shortcut 前,必须先拿到可用的 `base_token`,以及当前任务需要的 `table_id` / `view_id` / `record_id` / `form_id` / `dashboard_id` / `workflow_id` 等真实 ID;不要把完整 URL、wiki token、workspace token 或孤立 raw token 直接当作 `--base-token`。
|
||||||
|
|
||||||
|
- 用户输入 URL 或分享链接:先运行 `lark-cli base +url-resolve --url "<url>" --as user`,用返回的 `base_token` 和相关 ID 继续后续命令。
|
||||||
|
- 用户输入 Base 标题、关键词或不确定名称:先运行 `lark-cli base +title-resolve --title "<keyword>" --as user`;`--title` 传入标题中的短关键词,不超过 30 个字符;过长标题先取最有区分度的短关键词;多候选时先让用户消歧,不要猜。
|
||||||
|
- 文档嵌入 Base 标签:直接读取 `<bitable>` / `<base_refer>` 的 `token` 作为 `--base-token`,`table-id` 作为 `--table-id`,`view-id` 作为 `--view-id`;孤立 raw token 不走 `+url-resolve`。
|
||||||
|
- 仍无法定位且用户不是要新建 Base 时,先反问用户要操作哪一个 Base;用户要新建时才用 `+base-create`。
|
||||||
|
|
||||||
|
## 快速路由
|
||||||
|
|
||||||
|
| 用户目标 | 优先命令 | 何时读 reference |
|
||||||
|
|---|---|---|
|
||||||
|
| 查 Base 本体 | `+base-get` | 用返回确认 Base 名称、owner、权限和可继续操作的 token |
|
||||||
|
| 创建/复制 Base | `+base-create` / `+base-copy` | 新建时强烈推荐用 `--table-name` + `--fields` 同时配置新 Base 里唯一一个初始数据表的 name 和 schema;写入后报告新 Base 标识和 `permission_grant` |
|
||||||
|
| 查看 Base 内资源目录 | `+base-block-list` | 想先了解一个 Base 里有哪些 table/docx/dashboard/workflow/folder 时优先用它;返回 ID 关系和 fewshot 看 `--help` |
|
||||||
|
| 管理 Base 内资源目录 | `+base-block-create/move/rename/delete` | 创建或整理 Base 直接管理的 folder/table/docx/dashboard/workflow;资源内容继续用对应命令 |
|
||||||
|
| 管理数据表 | `+table-list/get/create/update/delete` | 处理 table 的列出、详情、创建、重命名和删除 |
|
||||||
|
| 列/查/删字段 | `+field-list/get/delete/search-options` | 写入前用 list/get 确认字段类型、选项、ID;删除前确认目标字段 |
|
||||||
|
| 创建/更新字段 | `+field-create` / `+field-update` | 必读 [lark-base-field-json.md](references/lark-base-field-json.md);公式读 [formula-field-guide.md](references/formula-field-guide.md);lookup 读 [lookup-field-guide.md](references/lookup-field-guide.md);命令细节读 [lark-base-field-create.md](references/lark-base-field-create.md) / [lark-base-field-update.md](references/lark-base-field-update.md) |
|
||||||
|
| 读记录明细 | `+record-get` / `+record-list` / `+record-search` | 涉及筛选、排序、Top/Bottom N、聚合、多表关联、全局结论时读 [lark-base-data-analysis-sop.md](references/lark-base-data-analysis-sop.md) |
|
||||||
|
| 写记录 | `+record-upsert` / `+record-batch-create` / `+record-batch-update` | 必读 [lark-base-record-upsert.md](references/lark-base-record-upsert.md) / [lark-base-record-batch-create.md](references/lark-base-record-batch-create.md) / [lark-base-record-batch-update.md](references/lark-base-record-batch-update.md) 和 [lark-base-cell-value.md](references/lark-base-cell-value.md) |
|
||||||
|
| 附件字段 | `+record-upload-attachment` / `+record-download-attachment` / `+record-remove-attachment` | 附件不要伪造成普通 CellValue;上传走本地文件,下载/删除按 file token 或字段定位 |
|
||||||
|
| 删除记录 / 分享记录链接 / 历史 | `+record-delete` / `+record-share-link-create` / `+record-history-list` | 删除前确认 record;分享链接最多 100 条;历史读 [lark-base-record-history-list.md](references/lark-base-record-history-list.md),只查单条记录,不做整表审计 |
|
||||||
|
| 管理视图 | `+view-*` | `+view-set-filter` 读 [lark-base-view-set-filter.md](references/lark-base-view-set-filter.md);其余配置先 get 现状,再按返回结构更新 |
|
||||||
|
| 一次性聚合统计 | `+data-query` | 必读 [lark-base-data-analysis-sop.md](references/lark-base-data-analysis-sop.md) 和入口 [lark-base-data-query-guide.md](references/lark-base-data-query-guide.md);完整 DSL 再读 [lark-base-data-query.md](references/lark-base-data-query.md) |
|
||||||
|
| 公式字段 | `+field-create/update --json '{"type":"formula",...}'` | 必读 [formula-field-guide.md](references/formula-field-guide.md),读后再加隐藏确认 flag `--i-have-read-guide` |
|
||||||
|
| Lookup 字段 | `+field-create/update --json '{"type":"lookup",...}'` | 必读 [lookup-field-guide.md](references/lookup-field-guide.md),读后再加隐藏确认 flag `--i-have-read-guide` |
|
||||||
|
| 表单提交 | `+form-submit` | 先读 [lark-base-form-detail.md](references/lark-base-form-detail.md) 获取题目、filter 和附件所需 `base_token`;提交 JSON 读 [lark-base-form-submit.md](references/lark-base-form-submit.md) |
|
||||||
|
| 表单题目创建/更新 | `+form-questions-create` / `+form-questions-update` | 读 [lark-base-form-questions-create.md](references/lark-base-form-questions-create.md) / [lark-base-form-questions-update.md](references/lark-base-form-questions-update.md) |
|
||||||
|
| 其他表单管理 | `+form-list/get/detail/create/update/delete` / `+form-questions-list/delete` | `+form-detail` 读 [lark-base-form-detail.md](references/lark-base-form-detail.md);删除前确认目标表单 |
|
||||||
|
| 仪表盘与组件 | `+dashboard-*` / `+dashboard-block-*` | 提到图表/看板/block 时先读 [lark-base-dashboard.md](references/lark-base-dashboard.md);组件 `data_config` 读 [dashboard-block-data-config.md](references/dashboard-block-data-config.md);读取图表计算结果用 `+dashboard-block-get-data` |
|
||||||
|
| Workflow | `+workflow-*` | 创建/更新或理解 steps 时读入口 [lark-base-workflow-guide.md](references/lark-base-workflow-guide.md) 和 steps JSON SSOT [lark-base-workflow-schema.md](references/lark-base-workflow-schema.md);list/get/enable/disable 只处理 workflow ID 与启停状态 |
|
||||||
|
| 高级权限与角色 | `+advperm-*` / `+role-*` | 角色操作先读入口 [lark-base-role-guide.md](references/lark-base-role-guide.md);角色 create/update 或解读完整配置再读权限 JSON SSOT [role-config.md](references/role-config.md);系统角色不可删除;关闭高级权限会影响自定义角色 |
|
||||||
|
|
||||||
|
## Base 心智模型
|
||||||
|
|
||||||
|
- Base 曾用名 Bitable;返回字段、错误或旧文档里的 `bitable` 多为历史兼容,不代表应改走裸 API 或另一套命令。
|
||||||
|
- `+base-block-list` 是查看一个 Base 内资源目录的新入口:它列出这个 Base 直接管理的 `folder/table/docx/dashboard/workflow`,适合先判断 Base 里有什么,再决定走 table、dashboard、workflow 或 docx 命令。
|
||||||
|
- `base-block` 只负责资源目录管理,包括创建资源、移动到 folder、重命名和删除;具体资源内容仍走 table/dashboard/workflow 命令。
|
||||||
|
- 新建 Base 时,强烈推荐一次性执行 `lark-cli base +base-create --name "<base>" --table-name "<table>" --fields '<field-json-array>'`,同时配置新 Base 里唯一一个初始数据表的 name 和 schema;使用 `--fields` 前先读 [lark-base-field-json.md](references/lark-base-field-json.md) 或复用 `+field-create` 的字段 JSON 形状,不要猜字段属性。
|
||||||
|
- `+base-create` 不传 `--table-name` 和 `--fields` 时,会创建一个默认 schema 的初始数据表。
|
||||||
|
- 表、字段、视图、workflow、dashboard block 的名称和 ID 必须来自真实返回,不要凭用户口述猜。
|
||||||
|
- 存储字段可写;系统字段、`formula`、`lookup` 只读;附件字段走专用 attachment 命令。
|
||||||
|
- 一次性原始记录查询优先用 `+record-list` / `+record-search` 的 filter/sort;聚合分析优先用 `+data-query`;需要长期显示在表中时,才新增 `formula` / `lookup` 字段。
|
||||||
|
- `formula` 适合常规计算、条件判断、文本/日期处理和长期派生指标;`lookup` 适合明确的跨表查找、筛选后取值或聚合引用。
|
||||||
|
- 写入、分析、公式、lookup、workflow、dashboard 前,先读取真实结构:表、字段、视图、关联表和 dashboard block 名称都以命令返回为准。
|
||||||
|
- 跨表场景必须读取目标表结构;link 单元格中的关联 `record_id` 只是连接键,最终回答要回查并展示用户可读字段。
|
||||||
|
|
||||||
|
## 身份与权限降级
|
||||||
|
|
||||||
|
- 默认显式使用 `--as user` 操作用户资源;只有用户明确要求应用身份时,才直接用 `--as bot`。
|
||||||
|
- user 身份报 scope/授权不足,或错误中包含 `missing_scopes` / `hint`,先转 `lark-shared` 做用户授权恢复,不要直接降级 bot。
|
||||||
|
- user 身份报资源级无访问且无授权恢复提示时,才可用 `--as bot` 重试一次;bot 仍失败就停止重试并按权限错误处理。
|
||||||
|
- `91403` 或明确不可访问错误不要循环换身份重试。
|
||||||
|
- `+base-create` / `+base-copy` 若用 bot 身份执行,关注返回中的 `permission_grant`,并把用户是否可打开新 Base 告知用户。
|
||||||
|
|
||||||
|
## 查询与统计规则
|
||||||
|
|
||||||
|
涉及查询、统计或判断结论时,先阅读 [lark-base-data-analysis-sop.md](references/lark-base-data-analysis-sop.md),并遵守:
|
||||||
|
|
||||||
|
1. `+record-list` 的默认页、固定 `--limit` 和本地 `jq` 只能证明已读取范围内的事实,不能直接支撑全局最值、全量计数、Top/Bottom N、异常识别或分组结论。
|
||||||
|
2. 能由 Base 表达的筛选、排序、投影、聚合、分组和限制,应在 Base 云端查询能力中执行;不要先拉原始记录到本地上下文再手工筛选排序。
|
||||||
|
3. `has_more=true` 或等价分页信号表示当前结果不是全量;除非用户只要样例/前 N 条,不能基于该页回答全局问题。
|
||||||
|
4. 多表查询必须先确认关系字段和连接键;link 单元格里的 `record_id` 是关系键,不是用户可读答案。
|
||||||
|
5. 最终答案必须能追溯到真实表、真实字段、查询范围、筛选/排序/聚合条件和必要的连接键。
|
||||||
|
6. 一次性原始记录查询优先用 `+record-list` / `+record-search` 的 filter/sort;聚合分析优先用 `+data-query`;要把结果长期显示在表里,才考虑新增 `formula` / `lookup` 字段。
|
||||||
|
7. `+data-query` 可返回聚合结果或维度字段行,但维度行按字段组合去重且不返回 `record_id`;需要逐条记录、记录定位或完整行级字段时,再用 `+record-list` / `+record-search` / `+record-get` 回查。
|
||||||
|
|
||||||
|
## 写入前置规则
|
||||||
|
|
||||||
|
- 优先用写入返回确认结果;返回信息不足或任务明确要求核验时,再读回。
|
||||||
|
- 写记录前先读字段结构;只写存储字段。系统字段、附件字段、`formula`、`lookup` 不作为普通记录写入目标。
|
||||||
|
- 附件上传、下载、删除走专用 `+record-*-attachment` 命令。
|
||||||
|
- 写字段前先读 [lark-base-field-json.md](references/lark-base-field-json.md);涉及 `formula` / `lookup` 时必须读 [formula-field-guide.md](references/formula-field-guide.md) / [lookup-field-guide.md](references/lookup-field-guide.md)。
|
||||||
|
- 表名、字段名、视图名、workflow 配置中的名称必须来自真实返回;跨表场景还要读取目标表结构。
|
||||||
|
- 删除、角色更新、字段更新、表单提交(`+form-submit`)等高风险操作遵循 CLI 的 confirmation gate,必须带 `--yes`;目标不明确时先用 get/list 消歧。
|
||||||
|
- 批量写入单批最多 200 条;连续写同一表时串行执行,遇到 `1254291` 按短暂等待后重试处理。
|
||||||
|
- `select` 字段只支持写入字段中已有的选项;构造 CellValue 前先用 `+field-list` 或 `+field-search-options` 确认目标选项存在。
|
||||||
|
|
||||||
|
## 表单与视图细节
|
||||||
|
|
||||||
|
- `+form-submit` 是高风险写操作,必须带 `--yes` 确认;调用前必须先跑 `+form-detail`,读取 `questions[].type`、`required`、`filter` 和附件场景需要的 `base_token`;不要填写被 filter 隐藏的问题。
|
||||||
|
- 表单附件不要写进 `fields`,放在 `--json.attachments`;提交附件时必须同时传表单所属 Base 的 `--base-token`。
|
||||||
|
- `+view-set-filter` 是唯一保留的 view reference;sort/group/card/timebar/visible-fields 这类配置先用对应 get 命令读现状,保留未修改字段,只替换用户要求变更的配置。
|
||||||
|
- 视图适合持久化、共享和 UI 复用;一次性筛选/排序可先用 `+record-list` / `+record-search` 的 filter/sort 验证结果,再按需要沉淀为持久视图。
|
||||||
|
|
||||||
|
## Dashboard / Workflow / Role
|
||||||
|
|
||||||
|
- Dashboard 的复杂点是 block 的 `data_config`,不是 list/get/create/delete 命令参数。创建或更新 block 前先读 [dashboard-block-data-config.md](references/dashboard-block-data-config.md),组件必须串行创建;`+dashboard-arrange` 是服务端智能布局,仅在用户明确要求重排/美化、或对本次会话从零新建的仪表盘做收尾整理时执行。`+dashboard-block-get-data` 读取图表最终计算结果,不返回 block 名称、类型、布局或 `data_config`;需要元数据先用 `+dashboard-block-get`。
|
||||||
|
- Workflow 的复杂点是 `steps` 结构。创建、更新或解释完整 workflow 时读入口 [lark-base-workflow-guide.md](references/lark-base-workflow-guide.md) 和 steps JSON SSOT [lark-base-workflow-schema.md](references/lark-base-workflow-schema.md);enable/disable/list 只需确认 workflow ID、当前启停状态和用户意图。
|
||||||
|
- Role 的复杂点是权限 JSON。角色操作先读入口 [lark-base-role-guide.md](references/lark-base-role-guide.md);`+role-create` 只支持自定义角色;`+role-update` 是 delta merge;角色 create/update 或解读完整配置时读权限 JSON SSOT [role-config.md](references/role-config.md)。`+role-delete` 只适用于自定义角色,系统角色不可删除;删除角色和关闭高级权限前必须确认目标和影响。
|
||||||
|
|
||||||
|
## 常见恢复
|
||||||
|
|
||||||
|
| 错误 / 现象 | 恢复动作 |
|
||||||
|
|---|---|
|
||||||
|
| `param baseToken is invalid` / `base_token invalid` | 检查是否把 wiki token、workspace token 或完整 URL 当成了 `--base-token`;按入口规则重新获取真实 `base_token` |
|
||||||
|
| `not found` 且输入来自 Wiki 链接 | 优先检查是否把 wiki token 当成 base token,不要立刻改走裸 API |
|
||||||
|
| `1254045` 字段名不存在 | 重新 `+field-list`,使用真实字段名或字段 ID;注意空格、大小写和跨表字段 |
|
||||||
|
| `1254015` 字段值类型不匹配 | 先 `+field-list`,再按 [lark-base-cell-value.md](references/lark-base-cell-value.md) 构造 CellValue |
|
||||||
|
| `Invalid discriminator value`(字段写入缺 `type`) | 按完整提交规则读取当前字段,只改目标内容后提交;不要只补 `type` 重试 |
|
||||||
|
| filter 报 `value of type array` / `Only string values` | 用 record/view 的 tuple `--filter-json`(非 `+data-query` 对象型),value 按字段 type 选标量或数组;见 [lark-base-view-set-filter.md](references/lark-base-view-set-filter.md) |
|
||||||
|
| 日期 / 人员 / 超链接字段报格式错误 | 日期用 `YYYY-MM-DD HH:mm:ss`;人员用 `[{ "id": "ou_xxx" }]`;超链接用 URL 或 markdown link 字符串 |
|
||||||
|
| formula / lookup 创建失败 | 先读 [formula-field-guide.md](references/formula-field-guide.md) / [lookup-field-guide.md](references/lookup-field-guide.md),再按 guide 重建请求 |
|
||||||
|
| `ignored_fields` / `READONLY` | 移除只读字段,只写存储字段 |
|
||||||
|
| `1254104` | 批量超过 200,分批调用 |
|
||||||
|
| `1254291` | 并发写冲突,串行写入并在批次间短暂等待 |
|
||||||
|
| `91403` | 无权限访问该 Base,按 `lark-shared` 权限流程处理,不要盲目重试 |
|
||||||
|
|
||||||
|
## 保留 Reference
|
||||||
|
|
||||||
|
- [lark-base-data-analysis-sop.md](references/lark-base-data-analysis-sop.md):查询/统计/全局结论的选路 SOP
|
||||||
|
- [lark-base-data-query-guide.md](references/lark-base-data-query-guide.md) / [lark-base-data-query.md](references/lark-base-data-query.md):聚合查询入口 fewshot 与 DSL SSOT
|
||||||
|
- [lark-base-cell-value.md](references/lark-base-cell-value.md):记录 CellValue 构造
|
||||||
|
- [lark-base-field-json.md](references/lark-base-field-json.md):字段 JSON 构造
|
||||||
|
- [formula-field-guide.md](references/formula-field-guide.md) / [lookup-field-guide.md](references/lookup-field-guide.md):公式与 lookup 字段
|
||||||
|
- [lark-base-field-create.md](references/lark-base-field-create.md) / [lark-base-field-update.md](references/lark-base-field-update.md):字段创建/更新命令级补充
|
||||||
|
- [lark-base-record-upsert.md](references/lark-base-record-upsert.md) / [lark-base-record-batch-create.md](references/lark-base-record-batch-create.md) / [lark-base-record-batch-update.md](references/lark-base-record-batch-update.md) / [lark-base-record-history-list.md](references/lark-base-record-history-list.md):记录写入 JSON 与历史返回解释
|
||||||
|
- [lark-base-view-set-filter.md](references/lark-base-view-set-filter.md):视图筛选 JSON
|
||||||
|
- [lark-base-form-detail.md](references/lark-base-form-detail.md) / [lark-base-form-submit.md](references/lark-base-form-submit.md) / [lark-base-form-questions-create.md](references/lark-base-form-questions-create.md) / [lark-base-form-questions-update.md](references/lark-base-form-questions-update.md):表单详情、提交和复杂 JSON
|
||||||
|
- [lark-base-dashboard.md](references/lark-base-dashboard.md) / [dashboard-block-data-config.md](references/dashboard-block-data-config.md) / [lark-base-dashboard-block-get-data.md](references/lark-base-dashboard-block-get-data.md):仪表盘、组件配置与图表结果协议
|
||||||
|
- [lark-base-workflow-guide.md](references/lark-base-workflow-guide.md) / [lark-base-workflow-schema.md](references/lark-base-workflow-schema.md):workflow 入口与 steps JSON SSOT
|
||||||
|
- [lark-base-role-guide.md](references/lark-base-role-guide.md) / [role-config.md](references/role-config.md):角色入口与权限 JSON SSOT
|
||||||
@ -0,0 +1,376 @@
|
|||||||
|
# dashboard block data_config SSOT
|
||||||
|
|
||||||
|
Block 的 `data_config` 字段因 `type` 不同而变化。本文档是 dashboard block `data_config` 的单一事实来源(SSOT),包含组件类型、字段结构、筛选格式、约束和可复制模板。
|
||||||
|
|
||||||
|
## 支持的组件类型(`type` 枚举)
|
||||||
|
|
||||||
|
| type 值 | 说明 |
|
||||||
|
|---------|------|
|
||||||
|
| `column` | 柱状图 |
|
||||||
|
| `bar` | 条形图 |
|
||||||
|
| `line` | 折线图 |
|
||||||
|
| `pie` | 饼图 |
|
||||||
|
| `ring` | 环形图 |
|
||||||
|
| `area` | 面积图 |
|
||||||
|
| `combo` | 组合图 |
|
||||||
|
| `scatter` | 散点图 |
|
||||||
|
| `funnel` | 漏斗图 |
|
||||||
|
| `wordCloud` | 词云 |
|
||||||
|
| `radar` | 雷达图 |
|
||||||
|
| `statistics` | 指标卡 |
|
||||||
|
| `text` | 文本(支持 Markdown) |
|
||||||
|
|
||||||
|
## 字段类型与操作符速查(AI 决策用)
|
||||||
|
|
||||||
|
> 先用 `+field-list` / `+field-get` 确认字段 `type`;本节使用当前字段接口里的 canonical 类型名:`number`、`text`、`select`、`datetime`、`checkbox`、`user`。
|
||||||
|
|
||||||
|
```
|
||||||
|
text: is, isNot, contains, doesNotContain, isEmpty, isNotEmpty
|
||||||
|
number: is, isNot, isGreater, isGreaterEqual, isLess, isLessEqual, isEmpty, isNotEmpty
|
||||||
|
select(multiple=false): is, isNot, isEmpty, isNotEmpty
|
||||||
|
select(multiple=true): is, isNot, contains, doesNotContain, isEmpty, isNotEmpty
|
||||||
|
datetime: is, isGreater, isGreaterEqual, isLess, isLessEqual, isEmpty, isNotEmpty
|
||||||
|
checkbox: is (value: true/false)
|
||||||
|
user / created_by / updated_by: is, isNot, isEmpty, isNotEmpty
|
||||||
|
```
|
||||||
|
|
||||||
|
## data_config 通用结构
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `table_name` | string | 关联数据表名称 |
|
||||||
|
| `series` | `[{ "field_name": "xxx", "rollup": "SUM" }]` | 指标/Y 轴(与 `count_all` 二选一)。rollup 支持 `SUM` / `MAX` / `MIN` / `AVERAGE` |
|
||||||
|
| `count_all` | boolean | COUNTA 聚合,统计所有记录数(与 `series` 二选一) |
|
||||||
|
| `group_by` | `[{ "field_name": "xxx", "mode": "integrated", "sort": {...} }]` | X 轴分组维度。`mode` 必填,`sort` 可选,见下方说明 |
|
||||||
|
| `filter` | object | 筛选条件 |
|
||||||
|
| `filter.conjunction` | `"and"` / `"or"` | 筛选逻辑 |
|
||||||
|
| `filter.conditions` | `[{ "field_name", "operator", "value" }]` | 筛选条件数组,value 类型因字段类型而异(见下方 filter 格式规则) |
|
||||||
|
|
||||||
|
### text 类型特殊结构
|
||||||
|
|
||||||
|
`text` 类型组件用于展示富文本内容,**不需要数据源配置**(无 `table_name`、`series`、`group_by`、`filter`)。
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `text` | string | **必填**。支持 Markdown 语法,详见下方说明 |
|
||||||
|
|
||||||
|
**支持的 Markdown 语法:**
|
||||||
|
|
||||||
|
| 语法 | 示例 | 效果 |
|
||||||
|
|------|------|------|
|
||||||
|
| 一级标题 | `# 标题` | 大标题 |
|
||||||
|
| 二级标题 | `## 标题` | 中标题 |
|
||||||
|
| 三级标题 | `### 标题` | 小标题 |
|
||||||
|
| 加粗 | `**文字**` | **文字** |
|
||||||
|
| 斜体 | `*文字*` | *文字* |
|
||||||
|
| 删除线 | `~~文字~~` | ~~文字~~ |
|
||||||
|
| 有序列表 | `1. 项目` | 1. 项目 |
|
||||||
|
| 无序列表 | `- 项目` | - 项目 |
|
||||||
|
|
||||||
|
> **注意**:以上未提及的 Markdown 语法(如链接、图片、代码块、表格等)均不支持。
|
||||||
|
|
||||||
|
## group_by 详细说明
|
||||||
|
|
||||||
|
### mode 枚举
|
||||||
|
|
||||||
|
| mode | 含义 | 适用场景 |
|
||||||
|
|------|------|----------|
|
||||||
|
| `integrated` | 聚合分组(默认) | 绝大部分场景,按字段值分组统计 |
|
||||||
|
| `enumerated` | 多值拆分统计 | 多选、人员等多值字段,将每个选项/人员拆开独立统计 |
|
||||||
|
|
||||||
|
> 多选、人员等多值字段默认用 `enumerated`;其他字段默认用 `integrated`。
|
||||||
|
|
||||||
|
### sort 排序
|
||||||
|
|
||||||
|
| sort.type | 含义 | 典型场景 |
|
||||||
|
|-----------|------|----------|
|
||||||
|
| `group` | 按横轴值排序 | 按月份升序、按品类名字母序 |
|
||||||
|
| `value` | 按纵轴值排序 | 按销售额从大到小 |
|
||||||
|
| `view` | 按数据源记录顺序 | 保持原表行序(不常用) |
|
||||||
|
|
||||||
|
`sort.order`:`asc`(升序)/ `desc`(降序)
|
||||||
|
|
||||||
|
只要写 `sort` 对象,就需要明确排序方向。CLI 会把 `sort.type` 为 `group` 或 `view` 且缺少 `order` 的情况规范化为 `order:"asc"`;`sort.type:"value"` 必须显式写 `order:"asc"` 或 `order:"desc"`,因为指标值排序方向会改变业务含义。
|
||||||
|
|
||||||
|
如果表中行序就是业务顺序,首次创建 block 时就一次性设置 `sort:{"type":"view","order":"asc"}` 保留行序,避免创建后再二次更新排序条件。
|
||||||
|
|
||||||
|
示例 — 柱状图按销售额降序:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "订单表",
|
||||||
|
"series": [{ "field_name": "金额", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "类别", "mode": "integrated", "sort": {"type": "value", "order": "desc"} }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## filter 格式规则
|
||||||
|
|
||||||
|
**基本结构:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"filter": {
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{ "field_name": "字段名", "operator": "操作符", "value": "值" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**多条件示例(and/or):**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"filter": {
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{ "field_name": "状态", "operator": "is", "value": "已完成" },
|
||||||
|
{ "field_name": "金额", "operator": "isGreater", "value": 1000 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**操作符:**
|
||||||
|
|
||||||
|
| 操作符 | 含义 | 是否需要 value |
|
||||||
|
|--------|------|---------------|
|
||||||
|
| `is` | 等于 | 是 |
|
||||||
|
| `isNot` | 不等于 | 是 |
|
||||||
|
| `contains` | 包含 | 是 |
|
||||||
|
| `doesNotContain` | 不包含 | 是 |
|
||||||
|
| `isEmpty` | 为空 | 否 |
|
||||||
|
| `isNotEmpty` | 不为空 | 否 |
|
||||||
|
| `isGreater` | 大于 | 是 |
|
||||||
|
| `isGreaterEqual` | 大于等于 | 是 |
|
||||||
|
| `isLess` | 小于 | 是 |
|
||||||
|
| `isLessEqual` | 小于等于 | 是 |
|
||||||
|
|
||||||
|
**各字段类型的 value 格式:**
|
||||||
|
|
||||||
|
| 字段类型 | value 类型 | 适用操作符 | 示例 |
|
||||||
|
|----------|-----------|-----------|------|
|
||||||
|
| `text` | string | is, isNot, contains, doesNotContain, isEmpty, isNotEmpty | `{"field_name":"姓名","operator":"contains","value":"张"}` |
|
||||||
|
| `number` | number | is, isNot, isGreater, isGreaterEqual, isLess, isLessEqual, isEmpty, isNotEmpty | `{"field_name":"金额","operator":"isGreater","value":0}` |
|
||||||
|
| `select` (`multiple=false`) | string(选项名) | is, isNot, isEmpty, isNotEmpty | `{"field_name":"状态","operator":"is","value":"已完成"}` |
|
||||||
|
| `select` (`multiple=true`) | string[](选多个)/ string(选单个) | is, isNot, contains, doesNotContain, isEmpty, isNotEmpty | 多选传数组如 `["标签1","标签2"]`;单选传单个字符串 |
|
||||||
|
| `datetime` / `created_at` / `updated_at` | number(Unix 毫秒时间戳,13位) | is, isGreater, isGreaterEqual, isLess, isLessEqual, isEmpty, isNotEmpty | `{"field_name":"创建日期","operator":"isGreater","value":1704038400000}` |
|
||||||
|
| `checkbox` | boolean | is | `{"field_name":"已审核","operator":"is","value":true}` |
|
||||||
|
| `user` / `created_by` / `updated_by` | string 或 string[](用户 ID,格式 `ou_xxx`)。不知道 `open_id` 时先用 `lark-cli contact +search-user --query "<姓名/邮箱/手机号>" --as user` 查 id。 | is, isNot, isEmpty, isNotEmpty | `{"field_name":"负责人","operator":"is","value":"ou_xxxxxxxxxxxxxxxx"}` |
|
||||||
|
| 所有类型(为空/不为空) | 不需要 value | isEmpty, isNotEmpty | `{"field_name":"备注","operator":"isEmpty"}` |
|
||||||
|
|
||||||
|
> `value` 类型为 `string | number | boolean | string[]`,需根据字段类型匹配正确格式
|
||||||
|
|
||||||
|
## 约束与本地校验
|
||||||
|
|
||||||
|
- 必填与互斥
|
||||||
|
- 图表类型必填:`table_name`
|
||||||
|
- text 类型必填:`text`
|
||||||
|
- 互斥:`series` 与 `count_all` 二选一,且至少提供其一(仅图表类型)
|
||||||
|
- text 类型**不支持**:`series`、`count_all`、`group_by`、`filter`
|
||||||
|
- 长度/结构
|
||||||
|
- `group_by` 最多 2 个;每项 `field_name` 必填
|
||||||
|
- `group_by[].sort.type` 取值 `group|value|view`;`order` 取值 `asc|desc`
|
||||||
|
- 规范化(CLI 自动处理;`--no-validate` 时不生效,`data_config` 原样透传给后端)
|
||||||
|
- `series[].rollup` 自动转成大写(如 `sum` → `SUM`)
|
||||||
|
- `group_by[].sort.type/order` 自动转成小写
|
||||||
|
- `group_by[].sort.type` 为 `group` 或 `view` 且缺少 `order` 时,自动补 `order:"asc"`;`value` 排序不会自动补方向
|
||||||
|
- 本地校验(可通过 `--no-validate` 跳过)
|
||||||
|
- `+dashboard-block-create` 默认对 `data_config` 做轻量校验;失败会聚合错误并给出修复建议
|
||||||
|
- `+dashboard-block-update` 不做强类型校验,由后端验证具体字段
|
||||||
|
- 仅需传入合法 JSON;CLI 不会擅自改写你的业务含义
|
||||||
|
|
||||||
|
## 可复制模板
|
||||||
|
|
||||||
|
**按意图选择模板:**
|
||||||
|
- 比较不同类别数值 → 柱状图 / 条形图
|
||||||
|
- 看趋势变化 → 折线图 / 面积图
|
||||||
|
- 看占比分布 → 饼图 / 环形图 / 词云
|
||||||
|
- 多指标对比 → 组合图
|
||||||
|
- 看两变量关系 → 散点图
|
||||||
|
- 看流程转化 → 漏斗图
|
||||||
|
- 看多维度评分 → 雷达图
|
||||||
|
- 显示单个指标 → 指标卡(统计数字或记录数)
|
||||||
|
|
||||||
|
最小柱状图:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [{ "field_name": "数值字段", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "分组字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
最小饼图/环形图(按分类字段统计行数占比):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"count_all": true,
|
||||||
|
"group_by": [{ "field_name": "分类字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
折线图(按月趋势):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [{ "field_name": "金额", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "月份", "mode": "integrated", "sort": {"type":"group","order":"asc"} }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
条形图(横向柱状图):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [{ "field_name": "数值字段", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "分组字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
面积图(趋势填充):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [{ "field_name": "数值字段", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "时间字段", "mode": "integrated", "sort": {"type":"group","order":"asc"} }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
组合图(柱+线等多指标对比):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [
|
||||||
|
{ "field_name": "指标1", "rollup": "SUM" },
|
||||||
|
{ "field_name": "指标2", "rollup": "SUM" }
|
||||||
|
],
|
||||||
|
"group_by": [{ "field_name": "分类字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
散点图(两变量相关性):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [{ "field_name": "Y轴字段(数值/指标)", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "X轴字段(分类/维度)", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
漏斗图(流程转化):
|
||||||
|
|
||||||
|
先判断用户要看的数值语义:
|
||||||
|
|
||||||
|
- **当前数量**:统计每个当前状态/阶段下有多少记录,例如“各环节当前数量”“当前阶段分布”。源表有状态/阶段字段时,直接用 `count_all:true` + `group_by`。
|
||||||
|
- **累计数量**:统计到达该阶段及其后续阶段(后缀和)的累计数量,例如“流程转化”“从 A 到 B 各环节转化”。此口径假设流程单向、无跳阶/回退、记录不删除;不满足时须用状态变更历史,不能对当前快照累加。如果表中已有累计数量字段或阶段汇总表,直接用该字段画漏斗图;否则先计算累计数量,创建并写入 helper 汇总表后再画图。
|
||||||
|
|
||||||
|
当前数量:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"count_all": true,
|
||||||
|
"group_by": [{ "field_name": "状态字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
累计数量:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "流程汇总表名",
|
||||||
|
"series": [{ "field_name": "累计数量", "rollup": "SUM" }],
|
||||||
|
"group_by": [{ "field_name": "阶段字段", "mode": "integrated", "sort": {"type":"view","order":"asc"} }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
如果只有当前状态数据但用户要看流程转化,需要先按业务阶段顺序计算每个阶段的累计数量,再创建 helper 汇总表(如:阶段、累计数量),用 `+record-batch-create` 一次写入后,按“累计数量”模板创建漏斗图。helper 表行序就是业务顺序时,首次创建 block 时一次性设置好 `group_by.sort`。
|
||||||
|
|
||||||
|
> ⚠️ 注意:helper 汇总表仅用于源表无法直接聚合出目标形态的场景(如上面的累计数量漏斗图)。只要能在源表上直接用 `group_by` + `rollup`(含 `AVERAGE`)算出,就不需要新建 helper 表。
|
||||||
|
|
||||||
|
词云(文本频率):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"count_all": true,
|
||||||
|
"group_by": [{ "field_name": "文本字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
雷达图(多维度评分):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "表名",
|
||||||
|
"series": [
|
||||||
|
{ "field_name": "维度1", "rollup": "SUM" },
|
||||||
|
{ "field_name": "维度2", "rollup": "SUM" },
|
||||||
|
{ "field_name": "维度3", "rollup": "SUM" }
|
||||||
|
],
|
||||||
|
"group_by": [{ "field_name": "分类字段", "mode": "integrated" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
指标卡(统计数字):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "数据表",
|
||||||
|
"series": [{ "field_name": "数字", "rollup": "SUM" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
指标卡(统计记录数):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"table_name": "数据表",
|
||||||
|
"count_all": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
文本组件(Markdown 富文本):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"text": "# 🚀 一级标题\n这是一个 **加粗** *斜体* ~~删除线~~ 的示例。\n\n## 📌 二级标题\n1. 有序列表项 1\n2. 有序列表项 2\n\n### 📌 三级标题\n- 无序列表项 1\n- 无序列表项 2"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **注意**:text 类型组件不需要 `table_name`、`series`、`group_by`、`filter` 等数据源相关字段。
|
||||||
|
|
||||||
|
## 常见错误与修复
|
||||||
|
|
||||||
|
- 同时存在 `series` 与 `count_all`
|
||||||
|
- 现象:后端/本地校验报互斥错误
|
||||||
|
- 修复:见「关键约束」章节的二选一规则
|
||||||
|
- 缺少 `table_name`
|
||||||
|
- 现象:本地校验缺少必填字段
|
||||||
|
- 修复:指定数据源表名(使用表名,非表 ID)
|
||||||
|
- `series[].rollup` 大小写/取值不合法
|
||||||
|
- 现象:本地校验提示枚举不支持
|
||||||
|
- 修复:改为 `SUM|MAX|MIN|AVERAGE` 中之一(不区分大小写,CLI 会统一为大写;计数请使用 `count_all:true`)
|
||||||
|
- `group_by` 超出 2 个或字段名为空
|
||||||
|
- 修复:保留前 2 个,或补齐 `field_name`
|
||||||
|
- 排序枚举不合法
|
||||||
|
- 修复:`group_by.sort.type` 仅能为 `group|value|view`;`order` 为 `asc|desc`
|
||||||
|
- filter 写法不规范
|
||||||
|
- 修复:`conjunction` 取 `and|or`;`conditions[].operator` 必须在本页表格列举的范围内;除 `isEmpty/isNotEmpty` 外需提供 `value`
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- **`count_all` 与 `series` 二选一** — 两者不能同时使用
|
||||||
|
- **filter `value` 类型因字段而异** — 文本/单选为 string,数字为 number,日期为毫秒时间戳,多选/人员可为 string[],复选框为 boolean;`isEmpty`/`isNotEmpty` 不需要 value
|
||||||
|
- **`data_config` 结构随 `type` 变化** — 不同组件类型的字段不同,创建前务必确认类型对应的字段
|
||||||
|
- **表名用 name,不是 ID** — `table_name` 对应的是表名称(如「订单表」),不是 `table_id`
|
||||||
737
.agents/skills/lark-base/references/formula-field-guide.md
Normal file
737
.agents/skills/lark-base/references/formula-field-guide.md
Normal file
@ -0,0 +1,737 @@
|
|||||||
|
# Base Formula Writing Guide
|
||||||
|
|
||||||
|
## Mandatory Read Acknowledgement
|
||||||
|
|
||||||
|
When creating or updating a formula field with `lark-cli base +field-create/+field-update --json ...` and `type` is `formula`, you should read this guide first and only then add `--i-have-read-guide` to the command.
|
||||||
|
|
||||||
|
Do **not** proactively add `--i-have-read-guide` before reading this guide. Without it, the CLI will fail fast and direct you back to this guide.
|
||||||
|
|
||||||
|
When using `+field-update`, also pass `--yes`: field update is a high-risk `PUT` operation because changing a field definition can affect the whole column.
|
||||||
|
|
||||||
|
## Default strategy
|
||||||
|
|
||||||
|
**All cross-table references, aggregations, and computed fields should use Formula fields by default.** Do NOT use Lookup fields unless the user explicitly requests it. Formula is a strict superset of Lookup — anything Lookup can do, Formula can do with a single expression.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
When creating a formula field, the Agent should:
|
||||||
|
|
||||||
|
1. Get all table names: `lark-cli base +table-list --base-token <base>` — returns `items[].table_name`
|
||||||
|
2. Get table structure: `lark-cli base +table-get --base-token <base> --table-id <table>` — returns `fields[]`
|
||||||
|
3. If the formula references other tables, also get those tables' structures
|
||||||
|
4. Write the formula expression following this guide
|
||||||
|
5. Construct the Formula field JSON and submit it to create or update the field
|
||||||
|
|
||||||
|
**Key constraints**:
|
||||||
|
|
||||||
|
- The JSON must include `"type": "formula"` — this field is required
|
||||||
|
- Table names and field names in the formula must **exactly match** those returned by `+table-list` / `+table-get`
|
||||||
|
- The `expression` value is a string containing the formula expression; double quotes inside the expression must be properly escaped in JSON (e.g. `\"text\"`)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 1: Core Concepts — Scalar vs List
|
||||||
|
|
||||||
|
This is the foundation of formula logic. You must determine this before writing any formula.
|
||||||
|
|
||||||
|
| Syntax | Meaning | Return type | Example |
|
||||||
|
| --------------------- | -------------------------------------------- | ---------------------- | -------------------------------------------- |
|
||||||
|
| `[Field]` | Value of this field in the current row | Scalar (single value) | `[Name]` → `"Alice"` |
|
||||||
|
| `[TableName].[Field]` | All values of this field in the target table | List (multiple values) | `[Employees].[Name]` → `["Alice","Bob",...]` |
|
||||||
|
| `[TableName]` | The target table (entire table) | Table reference | Used as data range for FILTER/COUNTIF etc. |
|
||||||
|
|
||||||
|
**Rules**:
|
||||||
|
|
||||||
|
- Scalars can be used directly in operations: `[Price] * [Quantity]`
|
||||||
|
- Lists cannot be used as scalars — they must be processed first: use `SUM()` for sum, `ARRAYJOIN(",")` for joining, `FIRST()`/`LAST()`/`NTH()` for single value extraction
|
||||||
|
- Link field access `[LinkField].[TargetField]` returns a list (values of the target field for all linked records)
|
||||||
|
- **LISTCOMBINE flattening rule**: When a FILTER's result column is itself a multi-value field (`select` with `multiple=true`, `link`, etc.), it produces a 2D array and **must** be flattened with `.LISTCOMBINE()`; for single-value fields (`number`, `text`, etc.) it can be omitted, but adding it is never wrong:
|
||||||
|
|
||||||
|
```
|
||||||
|
[Table].FILTER(CurrentValue.[Field] = [Value]).[Tags].LISTCOMBINE() ← required for multi-value columns
|
||||||
|
[Table].FILTER(CurrentValue.[Field] = [Value]).[NumberCol].LISTCOMBINE() ← optional for single-value columns
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 2: Data Types and Type Conversion
|
||||||
|
|
||||||
|
### Field storage types
|
||||||
|
|
||||||
|
| Type | Description | Supported operations |
|
||||||
|
|------|-------------|----------------------|
|
||||||
|
| `number` | Stored as numeric value | Math operations, comparisons, auto-converts to string for concatenation |
|
||||||
|
| `text` | Stored as string | String operations; can participate in math if content is numeric, otherwise errors |
|
||||||
|
| `datetime` | Date object | Date functions, add/subtract with numbers; auto-converts to default format string when using `&` — use TEXT to format first for controlled output |
|
||||||
|
| `select` (`multiple=true`) | Data list | List functions, CONTAIN checks |
|
||||||
|
| `link` | Links to other table records | Chained access `[LinkField].[Field]`, result is a list |
|
||||||
|
| `checkbox` | TRUE/FALSE | Logical operations; auto-converts to number when compared with numbers |
|
||||||
|
|
||||||
|
### Implicit type conversion
|
||||||
|
|
||||||
|
| Scenario | Conversion rule |
|
||||||
|
| ---------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||||
|
| Number + Float | → Float |
|
||||||
|
| Date + Number | → Date (adds/subtracts days). Use `+`/`-` for whole days, use `DURATION()` for hour/minute/second precision |
|
||||||
|
| Date - Date | → Duration |
|
||||||
|
| Boolean compared with Number | Boolean auto-converts to number (TRUE=1, FALSE=0) |
|
||||||
|
| `&` concatenation | Both sides auto-convert to string |
|
||||||
|
|
||||||
|
### Type consistency in comparisons
|
||||||
|
|
||||||
|
When using comparison operators (`>`, `>=`, `<`, `<=`, `=`, `!=`), **both sides should be the same type** to avoid semantic errors or unexpected results.
|
||||||
|
|
||||||
|
**Principle**: When types differ, explicitly convert one side rather than relying on implicit conversion:
|
||||||
|
|
||||||
|
- `number` vs `text` → use `VALUE()` to convert text to number
|
||||||
|
- `datetime` vs `text` → use `TEXT()` to convert date to text
|
||||||
|
- `datetime` vs `datetime` equality → dates include time components, so direct `=` comparison may fail due to different hours/minutes/seconds. For day-level equality, convert to text first: `TEXT([DateA], "YYYY/MM/DD") = TEXT([DateB], "YYYY/MM/DD")`
|
||||||
|
- `select` and `user` fields can be compared with both same-type values and text
|
||||||
|
- `text` fields in numeric aggregation (SUM/AVERAGE/MIN/MAX etc.) → convert to number with `VALUE()` first. For FILTER results, use `.MAP(VALUE(CurrentValue)).SUM()`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 3: CurrentValue
|
||||||
|
|
||||||
|
**CurrentValue is the iteration variable in FILTER/MAP/COUNTIF/SUMIF functions, representing the "current item" being processed in the data range.**
|
||||||
|
|
||||||
|
### CurrentValue meaning in different contexts
|
||||||
|
|
||||||
|
| Data range type | CurrentValue represents | Access pattern | Example |
|
||||||
|
| ---------------------------- | ----------------------- | --------------------------- | --------------------------------------------------------- |
|
||||||
|
| Entire table `[TableName]` | A row in the table | `CurrentValue.[FieldName]` | `[Orders].FILTER(CurrentValue.[Amount] > 100).[Customer]` |
|
||||||
|
| Column `[TableName].[Field]` | A single field value | Use `CurrentValue` directly | `[Orders].[Amount].FILTER(CurrentValue > 100)` |
|
||||||
|
| `select` (`multiple=true`) field `[Tags]` | One option | Use `CurrentValue` directly | `[Tags].FILTER(CurrentValue = "Important")` |
|
||||||
|
| LIST-generated list | One element | Use `CurrentValue` directly | `LIST(1,2,3).MAP(CurrentValue * 2)` |
|
||||||
|
|
||||||
|
### Key rules
|
||||||
|
|
||||||
|
1. **When data range is a table**, use `CurrentValue.[FieldName]` to access row fields
|
||||||
|
2. **When data range is a column/list**, use `CurrentValue` directly for the element value — **cannot** use `CurrentValue.[FieldName]`
|
||||||
|
3. CurrentValue can **only** appear inside the condition/mapping parameters of FILTER/MAP/COUNTIF/SUMIF functions
|
||||||
|
4. To reference the current table's field value in a condition, write `[FieldName]` directly — it refers to the formula row's value, not a property of CurrentValue
|
||||||
|
|
||||||
|
### Anti-patterns
|
||||||
|
|
||||||
|
| Wrong | Reason | Correct |
|
||||||
|
| ---------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------ |
|
||||||
|
| `[Table].[Col].FILTER(CurrentValue.[Col] > 0)` | Data range is a column; CurrentValue is a scalar, cannot use `.` to access fields | `[Table].[Col].FILTER(CurrentValue > 0)` |
|
||||||
|
| `[Table].FILTER(CurrentValue > 100)` | Data range is a table; CurrentValue is a row, cannot compare directly | `[Table].FILTER(CurrentValue.[Amount] > 100).[Amount]` |
|
||||||
|
| `CurrentValue + 1` (at top level) | CurrentValue can only be used inside iteration functions | Use inside MAP/FILTER etc. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 4: Operators
|
||||||
|
|
||||||
|
Base formulas **only allow** the following operators. `like`, `in`, `<>`, `**`, `^` etc. are prohibited.
|
||||||
|
|
||||||
|
| Category | Operators | Description |
|
||||||
|
| ------------- | -------------------------- | -------------------------------------------------------------------------- |
|
||||||
|
| Arithmetic | `+` `-` `*` `/` `%` | Add, subtract, multiply, divide, modulo (`%` is equivalent to `MOD()`) |
|
||||||
|
| Comparison | `>` `>=` `<` `<=` `=` `!=` | Greater than, greater or equal, less than, less or equal, equal, not equal |
|
||||||
|
| Logical | `&&` `\|\|` | AND, OR |
|
||||||
|
| Concatenation | `&` | Text concatenation; non-text values auto-convert to string |
|
||||||
|
|
||||||
|
**Important**:
|
||||||
|
|
||||||
|
- Equality uses `=` (single equals), not `==`
|
||||||
|
- Not-equal uses `!=`, not `<>`
|
||||||
|
- String concatenation uses `&`, not `+`
|
||||||
|
- Both `&&`/`||` and AND()/OR() functions are supported
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 5: Link Fields and Cross-Table References
|
||||||
|
|
||||||
|
### Link field description
|
||||||
|
|
||||||
|
When a field type is described as `FieldName: Link [target table: X, foreign key: Y]`, it links to target table X using field Y as the join key.
|
||||||
|
|
||||||
|
### Chained cross-table access
|
||||||
|
|
||||||
|
```
|
||||||
|
[LinkField].[TargetField]
|
||||||
|
```
|
||||||
|
|
||||||
|
Retrieves the target field values for all linked records as a list. Supports continued chaining: `[LinkA].[LinkB].[Field]`.
|
||||||
|
|
||||||
|
### Equivalent expanded form
|
||||||
|
|
||||||
|
- Multi-value link: `[TargetTableX].FILTER([LinkField].CONTAIN(CurrentValue.[Y])).[TargetField].LISTCOMBINE()`
|
||||||
|
- Single-value link: `[TargetTableX].FILTER(CurrentValue.[Y] = [LinkField]).[TargetField].LISTCOMBINE()`
|
||||||
|
|
||||||
|
(`.LISTCOMBINE()` is required when `[TargetField]` is a multi-value field; optional for single-value fields)
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
|
||||||
|
- Link fields typically return **lists** (possibly empty)
|
||||||
|
- To output a single value, use aggregation (SUM/MAX), joining (ARRAYJOIN), or extraction (FIRST/LAST/NTH)
|
||||||
|
- Do not nest FILTER inside FILTER for cross-table queries — prefer link field chained access
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 6: Function Call Conventions
|
||||||
|
|
||||||
|
### Two calling styles
|
||||||
|
|
||||||
|
| Style | Format | Description |
|
||||||
|
| ---------- | ------------------ | ----------------------------------- |
|
||||||
|
| Functional | `FUNC(arg1, arg2)` | Works for all functions |
|
||||||
|
| Chained | `arg1.FUNC(arg2)` | Moves the first argument before `.` |
|
||||||
|
|
||||||
|
**Rules**:
|
||||||
|
|
||||||
|
- Zero-argument functions cannot be chained: `NOW()`, `TODAY()`, `PI()`, `TRUE()`, `FALSE()`
|
||||||
|
- SORTBY can **only** be chained: `[Table].SORTBY([Table].[SortCol]).[OutputCol]`. The sort column always uses the original table's column name (`[TableName].[Field]` format); the engine aligns rows internally, even when the data range is a FILTER result
|
||||||
|
- FILTER is recommended to be chained: `[Table].FILTER(condition).[OutputCol]`
|
||||||
|
|
||||||
|
### FILTER / SORTBY result column rules
|
||||||
|
|
||||||
|
- **When data range is a table** `[TableName]`, FILTER / SORTBY returns a table reference. The chain **must** end with `.[Field]` to specify the result column, otherwise the formula fails:
|
||||||
|
|
||||||
|
```
|
||||||
|
Correct: [Sales].FILTER(CurrentValue.[Amount] > 100).[Customer]
|
||||||
|
Correct: [Sales].FILTER(condition).SORTBY([Sales].[SortCol]).[Customer] ← result column at end of chain
|
||||||
|
Wrong: [Sales].FILTER(CurrentValue.[Amount] > 100) ← missing result column
|
||||||
|
```
|
||||||
|
|
||||||
|
- **When data range is a column** `[TableName].[Field]` or a list, FILTER returns the filtered list directly — **no** result column needed:
|
||||||
|
|
||||||
|
```
|
||||||
|
Correct: [Sales].[Amount].FILTER(CurrentValue > 100)
|
||||||
|
```
|
||||||
|
|
||||||
|
After the result column, it's recommended to flatten with `.LISTCOMBINE()` first (especially when the result column is a multi-value field), then chain aggregation functions:
|
||||||
|
|
||||||
|
```
|
||||||
|
[Sales].FILTER(CurrentValue.[Amount] > 100).[Amount].LISTCOMBINE().SUM()
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 7: Hard Constraints
|
||||||
|
|
||||||
|
1. **Nesting prohibition**: FILTER / SUMIF / COUNTIF / MAP **must not be nested** inside each other's condition/mapping expressions. None of these functions can appear inside the condition or mapping parameter of another.
|
||||||
|
- Prohibited: `[Table1].FILTER(CurrentValue.[Col] = [Table2].FILTER(...).[Col])` ← FILTER inside FILTER condition
|
||||||
|
- Prohibited: `[Table].MAP([Table2].MAP(...))` ← MAP inside MAP mapping
|
||||||
|
- **Allowed**: `[Table].FILTER(cond1).[Col].FILTER(cond2)` ← chained call; the first FILTER's output is the second's data range, not nesting
|
||||||
|
|
||||||
|
2. **Function whitelist**: Only use functions listed in Section 8. No unlisted functions.
|
||||||
|
|
||||||
|
3. **Exact name matching**: Table names and field names in formulas must **exactly match** those returned by `+table-get` — no renaming or adding spaces.
|
||||||
|
|
||||||
|
4. **Operator whitelist**: Only use operators listed in Section 4.
|
||||||
|
|
||||||
|
5. **Strings use double quotes**: Strings must be wrapped in double quotes `"`, single quotes are not supported.
|
||||||
|
|
||||||
|
6. **Do not use LOOKUP**: FILTER is a superset of LOOKUP. All LOOKUP formulas can be rewritten with FILTER. Use FILTER exclusively to reduce complexity.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 8: Complete Function Reference
|
||||||
|
|
||||||
|
### 8.1 Logic functions
|
||||||
|
|
||||||
|
| Function | Signature | Return type | Description |
|
||||||
|
| ------------- | ------------------------------------------------------------------ | -------------------- | -------------------------------------------------------------------------------------------- |
|
||||||
|
| IF | `IF(condition, true_val, [false_val])` | Matches branch type | Returns true_val when TRUE, false_val otherwise; omitting false_val returns false (not null) |
|
||||||
|
| IFS | `IFS(cond1, val1, cond2, val2, ...)` | Matches branch type | Multi-condition branching; returns value for the first TRUE condition |
|
||||||
|
| SWITCH | `SWITCH(expr, match1, result1, [match2, result2, ...], [default])` | Matches branch type | Matches expression value and returns corresponding result |
|
||||||
|
| IFERROR | `IFERROR(expr, fallback)` | Matches branch type | Returns fallback when expression errors |
|
||||||
|
| IFBLANK | `IFBLANK(expr, fallback)` | Matches branch type | Returns fallback when expression is blank (blank = NULL/empty string/empty list) |
|
||||||
|
| AND | `AND(cond1, cond2, ...)` | Boolean | TRUE when all conditions are TRUE |
|
||||||
|
| OR | `OR(cond1, cond2, ...)` | Boolean | TRUE when any condition is TRUE |
|
||||||
|
| NOT | `NOT(condition)` | Boolean | Logical negation |
|
||||||
|
| ISBLANK | `ISBLANK(value)` | Boolean | Tests if blank (NULL/empty string/empty list are blank; 0 and FALSE are not) |
|
||||||
|
| ISNULL | `ISNULL(value)` | Boolean | Tests if NULL (only NULL is true; empty string is not) |
|
||||||
|
| ISERROR | `ISERROR(expr)` | Boolean | Tests if expression errors |
|
||||||
|
| ISNUMBER | `ISNUMBER(value)` | Boolean | Tests if value is a number |
|
||||||
|
| CONTAIN | `CONTAIN(search_range, value, ...)` | Boolean | Tests if a list or `select` (`multiple=true`) contains the value; **does NOT do text substring matching** |
|
||||||
|
| CONTAINSALL | `CONTAINSALL(search_range, value, ...)` | Boolean | Tests if a list or `select` (`multiple=true`) contains all specified values |
|
||||||
|
| CONTAINSONLY | `CONTAINSONLY(search_range, value, ...)` | Boolean | Tests if a list or `select` (`multiple=true`) contains only the specified values |
|
||||||
|
| TRUE | `TRUE()` | Boolean | Returns TRUE |
|
||||||
|
| FALSE | `FALSE()` | Boolean | Returns FALSE |
|
||||||
|
| RECORD_ID | `RECORD_ID()` | Text | Returns the current row's record ID |
|
||||||
|
| RANDOMBETWEEN | `RANDOMBETWEEN(min_int, max_int, [keep_updating])` | Number | Random integer in the specified range |
|
||||||
|
| RANDOMITEM | `RANDOMITEM(list, [keep_updating])` | Matches element type | Randomly picks one element from a list |
|
||||||
|
|
||||||
|
### 8.2 Numeric functions
|
||||||
|
|
||||||
|
| Function | Signature | Return type | Description |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| SUM | `SUM(val1, val2, ...)` | Number | Sum; accepts multiple values or a list |
|
||||||
|
| AVERAGE | `AVERAGE(val1, val2, ...)` | Number | Average |
|
||||||
|
| MAX | `MAX(val1, val2, ...)` | Number | Maximum |
|
||||||
|
| MIN | `MIN(val1, val2, ...)` | Number | Minimum |
|
||||||
|
| MEDIAN | `MEDIAN(val1, val2, ...)` | Number | Median |
|
||||||
|
| COUNTA | `COUNTA(val1, val2, ...)` | Number | Count of non-blank values |
|
||||||
|
| COUNTIF | `COUNTIF(data_range, condition)` | Number | Count matching items. Data range can be a **table** (CurrentValue is a row, use `CurrentValue.[Field]`) or a **column** (CurrentValue is a scalar value) |
|
||||||
|
| SUMIF | `SUMIF(data_range, condition)` | Number | Sum matching values. Data range **must be a numeric column** (e.g. `[Table].[NumField]`); CurrentValue is each value in that column (scalar), cannot use `CurrentValue.[Field]` to access other fields. For cross-field conditions, use FILTER+SUM instead |
|
||||||
|
| ROUND | `ROUND(number, digits)` | Number | Round. digits: 1=one decimal, 0=integer, -1=tens place |
|
||||||
|
| ROUNDUP | `ROUNDUP(number, digits)` | Number | Round away from zero. Same digits semantics as ROUND |
|
||||||
|
| ROUNDDOWN | `ROUNDDOWN(number, digits)` | Number | Round toward zero. Same digits semantics as ROUND |
|
||||||
|
| FLOOR | `FLOOR(number, [base])` | Number | Round down to nearest multiple of base (default 1) |
|
||||||
|
| CEILING | `CEILING(number, [base])` | Number | Round up to nearest multiple of base (default 1) |
|
||||||
|
| ABS | `ABS(number)` | Number | Absolute value |
|
||||||
|
| INT | `INT(number)` | Integer | Truncate to integer |
|
||||||
|
| MOD | `MOD(dividend, divisor)` | Number | Modulo |
|
||||||
|
| POWER | `POWER(base, exponent)` | Number | Exponentiation |
|
||||||
|
| QUOTIENT | `QUOTIENT(dividend, divisor)` | Number | Integer division |
|
||||||
|
| VALUE | `VALUE(text)` | Number | Convert text to number |
|
||||||
|
| ISODD | `ISODD(number)` | Boolean | Tests if number is odd |
|
||||||
|
| RANK | `RANK(value, search_range, [ascending])` | Number | Rank of value in range; default descending |
|
||||||
|
| SEQUENCE | `SEQUENCE(start, end, [step])` | List | Generate number sequence |
|
||||||
|
| PI | `PI()` | Number | Pi constant |
|
||||||
|
| SIN/COS/TAN/ASIN/ACOS/ATAN/ATAN2/SINH/COSH/TANH/ASINH/ACOSH/ATANH | `func(radians_or_value)` | Number | Trigonometric and hyperbolic functions; arguments in radians |
|
||||||
|
|
||||||
|
### 8.3 Text functions
|
||||||
|
|
||||||
|
| Function | Signature | Return type | Description |
|
||||||
|
| --------------- | ---------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------- |
|
||||||
|
| CONCATENATE | `CONCATENATE(text1, text2, ...)` | Text | Concatenate multiple texts; supports lists as input |
|
||||||
|
| LEN | `LEN(text)` | Number | Character count |
|
||||||
|
| LEFT | `LEFT(text, [count])` | Text | Extract from left; default 1 |
|
||||||
|
| RIGHT | `RIGHT(text, [count])` | Text | Extract from right; default 1 |
|
||||||
|
| MID | `MID(text, start, count)` | Text | Extract from middle |
|
||||||
|
| FIND | `FIND(search_val, search_range, [start])` | Number | Find substring position (case-sensitive); returns -1 if not found |
|
||||||
|
| REPLACE | `REPLACE(text, start, count, new_text)` | Text | Replace by position |
|
||||||
|
| SUBSTITUTE | `SUBSTITUTE(text, old_text, new_text, [occurrence])` | Text | Replace by content; can specify which occurrence |
|
||||||
|
| UPPER | `UPPER(text)` | Text | Convert to uppercase |
|
||||||
|
| LOWER | `LOWER(text)` | Text | Convert to lowercase |
|
||||||
|
| TRIM | `TRIM(text)` | Text | Remove leading/trailing spaces |
|
||||||
|
| TEXT | `TEXT(value, format)` | Text | Format output. Date formats: `"YYYY-MM-DD"`, `"YYYY/MM/DD hh:mm:ss"`; number formats: `"00"`, `"000.00"` |
|
||||||
|
| CONTAINTEXT | `CONTAINTEXT(text, search_text)` | Boolean | Tests if text contains substring (text substring matching) |
|
||||||
|
| SPLIT | `SPLIT(text, delimiter)` | List | Split text by delimiter |
|
||||||
|
| TODATE | `TODATE(value)` | Date | Convert date string to date type |
|
||||||
|
| CHAR | `CHAR(number)` | Text | ASCII code to character |
|
||||||
|
| FORMAT | `FORMAT(template, [val1, val2, ...])` | Text | Template string formatting; use `{1}`, `{2}` as placeholders |
|
||||||
|
| HYPERLINK | `HYPERLINK(url, [display_text])` | Hyperlink | Create a hyperlink |
|
||||||
|
| ENCODEURL | `ENCODEURL(text)` | Text | URL encode |
|
||||||
|
| REGEXMATCH | `REGEXMATCH(text, regex)` | Boolean | Regex match test |
|
||||||
|
| REGEXEXTRACT | `REGEXEXTRACT(text, regex)` | List | Extract first match's capture groups |
|
||||||
|
| REGEXEXTRACTALL | `REGEXEXTRACTALL(text, regex)` | 2D List | Extract all matches |
|
||||||
|
| REGEXREPLACE | `REGEXREPLACE(text, regex, replacement)` | Text | Regex replace |
|
||||||
|
|
||||||
|
### 8.4 Date functions
|
||||||
|
|
||||||
|
| Function | Signature | Return type | Description |
|
||||||
|
| ----------- | ----------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------- |
|
||||||
|
| NOW | `NOW()` | Date | Current date and time |
|
||||||
|
| TODAY | `TODAY()` | Date | Current date (midnight) |
|
||||||
|
| DATE | `DATE(year, month, day)` | Date | Construct a date |
|
||||||
|
| YEAR | `YEAR(date)` | Number | Extract year |
|
||||||
|
| MONTH | `MONTH(date)` | Number | Extract month |
|
||||||
|
| DAY | `DAY(date)` | Number | Extract day |
|
||||||
|
| HOUR | `HOUR(date)` | Number | Extract hour |
|
||||||
|
| MINUTE | `MINUTE(date)` | Number | Extract minute |
|
||||||
|
| SECOND | `SECOND(date)` | Number | Extract second |
|
||||||
|
| WEEKDAY | `WEEKDAY(date, [type])` | Number | Day of week |
|
||||||
|
| WEEKNUM | `WEEKNUM(date, [type])` | Number | Week number |
|
||||||
|
| DAYS | `DAYS(end_date, start_date)` | Number | Days between two dates (end - start), includes decimals. **Note parameter order: end date comes first** |
|
||||||
|
| DATEDIF | `DATEDIF(start_date, end_date, [unit])` | Number | Whole days/months/years between dates. Unit: `"D"`(default)/`"M"`/`"Y"`. **Start must be before end** |
|
||||||
|
| DURATION | `DURATION(days, [hours], [minutes], [seconds])` | Duration | Create a duration for date arithmetic |
|
||||||
|
| EDATE | `EDATE(date, months)` | Date | Date N months later |
|
||||||
|
| EOMONTH | `EOMONTH(date, [months])` | Date | End of month N months later; months default 0 |
|
||||||
|
| WORKDAY | `WORKDAY(start_date, days, [holidays])` | Date | Date N workdays later (skips weekends and holidays) |
|
||||||
|
| NETWORKDAYS | `NETWORKDAYS(start_date, end_date, [holidays])` | Number | Workdays between dates (inclusive) |
|
||||||
|
|
||||||
|
### 8.5 List functions
|
||||||
|
|
||||||
|
| Function | Signature | Return type | Description |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| LIST | `LIST(val1, val2, ...)` | List | Create a list |
|
||||||
|
| FIRST | `FIRST(list)` | Scalar | First element |
|
||||||
|
| LAST | `LAST(list)` | Scalar | Last element |
|
||||||
|
| NTH | `NTH(list, index)` | Scalar | Nth element (1-based) |
|
||||||
|
| FILTER | `[Table].FILTER(condition).[ResultCol]` or `[Table].[Col].FILTER(condition)` | List | Filter by condition. When data range is a table, result column is **required**; when it's a column/list, it's not needed. Use CurrentValue in conditions. Add `.LISTCOMBINE()` when result column is multi-value |
|
||||||
|
| MAP | `data_range.MAP(mapping_expr)` | List | Apply mapping to each element. Use CurrentValue in mapping |
|
||||||
|
| SORT | `SORT(list, [ascending])` | List | Sort; default ascending (TRUE) |
|
||||||
|
| SORTBY | `[Table].SORTBY([Table].[SortCol], [ascending]).[OutputCol]` | List | Sort by column then extract output column. **Chain-only, must include output column** |
|
||||||
|
| UNIQUE | `UNIQUE(list)` | List | Deduplicate |
|
||||||
|
| ARRAYJOIN | `ARRAYJOIN(list, [delimiter])` | Text | Join list elements as text; default comma-separated |
|
||||||
|
| LISTCOMBINE | `LISTCOMBINE(val1, [val2, ...])` or `list.LISTCOMBINE()` | List | Two uses: (1) merge values/lists into one list; (2) chained call to flatten 2D array (commonly used when FILTER result column is a multi-value field) |
|
||||||
|
| DISTANCE | `DISTANCE(location1, location2)` | Number | Distance between two geographic locations (km) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 9: Commonly Confused Functions
|
||||||
|
|
||||||
|
### CONTAIN vs CONTAINTEXT
|
||||||
|
|
||||||
|
| | CONTAIN | CONTAINTEXT |
|
||||||
|
| ----------- | -------------------------------------------------------------- | ---------------------------------------------------------- |
|
||||||
|
| Purpose | Tests if a **list / `select` (`multiple=true`)** contains a value | Tests if **text** contains a substring |
|
||||||
|
| Example | `[Tags].CONTAIN("Urgent")` | `[Notes].CONTAINTEXT("completed")` |
|
||||||
|
| Wrong usage | `CONTAIN([Notes], "completed")` — cannot do substring matching | `CONTAINTEXT([Tags], "Urgent")` — Tags is a list, not text |
|
||||||
|
|
||||||
|
### ISBLANK vs ISNULL
|
||||||
|
|
||||||
|
| | ISBLANK | ISNULL |
|
||||||
|
| ----------------- | ------- | ------ |
|
||||||
|
| NULL | TRUE | TRUE |
|
||||||
|
| `""` empty string | TRUE | FALSE |
|
||||||
|
| Empty list `[]` | TRUE | FALSE |
|
||||||
|
| `0` | FALSE | FALSE |
|
||||||
|
| `FALSE` | FALSE | FALSE |
|
||||||
|
|
||||||
|
### DAYS vs DATEDIF
|
||||||
|
|
||||||
|
| | DAYS | DATEDIF |
|
||||||
|
| --------------- | ------------------------------------------------------------ | ----------------------------------------- |
|
||||||
|
| Parameter order | `DAYS(end, start)` — end first | `DATEDIF(start, end, unit)` — start first |
|
||||||
|
| Precision | Includes decimals (hours/minutes/seconds as fractional days) | Integer only (whole days/months/years) |
|
||||||
|
| Negative values | Returns negative when start is after end | **Errors** when start is after end |
|
||||||
|
|
||||||
|
### SUM vs SUMIF
|
||||||
|
|
||||||
|
| | SUM | SUMIF |
|
||||||
|
| --------- | ---------------------------------------------- | -------------------------------------------------------------- |
|
||||||
|
| Purpose | Sum all values | Sum values **matching a condition** |
|
||||||
|
| Arguments | `SUM(val1, val2, ...)` or `SUM([Table].[Col])` | `SUMIF(data_range, condition)` with CurrentValue in condition |
|
||||||
|
| Example | `SUM([Orders].[Amount])` — sum all | `SUMIF([Orders].[Amount], CurrentValue > 100)` — sum only >100 |
|
||||||
|
|
||||||
|
### FILTER+aggregation vs COUNTIF/SUMIF
|
||||||
|
|
||||||
|
| | FILTER+aggregation | COUNTIF/SUMIF |
|
||||||
|
| ----------- | ----------------------------------------------------- | ------------------------------------------------------------------------------ |
|
||||||
|
| Nature | Filter then aggregate (two steps) | One-step (syntactic sugar) |
|
||||||
|
| Equivalence | `[Table].FILTER(cond).[Col].LISTCOMBINE().SUM()` | `SUMIF([Table].[Col], cond)` (only when condition involves only column values) |
|
||||||
|
| When to use | Conditions span multiple fields, or multi-step needed | Conditions only involve column values (e.g. `CurrentValue > 100`) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 10: Decision Trees
|
||||||
|
|
||||||
|
### Cross-table queries: which approach?
|
||||||
|
|
||||||
|
```
|
||||||
|
Need data from another table?
|
||||||
|
├─ Current table has a link field to the target table?
|
||||||
|
│ ├─ Yes → Use chained access: [LinkField].[TargetField]
|
||||||
|
│ │ Need aggregation? → .SUM() / .ARRAYJOIN(",") / .FIRST()
|
||||||
|
│ └─ No → Need to match by field value?
|
||||||
|
│ ├─ Field matching or complex filtering → [TargetTable].FILTER(CurrentValue.[MatchField] = [Value]).[OutputCol]
|
||||||
|
│ └─ Only counting or summing → COUNTIF([TargetTable], condition) / FILTER+SUM
|
||||||
|
```
|
||||||
|
|
||||||
|
### Conditional logic: IF vs IFS vs SWITCH?
|
||||||
|
|
||||||
|
```
|
||||||
|
Need conditional logic?
|
||||||
|
├─ Single condition → IF(condition, true_val, false_val)
|
||||||
|
├─ Multiple mutually exclusive conditions (if-elseif-else) → IFS(cond1, val1, cond2, val2, ...)
|
||||||
|
├─ Matching a value against fixed options → SWITCH(expr, option1, result1, option2, result2, ..., default)
|
||||||
|
└─ Need error handling?
|
||||||
|
├─ Catch errors → IFERROR(expr, fallback)
|
||||||
|
└─ Catch blanks → IFBLANK(expr, fallback)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Aggregation: which function?
|
||||||
|
|
||||||
|
```
|
||||||
|
Need to aggregate data?
|
||||||
|
├─ Sum/average/max/min for entire column → SUM/AVERAGE/MAX/MIN([Table].[Col])
|
||||||
|
├─ Count non-blank → COUNTA([Table].[Col])
|
||||||
|
├─ Conditional count → COUNTIF([Table], CurrentValue.[Field] = [Value])
|
||||||
|
├─ Conditional sum (column-only condition) → SUMIF([Table].[Col], CurrentValue > threshold)
|
||||||
|
├─ Conditional sum (cross-field condition) → [Table].FILTER(CurrentValue.[Field]=value).[NumCol].LISTCOMBINE().SUM()
|
||||||
|
├─ Count unique → [Table].[Col].UNIQUE().COUNTA()
|
||||||
|
└─ Ranking → RANK([Value], [Table].[Col])
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 11: Common Formula Patterns
|
||||||
|
|
||||||
|
### Pattern 1: Cross-table conditional count
|
||||||
|
|
||||||
|
Count rows in target table matching a condition:
|
||||||
|
|
||||||
|
```
|
||||||
|
[TargetTable].COUNTIF(CurrentValue.[MatchField] = [CurrentTableField])
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 2: Cross-table conditional sum
|
||||||
|
|
||||||
|
Filter target table by current row's value, then sum:
|
||||||
|
|
||||||
|
```
|
||||||
|
[TargetTable].FILTER(CurrentValue.[MatchField] = [CurrentTableField]).[NumCol].LISTCOMBINE().SUM()
|
||||||
|
```
|
||||||
|
|
||||||
|
SUMIF works when data range is a column and conditions only involve column values:
|
||||||
|
|
||||||
|
```
|
||||||
|
SUMIF([TargetTable].[NumCol], CurrentValue > 100)
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: COUNTIF can use a table as data range (only counting, no specific column needed), but SUMIF's data range **must be a numeric column** (needs values to sum), so `CurrentValue` is each value in that column (scalar) — cannot use `CurrentValue.[OtherField]` to access other fields. For cross-field conditions, use FILTER with a table as data range.
|
||||||
|
|
||||||
|
### Pattern 3: Cross-table lookup
|
||||||
|
|
||||||
|
```
|
||||||
|
[TargetTable].FILTER(CurrentValue.[MatchCol] = [CurrentTableField]).[ReturnCol]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 4: Link field values + aggregation
|
||||||
|
|
||||||
|
```
|
||||||
|
SUM([LinkField].[NumField])
|
||||||
|
[LinkField].[TextField].UNIQUE().ARRAYJOIN(",")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 5: Conditional text concatenation
|
||||||
|
|
||||||
|
```
|
||||||
|
IF([Condition], "prefix" & [Field] & "suffix", "default text")
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 6: Date difference
|
||||||
|
|
||||||
|
```
|
||||||
|
DATEDIF([StartDate], [EndDate], "D") & " days"
|
||||||
|
DAYS([EndDate], [StartDate])
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 7: List element mapping
|
||||||
|
|
||||||
|
```
|
||||||
|
[SelectField(which multiple=true)].MAP(CurrentValue & " tag")
|
||||||
|
SPLIT([TextField], ",").MAP(TRIM(CurrentValue))
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 8: Cross-table with sorting
|
||||||
|
|
||||||
|
```
|
||||||
|
[TargetTable].SORTBY([TargetTable].[SortCol], FALSE).[OutputCol]
|
||||||
|
[TargetTable].FILTER(CurrentValue.[Field] = [Value]).SORTBY([TargetTable].[SortCol]).[OutputCol]
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 12: Anti-Pattern Collection
|
||||||
|
|
||||||
|
### Mistake 1: Extra argument in MAP
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: [Table].[Col].MAP([Table2].[Col], CurrentValue + 1)
|
||||||
|
Correct: [Table].[Col].MAP(CurrentValue + 1)
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: MAP takes only two arguments (data range + mapping expression), no "lookup range".
|
||||||
|
|
||||||
|
### Mistake 2: Inverted FILTER syntax
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: condition.[Table].FILTER()
|
||||||
|
Correct: [Table].FILTER(condition).[ResultCol] (result column required when data range is a table)
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: FILTER's data range comes first, condition is passed as the argument.
|
||||||
|
|
||||||
|
### Mistake 3: Using CurrentValue.[Field] on a column range
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: SUMIF([Sales].[Revenue], CurrentValue.[Salesperson] = [Name])
|
||||||
|
Correct: [Sales].FILTER(CurrentValue.[Salesperson] = [Name]).[Revenue].LISTCOMBINE().SUM()
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: `SUMIF([Sales].[Revenue], ...)` uses "Revenue" column as data range. CurrentValue is each revenue value (scalar), not a row — cannot use `.` to access other fields. Use FILTER with the table as data range for cross-field conditions.
|
||||||
|
|
||||||
|
### Mistake 4: Missing result column after FILTER
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: [Sales].FILTER(CurrentValue.[Amount] > 100)
|
||||||
|
Correct: [Sales].FILTER(CurrentValue.[Amount] > 100).[Customer]
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: FILTER on a table returns a table reference; must specify result column with `.[Field]` at the end.
|
||||||
|
|
||||||
|
### Mistake 5: Nested FILTER
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: [Table1].FILTER(CurrentValue.[ID] = [Table2].FILTER(CurrentValue.[Status]="Done").[ID])
|
||||||
|
Correct: [Table1].FILTER(CurrentValue.[ID] = [CurrentRowField]).[OutputCol]
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: FILTER/MAP/SUMIF/COUNTIF cannot be nested inside each other's conditions. Split into multiple steps or use link fields.
|
||||||
|
|
||||||
|
### Mistake 6: SORTBY without output column
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: [Table].SORTBY([Table].[Col])
|
||||||
|
Correct: [Table].SORTBY([Table].[Col]).[OutputCol]
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: SORTBY must have an output column at the end; otherwise the result cannot be represented as an array.
|
||||||
|
|
||||||
|
### Mistake 7: SORTBY sort column without table name
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: [Table].SORTBY([Col]).[OutputCol]
|
||||||
|
Correct: [Table].SORTBY([Table].[Col]).[OutputCol]
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: SORTBY's sort column must use `[TableName].[FieldName]` format.
|
||||||
|
|
||||||
|
### Mistake 8: Using CONTAIN for text substring matching
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: CONTAIN([Notes], "urgent")
|
||||||
|
Correct: CONTAINTEXT([Notes], "urgent")
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: CONTAIN checks if a list or `select` (`multiple=true`) contains a whole value, not substring matching. Use CONTAINTEXT for text substrings.
|
||||||
|
|
||||||
|
### Mistake 9: Date concatenation without formatting
|
||||||
|
|
||||||
|
```
|
||||||
|
Not recommended: "Deadline: " & [DateField] ← output format is uncontrolled
|
||||||
|
Recommended: "Deadline: " & TEXT([DateField], "YYYY-MM-DD")
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: Concatenating a date with `&` won't error, but uses the default format. Use TEXT to specify the format explicitly.
|
||||||
|
|
||||||
|
### Mistake 10: Reversed DAYS parameter order
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: DAYS([StartDate], [EndDate]) → returns negative
|
||||||
|
Correct: DAYS([EndDate], [StartDate]) → returns positive
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: DAYS parameter order is end date first, start date second.
|
||||||
|
|
||||||
|
### Mistake 11: Chaining zero-argument functions
|
||||||
|
|
||||||
|
```
|
||||||
|
Wrong: TODAY.DAYS([Date])
|
||||||
|
Correct: TODAY().DAYS([Date])
|
||||||
|
```
|
||||||
|
|
||||||
|
Reason: NOW, TODAY, PI and other zero-argument functions must include parentheses.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 13: Complete Examples
|
||||||
|
|
||||||
|
### Example 1: Employee sales summary
|
||||||
|
|
||||||
|
**Table structure** (from `+table-get`):
|
||||||
|
|
||||||
|
- Employees: EmployeeID (Text), Name (Text), Department (Text)
|
||||||
|
- Sales: ContractID (Number), SalespersonID (Text), Quantity (Number), Total (Number)
|
||||||
|
|
||||||
|
**Current table**: Employees
|
||||||
|
|
||||||
|
**Requirement**: For each employee, output "Sold XX orders" if they have sales records, otherwise "No sales records".
|
||||||
|
|
||||||
|
**Formula**:
|
||||||
|
|
||||||
|
```
|
||||||
|
IF(
|
||||||
|
[Sales].COUNTIF(CurrentValue.[SalespersonID] = [EmployeeID]) >= 1,
|
||||||
|
"Sold " & [Sales].COUNTIF(CurrentValue.[SalespersonID] = [EmployeeID]) & " orders",
|
||||||
|
"No sales records"
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Field JSON**:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "formula",
|
||||||
|
"name": "Sales Summary",
|
||||||
|
"expression": "IF([Sales].COUNTIF(CurrentValue.[SalespersonID] = [EmployeeID]) >= 1, \"Sold \" & [Sales].COUNTIF(CurrentValue.[SalespersonID] = [EmployeeID]) & \" orders\", \"No sales records\")"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Explanation**: `[Sales].COUNTIF(...)` uses the entire Sales table as data range. CurrentValue represents each row in Sales, accessing `CurrentValue.[SalespersonID]` for that row's salesperson. `[EmployeeID]` refers to the current row in the Employees table (where the formula lives).
|
||||||
|
|
||||||
|
### Example 2: Chained cross-table access via link fields
|
||||||
|
|
||||||
|
**Table structure**:
|
||||||
|
|
||||||
|
- Orders: ID (`auto_number`), OrderItems (`link` [target: OrderItems, foreign key: ID])
|
||||||
|
- OrderItems: ID (`auto_number`), Product (`link` [target: Products, foreign key: ID])
|
||||||
|
- Products: ID (`auto_number`), ProductName (`text`)
|
||||||
|
|
||||||
|
**Current table**: Orders
|
||||||
|
|
||||||
|
**Requirement**: Deduplicate and comma-join all product names from linked order items.
|
||||||
|
|
||||||
|
**Formula**:
|
||||||
|
|
||||||
|
```
|
||||||
|
[OrderItems].[Product].[ProductName].UNIQUE().ARRAYJOIN(",")
|
||||||
|
```
|
||||||
|
|
||||||
|
**Field JSON**:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "formula",
|
||||||
|
"name": "Product List",
|
||||||
|
"expression": "[OrderItems].[Product].[ProductName].UNIQUE().ARRAYJOIN(\",\")"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Explanation**: `[OrderItems]` gets linked order item records, `.[Product]` expands to each item's linked product, `.[ProductName]` gets all product names, `.UNIQUE()` deduplicates, `.ARRAYJOIN(",")` joins with commas.
|
||||||
|
|
||||||
|
### Example 3: Cross-table filter + sort
|
||||||
|
|
||||||
|
**Table structure**:
|
||||||
|
|
||||||
|
- Projects: ProjectName (Text), Status (Text), Owner (Text)
|
||||||
|
- Tasks: TaskName (Text), Project (Text), Priority (Number), DueDate (Date)
|
||||||
|
|
||||||
|
**Current table**: Projects
|
||||||
|
|
||||||
|
**Requirement**: Find the highest-priority (lowest number) task name for the current project.
|
||||||
|
|
||||||
|
**Formula**:
|
||||||
|
|
||||||
|
```
|
||||||
|
FIRST(
|
||||||
|
[Tasks].FILTER(CurrentValue.[Project] = [ProjectName]).SORTBY([Tasks].[Priority], TRUE).[TaskName]
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Field JSON**:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "formula",
|
||||||
|
"name": "Top Priority Task",
|
||||||
|
"expression": "FIRST([Tasks].FILTER(CurrentValue.[Project] = [ProjectName]).SORTBY([Tasks].[Priority], TRUE).[TaskName])"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Explanation**: `[Tasks].FILTER(CurrentValue.[Project] = [ProjectName])` filters tasks belonging to the current project. `.SORTBY([Tasks].[Priority], TRUE)` sorts by priority ascending. `.[TaskName]` extracts task names. `FIRST(...)` gets the first one (highest priority).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 14: Translating User Requirements to Formulas
|
||||||
|
|
||||||
|
When the user describes their formula need in natural language, follow these rules to convert it into a precise expression:
|
||||||
|
|
||||||
|
1. **Numbers must use precise values**: "less than 80%" → field value less than `0.8`. "above 1000" → `>= 1000`.
|
||||||
|
2. **Interval boundaries**: "above/below/within" = closed (inclusive); "less than/more than/outside" = open (exclusive).
|
||||||
|
3. **Branching logic** must be organized as an ordered list with a fallback branch. Each branch has a condition and output.
|
||||||
|
- Example: "return risk level for 1-3" → `IFS([Value] = 1, "low", [Value] = 2, "medium", [Value] = 3, "high")` with an `IFERROR` or trailing empty-string fallback.
|
||||||
|
4. **Multi-level branches must be flattened** to a single level. Nested if-else chains → flat IFS.
|
||||||
|
5. **Branch conditions must be mutually exclusive**. If the user's conditions overlap, rewrite to eliminate ambiguity.
|
||||||
|
6. **Reorder branches by logical priority** if the user's order is illogical (e.g., check specific conditions before catch-all).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 15: Constraint Summary
|
||||||
|
|
||||||
|
- Request body must include `"type": "formula"` — this field is required
|
||||||
|
- Only use functions and operators listed in this document
|
||||||
|
- FILTER/SUMIF/COUNTIF/MAP must not be nested inside each other's conditions (chained calls are not nesting)
|
||||||
|
- Do not use LOOKUP — use FILTER exclusively
|
||||||
|
- Table and field names must exactly match `+table-get` output
|
||||||
|
- Strings must use double quotes `"`
|
||||||
|
- Format dates with TEXT before concatenating, to control output format
|
||||||
|
- SORTBY can only be chained and must include an output column
|
||||||
|
- Link fields return lists — aggregate or extract single values before output
|
||||||
158
.agents/skills/lark-base/references/lark-base-cell-value.md
Normal file
158
.agents/skills/lark-base/references/lark-base-cell-value.md
Normal file
@ -0,0 +1,158 @@
|
|||||||
|
# base CellValue 规范(lark-base-cell-value)
|
||||||
|
|
||||||
|
> 适用命令:`lark-cli base +record-upsert`、`lark-cli base +record-batch-create`、`lark-cli base +record-batch-update`
|
||||||
|
|
||||||
|
本文件定义 **shortcut 写记录** 时 `CellValue` 的推荐格式,目标是让 AI 一次写对。不同命令的外层 JSON 形状不同,但每个 cell 都以本文为 source of truth。
|
||||||
|
|
||||||
|
## 1. 顶层规则(必须遵守)
|
||||||
|
|
||||||
|
- `--json` 必须是 JSON 对象。
|
||||||
|
- `+record-upsert`:顶层直接传字段映射:`{"字段名或字段ID": CellValue}`。
|
||||||
|
- `+record-batch-create`:使用 `create_records`,其每个元素都是 `Map<FieldNameOrID, CellValue>`。
|
||||||
|
- `+record-batch-update`:使用 `update_records`,其每个 value 都是 `Map<FieldNameOrID, CellValue>`。
|
||||||
|
- 一次 payload 里同一字段只用一种 key(字段名或字段 ID),不要重复。
|
||||||
|
- 写入前先 `+field-list` 获取字段 `type/style/multiple`,再构造值。
|
||||||
|
- 需要清空字段时优先传 `null`(字段允许清空时)。
|
||||||
|
|
||||||
|
## 2. 各类型 CellValue
|
||||||
|
|
||||||
|
### 2.1 text
|
||||||
|
|
||||||
|
text 字段的 `style.type` 影响单元格检查逻辑:
|
||||||
|
`type=plain` 传 Markdown 格式的字符串。
|
||||||
|
`type=url` 传一个带 title 的 Markdown 格式链接,或单独传一个链接。
|
||||||
|
`type=phone` 传合法电话号码。
|
||||||
|
`type=email` 传合法邮箱字符串。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"标题": "Hello, [lark-cli](https://github.com/larksuite/cli)",
|
||||||
|
"官网": "[官网](https://example.com)",
|
||||||
|
"联系电话": "1380000000000",
|
||||||
|
"邮箱": "owner@example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.2 number
|
||||||
|
|
||||||
|
用 JSON number,不要用带单位或千分位的字符串。货币、百分比、进度、评分等数字类字段也按数字写入,展示格式由字段配置决定。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"工时": 12.5,
|
||||||
|
"预算": 3000,
|
||||||
|
"完成度": 0.65,
|
||||||
|
"评分": 4
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.3 select(单选/多选)
|
||||||
|
|
||||||
|
`select` 字段用 `multiple` 区分单选和多选:`multiple=false` 时传选项名字符串,`multiple=true` 时传选项名数组。只支持写入字段中已有的选项;构造 CellValue 前先用 `+field-list` 或 `+field-search-options` 确认目标选项存在。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"单选": "Todo",
|
||||||
|
"多选": ["后端", "高优"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.4 datetime
|
||||||
|
|
||||||
|
优先用 `YYYY-MM-DD HH:mm:ss` 字符串,这是最稳妥的写法,也和常见 API 输出更容易对齐。不要写相对时间(如“明天上午”)。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"截止时间": "2026-03-24 10:00:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.5 checkbox
|
||||||
|
|
||||||
|
用 JSON boolean:`true` 或 `false`,不要用 `"true"`、`"是"`、`1`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"已完成": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.6 user / group_chat
|
||||||
|
|
||||||
|
用对象数组,元素至少包含 `id`。人员字段传用户 ID(如 `ou_xxx`),群字段传群 ID(如 `oc_xxx`);单值/多值都统一使用数组。
|
||||||
|
|
||||||
|
> **人员字段:不要猜 ID。** 不知道 `open_id` 时,先用 `lark-contact` 查 id:`lark-cli contact +search-user --query "<姓名/邮箱/手机号>" --as user`。
|
||||||
|
|
||||||
|
> **群组字段:不要猜 ID。** 不知道 `chat_id` 时,先用 `lark-im` 搜群:`lark-cli im +chat-search --query "<群名关键词>" --as user`;取结果里的 `oc_xxx`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"负责人": [
|
||||||
|
{ "id": "ou_xxx" },
|
||||||
|
{ "id": "ou_xxx2" }
|
||||||
|
],
|
||||||
|
"协作群": [
|
||||||
|
{ "id": "oc_xxx" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.7 link
|
||||||
|
|
||||||
|
用对象数组,元素包含 `id`,值为目标记录的 `record_id`。不要传记录标题;先用 `+record-list` / `+record-search` 找到目标记录 ID。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"关联任务": [
|
||||||
|
{ "id": "<record_id>" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.8 location
|
||||||
|
|
||||||
|
写入对象必须使用 `{lng, lat}`,两者都是数字;`lng` 是经度,`lat` 是纬度。不需要手动传 `full_address`,平台会根据坐标解析地址。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"坐标": {
|
||||||
|
"lng": 116.397428,
|
||||||
|
"lat": 39.90923
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
读取、筛选、转文本等场景使用 `full_address` 字符串;只有公式能访问坐标。如果用户只给地址文本,先获取或确认坐标后再写入;不要把仅有地址文本直接当作 location CellValue。
|
||||||
|
|
||||||
|
### 2.9 attachment(不作为普通 CellValue 写入)
|
||||||
|
|
||||||
|
- 追加附件:使用 `lark-cli base +record-upload-attachment --record-id <record_id> --field-id <field_id> --file <path>`;可重复 `--file` 一次追加多个附件,不能用普通记录操作接口写附件值。
|
||||||
|
- 删除附件:使用 `lark-cli base +record-remove-attachment --record-id <record_id> --field-id <field_id> --file-token <file_token> --yes`;可重复 `--file-token` 一次删除同一单元格里的多个附件。
|
||||||
|
- 下载附件:使用 `lark-cli base +record-download-attachment --record-id <record_id> --file-token <file_token> --output <dir>`;不传 `--file-token` 时下载整行所有附件,也可重复 `--file-token` 只下载指定附件。Base 附件必须用这个命令下载,用其他下载入口可能失败。
|
||||||
|
|
||||||
|
## 3. 只读字段(不要写)
|
||||||
|
|
||||||
|
以下字段在写记录时应视为只读:
|
||||||
|
- `auto_number`
|
||||||
|
- `lookup`
|
||||||
|
- `formula`
|
||||||
|
- `created_at` / `updated_at`
|
||||||
|
- `created_by` / `updated_by`
|
||||||
|
|
||||||
|
写入只读字段通常不会更新数据;返回里可能出现 `ignored_fields`,reason 会说明 `READONLY`。看到这种返回时,不要重试同一 payload,应移除只读字段,只写存储字段。
|
||||||
|
|
||||||
|
## 4. 完整示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"标题": "Created from shortcut",
|
||||||
|
"状态": "Todo",
|
||||||
|
"标签": ["高优", "外部依赖"],
|
||||||
|
"工时": 8,
|
||||||
|
"截止时间": "2026-03-24 10:00:00",
|
||||||
|
"已完成": false,
|
||||||
|
"负责人": [{ "id": "ou_123" }],
|
||||||
|
"关联任务": [{ "id": "rec_456" }],
|
||||||
|
"坐标": { "lng": 116.397428, "lat": 39.90923 }
|
||||||
|
}
|
||||||
|
```
|
||||||
@ -0,0 +1,717 @@
|
|||||||
|
# base +dashboard-block-get-data
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [lark-base-dashboard.md](lark-base-dashboard.md) 了解 dashboard 整体工作流。
|
||||||
|
|
||||||
|
获取仪表盘图表组件(block)的**最终计算结果**,返回一份适合 AI 直接消费的图表协议 JSON。
|
||||||
|
|
||||||
|
这个命令适合以下场景:
|
||||||
|
|
||||||
|
1. 读取柱状图 / 条形图 / 折线图 / 饼图 / 环形图 / 面积图 / 组合图 / 散点图 / 漏斗图 / 雷达图 / 词云 / 指标卡的**实际计算结果**;
|
||||||
|
2. 把图表结果交给 AI 做后续总结、趋势解释、同比/环比说明、异常点提取;
|
||||||
|
3. 在**不读取原始记录**的前提下,直接消费图表层已经聚合好的结果;
|
||||||
|
4. 验证某个图表当前展示的数据是否符合预期。
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> - 本命令返回的是**图表结果协议**,不是 block 元数据;
|
||||||
|
> - 如果你需要 `name`、`type`、`layout`、`data_config` 等配置,请先用 `+dashboard-block-get`;
|
||||||
|
> - 文本组件(`text`)不涉及计算,不适用本命令;
|
||||||
|
|
||||||
|
## 一句话理解
|
||||||
|
|
||||||
|
`+dashboard-block-get-data` = **拿图表“算出来的结果”**,而不是拿图表“怎么配置的”。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 支持的图表类型
|
||||||
|
|
||||||
|
当前支持以下图表类型的数据计算与返回:
|
||||||
|
|
||||||
|
### 二维图表(10 种)
|
||||||
|
|
||||||
|
- 柱状图
|
||||||
|
- 条形图
|
||||||
|
- 折线图
|
||||||
|
- 饼图
|
||||||
|
- 环形图
|
||||||
|
- 面积图
|
||||||
|
- 组合图
|
||||||
|
- 散点图
|
||||||
|
- 漏斗图
|
||||||
|
- 雷达图
|
||||||
|
|
||||||
|
### 特殊类型(2 种)
|
||||||
|
|
||||||
|
- 词云
|
||||||
|
- 指标卡(statistics)
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 文本组件虽然也属于 dashboard block,但它不产生可计算数据,因此不会返回本协议。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token bascn***************CtadY \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你还不知道目标 block 的 ID,典型顺序是:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先看仪表盘里有哪些组件
|
||||||
|
lark-cli base +dashboard-block-list \
|
||||||
|
--base-token bascn***************CtadY \
|
||||||
|
--dashboard-id blkxxxxxxxx
|
||||||
|
|
||||||
|
# 再读取某个组件的最终计算结果
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token bascn***************CtadY \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
如果你需要先确认组件类型、名称或 `data_config`,请先执行:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +dashboard-block-get \
|
||||||
|
--base-token bascn***************CtadY \
|
||||||
|
--dashboard-id blkxxxxxxxx \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token,标识目标多维表格 |
|
||||||
|
| `--block-id <id>` | 是 | 图表 Block ID,即目标组件的唯一标识 |
|
||||||
|
| `--format <fmt>` | 否 | 输出格式,遵循 CLI 全局输出格式规则 |
|
||||||
|
| `--dry-run` | 否 | 只预览 API 调用,不真正执行 |
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> 这个命令**不需要** `--dashboard-id`。只要 `base_token + block_id` 即可定位并读取图表结果。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 返回结构总览
|
||||||
|
|
||||||
|
CLI 成功输出使用标准 `{ok, identity, data}` 信封:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"identity": "user",
|
||||||
|
"data": {
|
||||||
|
"dimensions": [],
|
||||||
|
"measures": [],
|
||||||
|
"main_data": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 `identity` 是本次调用实际使用的身份,`data` 是 CLI 图表协议本体。不同图表类型的 `data` 结构略有不同:
|
||||||
|
|
||||||
|
| 图表类型 | 一定有 | 可能有 |
|
||||||
|
|----------|--------|--------|
|
||||||
|
| 二维图表 | `dimensions` / `measures` / `main_data` | 无 |
|
||||||
|
| 词云 | `dimensions` / `measures` / `main_data` | 无 |
|
||||||
|
| 指标卡 | `dimensions` / `measures` / `main_data` | `comparison_data` / `trend_data` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 协议字段说明
|
||||||
|
|
||||||
|
### 1) `dimensions`
|
||||||
|
|
||||||
|
维度定义数组,告诉你主结果里每个 `dim_*` key 代表什么字段。
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"field_name": "文本",
|
||||||
|
"alias": "dim_5bKp"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
字段含义:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `field_name` | 维度字段显示名称 |
|
||||||
|
| `alias` | 维度别名,在 `main_data` / `trend_data` 中作为 key 使用 |
|
||||||
|
|
||||||
|
### 2) `measures`
|
||||||
|
|
||||||
|
指标定义数组,告诉你每个 `me_*` key 代表什么聚合指标。
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"field_name": "Count",
|
||||||
|
"aggregation": "count_all",
|
||||||
|
"alias": "me_Y291bnRfYWxsX0NvdW50"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
字段含义:
|
||||||
|
|
||||||
|
| 字段 | 说明 |
|
||||||
|
|------|------|
|
||||||
|
| `field_name` | 统计该指标时所使用的字段名称;当 `aggregation = count_all` 时固定为 `Count`,表示统计记录总数 |
|
||||||
|
| `aggregation` | 聚合方式,常见值:`count_all` / `count` / `sum` / `avg` / `min` / `max` |
|
||||||
|
| `alias` | 指标别名,在 `main_data` / `comparison_data` / `trend_data` 中作为 key 使用 |
|
||||||
|
|
||||||
|
例如:
|
||||||
|
|
||||||
|
- 如果统计“销售额”的求和,则 `field_name = 销售额`、`aggregation = sum`
|
||||||
|
- 如果统计记录总数,则 `field_name = Count`、`aggregation = count_all`
|
||||||
|
|
||||||
|
### 3) `main_data`
|
||||||
|
|
||||||
|
主结果集。每一行都是一个对象,key 不是字段名本身,而是 `dimensions` / `measures` 中声明过的 `alias`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"me_Y291bnRfYWxsX0NvdW50": {"value": 3}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4) `comparison_data`
|
||||||
|
|
||||||
|
仅指标卡可能返回。表示同/环比的两个值,顺序固定为:
|
||||||
|
|
||||||
|
1. 当前周期值
|
||||||
|
2. 对比周期值
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 原始协议里通常**不直接展示周期名称**,只提供对应的值。因此解释“同比”还是“环比”、以及比较窗口具体是什么,通常要结合组件配置或 UI 上下文理解。
|
||||||
|
|
||||||
|
### 5) `trend_data`
|
||||||
|
|
||||||
|
仅指标卡可能返回。表示时间序列趋势,每一行通常包含一个时间维度和一个指标值。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## alias 规则与读取方式
|
||||||
|
|
||||||
|
你不应该把 alias 当成人类可读字段名,而应把它视为**结果表里的列 ID**。
|
||||||
|
|
||||||
|
常见生成规则:
|
||||||
|
|
||||||
|
- 维度 alias:`dim_` + `base64(field_name)`
|
||||||
|
- 指标 alias:`me_` + `base64(aggregation + "_" + field_name)`
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 为了便于阅读,本文档中的部分示例会使用**简化后的 alias**(例如 `dim_xxx`、`me_xxx` 或较短的示例值),不保证和真实返回值逐字符一致。
|
||||||
|
> 在实际读取结果时,应始终以 `dimensions` / `measures` 中声明的 alias 为准,而不要假设所有示例都严格展开成完整编码值。
|
||||||
|
|
||||||
|
例如:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dimensions": [
|
||||||
|
{"field_name": "文本", "alias": "dim_5bKp"}
|
||||||
|
],
|
||||||
|
"measures": [
|
||||||
|
{"field_name": "Count", "aggregation": "count_all", "alias": "me_xxx"}
|
||||||
|
],
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"me_xxx": {"value": 3}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
应解读为:
|
||||||
|
|
||||||
|
- `dim_5bKp` 对应字段“文本”,取值是 `A`
|
||||||
|
- `me_xxx` 对应指标 `count_all(Count)`,取值是 `3`
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> 读取结果时,**先看 `dimensions` / `measures`,再解 `main_data`**。不要仅凭 alias 名字猜含义。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 各图表类型的协议细节
|
||||||
|
|
||||||
|
### 一、二维图表
|
||||||
|
|
||||||
|
适用于:柱状图、条形图、折线图、饼图、环形图、面积图、组合图、散点图、漏斗图、雷达图。
|
||||||
|
|
||||||
|
#### 结构特征
|
||||||
|
|
||||||
|
- `dimensions`:通常有 `1~2` 个维度
|
||||||
|
- 不分组聚合时:通常 1 个维度
|
||||||
|
- 开启分组聚合时:通常 2 个维度
|
||||||
|
- `measures`:指标定义数组
|
||||||
|
- `main_data`:按“维度组合”展开后的行数据
|
||||||
|
|
||||||
|
#### 这类数据代表什么
|
||||||
|
|
||||||
|
二维图表返回的本质上是一张**聚合结果表**:
|
||||||
|
|
||||||
|
- 每一行代表一个维度值,或一组维度组合;
|
||||||
|
- 每一个 measure 值代表该维度下算出来的指标结果;
|
||||||
|
- 如果图表开启了分组聚合,那么每一行表示“主维度 + 分组维度”的一个组合结果;
|
||||||
|
- 如果图表是折线图、面积图这类带时间轴的图,通常可以把第一维理解为横轴、把 measure 理解为纵轴数值;
|
||||||
|
- 如果图表是饼图、环形图这类占比图,通常可以把每一行理解为一个扇区对应的分类及其数值。
|
||||||
|
|
||||||
|
换句话说,AI 在读取这类结果时,可以把它当作“按某些维度聚合后的统计明细表”,适合进一步做排序、Top N、占比解释、分组对比和趋势总结。
|
||||||
|
|
||||||
|
#### 示例 1:普通二维图表(无分组聚合)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dimensions": [
|
||||||
|
{
|
||||||
|
"field_name": "文本",
|
||||||
|
"alias": "dim_5bKp"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"measures": [
|
||||||
|
{
|
||||||
|
"aggregation": "count_all",
|
||||||
|
"field_name": "Count",
|
||||||
|
"alias": "me_Y291bnRfYWxsX0NvdW50"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"me_Y291bnRfYWxsX0NvdW50": {"value": 3}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "B"},
|
||||||
|
"me_Y291bnRfYWxsX0NvdW50": {"value": 2}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "C"},
|
||||||
|
"me_Y291bnRfYWxsX0NvdW50": {"value": 2}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
可解读为:
|
||||||
|
|
||||||
|
- 维度字段是“文本”
|
||||||
|
- 指标是“按记录总数统计”
|
||||||
|
- 当“文本”字段为 `A` 时,对应的 `Count` 指标值是 `3`
|
||||||
|
- 当“文本”字段为 `B` 时,对应的 `Count` 指标值是 `2`
|
||||||
|
- 当“文本”字段为 `C` 时,对应的 `Count` 指标值是 `2`
|
||||||
|
|
||||||
|
#### 示例 2:二维图表(开启分组聚合)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dimensions": [
|
||||||
|
{
|
||||||
|
"field_name": "文本",
|
||||||
|
"alias": "dim_5bKp"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "单选",
|
||||||
|
"alias": "dim_5aSl"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"measures": [
|
||||||
|
{
|
||||||
|
"aggregation": "count_all",
|
||||||
|
"field_name": "Count",
|
||||||
|
"alias": "me_YW91bnR"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"dim_5aSl": {"value": "a-1"},
|
||||||
|
"me_YW91bnR": {"value": 2}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"dim_5aSl": {"value": "a-2"},
|
||||||
|
"me_YW91bnR": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "B"},
|
||||||
|
"dim_5aSl": {"value": "b-1"},
|
||||||
|
"me_YW91bnR": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "C"},
|
||||||
|
"dim_5aSl": {"value": "c-1"},
|
||||||
|
"me_YW91bnR": {"value": 2}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
可解读为:
|
||||||
|
|
||||||
|
- 第一维是“文本”,第二维是“单选”,指标是“按记录总数统计”
|
||||||
|
- 当“文本”字段为 `A`、且“单选”字段为 `a-1` 时,对应的指标值是 `2`
|
||||||
|
- 当“文本”字段为 `A`、且“单选”字段为 `a-2` 时,对应的指标值是 `1`
|
||||||
|
- 当“文本”字段为 `B`、且“单选”字段为 `b-1` 时,对应的指标值是 `1`
|
||||||
|
- 当“文本”字段为 `C`、且“单选”字段为 `c-1` 时,对应的指标值是 `2`
|
||||||
|
- 如果按“文本”字段汇总,那么“文本”字段为 `A` 时总指标值是 `3`;为 `B` 时总指标值是 `1`;为 `C` 时总指标值是 `2`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 二、词云
|
||||||
|
|
||||||
|
#### 结构特征
|
||||||
|
|
||||||
|
词云协议仍然沿用 `dimensions + measures + main_data` 的结构,但语义稍有不同:
|
||||||
|
|
||||||
|
- `dimensions` 对应被分词的字段;
|
||||||
|
- `main_data` 每一行代表一个词;
|
||||||
|
- `measure` 的 value 表示按该词分组后计算出来的统计值。
|
||||||
|
|
||||||
|
#### 这类数据代表什么
|
||||||
|
|
||||||
|
词云返回的不是“原文列表”,而是**按词分组后的聚合统计结果**:
|
||||||
|
|
||||||
|
- `dimensions` 定义的是被分词的来源字段;
|
||||||
|
- `measure` 对应的是该词在当前图表统计范围内对应的统计值,具体含义取决于聚合方式和指标字段;
|
||||||
|
- `main_data` 的每一行都可以理解成“某个词 + 该词对应的统计结果”,其中该维度的具体 value 就是拆分出来的词;
|
||||||
|
- 返回结果通常已经结合图表当前过滤条件、时间范围、数据权限等上下文计算完成。
|
||||||
|
|
||||||
|
因此,AI 读取词云数据时,更适合做“关键词排序”“热点词解释”“按词聚合结果分析”“主题归纳”,而不是把它当成逐条文本记录去理解。
|
||||||
|
|
||||||
|
#### 示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dimensions": [
|
||||||
|
{
|
||||||
|
"field_name": "文本",
|
||||||
|
"alias": "dim_5bKp"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"measures": [
|
||||||
|
{
|
||||||
|
"aggregation": "count_all",
|
||||||
|
"field_name": "Count",
|
||||||
|
"alias": "me_YW91bnR"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "A"},
|
||||||
|
"me_YW91bnR": {"value": 3}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "B"},
|
||||||
|
"me_YW91bnR": {"value": 2}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_5bKp": {"value": "C"},
|
||||||
|
"me_YW91bnR": {"value": 2}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
可解读为:
|
||||||
|
|
||||||
|
- 被统计的分词字段是“文本”
|
||||||
|
- 当前示例里的 measure 是 `count_all(Count)`,所以这里的统计值可以理解为“按词分组后的记录总数”
|
||||||
|
- 当分词结果为 `A` 时,对应的统计值是 `3`
|
||||||
|
- 当分词结果为 `B` 时,对应的统计值是 `2`
|
||||||
|
- 当分词结果为 `C` 时,对应的统计值是 `2`
|
||||||
|
- 按统计值排序,分词结果 `A` 对应的值最高
|
||||||
|
- 分词结果 `B` 和 `C` 的统计值相同,说明它们处于同一梯队
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 三、指标卡(statistics)
|
||||||
|
|
||||||
|
指标卡除了主值外,还可能包含同/环比与趋势结果,是本命令里结构最特殊的一类。
|
||||||
|
|
||||||
|
#### 结构特征
|
||||||
|
|
||||||
|
- `measures`:**有且仅有一个指标**
|
||||||
|
- `main_data`:通常只有一行,表示总指标值
|
||||||
|
- `comparison_data`:可选,表示当前周期值与对比周期值
|
||||||
|
- `trend_data`:可选,表示趋势序列
|
||||||
|
- `dimensions`:可能包含同/环比日期字段、趋势日期字段
|
||||||
|
|
||||||
|
#### 这类数据代表什么
|
||||||
|
|
||||||
|
指标卡返回的核心是一个**主指标摘要**,外加可选的比较信息和趋势信息:
|
||||||
|
|
||||||
|
- `main_data` 表示当前卡片最核心、最醒目的那个主值;它通常是某个表的记录总数,或某个字段的聚合值,本身**不带时间周期概念**;
|
||||||
|
- `comparison_data` 表示用于同/环比展示的两个数值,通常是“当前周期值”和“对比周期值”;它们表示某个时间周期下的记录总数,或某个字段的聚合值;
|
||||||
|
- `trend_data` 表示这个指标在一段时间内的变化轨迹,用来支持走势判断;
|
||||||
|
- `dimensions` 在指标卡里通常不是拿来做主分组展示,而是给 `trend_data` 或同/环比相关日期字段提供语义说明。
|
||||||
|
|
||||||
|
例如:
|
||||||
|
|
||||||
|
- `main_data = 7` 可以理解为当前卡片展示的主数据,比如某张表当前总记录数是 `7`;
|
||||||
|
- `comparison_data[0] = 6` 则表示某个比较周期下的当前值,比如“本月记录总数 = 6”;
|
||||||
|
- 因此,`main_data` 与 `comparison_data[0]` **不一定相等**,因为两者表达的口径并不完全相同。
|
||||||
|
|
||||||
|
因此,AI 在解读指标卡时,应该优先回答这几个问题:
|
||||||
|
|
||||||
|
1. 当前主值是多少;
|
||||||
|
2. 和对比周期相比是上升、下降还是持平;
|
||||||
|
3. 趋势整体是增长、波动还是下滑;
|
||||||
|
4. 是否存在明显的异常峰值或低谷。
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> 当指标卡**同时指定同/环比和趋势**时,`dimensions` 中日期维度的顺序是固定的:
|
||||||
|
> 1. 第一个元素是**趋势**对应的日期维度;
|
||||||
|
> 2. 第二个元素是**同/环比**对应的日期维度。
|
||||||
|
>
|
||||||
|
> 另外要注意:`comparison_data` 自身通常**不直接携带日期字段**,它只给出“当前周期值 / 对比周期值”。
|
||||||
|
> `dimensions` 中的第一个日期维度会直接出现在 `trend_data` 中,作为趋势序列的时间列;
|
||||||
|
> 第二个日期维度则主要用于补充“该卡片配置了哪类比较相关日期字段”的语义。
|
||||||
|
|
||||||
|
#### 示例
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dimensions": [
|
||||||
|
{
|
||||||
|
"field_name": "日期",
|
||||||
|
"alias": "dim_ZGF0ZQ"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "日期2",
|
||||||
|
"alias": "dim_ZGF0ZTI"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"measures": [
|
||||||
|
{
|
||||||
|
"aggregation": "count_all",
|
||||||
|
"field_name": "Count",
|
||||||
|
"alias": "me_YW91b"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"me_YW91b": {"value": 7}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"comparison_data": [
|
||||||
|
{
|
||||||
|
"me_YW91b": {"value": 6}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"me_YW91b": {"value": 0}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"trend_data": [
|
||||||
|
{
|
||||||
|
"dim_ZGF0ZQ": {"value": "2026-01-15"},
|
||||||
|
"me_YW91b": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_ZGF0ZQ": {"value": "2026-01-17"},
|
||||||
|
"me_YW91b": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_ZGF0ZQ": {"value": "2026-03-22"},
|
||||||
|
"me_YW91b": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_ZGF0ZQ": {"value": "2026-04-24"},
|
||||||
|
"me_YW91b": {"value": 2}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_ZGF0ZQ": {"value": "2026-05-01"},
|
||||||
|
"me_YW91b": {"value": 1}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
可解读为:
|
||||||
|
|
||||||
|
- 当前主指标值 = `7`
|
||||||
|
- 当前主指标值不带时间周期概念,可理解为当前卡片主数据
|
||||||
|
- comparison_data[0] = 当前周期值 `6`,例如某个时间周期(如本月)下的统计值
|
||||||
|
- comparison_data[1] = 对比周期值 `0`
|
||||||
|
- `dimensions[0]` 对应趋势日期维度,因此实际出现在 `trend_data` 里
|
||||||
|
- `dimensions[1]` 对应同/环比相关的日期维度,用来补充比较语义
|
||||||
|
- trend_data 展示该指标随时间的变化序列
|
||||||
|
- 从 comparison_data 看,当前周期相较对比周期是上升的,并且对比周期值为 0
|
||||||
|
- 从 trend_data 看,这个指标并不是每天都有值,而是在若干离散日期出现
|
||||||
|
- 趋势序列里的最高点出现在 `2026-04-24`,值为 `2`
|
||||||
|
- 其余出现的日期大多为 `1`,说明整体上有波动,但暂时没有持续快速增长的趋势
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> `comparison_data` 只告诉你“当前值 / 对比值”,**不额外标出日期区间文本**。如果用户需要完整说明“和上周比”还是“和上月比”,通常要结合组件配置或界面上下文进一步判断。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 如何正确解读返回值
|
||||||
|
|
||||||
|
建议按下面顺序阅读:
|
||||||
|
|
||||||
|
1. **先看 `dimensions`**:确认每个 `dim_*` alias 对应哪个字段;
|
||||||
|
2. **再看 `measures`**:确认每个 `me_*` alias 是什么聚合方式;
|
||||||
|
3. **最后读 `main_data` / `comparison_data` / `trend_data`**:把 alias 还原成“字段名 + 指标名”再做解释。
|
||||||
|
|
||||||
|
### 推荐解释模板
|
||||||
|
|
||||||
|
如果要把结果转成自然语言,建议不要只“复述数值”,而应尽量覆盖下面几个层次:
|
||||||
|
|
||||||
|
1. **先解释指标含义**:说明 measure 代表“记录总数”“某字段求和”“平均值”等;
|
||||||
|
2. **再给出核心结果**:明确当前主值、主要分类、主要组合或主要词项;
|
||||||
|
3. **做排序或 Top N 提炼**:指出最高、最低、前几名、同一梯队;
|
||||||
|
4. **补充分组/对比关系**:如果有第二维或 comparison_data,就说明比较对象和差异;
|
||||||
|
5. **分析趋势或异常点**:如果有时间序列,指出上升、下降、波动、峰值、低谷;
|
||||||
|
6. **最后给一句结论**:总结最值得关注的信息。
|
||||||
|
|
||||||
|
可参考下面模板:
|
||||||
|
|
||||||
|
- 二维图表:
|
||||||
|
- 基础模板:`按 <维度字段> 统计,当前指标 <指标含义>;其中 <维度值1>=<指标值1>,<维度值2>=<指标值2> ...`
|
||||||
|
- 增强模板:`按 <维度字段> 统计,当前指标表示 <指标含义>。从结果看,<Top1维度值> 的值最高,为 <Top1值>;<Top2维度值> 和 <Top3维度值> 紧随其后。若按 Top N 看,前 <N> 项合计贡献了 ...;若看低值项,<低值维度值> 最低,为 <低值>。整体上,<一句总结>`
|
||||||
|
|
||||||
|
- 分组聚合图表:
|
||||||
|
- 基础模板:`按 <维度1> 统计,并以 <维度2> 分组,得到 <组合1>=<值1>,<组合2>=<值2> ...`
|
||||||
|
- 增强模板:`当前指标表示 <指标含义>。按 <维度1> 拆分后,不同 <维度2> 组之间存在明显差异:例如 <组合1> = <值1>,<组合2> = <值2>。如果按 <维度1> 汇总,<Top1维度1值> 总值最高,为 <汇总值>;如果看组内对比,<某组> 在 <某维度1值> 下表现最强 / 最弱。整体说明 <一句总结>`
|
||||||
|
|
||||||
|
- 词云:
|
||||||
|
- 基础模板:`按分词结果统计,当前指标表示 <指标含义>;其中 <词1>=<统计值1>,<词2>=<统计值2> ...`
|
||||||
|
- 增强模板:`当前词云反映的是“按词分组后的 <指标含义>”。从结果看,<Top1词> 的值最高,为 <值1>,说明它是当前最突出的关键词;<Top2词>、<Top3词> 处于第二梯队。如果按 Top N 看,主要关注词集中在 <主题A>、<主题B>;如果有多个词数值接近,可归为同一热点层级。整体上,这组词更适合用来总结 <主题/热点/关注点>`
|
||||||
|
|
||||||
|
- 指标卡:
|
||||||
|
- 基础模板:`当前主指标值为 <main_data>;当前周期值为 <comparison_data[0]>;对比周期值为 <comparison_data[1]>;趋势上 ...`
|
||||||
|
- 增强模板:`当前主指标表示 <指标含义>,主值为 <main_data>。若看周期比较,当前周期值为 <comparison_data[0]>,对比周期值为 <comparison_data[1]>,因此整体表现为 <上升/下降/持平>。若看趋势序列,最高点出现在 <日期>,值为 <峰值>;最低点出现在 <日期>,值为 <低值>;整体走势表现为 <持续增长/阶段波动/明显回落>。如果需要给出结论,可总结为:<一句总结>`
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> 当用户明确要求“帮我分析”“帮我总结”“帮我找异常 / Top N / 趋势”时,优先采用增强模板,而不是只逐条复述原始数值。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常见工作流
|
||||||
|
|
||||||
|
### 场景 1:用户要“拿这个图表当前展示的数据”
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 如果已知 block_id,直接读结果
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token xxx \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 2:用户说“帮我分析这个图表”,但你还不知道它是什么组件
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先看组件配置,确认它是不是支持计算的图表类型
|
||||||
|
lark-cli base +dashboard-block-get \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
|
||||||
|
# 再读最终计算结果
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token xxx \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 3:用户要找“仪表盘里哪个图的结果异常”
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 先列组件
|
||||||
|
lark-cli base +dashboard-block-list \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx
|
||||||
|
|
||||||
|
# 再针对可疑 block 逐个取结果
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token xxx \
|
||||||
|
--block-id chtxxxxxxxx
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 何时优先用这个命令
|
||||||
|
|
||||||
|
- 用户说“帮我拿这个图表算出来的数据 / 结果 / 指标”
|
||||||
|
- 用户已经知道 `block_id`,目标是**读取结果**而不是看配置
|
||||||
|
- 用户后续还要让 AI 对图表结果做解释、归纳、比较、总结
|
||||||
|
- 你只关心图表层的聚合产出,不需要回到底表逐条读记录
|
||||||
|
|
||||||
|
## 何时不要误用
|
||||||
|
|
||||||
|
- 想看 block 的 `data_config`、名称、类型、布局 → 用 `+dashboard-block-get`
|
||||||
|
- 想列出仪表盘里有哪些组件 → 用 `+dashboard-block-list`
|
||||||
|
- 想修改或新建组件 → 用 `+dashboard-block-update` / `+dashboard-block-create`
|
||||||
|
- 想看原始记录明细,而不是图表聚合结果 → 回到 `record-*`
|
||||||
|
- 目标是文本组件 → 本命令不适用
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常见误区
|
||||||
|
|
||||||
|
### 误区 1:把这个命令当成“获取 block 详情”
|
||||||
|
|
||||||
|
不是。这个命令不返回:
|
||||||
|
|
||||||
|
- block 名称
|
||||||
|
- block 类型
|
||||||
|
- layout
|
||||||
|
- `data_config`
|
||||||
|
- 所属 dashboard 信息
|
||||||
|
|
||||||
|
这些都应该通过 `+dashboard-block-get` 获取。
|
||||||
|
|
||||||
|
### 误区 2:以为它返回的是原始记录
|
||||||
|
|
||||||
|
不是。它返回的是**图表聚合后的最终结果**。如果图表本身做了过滤、分组、聚合、时间窗口限制,返回值反映的是图表视角,不是原始表全量明细。
|
||||||
|
|
||||||
|
### 误区 3:直接把 alias 当真实字段名读
|
||||||
|
|
||||||
|
不应该。alias 只是协议里的键,必须结合 `dimensions` / `measures` 还原语义。
|
||||||
|
|
||||||
|
### 误区 4:看到指标卡的 `comparison_data` 就以为已经知道“同比/环比周期文本”
|
||||||
|
|
||||||
|
不一定。它只给出比较值,不一定给出周期标签。若要精确解释比较窗口,通常还需要组件配置或 UI 上下文。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## dry-run 用途
|
||||||
|
|
||||||
|
可用来确认最终会调用的接口路径:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +dashboard-block-get-data \
|
||||||
|
--base-token bascn_example_token \
|
||||||
|
--block-id chtxxxxxxxx \
|
||||||
|
--dry-run \
|
||||||
|
--format pretty
|
||||||
|
```
|
||||||
|
|
||||||
|
你应能看到类似:
|
||||||
|
|
||||||
|
```text
|
||||||
|
GET /open-apis/base/v3/bases/bascn_example_token/dashboards/blocks/chtxxxxxxxx/data
|
||||||
|
```
|
||||||
|
|
||||||
|
适合在以下场景使用:
|
||||||
|
|
||||||
|
- 校验 `base_token` / `block_id` 是否传对;
|
||||||
|
- 调试 agent 生成的命令;
|
||||||
|
- 编写自动化测试时确认请求结构。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-dashboard.md](lark-base-dashboard.md) — dashboard 模块总指引
|
||||||
|
- `+dashboard-block-get` — 获取 block 元数据
|
||||||
|
- [dashboard-block-data-config.md](dashboard-block-data-config.md) — data_config 结构和组件类型说明
|
||||||
247
.agents/skills/lark-base/references/lark-base-dashboard.md
Normal file
247
.agents/skills/lark-base/references/lark-base-dashboard.md
Normal file
@ -0,0 +1,247 @@
|
|||||||
|
# Dashboard(仪表盘/数据看板)模块指引
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
Dashboard 是 Base 中的数据可视化看板,可以把表格数据变成**组件**(图表、指标卡等)进行展示。
|
||||||
|
|
||||||
|
## 核心概念
|
||||||
|
|
||||||
|
- **Dashboard(仪表盘)**:容器,包含多个组件
|
||||||
|
- **Block(组件)**:仪表盘中的单个可视化元素(柱状图、折线图、饼图、指标卡等)
|
||||||
|
- **data_config**:组件的数据源配置(表名、字段、分组等)
|
||||||
|
|
||||||
|
## 能力速览
|
||||||
|
|
||||||
|
| 你想做什么 | 用这些命令 | 关键文档 |
|
||||||
|
|------|-----------|---------|
|
||||||
|
| 创建/删除/改名称 | `+dashboard-create/delete/update` | 本页下方「仪表盘管理」 |
|
||||||
|
| 在仪表盘里添加组件 | `+dashboard-block-create` | 先定位 dashboard、表和字段,再读 [dashboard-block-data-config.md](dashboard-block-data-config.md) 构造 `data_config` |
|
||||||
|
| 修改组件 | `+dashboard-block-update` | 先读 block 现状,再读 [dashboard-block-data-config.md](dashboard-block-data-config.md) 决定替换哪些顶层 key |
|
||||||
|
| 查看仪表盘有哪些组件 | `+dashboard-get` 或 `+dashboard-block-list` | 本页下方「查看仪表盘」 |
|
||||||
|
| 读取图表计算结果 | `+dashboard-block-get-data` | 返回图表最终数据协议;需要 block 元数据先用 `+dashboard-block-get` |
|
||||||
|
| 智能重排组件布局 | `+dashboard-arrange` | 用户明确要求重排,或本次会话新建仪表盘的收尾整理;无法指定精确位置 |
|
||||||
|
|
||||||
|
## 典型场景工作流
|
||||||
|
|
||||||
|
### 场景 1:从 0 到 1 创建仪表盘
|
||||||
|
|
||||||
|
从 0 到 1 创建仪表盘时,按用户需求规划组件的类型和数量,并注意以下要点:
|
||||||
|
|
||||||
|
- 聚合方式:创建指标卡或分布图时优先把聚合写进 `data_config`,只有 Top N、字段取值探索、复杂筛选校验或 helper 汇总表场景才先用 `+data-query`。
|
||||||
|
- Dry-run 边界:已按模板构造的简单指标卡、分布图、趋势图不需要逐个 `--dry-run` 后再真实创建;只有在调试 JSON、检查请求体、复杂自造 `data_config` 或处理 API validation 错误时才 dry-run。
|
||||||
|
- 验证方式:通过创建接口返回值确认创建成功与否,只在结果不确定时用 `+dashboard-get` 或 `+dashboard-block-list` 确认仪表盘和组件存在,或调用 `+dashboard-block-get-data`读取计算结果验证。
|
||||||
|
- 布局方式:`+dashboard-arrange` 仅两种情况使用:① 用户明确要求美化/重排;② 本次会话中从零新建的仪表盘,建完组件后做一次性布局整理。不是创建成功的必要步骤。
|
||||||
|
|
||||||
|
示例:搭建一个销售数据分析仪表盘
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 第 1 步:创建空白仪表盘
|
||||||
|
lark-cli base +dashboard-create --base-token xxx --name "销售数据分析"
|
||||||
|
# 记录返回的 dashboard_id
|
||||||
|
|
||||||
|
# 第 2 步:获取数据源信息
|
||||||
|
lark-cli base +table-list --base-token xxx
|
||||||
|
lark-cli base +field-list --base-token xxx --table-id <table_id>
|
||||||
|
|
||||||
|
# 第 3 步:规划应该创建哪些组件(根据用户需求确定组件类型和数量)
|
||||||
|
# 例如:总销售额(指标卡)、月度趋势(折线图)、品类占比(饼图)
|
||||||
|
|
||||||
|
# 第 4 步:顺序创建每个组件(必须串行执行,不能并发)
|
||||||
|
# 重要:创建组件前,先确定 dashboard_id、组件 name/type 和真实表字段
|
||||||
|
# 再阅读 dashboard-block-data-config.md 了解 data_config 结构、组件类型和 filter 规则
|
||||||
|
|
||||||
|
# 第 1 个组件
|
||||||
|
lark-cli base +dashboard-block-create \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx \
|
||||||
|
--name "总销售额" \
|
||||||
|
--type statistics \
|
||||||
|
--data-config '{"table_name":"订单表","series":[{"field_name":"金额","rollup":"SUM"}]}'
|
||||||
|
|
||||||
|
# 第 2 个组件(等上一个完成后再执行)
|
||||||
|
lark-cli base +dashboard-block-create \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx \
|
||||||
|
--name "月度趋势" \
|
||||||
|
--type line \
|
||||||
|
--data-config '{"table_name":"订单表","series":[{"field_name":"金额","rollup":"SUM"}],"group_by":[{"field_name":"月份","mode":"integrated"}]}'
|
||||||
|
|
||||||
|
# 继续创建其他组件...
|
||||||
|
|
||||||
|
# 第 5 步:组件创建完成后,使用 arrange 命令智能重排布局(可选但推荐)
|
||||||
|
# 默认布局可能不够美观,arrange 会根据组件数量和类型自动优化布局
|
||||||
|
# 若用户没有要求美化/重排,可先跳过此步骤;这不影响仪表盘和组件是否已创建成功
|
||||||
|
lark-cli base +dashboard-arrange \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 2:在已有仪表盘上添加新组件
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 第 1 步:列出仪表盘,定位到当前仪表盘
|
||||||
|
lark-cli base +dashboard-list --base-token xxx
|
||||||
|
# 获取目标 dashboard_id
|
||||||
|
|
||||||
|
# 第 2 步:根据用户诉求规划组件类型和数据源
|
||||||
|
# 建议先查看当前仪表盘已有组件,避免重复创建,或作为参考
|
||||||
|
lark-cli base +dashboard-get --base-token xxx --dashboard-id blk_xxx
|
||||||
|
|
||||||
|
# 第 3 步:获取数据源信息
|
||||||
|
lark-cli base +table-list --base-token xxx
|
||||||
|
lark-cli base +field-list --base-token xxx --table-id <table_id>
|
||||||
|
|
||||||
|
# 第 4 步:顺序创建每个新组件(必须串行执行,不能并发)
|
||||||
|
# 重要:先确定 dashboard_id、组件 name/type 和真实表字段
|
||||||
|
# 再阅读 dashboard-block-data-config.md 了解 data_config 结构
|
||||||
|
lark-cli base +dashboard-block-create \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx \
|
||||||
|
--name "新组件名" \
|
||||||
|
--type column \
|
||||||
|
--data-config '{...}'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 3:编辑已有组件
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> `+dashboard-block-update` **不能修改组件的 `type`**(图表类型),只能更新 `name` 和 `data_config`。
|
||||||
|
> 如需更换组件类型,必须先删除再重新创建。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 第 1 步:列出仪表盘,定位到当前仪表盘
|
||||||
|
lark-cli base +dashboard-list --base-token xxx
|
||||||
|
|
||||||
|
# 第 2 步:列出组件,获取到目标组件
|
||||||
|
lark-cli base +dashboard-block-list --base-token xxx --dashboard-id blk_xxx
|
||||||
|
# 获取目标 block_id
|
||||||
|
# 提示:查看已有组件可作为参考,或检查是否重复创建相似组件
|
||||||
|
|
||||||
|
# 第 3 步:获取组件当前详情
|
||||||
|
lark-cli base +dashboard-block-get --base-token xxx --dashboard-id blk_xxx --block-id chtxxxxxxxx
|
||||||
|
|
||||||
|
# 第 4 步:根据用户编辑诉求准备更新
|
||||||
|
# 如果编辑诉求涉及数据源变更,需要先获取数据源信息
|
||||||
|
lark-cli base +table-list --base-token xxx
|
||||||
|
lark-cli base +field-list --base-token xxx --table-id <table_id>
|
||||||
|
|
||||||
|
# 第 5 步:执行更新
|
||||||
|
# 重要:先读取当前 block 的 name/type/data_config
|
||||||
|
# 再阅读 dashboard-block-data-config.md 了解 data_config 更新规则
|
||||||
|
lark-cli base +dashboard-block-update \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx \
|
||||||
|
--block-id chtxxxxxxxx \
|
||||||
|
--data-config '{...}'
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 4:重排仪表盘布局
|
||||||
|
|
||||||
|
当用户明确要求对已有仪表盘进行布局重排或美化时使用(对本次会话从零新建的仪表盘,可在建完组件后直接做一次性整理,见场景 1)。
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> - 排列结果是**服务端智能推荐**,不一定完全符合用户预期
|
||||||
|
> - 无法指定具体位置(如"第一排放 A,第二排放 B"),排列逻辑是**自适应**的
|
||||||
|
> - **不建议**在已有仪表盘上自动调用,除非用户明确要求
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 第 1 步:列出仪表盘,定位到目标仪表盘
|
||||||
|
lark-cli base +dashboard-list --base-token xxx
|
||||||
|
|
||||||
|
# 第 2 步:执行智能重排
|
||||||
|
lark-cli base +dashboard-arrange \
|
||||||
|
--base-token xxx \
|
||||||
|
--dashboard-id blk_xxx
|
||||||
|
```
|
||||||
|
|
||||||
|
### 场景 5:读取仪表盘或组件现状
|
||||||
|
|
||||||
|
**选择查询方式:**
|
||||||
|
- 想看仪表盘整体结构(含主题、所有组件名称和类型)→ 用 **方式 A**
|
||||||
|
- 只想快速查看有哪些组件 → 用 **方式 B**
|
||||||
|
- 想看某个组件的详细 data_config 配置 → 用 **方式 C**
|
||||||
|
- 想看某个图表/指标卡实际算出来的数据 → 用 **方式 D**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 第 1 步:列出仪表盘,定位到当前仪表盘
|
||||||
|
lark-cli base +dashboard-list --base-token xxx
|
||||||
|
|
||||||
|
# 第 2 步:根据用户诉求查看详情
|
||||||
|
|
||||||
|
# 方式 A:查看仪表盘整体情况(包含所有组件列表)
|
||||||
|
lark-cli base +dashboard-get --base-token xxx --dashboard-id blk_xxx
|
||||||
|
|
||||||
|
# 方式 B:列出所有组件
|
||||||
|
lark-cli base +dashboard-block-list --base-token xxx --dashboard-id blk_xxx
|
||||||
|
|
||||||
|
# 方式 C:查看某个组件的详细配置
|
||||||
|
lark-cli base +dashboard-block-get --base-token xxx --dashboard-id blk_xxx --block-id chtxxxxxxxx
|
||||||
|
|
||||||
|
# 方式 D:查看某个图表组件的计算结果(AI 友好的 chart protocol)
|
||||||
|
lark-cli base +dashboard-block-get-data --base-token xxx --block-id chtxxxxxxxx
|
||||||
|
|
||||||
|
# 最后:把获取到的现状信息整理好告诉用户
|
||||||
|
```
|
||||||
|
|
||||||
|
## 组件类型选择
|
||||||
|
|
||||||
|
组件 `type` 决定展示形式:
|
||||||
|
|
||||||
|
| 用户想看什么 | 选什么 type | 说明 |
|
||||||
|
|-------------|------------|------|
|
||||||
|
| 数据趋势(时间变化) | line | 折线图组件 |
|
||||||
|
| 类别比较(谁高谁低) | column | 柱状图组件 |
|
||||||
|
| 占比分布(各部分比例) | pie | 饼图组件 |
|
||||||
|
| 单个关键指标 | statistics | 指标卡组件 |
|
||||||
|
| 富文本说明/标题/注释 | text | 文本组件(支持 Markdown) |
|
||||||
|
|
||||||
|
详细组件类型和 data_config 完整规则:[dashboard-block-data-config.md](dashboard-block-data-config.md)
|
||||||
|
|
||||||
|
## 常见问题
|
||||||
|
|
||||||
|
**Q: 创建组件的命令和 data_config 怎么写?**
|
||||||
|
A:
|
||||||
|
1. 先确定 `dashboard_id`、组件 `name`、组件 `type` 和真实表字段
|
||||||
|
2. 再读 [dashboard-block-data-config.md](dashboard-block-data-config.md) 了解:
|
||||||
|
- 全部组件类型的可复制模板
|
||||||
|
- filter 筛选条件格式
|
||||||
|
- 字段类型与操作符对应表
|
||||||
|
|
||||||
|
**Q: 为什么组件创建失败了?**
|
||||||
|
A: 常见原因:
|
||||||
|
- `table_name` 用了 table_id 而不是表名(必须用表名称,如「订单表」)
|
||||||
|
- `series` 和 `count_all` 同时存在(必须二选一,互斥)
|
||||||
|
- 字段名拼写错误(必须用 `+field-list` 获取的真实字段名,禁止猜测)
|
||||||
|
- 组件创建并发执行(必须串行,等上一个完成再执行下一个)
|
||||||
|
|
||||||
|
**Q: 可以一次创建多个组件吗?**
|
||||||
|
A: 不可以,必须串行执行。等上一个 `+dashboard-block-create` 完成后再执行下一个。
|
||||||
|
|
||||||
|
**Q: 组件的 `type` 创建后能改吗?**
|
||||||
|
A: 不能。`+dashboard-block-update` 只能修改 `name` 和 `data_config`,不能修改 `type`。
|
||||||
|
|
||||||
|
**Q: 更新组件的命令和 data_config 怎么写?**
|
||||||
|
A:
|
||||||
|
1. 先读取当前 block,确认 `block_id`、当前 `type` 和已有 `data_config`
|
||||||
|
2. 再读 [dashboard-block-data-config.md](dashboard-block-data-config.md) 了解 data_config 结构
|
||||||
|
|
||||||
|
**data_config 更新策略(顶层 key merge)**:
|
||||||
|
- 只传入需要修改的顶层字段(如 `series`、`filter`)
|
||||||
|
- 未传的顶层字段(如 `group_by`)自动保留原值
|
||||||
|
- 但每个传入的字段内部是**全量替换**(如传新 `filter` 会完整覆盖旧 `filter`)
|
||||||
|
|
||||||
|
**Q: 查看已有组件有什么用?**
|
||||||
|
A: 在「添加新组件」或「编辑组件」前查看已有组件可以:
|
||||||
|
- 了解当前仪表盘已有哪些可视化
|
||||||
|
- 避免重复创建相似的组件
|
||||||
|
- 参考已有组件的 data_config 结构作为模板
|
||||||
|
|
||||||
|
**Q: 我想直接拿图表算好的结果给 AI 分析,应该用什么?**
|
||||||
|
A: 用 `+dashboard-block-get-data`。它返回图表协议 JSON(常见字段包括 `dimensions`、`measures`、`main_data`,指标卡可能还有 `comparison_data`、`trend_data`),不返回 block 名称、类型、布局或 `data_config`;需要这些元数据时先用 `+dashboard-block-get`。
|
||||||
|
|
||||||
|
## 写入前检查
|
||||||
|
|
||||||
|
- 创建 block 前必须知道 `base_token`、`dashboard_id`、组件 `name/type` 和 `data_config`。
|
||||||
|
- 更新 block 前必须知道 `base_token`、`dashboard_id`、`block_id`,并读过当前 block。
|
||||||
|
- `data_config` 中使用表名和字段名,不使用 table_id / field_id;名称必须来自 `+table-list` / `+field-list` 的真实返回。
|
||||||
@ -0,0 +1,210 @@
|
|||||||
|
# Base data analysis SOP
|
||||||
|
|
||||||
|
Base 数据查询与分析任务的执行契约。覆盖记录读取、筛选、排序、Top/Bottom N、聚合统计、分组聚合、多表关联、临时分析和查询后写入前的目标定位。
|
||||||
|
|
||||||
|
本文只管查询选路和正确性边界;具体操作前先读真实结构和现状,复杂 JSON 再跳到 reference:
|
||||||
|
|
||||||
|
- `+data-query`: entry guide [lark-base-data-query-guide.md](lark-base-data-query-guide.md), full DSL SSOT [lark-base-data-query.md](lark-base-data-query.md)
|
||||||
|
- 视图筛选: [lark-base-view-set-filter.md](lark-base-view-set-filter.md)
|
||||||
|
- 记录读取: `+record-list` / `+record-search` / `+record-get`,先确认字段 ID、字段名、分页和投影范围
|
||||||
|
|
||||||
|
## 0. Hard Rules
|
||||||
|
|
||||||
|
- 全局问题不能用默认 `+record-list --limit N` 片面地回答。
|
||||||
|
- `jq` / shell / 本地代码是在个人电脑或当前运行环境中处理已返回数据,只适合小范围结果;超过 200 行默认不推荐本地统计、排序或求极值,应改用 Base 云端查询服务的 filter/sort/aggregate。
|
||||||
|
- “最高、最低、最新、最早、Top、Bottom、总数、全部、异常、最大、最小、最多、最少、优先级最高”等全局语义,必须在 Base 云端查询服务中完成筛选、排序或聚合。
|
||||||
|
- 一次性原始记录查询优先用 `+record-list` / `+record-search` 的 filter/sort;聚合分析优先用 `+data-query`。
|
||||||
|
- `+record-search` 用于关键词检索字段的展示文本;金额、状态、日期、空值、关联等结构化条件继续用 `--filter-json` 表达。
|
||||||
|
- 不要依赖已有视图,除非用户明确指定该视图,或你已读取并验证其 filter/sort/projection 符合当前问题。
|
||||||
|
- 交付输出必须使用用户可读的真实字段值;内部 ID、`record_id`、关联记录 ID、open_id、编码字段只可作为连接键或定位键,不能替代最终输出,除非用户明确要求输出这些键值。
|
||||||
|
- 每次读取必须做最小投影,并包含后续解释、回查或写入需要的业务 key。
|
||||||
|
|
||||||
|
## 1. Intent -> Tool Path
|
||||||
|
|
||||||
|
| 用户意图 | 首选路径 | 关键规则 |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| 看几条、预览、示例 | `+record-list --limit N --field-id ...` | 保持局部语义;不要推广为全局结论 |
|
||||||
|
| 已知 `record_id` | `+record-get` | 直接读取;不要 search/list 反查 |
|
||||||
|
| 明确关键词 | `+record-search --keyword ... --search-field ... --field-id ...` | 必须显式指定 `--search-field`;可叠加 `--filter-json` |
|
||||||
|
| 按条件找原始记录 | `+record-list --filter-json ...` | `filter-json` 与视图筛选结构一致,支持文本、数字、日期、选项、人员、群组、关联等值 |
|
||||||
|
| 排序 / TopN 原始记录 | `+record-list --filter-json ... --sort-json ... --limit N` | 最高/最新用 `desc:true`,最低/最早用 `desc:false`;数组顺序表达优先级;最多 10 个排序条件 |
|
||||||
|
| 聚合 / 分组 / 分组排序 | `+data-query` | 使用 filters/dimensions/measures/sort/limit |
|
||||||
|
| 聚合后输出逐条记录 | `+data-query` 得到业务 key 或候选字段组合 -> `+record-list --filter-json` / `+record-get` 回查 | `+data-query` 维度行按字段组合去重且不返回 `record_id` |
|
||||||
|
| 多表 / 多跳关联 | 以候选数最小的事实表为驱动表,沿业务 key 或 link `record_id` 逐跳回查 | 读出 link 单元格里的关联 `record_id` 后,到被关联表批量 `+record-get` 展示字段 |
|
||||||
|
| 查询后写入 / 视图化 | 先用本 SOP 得到可复核的目标记录 id 集合 | 再进入记录写入或视图配置;高价值可复用查询可沉淀为持久视图 |
|
||||||
|
|
||||||
|
## 2. Execution Patterns
|
||||||
|
|
||||||
|
### 2.1 结构化原始记录与 TopN
|
||||||
|
|
||||||
|
使用 `+record-list` 的 filter/sort 路径:
|
||||||
|
|
||||||
|
1. `+field-list` 确认筛选字段、排序字段、展示字段、业务 key。
|
||||||
|
2. 筛选只用 `--filter-json` 或 `--filter-json @file`。
|
||||||
|
3. 排序用 `--sort-json`。
|
||||||
|
4. `--field-id` 做最小投影,`--limit` 控制返回数量。
|
||||||
|
|
||||||
|
Example: string/number 条件 + TopN:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-list \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--filter-json '{"logic":"and","conditions":[["Title","==","Launch plan"],["Score",">=",80]]}' \
|
||||||
|
--sort-json '[{"field":"Updated","desc":true}]' \
|
||||||
|
--field-id Name \
|
||||||
|
--field-id Title \
|
||||||
|
--field-id Score \
|
||||||
|
--limit 20
|
||||||
|
```
|
||||||
|
|
||||||
|
Example: 复杂筛选从文件读取:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-list \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--filter-json @filter.json \
|
||||||
|
--sort-json '[{"field":"Priority","desc":true}]' \
|
||||||
|
--field-id Name \
|
||||||
|
--field-id Tags \
|
||||||
|
--limit 50
|
||||||
|
```
|
||||||
|
|
||||||
|
`filter-json` 与视图筛选结构一致。下面只列常用 fewshot;字段类型、operator、value 形状拿不准,或需要人员、群组、关联、空值、地理位置、formula / lookup 等完整筛选时,先读 [lark-base-view-set-filter.md](lark-base-view-set-filter.md),再把同样的 filter JSON 传给 `--filter-json`。
|
||||||
|
|
||||||
|
文本 `==`:字段值等于目标文本。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Title","==","Launch plan"]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
文本包含 / like:文本字段包含目标片段;operator 写 `intersects`。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Title","intersects","urgent"]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
数字 `==`:字段值等于目标数字。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Score","==",95]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
日期 `==`:字段值等于目标日期;datetime / created_at / updated_at 用 `ExactDate(...)`。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Due Date","==","ExactDate(2026-06-02)"]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
选项 `==`:字段值匹配单个选项;选项值使用选项名数组,单个选项也写数组。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Priority","==",["P0"]]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
选项 `intersects`:字段值与给定选项集合有交集,常用于多选或“命中任一选项”。
|
||||||
|
```json
|
||||||
|
{"logic":"and","conditions":[["Tags","intersects",["P0","Blocked"]]]}
|
||||||
|
```
|
||||||
|
|
||||||
|
`--sort-json` 传排序数组,数组顺序就是优先级,`desc:true` 为降序,`desc:false` 为升序,最多 10 个排序条件。
|
||||||
|
|
||||||
|
### 2.2 关键词检索后叠加结构化条件
|
||||||
|
|
||||||
|
使用 `+record-search` 做关键词命中,结构化条件仍用 `--filter-json` 下推:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-search \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--keyword Alice \
|
||||||
|
--search-field Name \
|
||||||
|
--filter-json '{"logic":"and","conditions":[["Status","!=","Done"]]}' \
|
||||||
|
--sort-json '[{"field":"Updated","desc":true}]' \
|
||||||
|
--field-id Name \
|
||||||
|
--field-id Status \
|
||||||
|
--limit 20
|
||||||
|
```
|
||||||
|
|
||||||
|
不要把 `+record-search` 当成金额、状态、日期、空值、关联字段的结构化筛选入口;这些条件继续写成 `--filter-json`。
|
||||||
|
|
||||||
|
### 2.3 聚合分析与 TopN
|
||||||
|
|
||||||
|
使用 `+data-query`:
|
||||||
|
|
||||||
|
- 让 Base 云端查询服务完成 filters、dimensions、measures、sort、pagination.limit。
|
||||||
|
- `pagination.limit` 是 Base 云端查询服务中的结果限制,不是本地分页扫描。
|
||||||
|
- 常用聚合 fewshot 先读 [lark-base-data-query-guide.md](lark-base-data-query-guide.md);字段类型、日期 value、DSL shape 以 [lark-base-data-query.md](lark-base-data-query.md) 为准。
|
||||||
|
- `+data-query` 可返回聚合结果或维度字段行;维度字段行按字段组合去重且不返回 `record_id`,不能当逐条原始记录结果使用。
|
||||||
|
- 需要输出逐条记录、记录定位或完整行级字段时,先用 `+data-query` 得到业务 key、分组值或候选字段组合,再用 `+record-list --filter-json` / `+record-get` 回查。
|
||||||
|
|
||||||
|
Example: 分组计数:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Status","alias":"status"}],"measures":[{"field_name":"Status","aggregation":"count","alias":"count"}],"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Example: 过滤后汇总并取 TopN:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Owner","alias":"owner"}],"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"filters":{"type":1,"conjunction":"and","conditions":[{"field_name":"Status","operator":"is","value":["Done"]}]},"sort":[{"field_name":"total_amount","order":"desc"}],"pagination":{"limit":10},"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2.4 视图化与复用
|
||||||
|
|
||||||
|
一次性查询先用 `+record-list` / `+record-search` 的 filter/sort 验证。需要用户长期打开、共享或复用时,再把同一套 filter/sort 沉淀为视图。
|
||||||
|
|
||||||
|
Example: 将已验证的筛选排序写入视图:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +view-set-filter \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--view-id <view_id> \
|
||||||
|
--json @filter.json
|
||||||
|
|
||||||
|
lark-cli base +view-set-sort \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--view-id <view_id> \
|
||||||
|
--json '{"sort_config":[{"field":"Priority","desc":true}]}'
|
||||||
|
```
|
||||||
|
|
||||||
|
手动配置和视图配置的优先级:
|
||||||
|
|
||||||
|
1. `--filter-json` 覆盖 `--view-id` 保存的 view filter JSON。
|
||||||
|
2. `--sort-json` 覆盖 `--view-id` 保存的 view sort config。
|
||||||
|
3. 没有手动 filter/sort 时,`--view-id` 使用视图自身保存的 filter/sort。
|
||||||
|
|
||||||
|
### 2.5 关系查询与回查
|
||||||
|
|
||||||
|
- link 单元格通常是关联表 `record_id` 数组,不是用户可读内容,只是连接键。
|
||||||
|
- 先用 `+field-list` 确认 link 字段的 `link_table`、业务唯一键和展示字段。
|
||||||
|
- 从驱动表拿到候选记录后,用关联 `record_id` 到关联表 `+record-get` 批量读取记录内容。
|
||||||
|
- 多跳关系逐跳建立 `record_id/key -> 用户可读字段` 映射;最终用户可读的信息。
|
||||||
|
|
||||||
|
禁止:
|
||||||
|
|
||||||
|
- 把 link `record_id` 当最终输出。
|
||||||
|
- 用 `+record-search` 搜 link `record_id`。
|
||||||
|
- 基于 ID、自增编号、link 值做语义猜测;禁止依赖字段先验、样本记忆补全交付输出。
|
||||||
|
|
||||||
|
## 3. Range & Pagination Contract
|
||||||
|
|
||||||
|
- `+record-list` 默认页、固定 `--limit`、本地 `jq`、shell 管道、手工浏览输出,都只覆盖已读取范围;超过 200 行不要把本地处理当作推荐路径。
|
||||||
|
- `has_more=true`、存在下一页 offset/page token、或返回行数等于 page size,都表示可能还有未读取数据。
|
||||||
|
- 对全局问题,只有 Base 云端查询服务已经通过 filter/sort/aggregate 收敛目标范围,或 `+data-query` 已在云端完成聚合、排序和限制时,才可以用有限返回形成结论。
|
||||||
|
- 必须全量导出时,按 `+record-list` 分页语义串行翻页;不要并发调用 `+record-list`。
|
||||||
|
|
||||||
|
## 4. Final Answer Check
|
||||||
|
|
||||||
|
形成交付输出前必须能确认:
|
||||||
|
|
||||||
|
- 问题范围是局部样例、单点定位、全局原始记录、聚合分析、多表关联,还是查询后写入。
|
||||||
|
- 筛选、排序、聚合是否发生在 Base 云端查询服务中,而不是本地 `jq` / shell 中。
|
||||||
|
- 如果使用 `jq` / shell,本地输入是否是 200 行以内的小范围结果;超过 200 行是否已改用 Base 云端查询服务查询。
|
||||||
|
- 如果使用 `+record-list` / `+record-search`,是否处理了 `has_more`,且投影包含业务 key 和解释字段。
|
||||||
|
- 如果涉及关系查询,是否按 `record_id` 或业务 key 精确回查,交付输出是否来自关联表真实字段。
|
||||||
|
- 交付输出能追溯到表、字段、筛选条件、排序/聚合条件和连接键。
|
||||||
|
|
||||||
|
任一项无法确认时,继续查询或明确说明只能得到局部结论。
|
||||||
@ -0,0 +1,61 @@
|
|||||||
|
# Base data-query guide
|
||||||
|
|
||||||
|
This guide is the entry point for `+data-query`. Use it for common aggregation fewshots and command selection. For the complete DSL fields, operators, limits, and response details, use [lark-base-data-query.md](lark-base-data-query.md) as the DSL SSOT.
|
||||||
|
|
||||||
|
Before using `+data-query`, also follow [lark-base-data-analysis-sop.md](lark-base-data-analysis-sop.md) to confirm that the task really needs aggregation instead of record listing or a temporary view.
|
||||||
|
|
||||||
|
## When to use
|
||||||
|
|
||||||
|
Use `+data-query` when the user asks for server-side:
|
||||||
|
|
||||||
|
- group by / aggregation
|
||||||
|
- sum, average, min, max, count, distinct count
|
||||||
|
- filtered aggregation
|
||||||
|
- sorted Top N or Bottom N
|
||||||
|
- global statistical conclusions
|
||||||
|
|
||||||
|
`+data-query` can return dimension field rows, but those rows are grouped by dimension values and do not include `record_id`. Use `+record-list`, `+record-search`, or `+record-get` for row-level output, record identity, or full raw record details.
|
||||||
|
|
||||||
|
## Common Fewshots
|
||||||
|
|
||||||
|
Count records by a category field:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Status","alias":"status"}],"measures":[{"field_name":"Status","aggregation":"count","alias":"count"}],"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Sum a number field by category and return Top 10:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Region","alias":"region"}],"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"sort":[{"field_name":"total_amount","order":"desc"}],"pagination":{"limit":10},"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Aggregate only records matching a filter:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableId":"<table_id>"}},"dimensions":[{"field_name":"Owner","alias":"owner"}],"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"filters":{"type":1,"conjunction":"and","conditions":[{"field_name":"Status","operator":"is","value":["Done"]}]},"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `tableName` when the table ID is unavailable but the table name is known:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--dsl '{"datasource":{"type":"table","table":{"tableName":"Orders"}},"measures":[{"field_name":"Amount","aggregation":"sum","alias":"total_amount"}],"shaper":{"format":"flat"}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## Routing to the DSL SSOT
|
||||||
|
|
||||||
|
Read [lark-base-data-query.md](lark-base-data-query.md) when you need:
|
||||||
|
|
||||||
|
- the full DSL field reference
|
||||||
|
- supported aggregations and field types
|
||||||
|
- filter operator details
|
||||||
|
- pagination and result limits
|
||||||
|
- response shape and error recovery
|
||||||
454
.agents/skills/lark-base/references/lark-base-data-query.md
Normal file
454
.agents/skills/lark-base/references/lark-base-data-query.md
Normal file
@ -0,0 +1,454 @@
|
|||||||
|
|
||||||
|
# Base data-query DSL SSOT
|
||||||
|
|
||||||
|
> **入口指南**: [lark-base-data-query-guide.md](lark-base-data-query-guide.md) | **前置条件**: 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
本文档是 `+data-query` JSON DSL 的单一事实来源(SSOT),用于说明完整字段、操作符、限制、返回和错误恢复。常用 fewshot 与命令选择先读 [lark-base-data-query-guide.md](lark-base-data-query-guide.md)。
|
||||||
|
|
||||||
|
查询类任务还必须先遵守 [`lark-base-data-analysis-sop.md`](lark-base-data-analysis-sop.md)。`+data-query` 适合让筛选、分组、聚合、排序和 TopN 在 Base 云端查询服务中执行;不要用默认分页的 `+record-list` 或本地 `jq` 替代聚合查询。
|
||||||
|
|
||||||
|
## 限制
|
||||||
|
|
||||||
|
- **权限要求**(按文档类型分流):
|
||||||
|
- **普通多维表格**:调用者拥有文档的**阅读权限**即可
|
||||||
|
- **高级权限多维表格**:调用者必须是文档管理员,拥有 **FA(Full Access / 完全访问权限)**
|
||||||
|
|
||||||
|
权限不足时返回权限错误。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 按字段分组计数
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token MAGObxxxxx \
|
||||||
|
--dsl '{
|
||||||
|
"datasource": {"type": "table", "table": {"tableId": "tblxxxxxxxx"}},
|
||||||
|
"dimensions": [{"field_name": "城市", "alias": "dim_city"}],
|
||||||
|
"measures": [{"field_name": "城市", "aggregation": "count", "alias": "count"}],
|
||||||
|
"shaper": {"format": "flat"}
|
||||||
|
}'
|
||||||
|
|
||||||
|
# 带过滤条件 + 排序 + 限制条数
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token MAGObxxxxx \
|
||||||
|
--dsl '{
|
||||||
|
"datasource": {"type": "table", "table": {"tableId": "tblxxxxxxxx"}},
|
||||||
|
"dimensions": [{"field_name": "城市", "alias": "dim_city"}],
|
||||||
|
"measures": [{"field_name": "金额", "aggregation": "sum", "alias": "total_amount"}],
|
||||||
|
"filters": {
|
||||||
|
"type": 1,
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [{"field_name": "城市", "operator": "isNot", "value": [""]}]
|
||||||
|
},
|
||||||
|
"sort": [{"field_name": "total_amount", "order": "desc"}],
|
||||||
|
"pagination": {"limit": 100},
|
||||||
|
"shaper": {"format": "flat"}
|
||||||
|
}'
|
||||||
|
|
||||||
|
# 使用 tableName(表名)代替 tableId
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token MAGObxxxxx \
|
||||||
|
--dsl '{
|
||||||
|
"datasource": {"type": "table", "table": {"tableName": "销售数据"}},
|
||||||
|
"measures": [{"field_name": "金额", "aggregation": "sum", "alias": "total"}],
|
||||||
|
"shaper": {"format": "flat"}
|
||||||
|
}'
|
||||||
|
|
||||||
|
# 聚合或维度查询后如需读取逐条记录,先让 data-query 返回可回查的业务 key
|
||||||
|
lark-cli base +data-query \
|
||||||
|
--base-token MAGObxxxxx \
|
||||||
|
--dsl '{
|
||||||
|
"datasource": {"type": "table", "table": {"tableId": "tblxxxxxxxx"}},
|
||||||
|
"dimensions": [{"field_name": "业务编号", "alias": "biz_key"}],
|
||||||
|
"measures": [{"field_name": "指标值", "aggregation": "max", "alias": "max_value"}],
|
||||||
|
"filters": {
|
||||||
|
"type": 1,
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [{"field_name": "状态", "operator": "is", "value": ["有效"]}]
|
||||||
|
},
|
||||||
|
"sort": [{"field_name": "max_value", "order": "desc"}],
|
||||||
|
"pagination": {"limit": 10},
|
||||||
|
"shaper": {"format": "flat"}
|
||||||
|
}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------------------------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token(base_token) |
|
||||||
|
| `--dsl <json>` | 是 | LiteQuery Protocol JSON DSL 查询语句 |
|
||||||
|
|
||||||
|
## 如何从链接中提取参数
|
||||||
|
|
||||||
|
用户通常会提供如下 URL:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://example.feishu.cn/base/<base_token>?table=<table_id>
|
||||||
|
```
|
||||||
|
|
||||||
|
- `--base-token`:取 `/base/` 后面的字符串
|
||||||
|
- DSL 中的 `tableId`:取 `table=` 后面的值
|
||||||
|
|
||||||
|
## API 入参详情
|
||||||
|
|
||||||
|
**HTTP 方法和路径:**
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /open-apis/base/v3/bases/:base_token/data/query
|
||||||
|
```
|
||||||
|
|
||||||
|
**Path 参数:**
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `base_token` | 是 | Base Token |
|
||||||
|
|
||||||
|
**Request Body — DSL 结构:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `datasource` | object | 是 | 数据源,包含 `type`(固定 `"table"`)和 `table` 对象 |
|
||||||
|
| `datasource.table.tableId` | string | 二选一 | 目标数据表 ID |
|
||||||
|
| `datasource.table.tableName` | string | 二选一 | 目标数据表名称 |
|
||||||
|
| `dimensions` | Dimension[] | 否* | 分组维度字段(GROUP BY) |
|
||||||
|
| `measures` | Measure[] | 否* | 聚合度量字段 |
|
||||||
|
| `filters` | FilterGroup | 否 | 过滤条件(WHERE) |
|
||||||
|
| `sort` | Sort[] | 否 | 排序规则 |
|
||||||
|
| `pagination` | object | 否 | 限制返回行数,`{limit: N}`,最大 5000 |
|
||||||
|
| `shaper` | object | 否 | 结果格式,固定 `{format: "flat"}` |
|
||||||
|
|
||||||
|
> \* `dimensions` 和 `measures` 至少填写一个。
|
||||||
|
|
||||||
|
**Dimension 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `field_name` | string | 是 | 字段名称 |
|
||||||
|
| `alias` | string | 否 | 输出列别名,需全局唯一 |
|
||||||
|
|
||||||
|
**Measure 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `field_name` | string | 是 | 字段名称 |
|
||||||
|
| `aggregation` | string | 是 | 聚合函数:`sum`、`avg`、`min`、`max`、`count`、`count_all`、`distinct_count` |
|
||||||
|
| `alias` | string | 否 | 输出列别名,需全局唯一 |
|
||||||
|
|
||||||
|
**聚合函数适用字段类型:**
|
||||||
|
|
||||||
|
| 聚合函数 | 适用字段类型 |
|
||||||
|
|----------|-------------|
|
||||||
|
| `sum` / `avg` | `number` |
|
||||||
|
| `min` / `max` | `number`、`datetime` |
|
||||||
|
| `count` | 全字段适用,计数非空值 |
|
||||||
|
| `count_all` | 全字段适用,计数所有行 |
|
||||||
|
| `distinct_count` | 全字段适用 |
|
||||||
|
|
||||||
|
> `number` 包含 `style.type` 为 `progress` / `currency` / `rating` 等所有子类型。
|
||||||
|
|
||||||
|
**FilterGroup:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"filters": {
|
||||||
|
"type": 1,
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{"field_name": "城市", "operator": "is", "value": ["北京"]}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `type` | int | 是 | 固定填 `1` |
|
||||||
|
| `conjunction` | string | 否 | 条件组合逻辑:`"and"` 或 `"or"`,默认 `"and"` |
|
||||||
|
| `conditions` | Condition[] | 否 | 条件列表 |
|
||||||
|
|
||||||
|
**Condition:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `field_name` | string | 是 | 字段名称(必须与表中字段名精确匹配) |
|
||||||
|
| `operator` | string | 是 | 运算符(见下方运算符表) |
|
||||||
|
| `value` | string[] | 是 | 条件值数组;`isEmpty`/`isNotEmpty` 时**必须**传空数组 `[]` |
|
||||||
|
|
||||||
|
**运算符:**
|
||||||
|
|
||||||
|
| 运算符 | 说明 |
|
||||||
|
|--------|------|
|
||||||
|
| `is` | 等于 |
|
||||||
|
| `isNot` | 不等于 |
|
||||||
|
| `contains` | 包含 |
|
||||||
|
| `doesNotContain` | 不包含 |
|
||||||
|
| `isEmpty` | 为空 |
|
||||||
|
| `isNotEmpty` | 不为空 |
|
||||||
|
| `isGreater` | 大于 |
|
||||||
|
| `isGreaterEqual` | 大于等于 |
|
||||||
|
| `isLess` | 小于 |
|
||||||
|
| `isLessEqual` | 小于等于 |
|
||||||
|
|
||||||
|
> 各运算符的适用字段类型见下方「按各字段类型筛选时 value 格式详解」。
|
||||||
|
|
||||||
|
**按各字段类型筛选时 value 格式详解:**
|
||||||
|
|
||||||
|
*`text`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` / `contains` / `doesNotContain` | `["文本内容"]` | 仅 1 个 | `["Hello"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:文本无自然顺序,比较运算无意义。
|
||||||
|
> `text` 也覆盖电话、超链接、邮箱、条码字段;通过 `style.type` 区分(`plain`(默认)/ `phone` / `url` / `email` / `barcode`),运算符集合一致。
|
||||||
|
> 当 `style.type=url` 时,value 筛选的是链接显示名称,而不是 URL 本身。
|
||||||
|
|
||||||
|
*`number`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` / `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual` | `["数字字符串"]` | 仅 1 个 | `["23.4"]`、`["-100"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> value 必须为合法数字的字符串形式。
|
||||||
|
> `number` 也覆盖货币、进度、评分字段;通过 `style.type` 区分(`plain`(默认)/ `currency` / `progress` / `rating`),运算符集合一致,仅 value 解释不同:
|
||||||
|
> - 当 `style.type=progress` 时,34% 对应 0.34 而不是 34。
|
||||||
|
> - 当 `style.type=rating` 时,必须输入整数,代表评分。
|
||||||
|
|
||||||
|
*`auto_number`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` / `contains` / `doesNotContain` | `["编号字符串"]` | 仅 1 个 | `["00001"]` |
|
||||||
|
| `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual` | `["编号字符串"]` | 仅 1 个 | `["00010"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
*`select`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` | `["选项名"]` | **仅 1 个** | `["选项A"]` |
|
||||||
|
| `contains` / `doesNotContain` | `["选项A", "选项B"]` | 可多个 | `["选项A", "选项B"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:选项为枚举值,无自然顺序。
|
||||||
|
> 通过 `multiple` 区分单选(`multiple=false`,默认)/ 多选(`multiple=true`)。
|
||||||
|
|
||||||
|
*`user` / `created_by` / `updated_by`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------------------------|
|
||||||
|
| `is` / `isNot` | `["用户ID1", "用户ID2"]` | **可多个** | `["ou_aaa", "ou_bbb"]` |
|
||||||
|
| `contains` / `doesNotContain` | `["用户ID1", "用户ID2"]` | 可多个 | `["ou_aaa", "ou_bbb"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:人员无法比大小。
|
||||||
|
> 用户 ID 使用 `open_id`(`ou_` 前缀),接口层会自动做 ID 转换。
|
||||||
|
|
||||||
|
*`group_chat`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` | `["群组ID1", "群组ID2"]` | 可多个 | `["oc_aaa", "oc_bbb"]` |
|
||||||
|
| `contains` / `doesNotContain` | `["群组ID1", "群组ID2"]` | 可多个 | `["oc_aaa", "oc_bbb"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:群组无法比大小。
|
||||||
|
|
||||||
|
*`link`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` | `["recId1", "recId2"]` | 可多个 | `["recAAA", "recBBB"]` |
|
||||||
|
| `contains` / `doesNotContain` | `["recId1", "recId2"]` | 可多个 | `["recAAA", "recBBB"]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:关联记录无法比大小。
|
||||||
|
> value 传关联表记录的 `record_id`。
|
||||||
|
> 双向关联(创建时设 `bidirectional=true`)也属于 `link` 类型,运算符与单向关联一致。
|
||||||
|
|
||||||
|
*`location`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` / `isNot` / `contains` / `doesNotContain` | `["地址文本"]` | 仅 1 个 | `["北京市朝阳区..."]` |
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> **不支持** `isGreater` / `isGreaterEqual` / `isLess` / `isLessEqual`:地理位置无自然顺序。
|
||||||
|
> location 按 `full_address` 字符串筛选,不支持经纬度空间筛选;查城市/片区时优先用 `contains`,避免用 `is` 匹配短地址词。
|
||||||
|
|
||||||
|
*`checkbox`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `is` | `["true"]` 或 `["false"]` | 仅 1 个 | `["true"]` |
|
||||||
|
|
||||||
|
> 仅支持 `is` 运算符,不支持其他运算符。
|
||||||
|
|
||||||
|
*`datetime` / `created_at` / `updated_at`*
|
||||||
|
|
||||||
|
日期字段仅支持 `is`、`isEmpty`、`isNotEmpty`、`isGreater`、`isLess` 五种运算符。
|
||||||
|
|
||||||
|
value 使用预定义关键字机制,第一个元素为字符串常量名称:
|
||||||
|
|
||||||
|
| 关键字 | 说明 | value 格式 | 支持的运算符 |
|
||||||
|
|--------|------|-----------|-------------|
|
||||||
|
| `ExactDate` | 精确日期 | `["ExactDate", "1773187200000"]`(毫秒时间戳) | `is`、`isGreater`、`isLess` |
|
||||||
|
| `Today` | 今天 | `["Today"]` | `is`、`isGreater`、`isLess` |
|
||||||
|
| `Tomorrow` | 明天 | `["Tomorrow"]` | `is`、`isGreater`、`isLess` |
|
||||||
|
| `Yesterday` | 昨天 | `["Yesterday"]` | `is`、`isGreater`、`isLess` |
|
||||||
|
| `CurrentWeek` | 本周 | `["CurrentWeek"]` | 仅 `is` |
|
||||||
|
| `LastWeek` | 上周 | `["LastWeek"]` | 仅 `is` |
|
||||||
|
| `CurrentMonth` | 本月 | `["CurrentMonth"]` | 仅 `is` |
|
||||||
|
| `LastMonth` | 上月 | `["LastMonth"]` | 仅 `is` |
|
||||||
|
| `TheLastWeek` | 过去七天 | `["TheLastWeek"]` | 仅 `is` |
|
||||||
|
| `TheNextWeek` | 未来七天 | `["TheNextWeek"]` | 仅 `is` |
|
||||||
|
| `TheLastMonth` | 过去三十天 | `["TheLastMonth"]` | 仅 `is` |
|
||||||
|
| `TheNextMonth` | 未来三十天 | `["TheNextMonth"]` | 仅 `is` |
|
||||||
|
|
||||||
|
> - **ExactDate 时区行为**:毫秒时间戳在实际筛选时会被转为**文档时区当天零点**,跨时区场景需注意日期可能偏移一天。
|
||||||
|
> - **范围型关键字**(`CurrentWeek`、`LastWeek`、`CurrentMonth`、`LastMonth`、`TheLastWeek`、`TheNextWeek`、`TheLastMonth`、`TheNextMonth`)仅支持 `is` 运算符。
|
||||||
|
> - **关键字大小写敏感**:`ExactDate`、`Today`、`CurrentWeek` 等首字母大写,写错大小写会导致校验失败。
|
||||||
|
|
||||||
|
*`attachment`*
|
||||||
|
|
||||||
|
| 运算符 | value 格式 | 元素个数 | 示例 |
|
||||||
|
|--------|-----------|---------|------|
|
||||||
|
| `isEmpty` / `isNotEmpty` | `[]` | 0 个 | `[]` |
|
||||||
|
|
||||||
|
> 附件字段仅支持 `isEmpty` 和 `isNotEmpty`,不支持其他运算符。
|
||||||
|
|
||||||
|
*`formula` / `lookup`*
|
||||||
|
|
||||||
|
公式和查找引用字段的运算符和 value 格式 **取决于其结果数据类型**,按结果类型参照上方对应字段类型的规则。例如:
|
||||||
|
|
||||||
|
- 公式结果为数字 → 按 `number` 规则
|
||||||
|
- 公式结果为日期 → 按 `datetime` 规则
|
||||||
|
- 公式结果为单选 → 按 `select` 规则
|
||||||
|
|
||||||
|
**Sort 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `field_name` | string | 是 | 字段名称或 alias |
|
||||||
|
| `order` | string | 否 | `"asc"`(默认)或 `"desc"` |
|
||||||
|
|
||||||
|
**Pagination 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `limit` | int | 否 | 返回记录数上限,必须为正整数,最大 5000;不填时使用系统默认值。不支持 offset |
|
||||||
|
|
||||||
|
**Shaper 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `format` | string | 是 | 固定为 `"flat"`,表示返回扁平化的对象数组 |
|
||||||
|
|
||||||
|
## CLI 出参详情
|
||||||
|
|
||||||
|
CLI 输出标准信封 `{ok, identity, data}`(失败时为 `{ok:false, identity, error}`)。
|
||||||
|
|
||||||
|
**成功时:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"ok": true, "identity": "user", "data": {"main_data": [{"dim_city": {"value": "北京"}, "total_amount": {"value": 12345.00}}, ...]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
**失败时:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"ok": false, "identity": "user", "error": {"type": "api", "subtype": "unknown", "code": 800004006, "message": "...does not exist in table schema", "hint": "...", "log_id": "..."}}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response 字段:**
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `ok` | bool | 是否成功 |
|
||||||
|
| `identity` | string | 执行身份:`user` / `bot` |
|
||||||
|
| `data.main_data` | []object | 查询结果数组,每个元素为一行数据(成功时) |
|
||||||
|
| `error` | object | 失败时的 typed 错误,含 `type` / `subtype` / `code` / `message` / `hint` / `log_id` |
|
||||||
|
|
||||||
|
每行数据的字段值封装在 CellValue 中:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dim_city": {
|
||||||
|
"value": "北京"
|
||||||
|
},
|
||||||
|
"total_amount": {
|
||||||
|
"value": 12345.00
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `value`:展示值(人员名称、选项名称、格式化日期等)
|
||||||
|
|
||||||
|
## 返回值
|
||||||
|
|
||||||
|
命令成功后输出 `data` 字段的内容:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"main_data": [
|
||||||
|
{
|
||||||
|
"dim_city": {"value": "直营"},
|
||||||
|
"measure_count": {"value": 1}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dim_city": {"value": "加盟"},
|
||||||
|
"measure_count": {"value": 2}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
1. 确认 base-token 和 table-id
|
||||||
|
2. **先查表结构**:执行 `lark-cli base +field-list --base-token <base_token> --table-id <table_id>`
|
||||||
|
3. 从返回的字段列表中获取 field_name(DSL 中使用的字段名称)
|
||||||
|
4. 根据字段信息构造 DSL JSON
|
||||||
|
5. 执行 +data-query
|
||||||
|
6. 解读返回结果:
|
||||||
|
- 结果在 `data.main_data` 数组中,每个元素代表一行
|
||||||
|
- 每行对象的 key 为 DSL 中指定的 `alias`;未指定 alias 时,key 为自动生成的列名
|
||||||
|
- 每个 value 是 CellValue 对象,实际值在 `value` 字段中,如 `{"value": "北京"}` 或 `{"value": 12345.00}`
|
||||||
|
- 失败时结果在 `data.error` 中,包含具体错误码和信息
|
||||||
|
|
||||||
|
## 与记录读取组合
|
||||||
|
|
||||||
|
`+data-query` 可返回聚合结果,也可在只传 `dimensions` 时返回维度字段行;这些维度行按字段组合去重,不包含 `record_id`,不能等同于逐条原始记录。需要输出聚合结果对应的原始记录字段、展示值、记录定位信息或关联表字段时,按以下方式组合:
|
||||||
|
|
||||||
|
1. 用 `+data-query` 在 Base 云端查询服务中完成全局筛选、分组、聚合、排序和 TopN,得到业务 key、分组值或候选字段组合。
|
||||||
|
2. 如果已经拿到候选记录的 `record_id`,用 `+record-get` 读取逐条记录字段。
|
||||||
|
3. 如果拿到的是结构化业务 key(例如编号、状态、日期、金额等),用 `+record-list --filter-json` 做精确过滤后读取;不要用 `+record-search` 代替结构化条件。
|
||||||
|
4. 只有候选条件本身是文本展示值关键词时,才使用 `+record-search`,并用 `search_fields` 限定范围、`select_fields` 做投影。
|
||||||
|
5. 若候选记录包含 link 字段,提取关联 `record_id` 后到关联表用 `+record-get` 批量读取展示字段。
|
||||||
|
6. 最终回答业务字段,不要把内部 `record_id` 当作用户可读答案。
|
||||||
|
|
||||||
|
不要把 `data-query pagination.limit` 理解为分页扫描;它只限制 Base 云端查询服务返回的聚合结果行数,不支持 offset。需要全量原始记录导出时回到 data analysis SOP 的 `+record-list` 分页规则。
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- ⚠️ **必须先查表结构**:DSL 的 `field_name` 必须与表中字段名称精确匹配(区分大小写),不能凭猜测构造。先用 `lark-cli base +field-list --base-token <base_token> --table-id <table_id>` 获取真实字段名
|
||||||
|
- ⚠️ **权限要求按文档类型分流**:普通多维表格只需文档**阅读权限**;高级权限多维表格必须是文档管理员(**FA / Full Access**),否则返回权限错误
|
||||||
|
- ⚠️ **alias 不支持中文**:dimensions 和 measures 的 alias 必须使用英文(如 `dim_city`、`total_amount`),中文 alias 会导致错误
|
||||||
|
- ⚠️ **API 路径是 `base/v3`**:本接口路径为 `/open-apis/base/v3/bases/:base_token/data/query`,不是 `bitable/v1`。两者完全不同,用错版本号会返回 `[2200] Internal Error`
|
||||||
|
- ⚠️ **`dimensions` 和 `measures` 至少填一个**:两个都不填会返回 DSL 校验错误
|
||||||
|
- ⚠️ **`shaper` 必须为 `{"format": "flat"}`**:不填或填其他值会导致结果格式不可预期,建议始终显式指定
|
||||||
|
- ⚠️ **数据表标识 `tableId` vs `tableName`**:datasource 中可以用 `tableId`(如 `tblXXX`)或 `tableName`(数据表的用户自定义显示名称),二选一,不要混用
|
||||||
|
- ⚠️ **`pagination.limit` 最大 5000**:超过会报错,且不支持 offset,只支持 limit
|
||||||
|
- ⚠️ **所有 alias 必须全局唯一**:dimensions 和 measures 之间的 alias 也不能重名
|
||||||
|
- ⚠️ **不要用本地分页结果替代 data-query**:凡是全局计数、分组、聚合、排序 TopN,优先让 `+data-query` 在 Base 云端查询服务中执行;默认页 `+record-list` 后本地统计只能得到已读取范围内的结果
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base](../SKILL.md) — 多维表格全部命令
|
||||||
|
- [lark-shared](../../lark-shared/SKILL.md) — 认证和全局参数
|
||||||
|
- [lark-base-data-analysis-sop.md](lark-base-data-analysis-sop.md) — 查询范围、选路、下推、分页、`+record-list` / `+record-search` 回查和关系查询 SOP
|
||||||
|
- [lark-base-cell-value.md](lark-base-cell-value.md) — CellValue 格式规范
|
||||||
|
- [lark-base-field-json.md](lark-base-field-json.md) — 字段类型与 JSON 结构
|
||||||
109
.agents/skills/lark-base/references/lark-base-field-create.md
Normal file
109
.agents/skills/lark-base/references/lark-base-field-create.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
# base +field-create
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
创建一个字段。
|
||||||
|
|
||||||
|
## Agent 最小工作流
|
||||||
|
|
||||||
|
1. 先判断是不是 `formula` / `lookup`。
|
||||||
|
2. 如果是:先读对应 guide。
|
||||||
|
3. 没读 guide 前,不要直接创建 formula / lookup 字段。
|
||||||
|
4. 读完 guide 后,再构造 `--json` 并创建字段。
|
||||||
|
5. 如果是跨表 formula / lookup,再补查**目标表**的结构。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +field-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--json '{"name":"预算","type":"number","style":{"type":"plain","precision":2}}'
|
||||||
|
|
||||||
|
lark-cli base +field-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--json '{"name":"状态","type":"select","multiple":false,"default_value":["Todo"],"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Done","hue":"Green","lightness":"Light"}]}'
|
||||||
|
|
||||||
|
lark-cli base +field-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--json '{"name":"负责人","type":"user","multiple":false,"default_value":[{"$slot":"current_user"}],"description":"用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token |
|
||||||
|
| `--table-id <id_or_name>` | 是 | 表 ID 或表名 |
|
||||||
|
| `--json <body>` | 是 | 字段属性 JSON 对象 |
|
||||||
|
## API 入参详情
|
||||||
|
|
||||||
|
**HTTP 方法和路径:**
|
||||||
|
|
||||||
|
```
|
||||||
|
POST /open-apis/base/v3/bases/:base_token/tables/:table_id/fields
|
||||||
|
```
|
||||||
|
|
||||||
|
## JSON 值规范
|
||||||
|
|
||||||
|
- `--json` 必须是 **JSON 对象**,顶层直接传字段定义,不要再套一层。
|
||||||
|
- 顶层最少包含:`name`、`type`。
|
||||||
|
- 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接,如 `协作约定可参考[团队字段约定](https://example.com/field-spec)`。
|
||||||
|
- 需要字段默认值时传 `default_value`,直接使用字段对应 CellValue;`datetime` / `user` 的动态填充用 `$slot`。完整规则见 [lark-base-field-json.md](lark-base-field-json.md)。
|
||||||
|
- `type` 不同,必填子字段不同:
|
||||||
|
- `select`:`multiple` 控制是否多选,`options` 定义静态选项,`dynamic_options_source` 定义动态选项来源。静态与动态选项配置二选一,不能同时传。
|
||||||
|
- `link`:必须有 `link_table`,可选 `bidirectional`、`bidirectional_link_field_name`。
|
||||||
|
- `formula`:必须有 `expression`;先读 formula guide,再创建。
|
||||||
|
- `lookup`:必须有 `from`、`select`、`where`;先读 lookup guide,再创建。
|
||||||
|
|
||||||
|
**正确(base +field-create)**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "状态",
|
||||||
|
"type": "select",
|
||||||
|
"multiple": false,
|
||||||
|
"default_value": ["Todo"],
|
||||||
|
"options": [
|
||||||
|
{ "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
|
||||||
|
{ "name": "Done", "hue": "Green", "lightness": "Light" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**字段说明示例**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "负责人",
|
||||||
|
"type": "user",
|
||||||
|
"multiple": false,
|
||||||
|
"description": "用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 返回重点
|
||||||
|
|
||||||
|
- 返回 `field` 和 `created: true`。
|
||||||
|
- 如果返回 `field_get_recommended:false` 且 `next_step:"done"`,表示本次是简单字段创建,通常不需要立刻执行 `+field-get`。
|
||||||
|
- 如果返回 `field_get_recommended:true` 或 `next_step:"field_get"`,按 `verification_hint` 读回字段;`formula`、`lookup`、`link`、`auto_number` 等计算、关联或生成型字段更适合读回确认服务端最终结构。
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
|
||||||
|
1. formula / lookup 字段必须先阅读对应指南;没读之前不要直接创建。
|
||||||
|
2. 创建简单字段时,优先相信命令返回;只有用户要求精确核对额外属性,或返回建议读回时,才继续执行 `+field-get`。
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- ⚠️ 这是写入操作,执行前必须确认。
|
||||||
|
- ⚠️ 当 `type` 是 `formula` 或 `lookup` 时,先读对应 guide,再创建。
|
||||||
|
- ⚠️ 不要把“每次创建后都 `+field-get`”当作固定流程;按返回里的 `field_get_recommended` 和 `next_step` 决定是否读回。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-field-json.md](lark-base-field-json.md) — 字段 JSON 规范(推荐)
|
||||||
|
- [formula-field-guide.md](formula-field-guide.md) — formula 指南(创建公式必读)
|
||||||
|
- [lookup-field-guide.md](lookup-field-guide.md) — lookup 指南(创建查找引用必读)
|
||||||
527
.agents/skills/lark-base/references/lark-base-field-json.md
Normal file
527
.agents/skills/lark-base/references/lark-base-field-json.md
Normal file
@ -0,0 +1,527 @@
|
|||||||
|
# Base field JSON SSOT
|
||||||
|
|
||||||
|
> 适用命令:`lark-cli base +field-create`、`lark-cli base +field-update`
|
||||||
|
|
||||||
|
本文档定义 `+field-create` / `+field-update` 写字段时 `--json` 的推荐格式,是字段类型与字段 JSON 结构的 source of truth。目标不是复刻完整 schema,而是让 agent 稳定产出正确 payload。
|
||||||
|
|
||||||
|
## 1. 顶层规则(必须遵守)
|
||||||
|
|
||||||
|
- `--json` 必须是 JSON 对象。
|
||||||
|
- 顶层统一使用:`type` + `name` + 类型特有字段。
|
||||||
|
- 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接。
|
||||||
|
- 字段默认值使用 `default_value`,直接传对应 CellValue;支持范围只有 `text`、`number`、静态 `select`、`datetime`、`user`。清空默认值传 `null`;省略表示创建时不设置、更新时不修改。
|
||||||
|
- 不要使用旧结构:`field_name`、`property`、`ui_type`、数字枚举 `type`。
|
||||||
|
- `+field-update` 使用同样的字段 JSON 结构,但语义是 `PUT`;这是高风险写入操作,建议先 `+field-get` 再按目标状态全量提交,并带 `--yes`。
|
||||||
|
- `type=formula` 或 `type=lookup` 创建/更新前,必须先读对应 guide。
|
||||||
|
|
||||||
|
推荐示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "需求背景",
|
||||||
|
"description": "记录需求背景与已知约束"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 2. 字段速查
|
||||||
|
|
||||||
|
| 类型 | 最小必填字段 | 常见补充字段 |
|
||||||
|
|------|--------------|-------------|
|
||||||
|
| `text` | `type` `name` | `style.type` `default_value` |
|
||||||
|
| `number` | `type` `name` | `style` `default_value` |
|
||||||
|
| `select` | `type` `name` | `multiple` + `options` + 静态 `default_value`,或 `multiple` + `dynamic_options_source` |
|
||||||
|
| `datetime` | `type` `name` | `style.format` `default_value` |
|
||||||
|
| `created_at` / `updated_at` | `type` `name` | `style.format` |
|
||||||
|
| `user` / `group_chat` | `type` `name` | `multiple`;仅 `user` 支持 `default_value` |
|
||||||
|
| `created_by` / `updated_by` | `type` `name` | 无 |
|
||||||
|
| `link` | `type` `name` `link_table` | `bidirectional` `bidirectional_link_field_name` |
|
||||||
|
| `formula` | `type` `name` `expression` | 无 |
|
||||||
|
| `lookup` | `type` `name` `from` `select` `where` | `aggregate` |
|
||||||
|
| `auto_number` | `type` `name` | `style.rules` |
|
||||||
|
| `attachment` / `location` / `checkbox` | `type` `name` | 无 |
|
||||||
|
|
||||||
|
所有类型都可额外传 `description`;上表的“常见补充字段”只列类型特有配置。
|
||||||
|
|
||||||
|
## 3. 各类型写法
|
||||||
|
|
||||||
|
### 3.1 text
|
||||||
|
|
||||||
|
文本字段;电话、超链接、邮箱、条码也都属于 `text`,通过 `style.type` 区分。
|
||||||
|
支持 `default_value`:静态 Markdown 文本字符串;`phone` style 必须是合法电话号码;`url` style 传一个 Markdown 链接或裸 URL;`email` style 必须是合法邮箱字符串,不要传 Markdown 链接或 `mailto:`。
|
||||||
|
|
||||||
|
最小写法(默认 `style.type` 为 `plain`):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "标题",
|
||||||
|
"default_value": "默认标题"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
常用写法:
|
||||||
|
|
||||||
|
默认值可以是 Markdown 文本
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "标题",
|
||||||
|
"description": "主标题字段",
|
||||||
|
"default_value": "未命名"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`style.type=phone` 时默认值是合法电话号码字符串。
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "联系电话",
|
||||||
|
"style": { "type": "phone" },
|
||||||
|
"default_value": "+8613800000000"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "官网",
|
||||||
|
"style": { "type": "url" },
|
||||||
|
"default_value": "[官网](https://example.com)"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "text",
|
||||||
|
"name": "邮箱",
|
||||||
|
"style": { "type": "email" },
|
||||||
|
"default_value": "owner@example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
常用 `style.type`:`plain`(默认)、`phone`、`url`、`email`、`barcode`。
|
||||||
|
|
||||||
|
### 3.2 number
|
||||||
|
|
||||||
|
数字字段;货币、进度、评分都属于 `number`,通过 `style.type` 区分。
|
||||||
|
支持 `default_value`:静态 JSON number;所有 number style 都按这个规则写。
|
||||||
|
|
||||||
|
最小写法(默认 `style.type` 为 `plain`):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "number",
|
||||||
|
"name": "工时",
|
||||||
|
"default_value": 8
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`style` 是按 `type` 区分的对象;不同 `style.type` 的内部字段不一样,不要混传。
|
||||||
|
|
||||||
|
#### `plain`
|
||||||
|
|
||||||
|
支持字段:`precision`、`percentage`、`thousands_separator`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `precision` 取值 `0..4`,默认 `2`
|
||||||
|
- `percentage` 默认 `false`
|
||||||
|
- `thousands_separator` 默认 `false`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "number",
|
||||||
|
"name": "工时",
|
||||||
|
"style": {
|
||||||
|
"type": "plain",
|
||||||
|
"precision": 2,
|
||||||
|
"percentage": false,
|
||||||
|
"thousands_separator": true
|
||||||
|
},
|
||||||
|
"default_value": 8
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `currency`
|
||||||
|
|
||||||
|
支持字段:`precision`、`currency_code`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `precision` 取值 `0..4`,默认 `2`
|
||||||
|
- `currency_code` 必填,如 `CNY`、`USD`、`EUR`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "number",
|
||||||
|
"name": "预算",
|
||||||
|
"style": { "type": "currency", "precision": 2, "currency_code": "CNY" }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `progress`
|
||||||
|
|
||||||
|
支持字段:`percentage`、`color`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `percentage` 默认 `true`
|
||||||
|
- `color` 必填
|
||||||
|
- `color` 可用:`Blue`、`Purple`、`DarkGreen`、`Green`、`Cyan`、`Orange`、`Red`、`Gray`、`WhiteToBlueGradient`、`WhiteToPurpleGradient`、`WhiteToOrangeGradient`、`GreenToRedGradient`、`RedToGreenGradient`、`BlueToPinkGradient`、`PinkToBlueGradient`、`SpectralGradient`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "number",
|
||||||
|
"name": "完成度",
|
||||||
|
"style": { "type": "progress", "percentage": true, "color": "Blue" },
|
||||||
|
"default_value": 0.65
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `rating`
|
||||||
|
|
||||||
|
支持字段:`icon`、`min`、`max`
|
||||||
|
|
||||||
|
默认值 / 已知平台范围:
|
||||||
|
- `icon` 默认 `star`
|
||||||
|
- `icon` 可用:`star`、`heart`、`thumbsup`、`fire`、`smile`、`lightning`、`flower`、`number`
|
||||||
|
- `min` 取值 `0..1`,默认 `1`
|
||||||
|
- `max` 默认 `5`;常见或已文档化的范围为 `1..10`,但 CLI 不强制上限为 `10`。如果用户明确需要更大评分范围,优先确认平台能力或用 `+field-create/update --dry-run` 检查请求形状;平台拒绝后再建议改用普通数字或进度字段。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "number",
|
||||||
|
"name": "评分",
|
||||||
|
"style": { "type": "rating", "icon": "star", "min": 1, "max": 5 }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.3 select
|
||||||
|
|
||||||
|
单选和多选都使用 `select`;用 `multiple` 区分。`multiple` 默认 `false`。静态选项用 `options`,动态选项用 `dynamic_options_source`;两者不要同时传。
|
||||||
|
|
||||||
|
#### 静态选项
|
||||||
|
|
||||||
|
支持字段:`multiple`、`options`
|
||||||
|
支持 `default_value`:静态选项名数组;即使 `multiple=false` 也写数组,如 `["Todo"]`。
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `multiple` 默认 `false`
|
||||||
|
- `options` 最多 `10000` 项
|
||||||
|
- `options[]` 结构是 `{name, hue?, lightness?}`
|
||||||
|
- `options[].name` 必填
|
||||||
|
- `options[].hue` 可用:`Red`、`Orange`、`Yellow`、`Lime`、`Green`、`Turquoise`、`Wathet`、`Blue`、`Carmine`、`Purple`、`Gray` 缺省值为 `Blue`
|
||||||
|
- `options[].lightness` 可用:`Lighter`、`Light`、`Standard`、`Dark`、`Darker` 缺省值为 `Lighter`
|
||||||
|
- 选项里没有 `id`,只有 `name`。
|
||||||
|
- 支持 `default_value` 配置:填选项名数组。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "select",
|
||||||
|
"name": "状态",
|
||||||
|
"multiple": false,
|
||||||
|
"default_value": ["Todo"],
|
||||||
|
"options": [
|
||||||
|
{ "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
|
||||||
|
{ "name": "Done", "hue": "Green", "lightness": "Light" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 动态选项
|
||||||
|
|
||||||
|
支持字段:`multiple`、`dynamic_options_source`
|
||||||
|
动态选项不支持 `default_value`。
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `multiple` 默认 `false`
|
||||||
|
- `dynamic_options_source` 结构是 `{table_id, field_id}`
|
||||||
|
- `dynamic_options_source.table_id` 填来源表 id 或表名
|
||||||
|
- `dynamic_options_source.field_id` 填来源字段 id 或字段名
|
||||||
|
- `dynamic_options_source` 仅创建支持;更新已有字段时不要传
|
||||||
|
- 引用选项条件 / 级联筛选条件:这个功能在 Base 前端支持,属于 UI-only 属性,OpenAPI 里不支持,CLI 不能读取、创建或更新;不要根据接口返回缺失判断未配置
|
||||||
|
- 动态选项不支持配置 `default_value`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "select",
|
||||||
|
"name": "动态状态",
|
||||||
|
"multiple": false,
|
||||||
|
"dynamic_options_source": {
|
||||||
|
"table_id": "选项表",
|
||||||
|
"field_id": "候选状态"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.4 datetime
|
||||||
|
|
||||||
|
手动填写的日期/时间字段。系统时间用 `created_at` / `updated_at`。
|
||||||
|
支持 `default_value`:静态时间字符串,或 `{ "$slot": "record_created_time" }`。`datetime + record_created_time` 是自动填充可编辑单元格;`created_at` 是只读创建时间元信息。
|
||||||
|
|
||||||
|
最小写法:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "datetime",
|
||||||
|
"name": "截止时间",
|
||||||
|
"default_value": "2026-03-24 10:00:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
支持字段:`style.format`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `style.format` 默认 `yyyy/MM/dd` 可用格式:`yyyy/MM/dd`、`yyyy/MM/dd HH:mm`、`yyyy/MM/dd HH:mm Z`、`yyyy-MM-dd`、`yyyy-MM-dd HH:mm`、`yyyy-MM-dd HH:mm Z`、`MM-dd`、`MM/dd/yyyy`、`dd/MM/yyyy`
|
||||||
|
- `style.format` 只控制前端显示格式;当前可配置格式最多显示到分钟,底层时间值仍可保留秒级精度。
|
||||||
|
|
||||||
|
常用写法:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "datetime",
|
||||||
|
"name": "截止时间",
|
||||||
|
"style": { "format": "yyyy-MM-dd HH:mm" },
|
||||||
|
"default_value": { "$slot": "record_created_time" }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.5 created_at / updated_at
|
||||||
|
|
||||||
|
系统创建时间 / 系统更新时间字段;可配显示格式,但记录写入时应视为只读。
|
||||||
|
|
||||||
|
支持字段:`style.format`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `style.format` 默认 `yyyy/MM/dd`
|
||||||
|
- 可用格式:`yyyy/MM/dd`、`yyyy/MM/dd HH:mm`、`yyyy/MM/dd HH:mm Z`、`yyyy-MM-dd`、`yyyy-MM-dd HH:mm`、`yyyy-MM-dd HH:mm Z`、`MM-dd`、`MM/dd/yyyy`、`dd/MM/yyyy`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "created_at", "name": "创建时间" }
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "updated_at", "name": "更新时间", "style": { "format": "yyyy/MM/dd HH:mm" } }
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.6 user / group_chat
|
||||||
|
|
||||||
|
人员字段和群字段都支持 `multiple`。
|
||||||
|
`user` 支持 `default_value`:人员 CellValue 数组,元素可用 `{ "id": "ou_xxx" }` 或 `{ "$slot": "current_user" }`;不要猜用户 ID。`group_chat` 不支持默认值。
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `multiple` 默认 `true`
|
||||||
|
- `user` 字段支持 `default_value` 配置,`group_chat` 字段不支持 `default_value` 配置。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "user",
|
||||||
|
"name": "负责人",
|
||||||
|
"multiple": true,
|
||||||
|
"default_value": [{ "$slot": "current_user" }, { "id": "ou_xxx" }]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "group_chat", "name": "负责群", "multiple": true }
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.7 created_by / updated_by
|
||||||
|
|
||||||
|
系统创建人 / 系统修改人字段;记录写入时应视为只读。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "created_by", "name": "创建人" }
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "updated_by", "name": "更新人" }
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.8 link
|
||||||
|
|
||||||
|
关联字段;`link_table` 必填。
|
||||||
|
|
||||||
|
支持字段:`link_table`、`bidirectional`、`bidirectional_link_field_name`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `link_table` 必填
|
||||||
|
- `link` 字段的单元格表示“当前记录关联到的对侧表记录集合”
|
||||||
|
- `bidirectional` 默认 `false`
|
||||||
|
- `bidirectional=true` 时,会在被关联表自动创建一个反向关联字段。任一侧记录的关联关系发生变更时,另一侧对应记录会自动同步更新
|
||||||
|
- `bidirectional_link_field_name` 仅在 `bidirectional=true` 时使用
|
||||||
|
- 关联字段筛选:这个功能在 Base 前端支持,属于 UI-only 属性,OpenAPI 里不支持,CLI 不能读取、创建或更新;不要根据接口返回缺失判断未配置
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "link",
|
||||||
|
"name": "关联任务",
|
||||||
|
"link_table": "任务表"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
双向关联:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "link",
|
||||||
|
"name": "关联任务",
|
||||||
|
"link_table": "任务表",
|
||||||
|
"bidirectional": true,
|
||||||
|
"bidirectional_link_field_name": "反向关联"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
更新时注意:
|
||||||
|
- `link` 不允许转换为其他类型,其他类型也不能转换为 `link`。
|
||||||
|
- 现有 `link` 字段的 `bidirectional` 不能改。
|
||||||
|
|
||||||
|
### 3.9 formula
|
||||||
|
|
||||||
|
公式字段;`expression` 必填。创建/更新前先读 [formula-field-guide.md](formula-field-guide.md) 学习公式语法。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "formula",
|
||||||
|
"name": "合计",
|
||||||
|
"expression": "1+1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.10 lookup
|
||||||
|
|
||||||
|
查找引用字段;`from`、`select`、`where` 必填,`aggregate` 可选。创建/更新前先读 [lookup-field-guide.md](lookup-field-guide.md)。
|
||||||
|
|
||||||
|
支持字段:`from`、`select`、`where`、`aggregate`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `from`、`select`、`where` 必填
|
||||||
|
- `aggregate` 默认 `raw_value` 代表不进行聚合,直接返回 select 回的原始值
|
||||||
|
- `aggregate` 可用:`raw_value`、`sum`、`average`、`counta`、`unique_counta`、`max`、`min`、`unique`
|
||||||
|
- `where.logic` 默认 `and`,仅支持 `and` / `or`
|
||||||
|
- `where.conditions` 至少 1 条
|
||||||
|
- `conditions` 每项是三元组 `[field, op, value?]`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "状态汇总",
|
||||||
|
"from": "任务表",
|
||||||
|
"select": "状态",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["负责人", "==", { "type": "field_ref", "field": "当前负责人" }],
|
||||||
|
["状态", "non_empty", null]
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"aggregate": "raw_value"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.11 auto_number
|
||||||
|
|
||||||
|
自动编号字段;创建时不写 `style.rules` 会使用默认规则:`NO.001`。更新已有自动编号字段时应显式提交目标 `style.rules`,因为 `+field-update` 会把新的编号规则重新应用到已有编号。
|
||||||
|
|
||||||
|
最小写法:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "auto_number",
|
||||||
|
"name": "编号"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
支持字段:`style.rules`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `style.rules` 是规则数组,数量 `1..9`
|
||||||
|
- 默认规则:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"style": {
|
||||||
|
"rules": [
|
||||||
|
{ "type": "text", "text": "NO." },
|
||||||
|
{ "type": "incremental_number", "length": 3 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `text`
|
||||||
|
|
||||||
|
支持字段:`text`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "text", "text": "TASK-" }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `incremental_number`
|
||||||
|
|
||||||
|
支持字段:`length`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `length` 取值 `1..9`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "incremental_number", "length": 4 }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `created_time`
|
||||||
|
|
||||||
|
支持字段:`date_format`
|
||||||
|
|
||||||
|
默认值 / 约束:
|
||||||
|
- `date_format` 可用:`yyyyMMdd`、`yyyyMM`、`yyMM`、`MMdd`、`yyyy`、`MM`、`dd`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "created_time", "date_format": "yyyyMMdd" }
|
||||||
|
```
|
||||||
|
|
||||||
|
自定义规则:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "auto_number",
|
||||||
|
"name": "编号",
|
||||||
|
"style": {
|
||||||
|
"rules": [
|
||||||
|
{ "type": "text", "text": "TASK-" },
|
||||||
|
{ "type": "created_time", "date_format": "yyyyMMdd" },
|
||||||
|
{ "type": "incremental_number", "length": 4 }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3.12 attachment / location / checkbox
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "attachment", "name": "附件" }
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "location", "name": "位置" }
|
||||||
|
```
|
||||||
|
|
||||||
|
写入必须使用 `{lng,lat}`。location 读回会包含 `full_address`;筛选和 `location -> text` 类型转换按 `full_address` 字符串处理,只有公式能访问坐标。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{ "type": "checkbox", "name": "完成" }
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. 创建与更新
|
||||||
|
|
||||||
|
- `+field-create`:按目标字段配置直接构造 `--json`。
|
||||||
|
- `+field-update`:使用同样的 JSON 结构,但语义是 `PUT`;建议先 `+field-get`,再按目标完整状态提交,并带 `--yes`。当 `type` 是 `auto_number` 时,更新编号规则本身就会把新规则应用到已有编号,无需额外参数,也不要在 JSON 里塞额外的底层实现参数。
|
||||||
|
|
||||||
|
## 5. 暂不支持字段
|
||||||
|
|
||||||
|
Object(对象字段)、Button(按钮字段)、Stage(流程字段)暂时都没有被 CLI 支持。这些字段会展示为 `not_support` 字段并被保护:不允许修改,不允许读取内容。
|
||||||
|
|
||||||
|
## 6. 易错点
|
||||||
|
|
||||||
|
- `select` 只有一个类型;不要写 `single_select` / `multi_select`,用 `multiple` 控制是否多选。
|
||||||
|
- `number` 的精度、货币、进度、评分配置都放在 `style` 下,不要写顶层 `precision`。
|
||||||
|
- `datetime` 是手动日期字段;系统时间请改用 `created_at` / `updated_at`。
|
||||||
|
- `formula` / `lookup` 没读 guide 前不要直接写。
|
||||||
|
- 只有 `text`、`number`、静态 `select`、`datetime`、`user` 支持 `default_value`;清空统一传 `"default_value": null`。其他字段类型不要配置默认值。
|
||||||
189
.agents/skills/lark-base/references/lark-base-field-update.md
Normal file
189
.agents/skills/lark-base/references/lark-base-field-update.md
Normal file
@ -0,0 +1,189 @@
|
|||||||
|
# base +field-update
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
更新一个已有字段。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +field-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--field-id <field_id> \
|
||||||
|
--json '{"name":"状态","type":"select","multiple":false,"default_value":["Doing"],"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Doing","hue":"Orange","lightness":"Light"},{"name":"Done","hue":"Green","lightness":"Light"}]}' \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
lark-cli base +field-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--field-id <field_id> \
|
||||||
|
--json '{"name":"负责人","type":"user","multiple":false,"default_value":null,"description":"用于标记记录的直接负责人"}' \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
lark-cli base +field-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--field-id <field_id> \
|
||||||
|
--json '{"name":"编号","type":"auto_number","style":{"rules":[{"type":"text","text":"TASK-"},{"type":"created_time","date_format":"yyyyMM"},{"type":"text","text":"-"},{"type":"incremental_number","length":4}]}}' \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token |
|
||||||
|
| `--table-id <id_or_name>` | 是 | 表 ID 或表名 |
|
||||||
|
| `--field-id <id_or_name>` | 是 | 字段 ID 或字段名 |
|
||||||
|
| `--json <body>` | 是 | 字段属性 JSON 对象 |
|
||||||
|
| `--yes` | 是 | 确认执行高风险字段更新 |
|
||||||
|
|
||||||
|
> 这是**高风险写入操作**。`+field-update` 使用 `PUT` 全量字段定义语义;改变字段类型或关键配置可能影响整列已有数据的解释、展示或可用性。CLI 层要求显式传 `--yes`;如果用户已经明确目标和期望更新,可直接执行并带上 `--yes`。
|
||||||
|
|
||||||
|
## API 入参详情
|
||||||
|
|
||||||
|
**HTTP 方法和路径:**
|
||||||
|
|
||||||
|
```
|
||||||
|
PUT /open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id
|
||||||
|
```
|
||||||
|
|
||||||
|
当 `--json.type` 是 `auto_number` 时,仍然走同一个 v3 字段更新接口:更新自动编号规则后,接口现状就会把新规则应用到已有编号(这是接口默认行为,只是 agent 通常不知道),因此**不需要**任何额外开关或参数。只需要正常提交目标自动编号字段定义即可;如果用户要求“将修改用于已有编号”,直接执行这次 `+field-update` 就能达到效果,不要在 `--json` 里额外添加任何参数去“触发”重排。
|
||||||
|
|
||||||
|
## JSON 值规范
|
||||||
|
|
||||||
|
- `--json` 必须是 **JSON 对象**,顶层直接传字段定义。
|
||||||
|
- 更新语义是 `PUT`(全量字段配置更新),不要只传零散片段;至少显式包含 `name`、`type`,并补齐该类型所需关键配置。
|
||||||
|
- 所有字段类型都支持可选 `description`;支持纯文本,也支持 Markdown 链接。
|
||||||
|
- 需要字段默认值时传 `default_value`,直接使用字段对应 CellValue;传 `null` 清空,省略表示不修改现有默认值。完整规则见 [lark-base-field-json.md](lark-base-field-json.md)。
|
||||||
|
- `select` 更新时:`options` 仍按对象数组传,避免混入无效字段。
|
||||||
|
- `link` 更新限制:
|
||||||
|
- 不能把非 `link` 字段改成 `link`,也不能把 `link` 改成非 `link`。
|
||||||
|
- 现有 `link` 字段的 `bidirectional` 不能改。
|
||||||
|
- `auto_number` 更新的 `style.rules` 支持 `text`、`created_time`、`incremental_number`。
|
||||||
|
|
||||||
|
**推荐更新示例**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "状态",
|
||||||
|
"type": "select",
|
||||||
|
"multiple": false,
|
||||||
|
"default_value": ["Doing"],
|
||||||
|
"options": [
|
||||||
|
{ "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
|
||||||
|
{ "name": "Doing", "hue": "Orange", "lightness": "Light" },
|
||||||
|
{ "name": "Done", "hue": "Green", "lightness": "Light" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**字段说明示例**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "负责人",
|
||||||
|
"type": "user",
|
||||||
|
"multiple": false,
|
||||||
|
"description": "用于标记记录的直接负责人"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 返回重点
|
||||||
|
|
||||||
|
- 返回 `field` 和 `updated: true`。
|
||||||
|
- `updated:true` 只表示更新请求成功,不表示字段结构、已有记录值或下游能力已经完成验证。`+field-update` 无法知道更新前的字段类型,因此成功响应会推荐执行 `+field-get`;若发生类型转换,还要抽样读取记录值。
|
||||||
|
- 如果响应中的 `field.type` 与提交的 `type` 不一致,必须把它当作待核验的类型不匹配;不能返回完成态,也不能只根据其中任一类型推断更新成功。
|
||||||
|
- 如果 API 报告本次更新没有产生任何变更(no-op),命令会如实返回该错误;这通常说明目标字段已是期望状态,不要机械重试同一份 `+field-update`。需要确认当前字段完整状态时执行 `+field-get`。
|
||||||
|
- 如果返回 `field_get_recommended:true` 或 `next_step:"field_get"`,按提示读回字段;`auto_number` 更新后还应抽样读记录值确认编号已按新规则生成。
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
|
||||||
|
1. 建议先用 `+field-get` 拉现状,再做最小化修改。
|
||||||
|
2. `formula/lookup` 类型更新前先阅读对应指南。
|
||||||
|
3. 如果更新 `auto_number`,理解为“更新编号规则,同时把新规则应用到已有编号”;执行后按返回提示读回字段并在必要时抽样记录值。
|
||||||
|
4. 如果这次更新会改变字段 `type` 先按下方“字段类型变更规则”判断能否执行。如果不修改 `type`,大多数场景都相对安全。
|
||||||
|
|
||||||
|
## 字段类型变更规则
|
||||||
|
|
||||||
|
字段类型变更采用白名单机制:**只允许白名单转换**;未命中白名单时,**不建议用 CLI 转换字段类型** 除非用户明确知道风险并同意。
|
||||||
|
|
||||||
|
### 允许直接转换 type
|
||||||
|
|
||||||
|
先 `+field-get` / `+field-list` 看结构,再抽样读值;只有命中以下规则时,转换才是比较安全的。
|
||||||
|
|
||||||
|
#### 相对安全
|
||||||
|
|
||||||
|
| 目标类型 | 允许的源类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `text` | `number`、`select`、`datetime`、`created_at`、`updated_at`、`location`(只保留 `full_address`)、`auto_number`、`checkbox` | 保留字符串表示;丢失原类型语义和结构化能力 |
|
||||||
|
| `number` | `text`、`number`、`datetime`、`created_at`、`updated_at`、`checkbox` | 保留可解析的数字值;无法解析的值会变空,原文本格式会丢失 |
|
||||||
|
| `datetime` | `text`、`number`、`datetime`、`created_at`、`updated_at` | 保留可解析的时间字符串和时间戳;无法解析的值会变空,原文本格式会丢失 |
|
||||||
|
| `select` | `text -> select`、`number -> select`、`single select -> multi select` | 只有完全匹配目标选项名的值会转成对应选项;没匹配上的值会被丢弃 |
|
||||||
|
|
||||||
|
#### 可执行但会截断 / 重算
|
||||||
|
|
||||||
|
- `select(multi) -> select(single)`: 只保留第一个值,其余值会被丢弃。
|
||||||
|
- `user(multi) -> user(single)`: 只保留第一个人员,其余值会被丢弃。
|
||||||
|
- `group_chat(multi) -> group_chat(single)`: 只保留第一个群,其余值会被丢弃。
|
||||||
|
|
||||||
|
#### 无状态字段可直接转换
|
||||||
|
|
||||||
|
- `created_at`、`created_by`、`updated_at`、`updated_by`、`formula`、`lookup`: 这类字段值由系统或计算逻辑生成,不承载独立存储数据;可以执行类型转换,不必担心破坏原始记录值,但仍要做下游读回验证。
|
||||||
|
|
||||||
|
### 一律不要用 CLI 转换
|
||||||
|
|
||||||
|
以下场景全部视为黑名单;默认要求用户改到 Web 页面手动完成,或改走“新建字段 + 数据迁移”。
|
||||||
|
|
||||||
|
- `any -> checkbox`
|
||||||
|
- `any -> user`
|
||||||
|
- `any -> group_chat`
|
||||||
|
- `any -> attachment`
|
||||||
|
- `any -> location`
|
||||||
|
- `link` 类型变更
|
||||||
|
- 任意涉及动态 / 静态选项来源切换的 `select` 类型变更
|
||||||
|
|
||||||
|
### 可例外继续执行的场景
|
||||||
|
|
||||||
|
只有在**整列数据丢失可接受**时,才允许对黑名单场景例外执行。
|
||||||
|
|
||||||
|
- `EmptyColumn`: 该列为空
|
||||||
|
- `FreshTableInit`: 新建空表初始化
|
||||||
|
- `PrimaryFieldBootstrap`: 主列不能删,只能更新完成初始化
|
||||||
|
- `ExplicitLossAccepted`: 用户明确接受整列数据丢失
|
||||||
|
|
||||||
|
不满足以上条件时,不要转换。
|
||||||
|
|
||||||
|
### 非白名单场景如何处理
|
||||||
|
|
||||||
|
- 命中白名单时:建议直接原地转换,再做读回验证。
|
||||||
|
- 未命中白名单时:先询问用户是否仍要执行转换,并明确说明风险:
|
||||||
|
- 无状态字段除外;这类字段可以直接转换
|
||||||
|
- 可能整列变空
|
||||||
|
- 可能只保留第一个值
|
||||||
|
- 可能只保留字符串表示,丢失原类型语义和结构化能力
|
||||||
|
- 可能影响视图 / 筛选 / 排序 / 公式 / lookup / 写入引用
|
||||||
|
- 如果用户不接受风险:不要执行转换。
|
||||||
|
|
||||||
|
### 完成态验证
|
||||||
|
|
||||||
|
- `FieldReadback`: 读回字段结构,确认 `type` / `multiple` / `style` / `options`
|
||||||
|
- `NoopReadback`: `+field-update` 返回 no-op 错误时,只能说明 API 报告没有产生变更;可以跳过重复 update,但不能替代 `FieldReadback`
|
||||||
|
- `ValueReadback`: 抽样读回转换后的单元格值
|
||||||
|
- `DownstreamReadback`: 若涉及看板 / 分组 / 排序 / lookup / 公式,继续读回结果
|
||||||
|
- `CompletionRule`: 结构、值、下游能力都正确,才能回复“已完成”
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- ⚠️ 这是全量字段属性更新语义,不是 patch。
|
||||||
|
- ⚠️ 这是高风险写入操作,执行时必须带 `--yes`。
|
||||||
|
- ⚠️ 当 `type` 是 `formula` 或 `lookup` 时,先阅读对应指南再执行。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- 更新前读取当前字段,确认现有 `type` 和具体配置细节,再决定是原地更新还是新建字段迁移。
|
||||||
|
- [lark-base-field-json.md](lark-base-field-json.md) — 字段 JSON 规范(推荐)
|
||||||
|
- [formula-field-guide.md](formula-field-guide.md) — formula 指南(更新公式前必读)
|
||||||
|
- [lookup-field-guide.md](lookup-field-guide.md) — lookup 指南(更新查找引用前必读)
|
||||||
71
.agents/skills/lark-base/references/lark-base-form-detail.md
Normal file
71
.agents/skills/lark-base/references/lark-base-form-detail.md
Normal file
@ -0,0 +1,71 @@
|
|||||||
|
# base +form-detail
|
||||||
|
|
||||||
|
通过表单分享 token 读取表单详情。只读操作,适合在提交表单前解析题目结构、必填项、显示条件和附件提交所需的 Base token。
|
||||||
|
|
||||||
|
## 何时使用
|
||||||
|
|
||||||
|
- 用户给出 `/share/base/form/{shareToken}` 表单分享链接,先提取最后一段作为 `--share-token`。
|
||||||
|
- 准备调用 `+form-submit` 前,必须先用 `+form-detail` 读取 `questions[]`。
|
||||||
|
- 只知道分享链接、还不知道 `base-token` / `table-id` / `form-id` 时,用 `+form-detail`;已在 Base 内部管理表单时,才用 `+form-get`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +form-detail --share-token <share_token> --format pretty
|
||||||
|
```
|
||||||
|
|
||||||
|
## 读取重点
|
||||||
|
|
||||||
|
`+form-detail` 返回的关键字段:
|
||||||
|
|
||||||
|
| 字段 | 用途 |
|
||||||
|
|---|---|
|
||||||
|
| `base_token` | 表单所属 Base;提交附件时必须传给 `+form-submit --base-token` |
|
||||||
|
| `questions[].id` | 题目标识,通常对应字段 ID |
|
||||||
|
| `questions[].title` | 提交时使用的字段名/题目名,以真实返回为准 |
|
||||||
|
| `questions[].type` | 决定值格式;与字段类型和 `lark-base-cell-value.md` 对齐 |
|
||||||
|
| `questions[].required` | 判断必填项 |
|
||||||
|
| `questions[].filter` | 判断题目是否对当前提交可见;被隐藏的问题不要填写 |
|
||||||
|
|
||||||
|
题目除固定字段外,会按类型携带动态配置,例如 `select.options` / `select.multiple`、`number.style`、`datetime.style.format`、`user.multiple`、`link.link_table`、`formula.expression`、`lookup.from/select/where/aggregate`。提交前按返回结构构造值,不要猜题目类型或选项。
|
||||||
|
|
||||||
|
## filter 显示条件
|
||||||
|
|
||||||
|
`questions[].filter` 控制题目显示/隐藏:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{"field_name": "是否携带家属", "operator": "is", "value": ["是"]},
|
||||||
|
{"field_name": "参与人数", "operator": "isGreater", "value": [1]}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- `conjunction` 为 `and` / `or`,表示条件全部满足或任一满足。
|
||||||
|
- `conditions[].field_name` 引用其他题目的 `title`。
|
||||||
|
- `conditions[].operator` 常见为 `is`、`isNot`、`contains`、`doesNotContain`、`isEmpty`、`isNotEmpty`、`isGreater`、`isGreaterEqual`、`isLess`、`isLessEqual`。
|
||||||
|
- `isEmpty` / `isNotEmpty` 不需要 `value`。
|
||||||
|
- 附件题目的 filter 只适合 `isEmpty` / `isNotEmpty`。
|
||||||
|
|
||||||
|
如果当前已填写值不满足某题目的 `filter`,该题目视为隐藏,不应放入 `+form-submit --json.fields` 或 `--json.attachments`。
|
||||||
|
|
||||||
|
## 与 form-submit 的关系
|
||||||
|
|
||||||
|
提交普通字段:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--json '{"fields":{"姓名":"张三","评分":5}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
提交附件字段:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--base-token <base_token_from_form_detail> \
|
||||||
|
--json '{"fields":{"姓名":"张三"},"attachments":{"附件":["./report.pdf"]}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
附件字段不要写进 `fields`;放在顶层 `attachments`,值为本地文件路径数组。
|
||||||
@ -0,0 +1,118 @@
|
|||||||
|
# base +form-questions-create
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
向多维表格表单/问卷中批量添加问题。
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 添加一个文本必填问题
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"type":"text","title":"您的姓名是?","required":true}]'
|
||||||
|
|
||||||
|
# 添加多个问题(按顺序排列)
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[
|
||||||
|
{"type":"text","title":"您的姓名是?","required":true},
|
||||||
|
{"type":"text","title":"您的联系方式是?","required":false}
|
||||||
|
]'
|
||||||
|
|
||||||
|
# 添加单选题(带选项)
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"type":"select","title":"满意度评价","required":true,"multiple":false,"options":[{"name":"非常满意","hue":"Green"},{"name":"满意","hue":"Blue"},{"name":"一般","hue":"Yellow"}]}]'
|
||||||
|
|
||||||
|
# 添加评分题
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"type":"number","title":"服务评分","style":{"type":"rating","icon":"star","min":1,"max":5}}]'
|
||||||
|
|
||||||
|
# 添加带描述的问题(纯文本)
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"type":"text","title":"您的姓名","description":"请填写真实姓名"}]'
|
||||||
|
# 添加带描述的问题(含链接)
|
||||||
|
lark-cli base +form-questions-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"type":"text","title":"反馈建议","description":"更多详情请查看[帮助文档](https://example.com/help)"}]'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token(base_token) |
|
||||||
|
| `--table-id <id>` | 是 | 数据表 ID |
|
||||||
|
| `--form-id <id>` | 是 | 表单 ID |
|
||||||
|
| `--questions <json>` | 是 | 问题 JSON 数组,最多 10 个(见下方格式) |
|
||||||
|
| `--format` | 否 | 输出格式:json(默认)\| pretty \| table \| ndjson \| csv |
|
||||||
|
| `--as` | 否 | 身份:user(默认)\| bot |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## `--questions` 格式
|
||||||
|
|
||||||
|
每个问题对象支持以下字段:
|
||||||
|
|
||||||
|
| 字段 | 必填 | 说明 |
|
||||||
|
|-----------------------|------|------|
|
||||||
|
| `title` | **是** | 问题标题(字段名) |
|
||||||
|
| `type` | **是** | 题目类型:`text`、`number`、`select`、`datetime`、`user`、`attachment`、`location` |
|
||||||
|
| `description` | 否 | 问题描述(纯文本或 Markdown 链接,如 `[文本](https://example.com)`) |
|
||||||
|
| `required` | 否 | 是否必填(true/false) |
|
||||||
|
| `option_display_mode` | 否 | 选项展示方式(仅 `select` 有效):`0`=下拉,`1`=纵向(默认),`2`=横向 |
|
||||||
|
| `multiple` | 否 | 是否多选(`select`/`user` 类型有效,bool) |
|
||||||
|
| `options` | 否 | 选项列表(仅 `select` 有效):`[{"name":"选项1","hue":"Blue"}]`,hue 可选:`Red`/`Orange`/`Yellow`/`Green`/`Blue`/`Purple`/`Gray` |
|
||||||
|
| `style` | 否 | 字段样式配置(见下方说明) |
|
||||||
|
|
||||||
|
### `style` 字段说明
|
||||||
|
|
||||||
|
| 类型 | style 结构 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `text` | `{"type":"plain"}` | 当前仅支持 `plain` |
|
||||||
|
| `number` | `{"type":"plain","precision":2}` | precision 为小数位数 |
|
||||||
|
| `number`(评分) | `{"type":"rating","icon":"star","min":1,"max":5}` | icon 可选:`star`/`heart`/`thumbsup`/`fire`/`smile`/`lightning`/`flower`/`number` |
|
||||||
|
| `datetime` | `{"format":"yyyy/MM/dd"}` | format 可选:`yyyy/MM/dd`、`yyyy/MM/dd HH:mm`、`MM-dd`、`MM/dd/yyyy`、`dd/MM/yyyy` |
|
||||||
|
|
||||||
|
## 输出格式
|
||||||
|
|
||||||
|
返回创建成功的问题列表:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"data": {
|
||||||
|
"items": [
|
||||||
|
{"id": "q_001", "title": "您的姓名是?", "required": true}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是**写入操作** — 执行前必须向用户确认。
|
||||||
|
|
||||||
|
1. 先用 `+form-questions-list` 查看现有问题
|
||||||
|
2. 确认要添加的问题内容
|
||||||
|
3. 执行命令并报告新建的问题 ID
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base](../SKILL.md) — 多维表格全部命令
|
||||||
|
- [lark-shared](../../lark-shared/SKILL.md) — 认证和全局参数
|
||||||
@ -0,0 +1,92 @@
|
|||||||
|
# base +form-questions-update
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
批量更新多维表格表单/问卷中的问题(标题、描述、是否必填)。
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 更新一个问题的标题
|
||||||
|
lark-cli base +form-questions-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"id":"q_001","title":"您的真实姓名是?"}]'
|
||||||
|
|
||||||
|
# 同时更新多个问题
|
||||||
|
lark-cli base +form-questions-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[
|
||||||
|
{"id":"q_001","title":"姓名(必填)","required":true},
|
||||||
|
{"id":"q_002","title":"联系方式","required":false}
|
||||||
|
]'
|
||||||
|
|
||||||
|
# 更新问题描述(纯文本)
|
||||||
|
lark-cli base +form-questions-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"id":"q_001","description":"请填写您的真实姓名"}]'
|
||||||
|
# 更新问题描述(含链接)
|
||||||
|
lark-cli base +form-questions-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--form-id <form_id> \
|
||||||
|
--questions '[{"id":"q_001","description":"更多说明请参考[帮助文档](https://example.com/help)"}]'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token(base_token) |
|
||||||
|
| `--table-id <id>` | 是 | 数据表 ID |
|
||||||
|
| `--form-id <id>` | 是 | 表单 ID |
|
||||||
|
| `--questions <json>` | 是 | 问题更新 JSON 数组,最多 10 个(见下方格式) |
|
||||||
|
| `--format` | 否 | 输出格式:json(默认)\| pretty \| table \| ndjson \| csv |
|
||||||
|
| `--as` | 否 | 身份:user(默认)\| bot |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
## `--questions` 格式
|
||||||
|
|
||||||
|
每个问题对象必须包含 `id`,其余字段按需传入:
|
||||||
|
|
||||||
|
| 字段 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `id` | **是** | 问题 ID(field_id),不可修改 |
|
||||||
|
| `title` | 否 | 新的问题标题 |
|
||||||
|
| `description` | 否 | 新的问题描述(纯文本或 Markdown 链接,如 `[文本](https://example.com)`) |
|
||||||
|
| `required` | 否 | 是否必填 |
|
||||||
|
| `option_display_mode` | 否 | 选项展示方式(仅 `select` 有效):`0`=下拉,`1`=纵向(默认),`2`=横向 |
|
||||||
|
|
||||||
|
## 输出格式
|
||||||
|
|
||||||
|
返回更新后的问题列表:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"data": {
|
||||||
|
"items": [
|
||||||
|
{"id": "q_001", "title": "姓名(必填)", "required": true}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 工作流
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> 这是**写入操作** — 执行前必须向用户确认。
|
||||||
|
|
||||||
|
1. 先用 `+form-questions-list` 获取现有问题及其 `id`
|
||||||
|
2. 构造包含 `id` 的更新数组
|
||||||
|
3. 执行命令并报告更新结果
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base](../SKILL.md) — 多维表格全部命令
|
||||||
|
- [lark-shared](../../lark-shared/SKILL.md) — 认证和全局参数
|
||||||
179
.agents/skills/lark-base/references/lark-base-form-submit.md
Normal file
179
.agents/skills/lark-base/references/lark-base-form-submit.md
Normal file
@ -0,0 +1,179 @@
|
|||||||
|
# base +form-submit
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
通过表单分享链接填写并提交多维表格表单。仅支持分享模式(share_token),支持填写普通字段值和上传本地文件作为附件。
|
||||||
|
|
||||||
|
> **⚠️ 高风险写操作(high-risk-write):** 本命令会向表单写入并提交数据,属于高风险写操作,必须额外传递 `--yes` 进行确认,否则会返回 `confirmation_required` 错误并退出。当用户明确要求提交且目标表单无歧义时,直接附加 `--yes`,无需再次询问。
|
||||||
|
|
||||||
|
## 填写前必读:先获取表单详情
|
||||||
|
|
||||||
|
**在调用 `+form-submit` 之前,必须先使用 `+form-detail` 获取表单详情。** 原因如下:
|
||||||
|
|
||||||
|
1. **字段类型匹配**:每个题目的 `type` 决定了值的格式(文本、数字、选项、人员、日期等),需根据类型正确构造 `fields` 中的值
|
||||||
|
2. **必填校验**:通过 `questions[].required` 判断哪些题目为必填项,避免遗漏
|
||||||
|
3. **显示条件过滤**:部分题目带有 `filter`(显示/隐藏逻辑),需根据用户已填的其他题目值判断该题目是否应该出现——**不应填写被 filter 隐藏的题目**
|
||||||
|
4. **获取 base_token(附件场景必用)**:`+form-detail` 返回的 `data.base_token` 是该表单所属的多维表格标识。当表单包含附件字段时,提交时必须通过 `--base-token` 传入此值,因为附件需要上传到该 Base 的 Drive Media 中
|
||||||
|
|
||||||
|
典型流程:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 1️⃣ 先获取表单详情,了解所有题目
|
||||||
|
lark-cli base +form-detail --share-token <share_token>
|
||||||
|
|
||||||
|
# 2️⃣ 根据返回的 questions 列表,按 type 格式化值、检查 required、判断 filter 条件
|
||||||
|
|
||||||
|
# 3️⃣ 再提交(高风险写操作,必须带 --yes)
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--json '{"fields":{...}}' \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
`+form-detail` 的返回中要重点读取 `questions[].type`、`questions[].required`、题目 `filter` 和附件场景所需的 `data.base_token`。
|
||||||
|
|
||||||
|
## 命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 基本提交(填写普通字段)
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--json '{"fields":{"服务评分":5,"评价内容":"服务态度好"}}' \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 带附件提交(需要额外提供 --base-token)
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--json '{
|
||||||
|
"fields": {"服务评分": 5, "评价内容": "好"},
|
||||||
|
"attachments": {
|
||||||
|
"附件字段名": ["./report.pdf", "./photo.png"],
|
||||||
|
"另一个附件字段": ["./doc.docx"]
|
||||||
|
}
|
||||||
|
}' \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 使用应用身份(bot)
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--json '{"fields":{...}}' \
|
||||||
|
--as bot \
|
||||||
|
--yes
|
||||||
|
|
||||||
|
# 预览 API 调用(不实际执行,dry-run 无需 --yes)
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token <share_token> \
|
||||||
|
--json '{"fields":{...}}' \
|
||||||
|
--dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--share-token <token>` | 是 | 表单分享 Token(必填),从表单分享链接中提取 |
|
||||||
|
| `--base-token <token>` | 条件必填 | Base token;**当 `--json` 包含 `attachments` 时必须提供**,用于将附件上传到 Base Drive Media |
|
||||||
|
| `--json <json>` | 是 | JSON 对象,包含 `"fields"`(普通字段值)和 `"attachments"`(附件上传),详见下方说明 |
|
||||||
|
| `--yes` | 是 | 确认高风险写操作。本命令为 high-risk-write,不带 `--yes` 会返回 `confirmation_required` |
|
||||||
|
| `--format` | 否 | 输出格式:json(默认)\| pretty \| table \| ndjson \| csv |
|
||||||
|
| `--as` | 否 | 身份:user(默认)\| bot |
|
||||||
|
| `--dry-run` | 否 | 预览 API 调用,不执行 |
|
||||||
|
|
||||||
|
### --json 结构说明
|
||||||
|
|
||||||
|
`--json` 是一个 JSON 对象,包含两个部分:
|
||||||
|
|
||||||
|
#### fields(普通字段)
|
||||||
|
|
||||||
|
`fields` 中的单元格值写法与 [`lark-base-cell-value.md`](lark-base-cell-value.md) 完全对齐,填写前应先阅读该文档了解各类型的构造规则:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"文本字段": "Hello World",
|
||||||
|
"电话字段": "13800000000",
|
||||||
|
"超链接字段": "https://example.com",
|
||||||
|
"数字字段": 12.5,
|
||||||
|
"单选字段": "选项A",
|
||||||
|
"多选字段": ["选项A", "选项B"],
|
||||||
|
"时间字段": "2026-04-27 14:30:00",
|
||||||
|
"复选框字段": true,
|
||||||
|
"人员字段": [{ "id": "ou_7094d131420c8749632145f08fbf114a" }],
|
||||||
|
"关联字段": [{ "id": "recXXXXXXXXXXXX" }],
|
||||||
|
"地理位置字段": { "lng": 116.397428, "lat": 39.90923 }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> **注意:附件类型字段不要写在 `fields` 里。** `fields` 中不包含附件,附件有独立的填写方式,见下方「attachments(附件上传)」章节。
|
||||||
|
|
||||||
|
> 自动编号、公式、创建/修改人、创建/修改时间等系统字段会自动填入,无需手动传入。
|
||||||
|
|
||||||
|
#### attachments(附件上传)
|
||||||
|
|
||||||
|
**附件字段的填写方式与 `fields` 中的普通单元格完全不同**,不能在 `fields` 里传 `file_token` 或其他附件格式。必须将附件字段单独放在 `--json` 的顶层 `attachments` 对象中,值为**本地文件路径数组**(不是 token):
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"attachments": {
|
||||||
|
"附件字段名": ["./report.pdf", "./photo.png"],
|
||||||
|
"另一个附件字段": ["./doc.docx"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
CLI 收到路径后会自动完成以下流程:
|
||||||
|
1. 校验所有文件(存在性、大小 ≤2GB、常规文件)
|
||||||
|
2. 并行上传到 Base Drive Media(并发上限 5,跨字段重复路径自动去重)
|
||||||
|
3. 获取 `file_token` 后合并到最终表单提交内容中
|
||||||
|
|
||||||
|
> 与 [`lark-base-cell-value.md`](lark-base-cell-value.md) 中 Record 场景的附件写法不同:Record 写入时附件走独立的 `+record-upload-attachment` 命令;而 `+form-submit` 只需在 `attachments` 中传本地路径,上传由 CLI 内部自动完成。
|
||||||
|
|
||||||
|
### 从分享链接提取 share-token
|
||||||
|
|
||||||
|
用户提供形如以下格式的表单分享链接时:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://www.example.com/share/base/form/shrbcvST8eZy0vk8zjVZ1CAXNye
|
||||||
|
```
|
||||||
|
|
||||||
|
**提取方式:** 取 URL 路径最后一段作为 `--share-token`。
|
||||||
|
|
||||||
|
以上述链接为例:
|
||||||
|
|
||||||
|
- `share-token` = `shrbcvST8eZy0vk8zjVZ1CAXNye`
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +form-submit \
|
||||||
|
--share-token shrbcvST8eZy0vk8zjVZ1CAXNye \
|
||||||
|
--json '{"fields":{...}}' \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## 输出格式
|
||||||
|
|
||||||
|
| 字段 | 类型 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `can_submit_again` | bool | 是否可以再次填写 |
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"data": {
|
||||||
|
"can_submit_again": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 提示
|
||||||
|
|
||||||
|
- **本命令为高风险写操作(high-risk-write),必须额外传递 `--yes` 确认**,否则返回 `confirmation_required` 并以非零码退出;`--dry-run` 预览除外
|
||||||
|
- 本命令仅支持通过表单分享链接(share_token)提交,不支持通过 base_token + table_id + view_id 方式提交
|
||||||
|
- **当 `--json` 包含 `attachments` 时,必须额外提供 `--base-token`**,因为附件上传到 Base Drive Media 需要指定目标 Base
|
||||||
|
- 附件字段只需在 `--json.attachments` 中提供本地路径即可,CLI 自动完成校验、并行上传、Token 获取和合并写入
|
||||||
|
- 限流:单应用 20 QPS,单用户 5 QPS
|
||||||
|
- 权限要求:`base:form:update`;使用 attachments 时还需 `docs:document.media:upload`
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base](../SKILL.md) — 多维表格全部命令
|
||||||
|
- [lark-shared](../../lark-shared/SKILL.md) — 认证和全局参数
|
||||||
@ -0,0 +1,59 @@
|
|||||||
|
# base +record-batch-create
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
批量创建记录。
|
||||||
|
|
||||||
|
## 适用场景(重点)
|
||||||
|
|
||||||
|
- 适合导入 CSV / Excel、外部系统一次性写入新数据。
|
||||||
|
- 先把每条输入数据映射为独立的字段对象,再组装到 `create_records`。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-batch-create --base-token <base_token> --table-id <table_id> \
|
||||||
|
--json '{"create_records":[{"标题":"任务 A","状态":"Open"},{"标题":"任务 B","状态":"Done"}]}'
|
||||||
|
|
||||||
|
lark-cli base +record-batch-create --base-token <base_token> --table-id <table_id> --json @batch-create.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token |
|
||||||
|
| `--table-id <id_or_name>` | 是 | 表 ID 或表名 |
|
||||||
|
| `--json <body>` | 是 | 批量创建请求体,必须是 JSON 对象。支持直接传 JSON 字符串,或 `@<file_path>` 从文件读取 |
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
`POST /open-apis/base/v3/bases/:base_token/tables/:table_id/records/batch_create`
|
||||||
|
|
||||||
|
## `--json` 结构
|
||||||
|
|
||||||
|
本节只说明 `+record-batch-create` 的外层 JSON 形状;CellValue 统一看 [lark-base-cell-value.md](lark-base-cell-value.md)。
|
||||||
|
|
||||||
|
对象形态:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"create_records":[{"标题":"任务 A","状态":"Open"},{"标题":"任务 B","状态":"Done"}]}
|
||||||
|
```
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `create_records` | `Array<Map<FieldNameOrID, CellValue>>` | 是 | 记录字段对象数组;每条记录可以提交不同字段,单次最多 200 条 |
|
||||||
|
|
||||||
|
## 返回重点
|
||||||
|
|
||||||
|
返回 `record_id_list` 和可选的 `ignored_fields`。
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- 每个 `create_records` 元素都是独立的记录字段对象,只提交该记录需要写入的字段。
|
||||||
|
- 单次最多 200 条,超出需分批写入。
|
||||||
|
- `select` 字段只支持写入字段中已有的选项;构造 CellValue 前先用 `+field-list` 或 `+field-search-options` 确认目标选项存在。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-cell-value.md](lark-base-cell-value.md) — CellValue 格式规范
|
||||||
@ -0,0 +1,54 @@
|
|||||||
|
# base +record-batch-update (batch update)
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
通过 `update_records` 为每条记录提交字段值。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-batch-update --base-token <base_token> --table-id <table_id> \
|
||||||
|
--json '{"update_records":{"<record_id_a>":{"状态":["完成"]},"<record_id_b>":{"分数":20}}}'
|
||||||
|
|
||||||
|
lark-cli base +record-batch-update --base-token <base_token> --table-id <table_id> --json @batch-update.json
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token |
|
||||||
|
| `--table-id <id_or_name>` | 是 | 表 ID 或表名 |
|
||||||
|
| `--json <body>` | 是 | 批量更新请求体,必须是 JSON 对象。支持直接传 JSON 字符串,或 `@<file_path>` 从文件读取 |
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
`POST /open-apis/base/v3/bases/:base_token/tables/:table_id/records/batch_update`
|
||||||
|
|
||||||
|
## `--json` 结构
|
||||||
|
|
||||||
|
本节只说明 `+record-batch-update` 的外层 JSON 形状;CellValue 统一看 [lark-base-cell-value.md](lark-base-cell-value.md)。
|
||||||
|
|
||||||
|
对象形态:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"update_records":{"recA":{"状态":["完成"]},"recB":{"分数":20}}}
|
||||||
|
```
|
||||||
|
|
||||||
|
| 字段 | 类型 | 必填 | 说明 |
|
||||||
|
|------|------|------|------|
|
||||||
|
| `update_records` | `Map<RecordID, Map<FieldNameOrID, CellValue>>` | 是 | record ID 到字段更新对象的映射(单次最多 200 条) |
|
||||||
|
|
||||||
|
## 返回重点
|
||||||
|
|
||||||
|
成功响应只包含可选的 `ignored_fields`;没有忽略字段时 `data` 为空对象。请求不会预先校验 record ID 是否存在,因此需要确认实际写入结果时,应再用 `+record-get` 读回目标记录。
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- 单次最多更新 200 条记录,超过会被接口校验拒绝。
|
||||||
|
- 命令不会自动做字段/行映射转换,传什么就发什么。
|
||||||
|
- 如果字段映射包含只读字段,返回里可能出现 `ignored_fields`;这些字段不会被更新。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-cell-value.md](lark-base-cell-value.md) — CellValue 格式规范
|
||||||
@ -0,0 +1,43 @@
|
|||||||
|
# base +record-history-list
|
||||||
|
|
||||||
|
查询单条记录的变更历史。它返回历史事件,不返回记录当前值,也不支持整表审计扫描。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +record-history-list \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--record-id <record_id>
|
||||||
|
|
||||||
|
lark-cli base +record-history-list \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--record-id <record_id> \
|
||||||
|
--page-size 30 \
|
||||||
|
--max-version <next_max_version>
|
||||||
|
```
|
||||||
|
|
||||||
|
## 返回解释
|
||||||
|
|
||||||
|
- 历史条目通常按版本号降序返回,最新在前。
|
||||||
|
- 每条历史包含版本号、操作人、操作时间、操作类型和字段变更。
|
||||||
|
- `create_time` 是秒级 Unix 时间戳。
|
||||||
|
- `field_changes` 描述字段变更,重点看字段名/字段类型、`before` 和 `after`。
|
||||||
|
- `activity_type` 常见值:`create`(创建记录)、`update`(编辑记录)、`delete`(删除记录)。
|
||||||
|
|
||||||
|
以下字段类型的变化可能不会出现在 `field_changes` 中:
|
||||||
|
|
||||||
|
- 计算字段:`formula`、`lookup`
|
||||||
|
- 系统字段:自动编号、创建时间、创建人、修改时间、修改人
|
||||||
|
|
||||||
|
## 翻页
|
||||||
|
|
||||||
|
- 首次请求不传 `--max-version`。
|
||||||
|
- 如果返回 `has_more=true`,取返回中的 `next_max_version` 作为下一次请求的 `--max-version`。
|
||||||
|
- `--page-size` 默认 30,最大 50。
|
||||||
|
|
||||||
|
## 注意
|
||||||
|
|
||||||
|
- `table-id` 和 `record-id` 必须来自同一张表。
|
||||||
|
- 这是单条记录历史,不是表级审计;需要查多条记录时串行调用。
|
||||||
@ -0,0 +1,63 @@
|
|||||||
|
# base +record-upsert
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
创建记录,或在带 `--record-id` 时更新记录。
|
||||||
|
|
||||||
|
## 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 创建记录
|
||||||
|
lark-cli base +record-upsert --base-token <base_token> --table-id <table_id> \
|
||||||
|
--json '{"项目名称":"Apollo","状态":"进行中"}'
|
||||||
|
|
||||||
|
# 更新记录
|
||||||
|
lark-cli base +record-upsert --base-token <base_token> --table-id <table_id> --record-id <record_id> \
|
||||||
|
--json '{"项目名称":"Apollo","状态":"完成","完成时间":"2026-03-24 10:00:00"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 参数
|
||||||
|
|
||||||
|
| 参数 | 必填 | 说明 |
|
||||||
|
|------|------|------|
|
||||||
|
| `--base-token <token>` | 是 | Base Token |
|
||||||
|
| `--table-id <id_or_name>` | 是 | 表 ID 或表名 |
|
||||||
|
| `--record-id <id>` | 否 | 传入时走更新,不传时走创建 |
|
||||||
|
| `--json <body>` | 是 | 字段写入对象,类型 `Map<FieldNameOrID, CellValue>` |
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
- 创建:`POST /open-apis/base/v3/bases/:base_token/tables/:table_id/records`
|
||||||
|
- 更新:带 `--record-id` 时改走 `PATCH /records/:record_id`
|
||||||
|
|
||||||
|
## `--json` 结构
|
||||||
|
|
||||||
|
- `--json` 必须是 **JSON object map**,形状是 `Map<FieldNameOrID, CellValue>`。
|
||||||
|
- key 是字段名或字段 ID;value 是该字段的 `CellValue`。
|
||||||
|
- 一次请求里同一字段只用一种标识,避免重复写入冲突。
|
||||||
|
- 写入前先 `+field-list` 确认字段类型和字段名/ID。
|
||||||
|
- CellValue 统一看 [lark-base-cell-value.md](lark-base-cell-value.md)。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"项目名称": "Apollo",
|
||||||
|
"状态": "进行中",
|
||||||
|
"完成时间": "2026-03-24 10:00:00"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 返回重点
|
||||||
|
|
||||||
|
- 创建时返回 `record` 和 `created: true`。
|
||||||
|
- 更新时返回 `record` 和 `updated: true`。
|
||||||
|
- 如果写入了 `formula / lookup / created_at / updated_at / created_by / updated_by` 等只读字段,返回里可能出现 `ignored_fields`,这些字段不会被更新。
|
||||||
|
|
||||||
|
## 坑点
|
||||||
|
|
||||||
|
- 有 `--record-id` 就一定更新;不传就一定创建,不会自动查重或按业务键 upsert。
|
||||||
|
- `select` 字段只支持写入字段中已有的选项;构造 CellValue 前先用 `+field-list` 或 `+field-search-options` 确认目标选项存在。
|
||||||
|
- 这是写入操作,执行前必须确认目标表和字段。
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-cell-value.md](lark-base-cell-value.md) — CellValue 格式规范
|
||||||
65
.agents/skills/lark-base/references/lark-base-role-guide.md
Normal file
65
.agents/skills/lark-base/references/lark-base-role-guide.md
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
# Base advanced permission and role guide
|
||||||
|
|
||||||
|
This guide is the entry point for Base advanced permissions and roles. Use it to choose commands and understand safety boundaries. For the permission JSON itself, use [role-config.md](role-config.md) as the SSOT.
|
||||||
|
|
||||||
|
## Command selection
|
||||||
|
|
||||||
|
| Goal | Command | Notes |
|
||||||
|
|------|---------|-------|
|
||||||
|
| Enable advanced permissions | `+advperm-enable` | Required before creating or updating roles. Caller must be a Base admin. |
|
||||||
|
| Disable advanced permissions | `+advperm-disable` | High-risk write. Disabling invalidates existing custom roles. |
|
||||||
|
| Locate roles | `+role-list` | Returns role summaries. Use `+role-get` for full config. |
|
||||||
|
| Inspect one role | `+role-get` | Use before updating a role or deciding whether a role can be deleted. |
|
||||||
|
| Create a custom role | `+role-create` | Supports `custom_role` only. Read [role-config.md](role-config.md) before constructing `--json`. |
|
||||||
|
| Update a role | `+role-update` | Delta merge. Read current config first, then send only intended changes. |
|
||||||
|
| Delete a role | `+role-delete` | Custom roles only. System roles cannot be deleted. |
|
||||||
|
|
||||||
|
## Safety boundaries
|
||||||
|
|
||||||
|
- Role operations require advanced permissions to be enabled and the caller to be a Base admin.
|
||||||
|
- `+role-create` creates custom roles only.
|
||||||
|
- `+role-delete` is only for custom roles. System roles such as editor/reader can be configured within supported limits, but cannot be deleted.
|
||||||
|
- `+role-update` uses delta merge: omitted fields remain unchanged, but identity fields such as `role_name` and `role_type` should match the current target role.
|
||||||
|
- `+advperm-disable` invalidates existing custom roles; confirm the target Base and user intent before passing `--yes`.
|
||||||
|
|
||||||
|
## Common Fewshots
|
||||||
|
|
||||||
|
Use these fewshots for simple role changes. For table, field, record, dashboard, docx, or filter permission details, switch to [role-config.md](role-config.md).
|
||||||
|
|
||||||
|
Create a custom role that keeps copy/download disabled:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +role-create \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--json '{"role_name":"Reviewer","role_type":"custom_role","base_rule_map":{"copy":false,"download":false}}'
|
||||||
|
```
|
||||||
|
|
||||||
|
Rename a role while preserving its type:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +role-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--role-id <role_id> \
|
||||||
|
--json '{"role_name":"Finance Reviewer","role_type":"custom_role"}' \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
Grant read-only access to one table:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +role-update \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--role-id <role_id> \
|
||||||
|
--json '{"role_name":"Finance Reviewer","role_type":"custom_role","table_rule_map":{"Orders":{"perm":"read_only"}}}' \
|
||||||
|
--yes
|
||||||
|
```
|
||||||
|
|
||||||
|
## JSON SSOT
|
||||||
|
|
||||||
|
Use [role-config.md](role-config.md) for:
|
||||||
|
|
||||||
|
- `AdvPermBaseRoleConfig` top-level structure.
|
||||||
|
- `base_rule_map`, `table_rule_map`, `dashboard_rule_map`, and `docx_rule_map`.
|
||||||
|
- Table, view, field, record, dashboard, and docx permission values.
|
||||||
|
- Filter permission JSON.
|
||||||
|
- Default permission strategy and risk rules.
|
||||||
191
.agents/skills/lark-base/references/lark-base-view-set-filter.md
Normal file
191
.agents/skills/lark-base/references/lark-base-view-set-filter.md
Normal file
@ -0,0 +1,191 @@
|
|||||||
|
# base +view-set-filter
|
||||||
|
|
||||||
|
> **前置条件:** 先阅读 [`../lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||||||
|
|
||||||
|
更新视图筛选配置。
|
||||||
|
|
||||||
|
## 1. 顶层规则
|
||||||
|
|
||||||
|
- `--json` 必须是 JSON 对象。
|
||||||
|
- 顶层结构是 `{logic?, conditions?}`。
|
||||||
|
- `logic` 默认 `and`;推荐只用 canonical 值 `and` / `or`。
|
||||||
|
- `conditions` 默认空数组。
|
||||||
|
- 每条条件写成 tuple:`[field, operator, value?]`。
|
||||||
|
- `empty` / `non_empty` 可写成 2 项:`[field, "empty"]`、`[field, "non_empty"]`。
|
||||||
|
- 支持 `filter` 的视图类型:`grid`、`kanban`、`gallery`、`calendar`、`gantt`。
|
||||||
|
|
||||||
|
## 2. operator
|
||||||
|
|
||||||
|
可用 operator:
|
||||||
|
- `==`
|
||||||
|
- `!=`
|
||||||
|
- `>`
|
||||||
|
- `>=`
|
||||||
|
- `<`
|
||||||
|
- `<=`
|
||||||
|
- `intersects`
|
||||||
|
- `disjoint`
|
||||||
|
- `empty`
|
||||||
|
- `non_empty`
|
||||||
|
|
||||||
|
## 3. value 写法
|
||||||
|
|
||||||
|
### `text`
|
||||||
|
|
||||||
|
用字符串:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["标题", "intersects", "发布"]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `location`
|
||||||
|
|
||||||
|
location 筛选只按 `full_address` 字符串匹配,不能直接按经纬度筛选;优先使用 `intersects` 做包含匹配,例如查深圳:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["位置", "intersects", "深圳"]
|
||||||
|
```
|
||||||
|
|
||||||
|
不推荐写 `["位置", "==", "深圳"]` 这类精确匹配,除非确保筛选值与完整 `full_address` 完全一致。
|
||||||
|
|
||||||
|
### `number` / `auto_number`
|
||||||
|
|
||||||
|
用数字:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["工时", ">=", 3.5]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `select`
|
||||||
|
|
||||||
|
用选项名数组:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["状态", "intersects", ["Doing", "Blocked"]]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `user` / `created_by` / `updated_by`
|
||||||
|
|
||||||
|
用对象数组:
|
||||||
|
|
||||||
|
> **人员筛选:不要猜 ID。** 不知道 `open_id` 时,先用 `lark-contact` 查 id:`lark-cli contact +search-user --query "<姓名/邮箱/手机号>" --as user`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
["负责人", "intersects", [{ "id": "ou_xxx" }]]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `group_chat`
|
||||||
|
|
||||||
|
用对象数组:
|
||||||
|
|
||||||
|
> **群组筛选:不要猜 ID。** 不知道 `chat_id` 时,先用 `lark-im` 搜群:`lark-cli im +chat-search --query "<群名关键词>" --as user`;取结果里的 `oc_xxx`。
|
||||||
|
|
||||||
|
```json
|
||||||
|
["负责群", "intersects", [{ "id": "oc_xxx" }]]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `link`
|
||||||
|
|
||||||
|
用记录 id 对象数组:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["关联任务", "intersects", [{ "id": "rec_xxx" }]]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `checkbox`
|
||||||
|
|
||||||
|
用布尔值:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["完成", "==", true]
|
||||||
|
```
|
||||||
|
|
||||||
|
### `datetime` / `created_at` / `updated_at`
|
||||||
|
|
||||||
|
用相对时间关键字或 `ExactDate(...)`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["截止时间", "==", "ExactDate(2026-01-01)"]
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
["截止时间", "==", "ExactDate(2026-01-01 11:30)"]
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
["截止时间", "==", "Today"]
|
||||||
|
```
|
||||||
|
|
||||||
|
可用关键字:
|
||||||
|
- `Today`
|
||||||
|
- `Yesterday`
|
||||||
|
- `Tomorrow`
|
||||||
|
|
||||||
|
### `formula` / `lookup`
|
||||||
|
|
||||||
|
- 筛选值类型由字段计算结果类型动态决定。
|
||||||
|
- 拿不准时,先把 `value` 当作单个字符串填入做一次尝试。
|
||||||
|
- 如果报错,再按错误提示把 `value` 改成对应类型。
|
||||||
|
|
||||||
|
字符串示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["风险说明", "intersects", "高风险"]
|
||||||
|
```
|
||||||
|
|
||||||
|
数字示例:
|
||||||
|
|
||||||
|
```json
|
||||||
|
["汇总分", ">=", 80]
|
||||||
|
```
|
||||||
|
|
||||||
|
## 4. 推荐命令
|
||||||
|
|
||||||
|
```bash
|
||||||
|
lark-cli base +view-set-filter \
|
||||||
|
--base-token <base_token> \
|
||||||
|
--table-id <table_id> \
|
||||||
|
--view-id <view_id> \
|
||||||
|
--json '{"logic":"and","conditions":[["状态","intersects",["Doing"]],["负责人","intersects",[{"id":"ou_xxx"}]],["截止时间","empty"]]}'
|
||||||
|
```
|
||||||
|
|
||||||
|
## 5. JSON 写法
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["状态", "intersects", ["Doing"]],
|
||||||
|
["负责人", "intersects", [{ "id": "ou_xxx" }]],
|
||||||
|
["截止时间", "empty"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
清空写法:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"conditions": []
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 6. 使用建议
|
||||||
|
|
||||||
|
- 先读取当前筛选配置,理解现有 `logic` 和 `conditions` 的组合关系;只替换用户要求变更的条件,未提到的条件默认保留。
|
||||||
|
- 优先传字段 id,不要依赖字段名。
|
||||||
|
- 拿不准字段 type 或真实取值时,先用 `+field-list` / `+record-list` 确认,再按对应字段类型的 value 写法构造条件;别按字段名猜 type、凭印象猜枚举取值。
|
||||||
|
- 需要清空全部筛选时,直接传 `{"conditions":[]}`。
|
||||||
|
|
||||||
|
## 7. 易错点
|
||||||
|
|
||||||
|
- 本 tuple DSL 由 `+view-set-filter` 与 `+record-list` / `+record-search` 的 `--filter-json` 共用;不要写成 `+data-query` 的对象风格 `{"field_name":...,"operator":...}`(会报校验失败)。
|
||||||
|
- 标量类字段(`text` / `number` / `datetime` 等)的 value 用标量、别包成数组(各类型详见 value 写法一节)。
|
||||||
|
- `user` / `group_chat` / `link` 不要写成单个标量。
|
||||||
|
- `empty` / `non_empty` 不要硬塞无意义的 value。
|
||||||
|
- 日期条件稳定写法用 `ExactDate(...)` 或 `Today` / `Yesterday` / `Tomorrow`。
|
||||||
|
- `formula` / `lookup` 的 value 形状不固定;拿不准时先读当前 filter 或字段定义,或根据错误提示修正类型。
|
||||||
|
|
||||||
|
## 8. 参考
|
||||||
|
|
||||||
|
- [lookup-field-guide.md](lookup-field-guide.md)
|
||||||
830
.agents/skills/lark-base/references/lark-base-workflow-guide.md
Normal file
830
.agents/skills/lark-base/references/lark-base-workflow-guide.md
Normal file
@ -0,0 +1,830 @@
|
|||||||
|
# Workflow guide
|
||||||
|
|
||||||
|
本文档是 Workflow 的入口指南,帮助选择步骤组合、理解创建/更新边界,并引导到 steps JSON SSOT。
|
||||||
|
|
||||||
|
> **配套文档**:
|
||||||
|
> - Workflow 的数据结构参考:[lark-base-workflow-schema.md](lark-base-workflow-schema.md)
|
||||||
|
> - 创建/更新时重点构造 `title`、`status` 和 `steps`;复杂度集中在 `steps[].type/data/next`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 快速开始
|
||||||
|
|
||||||
|
### 最简单的 Workflow
|
||||||
|
|
||||||
|
新增记录时发送消息通知:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067200",
|
||||||
|
"title": "新订单自动通知",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "trigger_1",
|
||||||
|
"type": "AddRecordTrigger",
|
||||||
|
"title": "监控新订单",
|
||||||
|
"next": "action_1",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"watched_field_name": "订单号"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "action_1",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "发送通知",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "user", "value": {"id": "ou_xxxx", "name": "张三"} }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "新订单提醒" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "收到新订单" }
|
||||||
|
],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 场景速查表
|
||||||
|
|
||||||
|
| 场景 | 步骤组合 | 示例 |
|
||||||
|
|------|---------|------|
|
||||||
|
| 新增触发+通知 | AddRecordTrigger → LarkMessageAction | [下方](#示例1-新增记录触发--发送消息) |
|
||||||
|
| 按钮点击+调用外部接口+写入日志 | ButtonTrigger → HTTPClientAction → AddRecordAction | [下方](#示例-6-按钮触发--调用外部接口--写入同步日志) |
|
||||||
|
| 定时+循环 | TimerTrigger → FindRecordAction → Loop → LarkMessageAction | [下方](#示例2-定时触发--查找记录--循环遍历--发送消息) |
|
||||||
|
| 条件判断 | ... → IfElseBranch → 分支处理 | [下方](#示例3-条件分支-ifelsebranch) |
|
||||||
|
| 多路分类 | ... → SwitchBranch → 多分支处理 | [下方](#示例4-多路分支-switchbranch) |
|
||||||
|
| 复杂组合 | 定时+查找+循环+分支+消息 | [下方](#示例5-组合场景-定时查找循环分支消息) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 完整示例
|
||||||
|
|
||||||
|
### 示例 1: 新增记录触发 + 发送消息
|
||||||
|
|
||||||
|
**场景**: 当订单表新增记录时,发送飞书消息通知负责人。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067201",
|
||||||
|
"title": "新订单自动通知",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_trigger",
|
||||||
|
"type": "AddRecordTrigger",
|
||||||
|
"title": "新增订单时触发",
|
||||||
|
"next": "step_notify",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"watched_field_name": "订单号",
|
||||||
|
"condition_list": null
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_notify",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "发送订单通知",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "ref", "value": "$.step_trigger.fldManager" }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "新订单提醒" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "客户 " },
|
||||||
|
{ "value_type": "ref", "value": "$.step_trigger.fldCustomer" },
|
||||||
|
{ "value_type": "text", "value": " 创建了新订单,金额:¥" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_trigger.fldAmount" }
|
||||||
|
],
|
||||||
|
"btn_list": [
|
||||||
|
{
|
||||||
|
"text": "查看订单",
|
||||||
|
"btn_action": "openLink",
|
||||||
|
"link": [{ "value_type": "ref", "value": "$.step_trigger.recordLink" }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键点**:
|
||||||
|
- `AddRecordTrigger` 监控 `table_name` 表的 `watched_field_name` 字段
|
||||||
|
- 使用 `ref` 引用触发器输出的字段值(注意是 fieldId,不是字段名)
|
||||||
|
- `recordLink` 是触发器内置输出,表示记录链接
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 示例 2: 定时触发 + 查找记录 + 循环遍历 + 发送消息
|
||||||
|
|
||||||
|
**场景**: 每天早上 9 点,查找所有待处理订单,给每个客户发送提醒。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067202",
|
||||||
|
"title": "每日待处理订单提醒",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_timer",
|
||||||
|
"type": "TimerTrigger",
|
||||||
|
"title": "每天早上9点触发",
|
||||||
|
"next": "step_find_orders",
|
||||||
|
"data": {
|
||||||
|
"rule": "DAILY",
|
||||||
|
"start_time": "2025-01-01 09:00",
|
||||||
|
"is_never_end": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_find_orders",
|
||||||
|
"type": "FindRecordAction",
|
||||||
|
"title": "查找所有待处理订单",
|
||||||
|
"next": "step_loop_customers",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"field_names": ["客户名称", "订单金额", "客户联系方式"],
|
||||||
|
"should_proceed_when_no_results": false,
|
||||||
|
"filter_info": {
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"field_name": "状态",
|
||||||
|
"operator": "is",
|
||||||
|
"value": [{ "value_type": "option", "value": { "name": "待处理" } }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_loop_customers",
|
||||||
|
"type": "Loop",
|
||||||
|
"title": "遍历每个订单",
|
||||||
|
"children": {
|
||||||
|
"links": [
|
||||||
|
{ "kind": "loop_start", "to": "step_send_reminder" }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"loop_mode": "continue",
|
||||||
|
"max_loop_times": 100,
|
||||||
|
"data": [{
|
||||||
|
"value_type": "ref",
|
||||||
|
"value": "$.step_find_orders.fieldRecords"
|
||||||
|
}]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_send_reminder",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "发送催办消息",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{
|
||||||
|
"value_type": "ref",
|
||||||
|
"value": "$.step_loop_customers.item.fldContact"
|
||||||
|
}],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "订单处理提醒" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "您好,您的订单 " },
|
||||||
|
{ "value_type": "ref", "value": "$.step_loop_customers.item.fldName" },
|
||||||
|
{ "value_type": "text", "value": " 金额 ¥" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_loop_customers.item.fldAmount" },
|
||||||
|
{ "value_type": "text", "value": " 正在处理中。" }
|
||||||
|
],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键点**:
|
||||||
|
- `Loop.data` 必须传入 `ref` 类型的数据源(通常是 FindRecordAction 的 `fieldRecords`)
|
||||||
|
- `Loop.children.links` 必须包含 `kind: "loop_start"` 的链接指向循环体
|
||||||
|
- 循环体内用 `$.{loopStepId}.item.{fieldId}` 引用当前遍历记录的字段
|
||||||
|
- `$.{loopStepId}.index` 获取当前索引(从 0 开始)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 示例 3: 条件分支(IfElseBranch)
|
||||||
|
|
||||||
|
**场景**: 根据订单金额判断,大额订单通知主管审批,小额订单自动通过。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067203",
|
||||||
|
"title": "订单金额自动判断",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_trigger",
|
||||||
|
"type": "AddRecordTrigger",
|
||||||
|
"title": "新增订单时触发",
|
||||||
|
"next": "step_check_amount",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"watched_field_name": "订单金额"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_check_amount",
|
||||||
|
"type": "IfElseBranch",
|
||||||
|
"title": "判断是否为大额订单",
|
||||||
|
"children": {
|
||||||
|
"links": [
|
||||||
|
{ "kind": "if_true", "to": "step_notify_manager", "label": "high", "desc": "金额>=10000" },
|
||||||
|
{ "kind": "if_false", "to": "step_auto_approve", "label": "normal", "desc": "金额<10000" }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"next": "step_log",
|
||||||
|
"data": {
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_trigger.fldAmount" },
|
||||||
|
"operator": "isGreaterEqual",
|
||||||
|
"right_value": [{ "value_type": "number", "value": 10000 }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_notify_manager",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "通知主管审批大额订单",
|
||||||
|
"next": "step_log",
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "user", "value": {"id": "ou_manager", "name": "主管"} }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "大额订单待审批" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "有大额订单 ¥" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_trigger.fldAmount" },
|
||||||
|
{ "value_type": "text", "value": " 需要您审批" }
|
||||||
|
],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_auto_approve",
|
||||||
|
"type": "SetRecordAction",
|
||||||
|
"title": "自动标记小额订单为已审核",
|
||||||
|
"next": "step_log",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"ref_info": { "step_id": "step_trigger" },
|
||||||
|
"field_values": [
|
||||||
|
{
|
||||||
|
"field_name": "审批状态",
|
||||||
|
"value": [{ "value_type": "option", "value": { "name": "已自动审核" } }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_log",
|
||||||
|
"type": "GenerateAiTextAction",
|
||||||
|
"title": "生成订单处理日志",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"prompt": [
|
||||||
|
{ "value_type": "text", "value": "请生成订单处理日志,金额:" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_trigger.fldAmount" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键点**:
|
||||||
|
- `IfElseBranch.children.links` 必须包含 `if_true` 和 `if_false` 两个分支
|
||||||
|
- `next` 指向两个分支汇合后的步骤(可选,为 null 则分支结束)
|
||||||
|
- `condition` 使用 OrGroup 结构,支持 `(A and B) or (C and D)` 的复杂条件
|
||||||
|
- 分支内可以用 `ref_info` 引用触发记录,用 `filter_info` 批量筛选记录
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 示例 4: 多路分支(SwitchBranch)
|
||||||
|
|
||||||
|
**场景**: 根据订单优先级(P0/P1/P2)执行不同的处理流程。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067204",
|
||||||
|
"title": "按优先级分类处理订单",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_trigger",
|
||||||
|
"type": "AddRecordTrigger",
|
||||||
|
"title": "新增订单时触发",
|
||||||
|
"next": "step_classify",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"watched_field_name": "优先级"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_classify",
|
||||||
|
"type": "SwitchBranch",
|
||||||
|
"title": "按优先级分类",
|
||||||
|
"children": {
|
||||||
|
"links": [
|
||||||
|
{ "kind": "case", "to": "step_p0_handler", "label": "p0", "desc": "P0-紧急" },
|
||||||
|
{ "kind": "case", "to": "step_p1_handler", "label": "p1", "desc": "P1-高优先级" },
|
||||||
|
{ "kind": "case", "to": "step_p2_handler", "label": "p2", "desc": "P2-普通" },
|
||||||
|
{ "kind": "case", "to": "step_other_handler", "label": "other", "desc": "其他" }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"mode": "exclusive",
|
||||||
|
"no_match_action": "classifyToOther",
|
||||||
|
"child_branch_list": [
|
||||||
|
{
|
||||||
|
"name": "P0-紧急",
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_trigger.fldPriority" },
|
||||||
|
"operator": "is",
|
||||||
|
"right_value": [{ "value_type": "option", "value": { "name": "P0" } }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "P1-高优先级",
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_trigger.fldPriority" },
|
||||||
|
"operator": "is",
|
||||||
|
"right_value": [{ "value_type": "option", "value": { "name": "P1" } }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "P2-普通",
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_trigger.fldPriority" },
|
||||||
|
"operator": "is",
|
||||||
|
"right_value": [{ "value_type": "option", "value": { "name": "P2" } }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_p0_handler",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "P0紧急处理",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "user", "value": {"id": "ou_director", "name": "总监"} }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "🚨 P0 紧急订单" }],
|
||||||
|
"content": [{ "value_type": "text", "value": "有新的 P0 紧急订单需要立即处理" }],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_p1_handler",
|
||||||
|
"type": "SetRecordAction",
|
||||||
|
"title": "标记高优先级",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"ref_info": { "step_id": "step_trigger" },
|
||||||
|
"field_values": [
|
||||||
|
{ "field_name": "处理状态", "value": [{ "value_type": "text", "value": "高优先级待处理" }] }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_p2_handler",
|
||||||
|
"type": "Delay",
|
||||||
|
"title": "普通订单延迟处理",
|
||||||
|
"next": null,
|
||||||
|
"data": { "duration": 60 }
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_other_handler",
|
||||||
|
"type": "SetRecordAction",
|
||||||
|
"title": "标记其他订单",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"ref_info": { "step_id": "step_trigger" },
|
||||||
|
"field_values": [
|
||||||
|
{ "field_name": "处理状态", "value": [{ "value_type": "text", "value": "待分类" }] }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键点**:
|
||||||
|
- `SwitchBranch` 适合 3 路及以上的分支场景(少于 3 路用 `IfElseBranch` 更简洁)
|
||||||
|
- `children.links` 中 `kind: "case"` 的 `label` 对应 `child_branch_list` 中的条件
|
||||||
|
- `mode: "exclusive"` 表示排他执行(第一个匹配的分支执行后停止)
|
||||||
|
- `no_match_action: "classifyToOther"` 表示无匹配时走最后一个 `case`(兜底分支)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 示例 5: 组合场景(定时+查找+循环+分支+消息)
|
||||||
|
|
||||||
|
**场景**: 每天早上 9 点,查找昨天的订单,按金额分级,给不同级别的销售发送不同的通知。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067205",
|
||||||
|
"title": "每日订单分级通知",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_timer",
|
||||||
|
"type": "TimerTrigger",
|
||||||
|
"title": "每天早上9点触发",
|
||||||
|
"next": "step_find_orders",
|
||||||
|
"data": {
|
||||||
|
"rule": "DAILY",
|
||||||
|
"start_time": "2025-01-01 09:00",
|
||||||
|
"is_never_end": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_find_orders",
|
||||||
|
"type": "FindRecordAction",
|
||||||
|
"title": "查找昨天所有订单",
|
||||||
|
"next": "step_loop",
|
||||||
|
"data": {
|
||||||
|
"table_name": "订单表",
|
||||||
|
"field_names": ["订单号", "客户名称", "金额", "销售负责人"],
|
||||||
|
"should_proceed_when_no_results": false,
|
||||||
|
"filter_info": {
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{ "field_name": "创建时间", "operator": "isGreaterEqual", "value": [{ "value_type": "date", "value": "yesterday" }] }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_loop",
|
||||||
|
"type": "Loop",
|
||||||
|
"title": "遍历每个订单",
|
||||||
|
"children": {
|
||||||
|
"links": [
|
||||||
|
{ "kind": "loop_start", "to": "step_classify" }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"next": "step_summary",
|
||||||
|
"data": {
|
||||||
|
"loop_mode": "continue",
|
||||||
|
"max_loop_times": 500,
|
||||||
|
"data": [{ "value_type": "ref", "value": "$.step_find_orders.fieldRecords" }]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_classify",
|
||||||
|
"type": "SwitchBranch",
|
||||||
|
"title": "按金额分类",
|
||||||
|
"children": {
|
||||||
|
"links": [
|
||||||
|
{ "kind": "case", "to": "step_vip_notify", "label": "vip", "desc": "VIP >= 10万" },
|
||||||
|
{ "kind": "case", "to": "step_normal_notify", "label": "normal", "desc": "普通 < 10万" }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"mode": "exclusive",
|
||||||
|
"no_match_action": "fail",
|
||||||
|
"child_branch_list": [
|
||||||
|
{
|
||||||
|
"name": "VIP订单",
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_loop.item.fldAmount" },
|
||||||
|
"operator": "isGreaterEqual",
|
||||||
|
"right_value": [{ "value_type": "number", "value": 100000 }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "普通订单",
|
||||||
|
"condition": {
|
||||||
|
"conjunction": "or",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"conjunction": "and",
|
||||||
|
"conditions": [
|
||||||
|
{
|
||||||
|
"left_value": { "value_type": "ref", "value": "$.step_loop.item.fldAmount" },
|
||||||
|
"operator": "isLess",
|
||||||
|
"right_value": [{ "value_type": "number", "value": 100000 }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_vip_notify",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "VIP订单通知",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "ref", "value": "$.step_loop.item.fldSales" }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "🌟 VIP大额订单" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "恭喜!您有一笔 VIP 订单 ¥" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_loop.item.fldAmount" },
|
||||||
|
{ "value_type": "text", "value": ",客户:" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_loop.item.fldCustomer" }
|
||||||
|
],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_normal_notify",
|
||||||
|
"type": "LarkMessageAction",
|
||||||
|
"title": "普通订单通知",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"receiver": [{ "value_type": "ref", "value": "$.step_loop.item.fldSales" }],
|
||||||
|
"send_to_everyone": false,
|
||||||
|
"title": [{ "value_type": "text", "value": "新订单通知" }],
|
||||||
|
"content": [
|
||||||
|
{ "value_type": "text", "value": "您有一笔新订单 ¥" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_loop.item.fldAmount" }
|
||||||
|
],
|
||||||
|
"btn_list": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_summary",
|
||||||
|
"type": "GenerateAiTextAction",
|
||||||
|
"title": "生成日报",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"prompt": [
|
||||||
|
{ "value_type": "text", "value": "请生成昨日订单处理日报" }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 示例 6: 按钮触发 + 调用外部接口 + 写入同步日志
|
||||||
|
|
||||||
|
**场景**: 在「客户线索表」里给每条记录配置一个“同步到 CRM”按钮。销售点击按钮后,Workflow 调用外部 CRM 接口同步当前线索,再在「同步日志表」新增一条记录,方便后续审计和排查。
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"client_token": "1704067206",
|
||||||
|
"title": "线索一键同步到 CRM",
|
||||||
|
"steps": [
|
||||||
|
{
|
||||||
|
"id": "step_button_trigger",
|
||||||
|
"type": "ButtonTrigger",
|
||||||
|
"title": "点击同步到 CRM 按钮时触发",
|
||||||
|
"next": "step_call_crm_api",
|
||||||
|
"data": {
|
||||||
|
"button_type": "buttonField",
|
||||||
|
"table_name": "客户线索表"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_call_crm_api",
|
||||||
|
"type": "HTTPClientAction",
|
||||||
|
"title": "调用 CRM 同步接口",
|
||||||
|
"next": "step_add_sync_log",
|
||||||
|
"data": {
|
||||||
|
"method": "POST",
|
||||||
|
"url": [
|
||||||
|
{ "value_type": "text", "value": "https://api.example-crm.com/v1/leads/sync" }
|
||||||
|
],
|
||||||
|
"headers": [
|
||||||
|
{ "key": "Content-Type", "value": [{ "value_type": "text", "value": "application/json" }] },
|
||||||
|
{ "key": "X-System", "value": [{ "value_type": "text", "value": "lark_base_workflow" }] }
|
||||||
|
],
|
||||||
|
"body_type": "raw",
|
||||||
|
"raw_body": [
|
||||||
|
{ "value_type": "text", "value": "{\"lead_name\":\"" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_button_trigger.fldLeadName" },
|
||||||
|
{ "value_type": "text", "value": "\",\"mobile\":\"" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_button_trigger.fldMobile" },
|
||||||
|
{ "value_type": "text", "value": "\",\"company\":\"" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_button_trigger.fldCompany" },
|
||||||
|
{ "value_type": "text", "value": "\",\"owner\":\"" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_button_trigger.fldOwner" },
|
||||||
|
{ "value_type": "text", "value": "\",\"source_record_id\":\"" },
|
||||||
|
{ "value_type": "ref", "value": "$.step_button_trigger.recordId" },
|
||||||
|
{ "value_type": "text", "value": "\"}" }
|
||||||
|
],
|
||||||
|
"response_type": "json",
|
||||||
|
"response_value": "{\"success\":true,\"message\":\"lead synced successfully\"}"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "step_add_sync_log",
|
||||||
|
"type": "AddRecordAction",
|
||||||
|
"title": "写入同步日志",
|
||||||
|
"next": null,
|
||||||
|
"data": {
|
||||||
|
"table_name": "同步日志表",
|
||||||
|
"field_values": [
|
||||||
|
{
|
||||||
|
"field_name": "线索名称",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_button_trigger.fldLeadName" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "手机号",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_button_trigger.fldMobile" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "公司名称",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_button_trigger.fldCompany" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "负责人",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_button_trigger.fldOwner" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "来源记录ID",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_button_trigger.recordId" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "同步状态",
|
||||||
|
"value": [{ "value_type": "text", "value": "已提交 CRM 同步" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "同步是否成功",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_call_crm_api.body.success" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "同步结果说明",
|
||||||
|
"value": [{ "value_type": "ref", "value": "$.step_call_crm_api.body.message" }]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"field_name": "备注",
|
||||||
|
"value": [{ "value_type": "text", "value": "由按钮触发自动发起同步请求" }]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**关键点**:
|
||||||
|
- `ButtonTrigger` 适合“人工确认后再执行”的场景,比如同步 CRM、推送 ERP、发起审批等
|
||||||
|
- `button_type: "buttonField"` 表示按钮挂在记录上,因此可以直接引用当前记录的字段和值
|
||||||
|
- `HTTPClientAction.raw_body` 可以通过 `text + ref + text` 的方式动态拼接 JSON 请求体
|
||||||
|
- `HTTPClientAction` 的输出引用规则是:`response_type=none` 时不可引用;`response_type=text` 时只能用 `$.stepId` 引整个文本;`response_type=json` 时用 `$.stepId.body` 引整个 body、用 `$.stepId.body.字段名` 引 body 中字段,同时 `$.stepId.status_code` 表示 HTTP 返回状态码
|
||||||
|
- `HTTPClientAction.response_value` 中声明了哪些字段,后续节点就只能引用这些字段;例如 `$.step_call_crm_api.body.success`、`$.step_call_crm_api.body.message`
|
||||||
|
- `AddRecordAction` 常用于写日志表、操作审计表、同步结果表,便于追踪谁在什么时候触发了外部调用
|
||||||
|
- 示例里的 `fldLeadName` / `fldMobile` / `fldCompany` / `fldOwner` 只是占位的 fieldId,请以实际表字段 ID 为准
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 构造技巧
|
||||||
|
|
||||||
|
### Loop 构造要点
|
||||||
|
|
||||||
|
1. **数据源**: `Loop.data` 必须传入 `ref` 类型,通常是 `FindRecordAction` 的 `fieldRecords`
|
||||||
|
2. **循环体**: `children.links` 必须包含 `kind: "loop_start"` 指向循环体入口
|
||||||
|
3. **引用**: 循环体内用 `$.{loopStepId}.item.{fieldId}` 引用当前元素
|
||||||
|
4. **索引**: 用 `$.{loopStepId}.index` 获取当前索引(从 0 开始)
|
||||||
|
|
||||||
|
### 分支构造要点
|
||||||
|
|
||||||
|
1. **IfElseBranch**:
|
||||||
|
- 适合二元判断(是/否、大于/小于)
|
||||||
|
- `children.links` 必须包含 `if_true` 和 `if_false`
|
||||||
|
- 可以用 `next` 指向汇合点
|
||||||
|
|
||||||
|
2. **SwitchBranch**:
|
||||||
|
- 适合多路分类(3路及以上)
|
||||||
|
- `label` 对应 `child_branch_list` 中的条件顺序
|
||||||
|
- 建议加一个兜底分支(其他)
|
||||||
|
|
||||||
|
### 字段值构造
|
||||||
|
|
||||||
|
| 字段类型 | value_type | 示例 |
|
||||||
|
|---------|------------|------|
|
||||||
|
| 文本 | `text` | `{"value_type": "text", "value": "张三"}` |
|
||||||
|
| 数字 | `number` | `{"value_type": "number", "value": 100}` |
|
||||||
|
| 单选 | `option` | `{"value_type": "option", "value": {"name": "已完成"}}` |
|
||||||
|
| 人员 | `user` | `{"value_type": "user", "value": {"id": "ou_xxxx"}}` |
|
||||||
|
| 引用 | `ref` | `{"value_type": "ref", "value": "$.step_1.fldxxx"}` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 常见错误避免
|
||||||
|
|
||||||
|
### Top 10 高频错误
|
||||||
|
|
||||||
|
| # | 错误信息 | 原因 | 解决方案 |
|
||||||
|
|---|---------|------|---------|
|
||||||
|
| 1 | `path "xxx" does not exist in the output path tree` | ref 引用路径错误或 stepId 不存在 | 检查 stepId 是否在 steps 数组中;使用 fieldId 而非字段名;确保路径以 `$.` 开头 |
|
||||||
|
| 2 | `recordInfo.conditions must be non-empty` | `condition_list` 为空数组 `[]` | 改用 `null` 或省略该字段 |
|
||||||
|
| 3 | `At least one of filter info and ref info is required` | SetRecordAction/FindRecordAction 缺少定位条件 | 必须提供 `filter_info` 或 `ref_info` 之一 |
|
||||||
|
| 4 | `client token is empty` | 缺少 `client_token` | 每次请求传入唯一值(时间戳或随机字符串) |
|
||||||
|
| 5 | `valueType 'text' not allowed for fieldType '3'` | select 类型字段值格式错误 | 改用 `option` 类型 |
|
||||||
|
| 6 | `Undefined Step Type` | 使用了不支持的 StepType | 使用 `AddRecordTrigger` 而非 `CreateRecordTrigger` |
|
||||||
|
| 7 | `prompt references an unknown reference from step` | 引用的 stepId 不存在 | 确保引用的 step 在同一 workflow 的 steps 数组中 |
|
||||||
|
| 8 | `[2200] Internal Error` | 1. steps[].id 重复 2. next/children.links 引用了不存在的 step | 确保所有 step id 唯一;检查引用关系 |
|
||||||
|
| 9 | 工作流结构不完整 | Branch/Loop 节点缺少 `children` | 仅 Branch(IfElseBranch/SwitchBranch)和 Loop 节点需要 `children`,Trigger/Action 节点无需设置 |
|
||||||
|
| 10 | 嵌套分支过于复杂 | 多层 IfElseBranch 嵌套 | 3+ 路分支用 SwitchBranch 替代嵌套 IfElseBranch |
|
||||||
|
|
||||||
|
### 其他常见错误
|
||||||
|
|
||||||
|
**1. condition_list 为空数组**
|
||||||
|
```json
|
||||||
|
// ❌ 错误
|
||||||
|
{ "condition_list": [] }
|
||||||
|
|
||||||
|
// ✅ 正确
|
||||||
|
{ "condition_list": null }
|
||||||
|
// 或省略该字段
|
||||||
|
```
|
||||||
|
|
||||||
|
**2. filter_info 和 ref_info 同时提供**
|
||||||
|
```json
|
||||||
|
// ❌ 错误
|
||||||
|
{ "filter_info": {...}, "ref_info": {...} }
|
||||||
|
|
||||||
|
// ✅ 正确(二选一)
|
||||||
|
{ "filter_info": {...}, "ref_info": null }
|
||||||
|
{ "filter_info": null, "ref_info": {...} }
|
||||||
|
```
|
||||||
|
|
||||||
|
**3. 使用字段名而非 fieldId**
|
||||||
|
```json
|
||||||
|
// ❌ 错误
|
||||||
|
{ "value": "$.step_1.客户名称" }
|
||||||
|
|
||||||
|
// ✅ 正确
|
||||||
|
{ "value": "$.step_1.fldXXXXXXXX" }
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 参考
|
||||||
|
|
||||||
|
- [lark-base-workflow-schema.md](lark-base-workflow-schema.md) — 字段定义参考
|
||||||
|
- 创建/更新前先确认真实表名、字段名和目标 workflow ID;`steps` 结构按 schema 构造,不凭自然语言猜 `type`
|
||||||
1071
.agents/skills/lark-base/references/lark-base-workflow-schema.md
Normal file
1071
.agents/skills/lark-base/references/lark-base-workflow-schema.md
Normal file
File diff suppressed because it is too large
Load Diff
512
.agents/skills/lark-base/references/lookup-field-guide.md
Normal file
512
.agents/skills/lark-base/references/lookup-field-guide.md
Normal file
@ -0,0 +1,512 @@
|
|||||||
|
# Base Lookup Field Configuration Guide
|
||||||
|
|
||||||
|
## Mandatory Read Acknowledgement
|
||||||
|
|
||||||
|
When creating or updating a lookup field with `lark-cli base +field-create/+field-update --json ...` and `type` is `lookup`, you should read this guide first and only then add `--i-have-read-guide` to the command.
|
||||||
|
|
||||||
|
Do **not** proactively add `--i-have-read-guide` before reading this guide. Without it, the CLI will fail fast and direct you back to this guide.
|
||||||
|
|
||||||
|
When using `+field-update`, also pass `--yes`: field update is a high-risk `PUT` operation because changing a field definition can affect the whole column.
|
||||||
|
|
||||||
|
## Default strategy
|
||||||
|
|
||||||
|
**Use Formula fields by default for cross-table references and aggregations.** Only use Lookup fields when the user explicitly requests a Lookup field. Formula is a strict superset of Lookup — anything Lookup can do, Formula can do with a single expression.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
When creating a lookup field, the Agent should:
|
||||||
|
|
||||||
|
1. Get all table names: `lark-cli base +table-list --base-token <base>` — returns `items[].table_name`
|
||||||
|
2. Get table structure: `lark-cli base +table-get --base-token <base> --table-id <table>` — returns `fields[]`
|
||||||
|
3. If the lookup references other tables, also get those tables' structures
|
||||||
|
4. Determine the four elements: from (source table), select (source field), where (filter), aggregate (aggregation)
|
||||||
|
5. Construct the Lookup field JSON and submit it to create or update the field
|
||||||
|
|
||||||
|
**Key constraints**:
|
||||||
|
|
||||||
|
- Table names and field names must **exactly match** those returned by `+table-list` / `+table-get`
|
||||||
|
- The `from` table must be in the same Base
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 1: Core Concepts — Four-Element Model
|
||||||
|
|
||||||
|
A Lookup field is defined by five fields:
|
||||||
|
|
||||||
|
| Field | Meaning | JSON key | Required |
|
||||||
|
|-------|---------|----------|----------|
|
||||||
|
| **type** | Must be `"lookup"` | `type` | Yes |
|
||||||
|
| **from** | Source table to pull data from | `from` | Yes |
|
||||||
|
| **select** | Field in the source table to retrieve | `select` | Yes |
|
||||||
|
| **where** | Filter conditions on the source table | `where` | Yes (at least one condition) |
|
||||||
|
| **aggregate** | How to aggregate multiple matching records | `aggregate` | No (default: `raw_value`) |
|
||||||
|
|
||||||
|
**SQL analogy**:
|
||||||
|
|
||||||
|
```
|
||||||
|
SELECT [select field]
|
||||||
|
FROM [from table]
|
||||||
|
WHERE [filter conditions]
|
||||||
|
GROUP BY [aggregate function]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Row-level matching (most important concept)**:
|
||||||
|
|
||||||
|
A Lookup field is computed row-by-row — for each row in the current table, it filters the source table to find "related" records. **The filter defines what "related" means.**
|
||||||
|
|
||||||
|
```
|
||||||
|
Current table row 1 → filter source table → matching records → select field → aggregate → result
|
||||||
|
Current table row 2 → filter source table → matching records → select field → aggregate → result
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
**Rule: Whenever the current table and the source table have a row-level correspondence (matching by some field value), you must specify a filter.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 2: Lookup vs Link vs Formula
|
||||||
|
|
||||||
|
Lookup and Link serve **different purposes**. Creating a Lookup does NOT require a Link field to exist first.
|
||||||
|
|
||||||
|
| Dimension | Link | Lookup | Formula |
|
||||||
|
|-----------|------|--------|---------|
|
||||||
|
| Purpose | Establish record relationships (read-write) | Pull and aggregate data from another table (read-only) | Compute values from expressions (read-only) |
|
||||||
|
| When to use | "link" / "associate" / "bind" two tables | "look up" / "reference" / "aggregate" / "count" from another table | Calculations, text manipulation, conditional logic |
|
||||||
|
|
||||||
|
**Common mistake**: Creating a Link field just to create a Lookup. If two tables share a matching text/number field, Lookup can match directly — no Link required.
|
||||||
|
|
||||||
|
**Selection decision tree**:
|
||||||
|
|
||||||
|
```
|
||||||
|
What does the user need?
|
||||||
|
├─ "Link"/"associate"/"bind" records between tables → Link
|
||||||
|
├─ "Look up"/"reference"/"aggregate"/"count" from another table → Lookup
|
||||||
|
│ ├─ Needs aggregation (sum/count/average)? → Lookup + aggregate
|
||||||
|
│ └─ Just reference a value? → Lookup (aggregate = null)
|
||||||
|
├─ Calculations/text manipulation within current table → Formula
|
||||||
|
└─ Access linked record's field → Prefer Lookup (more intuitive), or Formula chain access
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 3: Filter Condition Rules
|
||||||
|
|
||||||
|
**You must provide a `where` with at least one condition.** Improper conditions cause every row to pull all records from the source table.
|
||||||
|
|
||||||
|
### The Iron Rule: field belongs to source table
|
||||||
|
|
||||||
|
```
|
||||||
|
filter condition:
|
||||||
|
field → must be a field in the FROM table (source table)
|
||||||
|
value → constant or reference to a field in the CURRENT table
|
||||||
|
```
|
||||||
|
|
||||||
|
### How to find the matching field pair
|
||||||
|
|
||||||
|
**With a Link field (most common)**: The match is between the **Link field** and the **target table's primary field**.
|
||||||
|
|
||||||
|
```
|
||||||
|
Link is in the source table → source.linkField matches current.primaryField
|
||||||
|
Link is in the current table → source.primaryField matches current.linkField
|
||||||
|
```
|
||||||
|
|
||||||
|
**Without a Link field**: Two tables share a field with the same meaning — match directly.
|
||||||
|
|
||||||
|
### Where condition structure
|
||||||
|
|
||||||
|
Each condition is a **tuple** (array) of 2 or 3 elements: `[field, operator, value?]`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["<source table field>", "<operator>", { "type": "constant", "value": "<val>" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
For `empty` / `non_empty`, the value can be omitted (2-element tuple):
|
||||||
|
|
||||||
|
```json
|
||||||
|
["<source table field>", "empty"]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Two value formats
|
||||||
|
|
||||||
|
**Constant value** — for fixed conditions (e.g., "status is completed"):
|
||||||
|
|
||||||
|
```json
|
||||||
|
["状态", "==", { "type": "constant", "value": "已完成" }]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Field reference** — for dynamic per-row matching (e.g., "match current row's project"):
|
||||||
|
|
||||||
|
```json
|
||||||
|
["项目名", "==", { "type": "field_ref", "field": "项目名" }]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Decision guide**: Fixed condition (e.g., "status is completed") → `constant`. Dynamic condition (e.g., "match current record's project ID") → `field_ref`.
|
||||||
|
|
||||||
|
### Constant value format by field type
|
||||||
|
|
||||||
|
The `value` inside `{ "type": "constant", "value": ... }` varies by field type:
|
||||||
|
|
||||||
|
| Field type | Constant value format | Example |
|
||||||
|
|-----------|----------------------|---------|
|
||||||
|
| `text` | String | `"已完成"` |
|
||||||
|
| `number` | Number | `100`, `0.8` |
|
||||||
|
| `datetime` / `created_at` / `updated_at` | String | `"ExactDate(2025-01-01)"`, `"ExactDate(2025-01-01 09:30)"`, `"Today"`, `"Yesterday"`, `"Tomorrow"` |
|
||||||
|
| `select` (`multiple=false/true`) | Option name array | `["Todo"]`, `["Todo", "Done"]` |
|
||||||
|
| `link` | Record reference array | `[{ "id": "rec_xxx" }]`, `[{ "id": "rec_xxx" }, { "id": "rec_yyy" }]` |
|
||||||
|
| `user` / `created_by` / `updated_by` | User reference array | `[{ "id": "ou_xxx" }]`, `[{ "id": "ou_xxx" }, { "id": "ou_yyy" }]` |
|
||||||
|
| `checkbox` | Boolean | `true`, `false` |
|
||||||
|
| `attachment` / `location` | Only `empty` / `non_empty` | value must be `null` or omitted |
|
||||||
|
| `auto_number` | Not supported for constant comparison | Use dynamic field\_ref instead |
|
||||||
|
| `formula` / `lookup` (exact type) | Follow the underlying type rules | — |
|
||||||
|
| `formula` / `lookup` (fuzzy type) | String | `"some text"` |
|
||||||
|
|
||||||
|
**`datetime` notes**:
|
||||||
|
- Supported datetime constant values are `ExactDate(...)`, `Today`, `Yesterday`, `Tomorrow`
|
||||||
|
- Date-only fields use `ExactDate(YYYY-MM-DD)`
|
||||||
|
- Fields that include time use `ExactDate(YYYY-MM-DD HH:mm)`
|
||||||
|
- For complex or relative date filtering, consider using a Formula field instead
|
||||||
|
|
||||||
|
### Dynamic field reference — set comparison semantics
|
||||||
|
|
||||||
|
When using `{ "type": "field_ref", "field": "..." }`, values from both sides are first **converted to sets** at runtime, then compared using set operations:
|
||||||
|
|
||||||
|
- **`==`**: Sets are exactly equal (strict matching)
|
||||||
|
- **`intersects`**: Sets have a non-empty intersection (most commonly used)
|
||||||
|
|
||||||
|
**Conversion rules by field type**:
|
||||||
|
|
||||||
|
| Field type | Converted to |
|
||||||
|
|-----------|-------------|
|
||||||
|
| `text` | Single-element string set |
|
||||||
|
| `number` / `auto_number` / `datetime` | Single-element number set |
|
||||||
|
| `select` (`multiple=false/true`) | Set of option name strings |
|
||||||
|
| `user` / `created_by` / `updated_by` | Set of user name strings |
|
||||||
|
| `link` | Set of linked records' primary field string representations |
|
||||||
|
| `formula` / `lookup` | The computed value set |
|
||||||
|
|
||||||
|
**Examples**:
|
||||||
|
- User field `["name1", "name2"]` **intersects** text `"name1"` → true; **==** text `"name1"` → false (sets not equal)
|
||||||
|
- User field `["name1"]` **==** text `"name1"` → true (single-element sets are equal)
|
||||||
|
- Link field referencing records → converted to primary field strings, then compared
|
||||||
|
|
||||||
|
### Supported operators
|
||||||
|
|
||||||
|
| Operator | Meaning | Applicable field types |
|
||||||
|
|----------|---------|-----------------|
|
||||||
|
| `==` | Equal (exact match) | All types |
|
||||||
|
| `!=` | Not equal | All types |
|
||||||
|
| `>` | Greater than | `number`, `datetime` |
|
||||||
|
| `>=` | Greater than or equal | `number`, `datetime` |
|
||||||
|
| `<` | Less than | `number`, `datetime` |
|
||||||
|
| `<=` | Less than or equal | `number`, `datetime` |
|
||||||
|
| `intersects` | Has intersection (non-empty overlap) | All types (most commonly used for dynamic field\_ref) |
|
||||||
|
| `disjoint` | No intersection | All types |
|
||||||
|
| `empty` | Field is empty | All types (value must be null or omitted) |
|
||||||
|
| `non_empty` | Field is not empty | All types (value must be null or omitted) |
|
||||||
|
|
||||||
|
### Constraints
|
||||||
|
|
||||||
|
- **Only one level of and/or** — nesting (e.g., `{ and: [{ or: [...] }] }`) is not supported
|
||||||
|
- **At least one condition** — empty conditions array will error
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 4: Aggregate Rules
|
||||||
|
|
||||||
|
| Aggregate | Common user phrasing | Select field should be | Result type |
|
||||||
|
|-----------|---------------------|----------------------|-------------|
|
||||||
|
| `sum` | "total" / "sum" / "cumulative amount" | `number` field (e.g., amount) | Number |
|
||||||
|
| `average` | "average" / "mean" | `number` field | Number |
|
||||||
|
| `max` | "maximum" / "latest" / "most recent" | `number` / `datetime` field | Same as source |
|
||||||
|
| `min` | "minimum" / "earliest" | `number` / `datetime` field | Same as source |
|
||||||
|
| `counta` | "count" / "how many" / "total number" | Any field | Number |
|
||||||
|
| `unique_counta` | "count distinct" / "how many different" | Field to deduplicate | Number |
|
||||||
|
| `unique` | "list distinct" / "which ones" / "show different" | Field to display | List |
|
||||||
|
| `raw_value` | "list all" / "show all values" (default) | Field to display | List |
|
||||||
|
|
||||||
|
**Common confusion**: `unique` returns a **deduplicated list**, `unique_counta` returns a **count**. "Which categories are involved" → `unique`; "How many categories" → `unique_counta`.
|
||||||
|
|
||||||
|
**Important**:
|
||||||
|
- Enum values are **snake_case lowercase**: `sum` not `Sum`, `average` not `Average`
|
||||||
|
- **Count is `counta`, NOT `count`** — this is the most common enum mistake
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 5: Hard Constraints
|
||||||
|
|
||||||
|
1. **Always write a filter**: The `where` field is required with at least one condition. Whenever the current table and source table have row-level correspondence, the condition should express that relationship.
|
||||||
|
2. **Lookup fields are read-only**: Cell values cannot be manually set.
|
||||||
|
3. **Create Lookup after all dependent fields exist**: The source table and referenced fields must exist before creating the Lookup field.
|
||||||
|
4. **Source table must be in the same Base**: Cross-Base lookups are not supported.
|
||||||
|
5. **Changing `from` requires changing `select`**: Updating the source table without updating the select field will error.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 6: Decision Trees
|
||||||
|
|
||||||
|
### How to build the filter
|
||||||
|
|
||||||
|
```
|
||||||
|
Step 1: Analyze the filtering semantics in the user's request
|
||||||
|
"Count artworks per exhibition" → filter: belongs to exhibition = current exhibition
|
||||||
|
"Sum completed order amounts" → filter: status = completed AND project = current project
|
||||||
|
|
||||||
|
Step 2: Find the matching field pair
|
||||||
|
├─ Tables have a Link relationship?
|
||||||
|
│ ├─ Link is in source table → source.linkField matches current.primaryField
|
||||||
|
│ └─ Link is in current table → source.primaryField matches current.linkField
|
||||||
|
├─ Tables share same-meaning text/number field? → source.field matches current.field
|
||||||
|
└─ Also need constant filtering? → AND combination
|
||||||
|
```
|
||||||
|
|
||||||
|
### Which aggregate?
|
||||||
|
|
||||||
|
```
|
||||||
|
How to handle multiple matching records?
|
||||||
|
├─ Show all values as-is → raw_value (default)
|
||||||
|
├─ Show deduplicated list → unique
|
||||||
|
├─ Sum → sum
|
||||||
|
├─ Average → average
|
||||||
|
├─ Maximum / minimum → max / min
|
||||||
|
├─ Count records → counta
|
||||||
|
└─ Count distinct → unique_counta
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 7: Common Configuration Patterns
|
||||||
|
|
||||||
|
> Patterns are categorized by **filter matching method**. Aggregate choice is independent — see Section 4.
|
||||||
|
|
||||||
|
### Pattern 1: Aggregate from a linked table (Link is in the source table)
|
||||||
|
|
||||||
|
**Scenario**: "Count artworks per exhibition", "Sum order amounts per project"
|
||||||
|
|
||||||
|
When the source table has a Link pointing to the current table:
|
||||||
|
|
||||||
|
```
|
||||||
|
Exhibition table: ExhibitionName (primaryField) ← current table
|
||||||
|
Artwork table: ArtworkName (primaryField), ← source table (Link is here)
|
||||||
|
Exhibition (Link → Exhibition table)
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "Artwork Count",
|
||||||
|
"from": "Artwork table",
|
||||||
|
"select": "ArtworkName",
|
||||||
|
"aggregate": "counta",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["Exhibition", "intersects", { "type": "field_ref", "field": "ExhibitionName" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 2: Reference a linked record's field (Link is in the current table)
|
||||||
|
|
||||||
|
**Scenario**: "Show supplier's contact person", "Display warehouse manager"
|
||||||
|
|
||||||
|
When the current table has a Link pointing to the source table:
|
||||||
|
|
||||||
|
```
|
||||||
|
Supplier table: SupplierName (primaryField), Contact (Text) ← source table
|
||||||
|
Inventory table: ProductName (primaryField), ← current table (Link is here)
|
||||||
|
Supplier (Link → Supplier table)
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "Supplier Contact",
|
||||||
|
"from": "Supplier table",
|
||||||
|
"select": "Contact",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["SupplierName", "intersects", { "type": "field_ref", "field": "Supplier" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 3: Match by same-meaning field (no Link)
|
||||||
|
|
||||||
|
**Scenario**: "Sum order amounts per project" (tables share a "ProjectName" field but no Link)
|
||||||
|
|
||||||
|
```
|
||||||
|
Project table: ProjectName (primaryField) ← current table
|
||||||
|
Order table: OrderID (primaryField), ProjectName (Text), ← source table
|
||||||
|
Amount (Number)
|
||||||
|
```
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "Order Total",
|
||||||
|
"from": "Order table",
|
||||||
|
"select": "Amount",
|
||||||
|
"aggregate": "sum",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["ProjectName", "==", { "type": "field_ref", "field": "ProjectName" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 4: Dynamic matching + constant filtering
|
||||||
|
|
||||||
|
**Scenario**: "Only count completed orders", "Only sum approved budgets"
|
||||||
|
|
||||||
|
Combine row-level matching with fixed-value filtering using `logic: "and"`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "Completed Order Amount",
|
||||||
|
"from": "Order table",
|
||||||
|
"select": "Amount",
|
||||||
|
"aggregate": "sum",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["Manager", "==", { "type": "field_ref", "field": "EmployeeName" }],
|
||||||
|
["Status", "==", { "type": "constant", "value": "Completed" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Pattern 5: Date filtering with constant value
|
||||||
|
|
||||||
|
**Scenario**: "Look up orders created after 2025-01-01", "Sum today's sales"
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"type": "lookup",
|
||||||
|
"name": "Recent Orders",
|
||||||
|
"from": "Order table",
|
||||||
|
"select": "Amount",
|
||||||
|
"aggregate": "sum",
|
||||||
|
"where": {
|
||||||
|
"logic": "and",
|
||||||
|
"conditions": [
|
||||||
|
["ProjectName", "==", { "type": "field_ref", "field": "ProjectName" }],
|
||||||
|
["CreatedDate", ">=", { "type": "constant", "value": "ExactDate(2025-01-01)" }]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 8: Anti-Pattern Collection
|
||||||
|
|
||||||
|
### Mistake 1: Omitting where (most common)
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong: no where, every row pulls all records
|
||||||
|
{ "type": "lookup", "name": "Artwork Count", "from": "Artwork table", "select": "ArtworkName", "aggregate": "counta" }
|
||||||
|
|
||||||
|
// Correct: where with Link relationship
|
||||||
|
{ "type": "lookup", "name": "Artwork Count", "from": "Artwork table", "select": "ArtworkName", "aggregate": "counta",
|
||||||
|
"where": { "logic": "and", "conditions": [
|
||||||
|
["Exhibition", "intersects", { "type": "field_ref", "field": "ExhibitionName" }]
|
||||||
|
]}}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 2: Wrong value type — confusing constant vs field_ref
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong: using constant for a dynamic join
|
||||||
|
["ProjectName", "==", { "type": "constant", "value": "ProjectName" }]
|
||||||
|
|
||||||
|
// Correct: use field_ref for dynamic per-row matching
|
||||||
|
["ProjectName", "==", { "type": "field_ref", "field": "ProjectName" }]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 3: Using `count` instead of `counta`
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong
|
||||||
|
{ "aggregate": "count" }
|
||||||
|
|
||||||
|
// Correct
|
||||||
|
{ "aggregate": "counta" }
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 4: Wrong case for aggregate values
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong
|
||||||
|
{ "aggregate": "SUM" }
|
||||||
|
{ "aggregate": "Sum" }
|
||||||
|
|
||||||
|
// Correct — snake_case lowercase
|
||||||
|
{ "aggregate": "sum" }
|
||||||
|
{ "aggregate": "average" }
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 5: Nested where conditions
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong: nesting not supported
|
||||||
|
{ "logic": "and", "conditions": [
|
||||||
|
{ "logic": "or", "conditions": [...] }
|
||||||
|
]}
|
||||||
|
|
||||||
|
// Correct: only one level
|
||||||
|
{ "logic": "and", "conditions": [cond1, cond2, cond3] }
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 6: Confusing Lookup with Link
|
||||||
|
|
||||||
|
The user says "aggregate order amounts" — use Lookup, not Link. Link establishes relationships; Lookup retrieves and aggregates data.
|
||||||
|
|
||||||
|
### Mistake 7: Using object format instead of tuple for conditions
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong: object format
|
||||||
|
{ "fieldRef": "Status", "operator": "is", "value": { "type": "constant", "value": "Done" } }
|
||||||
|
|
||||||
|
// Correct: tuple format [field, operator, value?]
|
||||||
|
["Status", "==", { "type": "constant", "value": "Done" }]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Mistake 8: Missing `type` field
|
||||||
|
|
||||||
|
```json
|
||||||
|
// Wrong: no type field
|
||||||
|
{ "name": "Total", "from": "Orders", "select": "Amount", "aggregate": "sum", "where": { ... } }
|
||||||
|
|
||||||
|
// Correct: must include type
|
||||||
|
{ "type": "lookup", "name": "Total", "from": "Orders", "select": "Amount", "aggregate": "sum", "where": { ... } }
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Section 9: Constraint Summary
|
||||||
|
|
||||||
|
- `type` must be `"lookup"` — this field is required in the request body
|
||||||
|
- `where` is required with at least one condition — always specify a filter
|
||||||
|
- Conditions use **tuple format**: `[field, operator, value?]` — NOT object format
|
||||||
|
- Lookup fields are read-only — values cannot be manually set
|
||||||
|
- Source table and referenced fields must exist before creating the Lookup
|
||||||
|
- Condition field (first element of tuple) must reference a field in the source table, not the current table
|
||||||
|
- Where supports only one level of and/or — no nesting
|
||||||
|
- Aggregate values are snake_case lowercase: `sum`, `counta`, `unique_counta` (NOT `count`)
|
||||||
|
- Operators: `==`, `!=`, `>`, `>=`, `<`, `<=`, `intersects`, `disjoint`, `empty`, `non_empty`
|
||||||
|
- Table and field names must exactly match `+table-get` output
|
||||||
|
- `datetime` constant values use string format: `ExactDate(YYYY-MM-DD)` / `ExactDate(YYYY-MM-DD HH:mm)` / `Today` / `Yesterday` / `Tomorrow`
|
||||||
|
- `select` constant values use option names;
|
||||||
|
- `link` / `user` constant values use `{id}` object arrays
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user