feat(base): add button rule commands #2289
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| // Copyright (c) 2026 Lark Technologies Pte. Ltd. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package base | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
|
|
||
| "github.com/larksuite/cli/shortcuts/common" | ||
| ) | ||
|
|
||
| var BaseButtonBind = common.Shortcut{ | ||
| Service: "base", | ||
| Command: "+button-bind", | ||
| Description: "Bind a button field to a workflow", | ||
| Risk: "write", | ||
| Scopes: []string{"base:field:update", "base:workflow:update"}, | ||
| AuthTypes: authTypes(), | ||
| Flags: []common.Flag{ | ||
| baseTokenFlag(true), | ||
| tableRefFlag(true), | ||
| fieldRefFlag(true), | ||
| {Name: "workflow-id", Desc: "workflow ID (wkf... prefix)", Required: true}, | ||
| }, | ||
| Tips: []string{ | ||
| "Create the button-trigger workflow first, then create the button field, then bind them with this command.", | ||
| "Button field JSON must not include workflow_id; binding is managed only through button_rule APIs.", | ||
| "workflow-id must start with wkf; do not pass a tbl table ID or raw internal automation ID.", | ||
| }, | ||
| Validate: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return validateButtonBind(runtime) | ||
| }, | ||
| DryRun: dryRunButtonBind, | ||
| Execute: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return executeButtonBind(runtime) | ||
| }, | ||
| } | ||
|
|
||
| var BaseButtonGet = common.Shortcut{ | ||
| Service: "base", | ||
| Command: "+button-get", | ||
| Description: "Get the workflow bound to a button field", | ||
| Risk: "read", | ||
| Scopes: []string{"base:field:read", "base:workflow:read"}, | ||
| AuthTypes: authTypes(), | ||
| Flags: []common.Flag{ | ||
| baseTokenFlag(true), | ||
| tableRefFlag(true), | ||
| fieldRefFlag(true), | ||
| }, | ||
| Tips: []string{ | ||
| "Returns the button_rule binding for a button field; use +workflow-get for workflow details.", | ||
| "The binding workflow_id is the public wkf-prefixed workflow ID.", | ||
| }, | ||
| Validate: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return validateButtonRuleLocator(runtime) | ||
| }, | ||
| DryRun: dryRunButtonGet, | ||
| Execute: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return executeButtonGet(runtime) | ||
| }, | ||
| } | ||
|
|
||
| var BaseButtonUnbind = common.Shortcut{ | ||
| Service: "base", | ||
| Command: "+button-unbind", | ||
| Description: "Unbind a button field from its workflow", | ||
| Risk: "high-risk-write", | ||
| Scopes: []string{"base:field:update", "base:workflow:update"}, | ||
| AuthTypes: authTypes(), | ||
| Flags: []common.Flag{ | ||
| baseTokenFlag(true), | ||
| tableRefFlag(true), | ||
| fieldRefFlag(true), | ||
| }, | ||
| Tips: []string{ | ||
| "Unbind only removes the button_rule relation; it does not delete the button field or workflow.", | ||
| "Agent guidance: for high-risk writes, explain the exact target and pass --yes without asking again when the user has already asked you to perform this action.", | ||
| }, | ||
| Validate: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return validateButtonRuleLocator(runtime) | ||
| }, | ||
| DryRun: dryRunButtonUnbind, | ||
| Execute: func(ctx context.Context, runtime *common.RuntimeContext) error { | ||
| return executeButtonUnbind(runtime) | ||
| }, | ||
| } | ||
|
|
||
| func validateButtonRuleLocator(runtime *common.RuntimeContext) error { | ||
| if strings.TrimSpace(runtime.Str("base-token")) == "" { | ||
| return baseFlagErrorf("--base-token must not be blank") | ||
| } | ||
| if strings.TrimSpace(baseTableID(runtime)) == "" { | ||
| return baseFlagErrorf("--table-id must not be blank") | ||
| } | ||
| if strings.TrimSpace(runtime.Str("field-id")) == "" { | ||
| return baseFlagErrorf("--field-id must not be blank") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func validateButtonBind(runtime *common.RuntimeContext) error { | ||
| if err := validateButtonRuleLocator(runtime); err != nil { | ||
| return err | ||
| } | ||
| workflowID := strings.TrimSpace(runtime.Str("workflow-id")) | ||
| if workflowID == "" { | ||
| return baseFlagErrorf("--workflow-id must not be blank") | ||
| } | ||
| if !strings.HasPrefix(workflowID, "wkf") { | ||
| return baseFlagErrorf("--workflow-id must be a public workflow ID with wkf prefix") | ||
| } | ||
|
Comment on lines
+107
to
+113
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Reject or normalize surrounding whitespace in
Reject leading or trailing whitespace before validation succeeds, or use the normalized value in both request bodies. Add a regression test for whitespace-padded input. Also applies to: 126-134, 152-159 🤖 Prompt for AI Agents |
||
| return nil | ||
| } | ||
|
|
||
| func buttonRulePath(runtime *common.RuntimeContext) string { | ||
| return baseV3Path( | ||
| "bases", runtime.Str("base-token"), | ||
| "tables", baseTableID(runtime), | ||
| "fields", runtime.Str("field-id"), | ||
| "button_rule", | ||
| ) | ||
| } | ||
|
|
||
| func dryRunButtonBind(_ context.Context, runtime *common.RuntimeContext) *common.DryRunAPI { | ||
| body := map[string]interface{}{"workflow_id": runtime.Str("workflow-id")} | ||
| return common.NewDryRunAPI(). | ||
| PUT("/open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id/button_rule"). | ||
| Body(body). | ||
| Set("base_token", runtime.Str("base-token")). | ||
| Set("table_id", baseTableID(runtime)). | ||
| Set("field_id", runtime.Str("field-id")) | ||
| } | ||
|
|
||
| func dryRunButtonGet(_ context.Context, runtime *common.RuntimeContext) *common.DryRunAPI { | ||
| return common.NewDryRunAPI(). | ||
| GET("/open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id/button_rule"). | ||
| Set("base_token", runtime.Str("base-token")). | ||
| Set("table_id", baseTableID(runtime)). | ||
| Set("field_id", runtime.Str("field-id")) | ||
| } | ||
|
|
||
| func dryRunButtonUnbind(_ context.Context, runtime *common.RuntimeContext) *common.DryRunAPI { | ||
| return common.NewDryRunAPI(). | ||
| DELETE("/open-apis/base/v3/bases/:base_token/tables/:table_id/fields/:field_id/button_rule"). | ||
| Set("base_token", runtime.Str("base-token")). | ||
| Set("table_id", baseTableID(runtime)). | ||
| Set("field_id", runtime.Str("field-id")) | ||
| } | ||
|
|
||
| func executeButtonBind(runtime *common.RuntimeContext) error { | ||
| body := map[string]interface{}{"workflow_id": runtime.Str("workflow-id")} | ||
| data, err := baseV3CallAny(runtime, "PUT", buttonRulePath(runtime), nil, body) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| runtime.Out(map[string]interface{}{"button_rule": data, "bound": true}, nil) | ||
| return nil | ||
| } | ||
|
|
||
| func executeButtonGet(runtime *common.RuntimeContext) error { | ||
| data, err := baseV3CallAny(runtime, "GET", buttonRulePath(runtime), nil, nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| runtime.Out(map[string]interface{}{"button_rule": data}, nil) | ||
| return nil | ||
| } | ||
|
|
||
| func executeButtonUnbind(runtime *common.RuntimeContext) error { | ||
| data, err := baseV3CallAny(runtime, "DELETE", buttonRulePath(runtime), nil, nil) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| runtime.Out(map[string]interface{}{"button_rule": data, "unbound": true}, nil) | ||
| return nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🗄️ Data Integrity & Integration | 🟠 Major | 🏗️ Heavy lift
Add mounted dry-run and live E2E coverage for the new shortcuts.
This test calls
dryRunButtonBind,dryRunButtonGet, anddryRunButtonUnbinddirectly. It does not cover shortcut mounting, flag wiring, validation routing, confirmation behavior, orExecuterequest plumbing.Add shortcut-level dry-run E2E tests. Add self-contained live E2E coverage that creates the workflow and button field, binds, gets, unbinds, and cleans up the resources.
As per coding guidelines: “Shortcut changes require dry-run E2E coverage” and “new shortcuts require live E2E coverage.”
🤖 Prompt for AI Agents
Source: Coding guidelines