Command Sequences, Blocking CLI Commands, New Plugin APIs (#4546)

* fix deadlocks

* initial logging to plugin implementation

* only log actions, include keys as Action::Write

* send actions to plugins as a new Event::UserAction

* add Action::Write metadata to plugin API

* run_action plugin command and permission

* block-until-exit/success/failure in the cli

* fix tests

* add NewBlockingPane to the plugin API

* run actions in a different thread so as not to block plugin execution

* add custom context to run_action flow

* fixes for floating pane z_index sorting and unknown protobuf events not crashing plugins

* always render the frame of pinned panes

* macros module

* add macros to config

* KDL macro parsing

* thread macros to the plugin thread

* get/update/delete macros from plugins

* add macros updated event

* add ability to rename macros

* fix deadlock

* fix z_indices with pinned unselectable panes bug

* allow plugins to opt-in to show_cursor

* change show_cursor(bool) to show_cursor(Option<coordinates>)

* test

* upgrade strum to allow proper enum iteration and case insensitive fromstr implementation for Actions

* better cwd tracking for exited command panes

* add initial panes to NewTab Action (no-op for now)

* add initial panes to cli newtab action

* make initial panes work

* add close_on_exit and start_suspended to the cli

* properly convert newtab action (potentially breaking for plugins)

* allow first pane in tab to block

* make distinction between opening panes with the last active client and the current pane in the cli

* improve some apis

* fix fixed size closing pane bug

* fix plugin cursor coordinates

* fix issues with launch-or-focus-plugin having to do with in-place and suppressed panes

* fix: set affected pane in replace pane

* allow setting a pane in place when it is suppressed and being focused (tests failing)

* fix tests

* some fixes for unsuppression of panes

* some fixes for completion_tx in new tab action

* allow replace/suppressed rather than replace/close only

* fixes for inserting suppressed panes without conflicts

* pane focus history and explicit unsuppress plugin api

* fix: prefer explicitly provided pane id in placement in actions that provide it

* fix floating pane coordinate change and z_index

* fix plugin cache dir to persist between sessions

* fix some stack focusing issues when adding panes without a client id

* make sure pinned panes are always above non-pinned floating panes

* allow plugins to copy to clipboard

* initial text styling additions implementations - buggy

* fix dimming issues

* remove extras, stay with just dim and unbold

* unbold and dim as indices

* allow ui components to render success/error colors

* allow plugins to send sigint/sigkill to processes, as well as receive their pid

* ui component fixes and send originating plugin context with run_action

* originating plugin for new tab too

* make plugn show pane command also expand stacked panes

* add sequence plugin

* remove macros

* remove snapshots

* add shortcut for sequence plugin

* fix plugin tests

* plugin tests for new apis

* update snapshots for sequence shortcut

* cleanups and formatting

* Event::CwdChanged

* moar cleanups

* remove some warnings

* remove mroe warnings

* remove dead code

* remove more dead code

* fix minor bugs in sequence plugin

* update sequence help and format codebase

* fix conditional blocking cli commands

* fix initial-command new-tab cli flag

* add client_ids to CwdChanged Event

* last fixes

* add pr

1 files changed, 31 insertions, 0 deletions

diff --git a/zellij-utils/src/plugin_api/event.proto b/zellij-utils/src/plugin_api/event.proto
index f5059131..3bdeea19 100644
--- a/zellij-utils/src/plugin_api/event.proto
+++ b/zellij-utils/src/plugin_api/event.proto
@@ -59,6 +59,9 @@ enum EventType {
     FailedToStartWebServer = 34;
     InterceptedKeyPress = 35;
     PaneRenderReport = 36;
+    UserAction = 37;
+    ActionComplete = 38;
+    CwdChanged = 39;
 }
 
 message EventNameList {
@@ -97,9 +100,18 @@ message Event {
     FailedToStartWebServerPayload failed_to_start_web_server_payload = 28;
     key.Key intercepted_key_payload = 29;
     PaneRenderReportPayload pane_render_report_payload = 30;
+    UserActionPayload user_action_payload = 31;
+    ActionCompletePayload action_complete_payload = 32;
+    CwdChangedPayload cwd_changed_payload = 33;
   }
 }
 
+message CwdChangedPayload {
+  PaneId pane_id = 1;
+  string new_cwd = 2;
+  repeated uint32 focused_client_ids = 3;
+}
+
 message FailedToStartWebServerPayload {
   string error = 1;
 }
@@ -284,6 +296,7 @@ message SessionManifest {
   bool web_clients_allowed = 8;
   uint32 web_client_count = 9;
   repeated ClientTabHistory tab_history = 10;
+  repeated ClientPaneHistory pane_history = 11;
 }
 
 message ClientTabHistory {
@@ -291,6 +304,11 @@ message ClientTabHistory {
   repeated uint32 tab_history = 2;
 }
 
+message ClientPaneHistory {
+  uint32 client_id = 1;
+  repeated PaneId pane_history = 2;
+}
+
 message PluginInfo {
   uint32 plugin_id = 1;
   string plugin_url = 2;
@@ -418,3 +436,16 @@ message SelectedText {
   action.Position start = 1;
   action.Position end = 2;
 }
+
+message UserActionPayload {
+  action.Action action = 1;
+  uint32 client_id = 2;
+  optional uint32 terminal_id = 3;
+  optional uint32 cli_client_id = 4;
+}
+
+message ActionCompletePayload {
+  action.Action action = 1;
+  optional PaneId pane_id = 2;
+  repeated ContextItem context = 3;
+}