mirror of
https://github.com/larksuite/cli.git
synced 2026-09-14 18:42:53 +08:00
zhouyue-bytedance
d5afe3f705
* fix(base): improve dashboard shortcut guidance
* docs(base): refine dashboard funnel guidance
* docs(base): drop redundant block-get audit tip
The 'do not audit every block after creation' hint duplicates the
create-then-suppress-get guidance already in lark-base-dashboard.md,
so remove it from the +dashboard-block-get tips to keep them focused.
* test(base): drop stale block-get audit tip assertion
Commit 778da63a removed the 'do not audit every block' tip from the
+dashboard-block-get source as redundant but left the matching
assertion in TestBaseDashboardHelpGuidesAgents, breaking the unit
test. Remove the stale assertion to realign the test with the tips.
* docs(base): clarify when NOT to use helper table for dashboard blocks
* fix(base): defer record-list --json to framework shorthand (align with main)
* fix(base): reject non-string dashboard sort.order instead of silently defaulting to asc
* docs(base): fix reversed cumulative-funnel direction (suffix sum + assumptions)
* docs(base): scope dashboard-arrange to explicit request or fresh new dashboard
* test(base): pin missing sort.order behavior; clarify --no-validate is raw pass-through
* docs(base): show real CLI envelope {ok,identity,data} for get-data and data-query outputs
85 lines
3.2 KiB
Go
85 lines
3.2 KiB
Go
// Copyright (c) 2026 Lark Technologies Pte. Ltd.
|
||
// SPDX-License-Identifier: MIT
|
||
|
||
package base
|
||
|
||
import (
|
||
"context"
|
||
"encoding/json"
|
||
"strings"
|
||
|
||
"github.com/larksuite/cli/shortcuts/common"
|
||
)
|
||
|
||
var BaseDashboardBlockUpdate = common.Shortcut{
|
||
Service: "base",
|
||
Command: "+dashboard-block-update",
|
||
Description: "Update a dashboard block",
|
||
Risk: "write",
|
||
Scopes: []string{"base:dashboard:update"},
|
||
AuthTypes: authTypes(),
|
||
HasFormat: true,
|
||
Flags: []common.Flag{
|
||
baseTokenFlag(true),
|
||
dashboardIDFlag(true),
|
||
blockIDFlag(true),
|
||
{Name: "name", Desc: "new block name"},
|
||
{Name: "data-config", Desc: "data_config JSON object; read dashboard-block-data-config.md for the SSOT"},
|
||
{Name: "user-id-type", Desc: "user ID type for user fields in filters: open_id / union_id / user_id"},
|
||
{Name: "no-validate", Type: "bool", Desc: "skip local data_config validation and normalization; send data_config as-is"},
|
||
},
|
||
Tips: []string{
|
||
`lark-cli base +dashboard-block-update --base-token <base_token> --dashboard-id <dashboard_id> --block-id <block_id> --name "Total Sales"`,
|
||
`lark-cli base +dashboard-block-update --base-token <base_token> --dashboard-id <dashboard_id> --block-id <block_id> --data-config '{"series":[{"field_name":"Amount","rollup":"SUM"}]}'`,
|
||
"Read dashboard-block-data-config.md as the SSOT for data_config templates, filters, metric rules, and type-specific fields; do not invent data_config from natural language.",
|
||
"Use +dashboard-block-get first to inspect the current data_config before replacing nested values.",
|
||
"Block type cannot be changed; delete and recreate the block to change chart type.",
|
||
"data_config update merges top-level keys, but each provided key is replaced as a whole.",
|
||
},
|
||
Validate: func(ctx context.Context, runtime *common.RuntimeContext) error {
|
||
pc := newParseCtx(runtime)
|
||
if runtime.Bool("no-validate") {
|
||
return nil
|
||
}
|
||
raw := runtime.Str("data-config")
|
||
if strings.TrimSpace(raw) == "" {
|
||
return nil
|
||
}
|
||
cfg, err := parseJSONObject(pc, raw, "data-config")
|
||
if err != nil {
|
||
return err
|
||
}
|
||
norm := normalizeDataConfig(cfg)
|
||
// update 时不做强类型校验（不传 type），让后端验证具体字段
|
||
b, _ := json.Marshal(norm)
|
||
_ = runtime.Cmd.Flags().Set("data-config", string(b))
|
||
return nil
|
||
},
|
||
DryRun: func(ctx context.Context, runtime *common.RuntimeContext) *common.DryRunAPI {
|
||
pc := newParseCtx(runtime)
|
||
body := map[string]interface{}{}
|
||
if name := runtime.Str("name"); name != "" {
|
||
body["name"] = name
|
||
}
|
||
if raw := runtime.Str("data-config"); raw != "" {
|
||
if parsed, err := parseJSONObject(pc, raw, "data-config"); err == nil {
|
||
body["data_config"] = parsed
|
||
}
|
||
}
|
||
params := map[string]interface{}{}
|
||
if uid := runtime.Str("user-id-type"); uid != "" {
|
||
params["user_id_type"] = uid
|
||
}
|
||
return common.NewDryRunAPI().
|
||
PATCH("/open-apis/base/v3/bases/:base_token/dashboards/:dashboard_id/blocks/:block_id").
|
||
Params(params).
|
||
Body(body).
|
||
Set("base_token", runtime.Str("base-token")).
|
||
Set("dashboard_id", runtime.Str("dashboard-id")).
|
||
Set("block_id", runtime.Str("block-id"))
|
||
},
|
||
Execute: func(ctx context.Context, runtime *common.RuntimeContext) error {
|
||
return executeDashboardBlockUpdate(runtime)
|
||
},
|
||
}
|