terminal.proto RawHistoryFolder

1// Terminal I/O, UI fences, and bounded preview viewports.
2syntax = "proto3";
3
4package vev.wire.v1;
5
6import "common.proto";
7import "session.proto";
8
9option go_package = "github.com/bnema/vev/internal/protocol/wire";
10
11// ViewContext is the committed boundary of one output state.
12message ViewContext {
13  uint64 publication = 1;
14  CommittedRouteIdentity route = 2;
15  string tab_id = 3;
16  string focused_pane_id = 4;
17}
18
19// Output is one terminal state. Terminal data uses the explicit encoding
20// enum below; converters compress only full snapshots at the frozen
21// threshold and only when smaller.
22message Output {
23  uint64 epoch = 1;
24  uint64 base = 2;
25  uint64 new_state = 3;
26  uint64 echo = 4;
27  uint64 view_revision = 5;
28  uint32 cols = 6;
29  uint32 rows = 7;
30  bool full = 8;
31  ViewContext context = 9; // optional pointer
32  // Closed encoding taxonomy: 0 = raw, 1 = zlib (full snapshots only).
33  uint32 encoding = 10;
34  uint64 uncompressed_length = 11;
35  bytes data = 12;
36}
37
38// Ack cumulatively acknowledges one epoch.
39message Ack {
40  uint64 epoch = 1;
41  uint64 state = 2;
42}
43
44// Input carries client keystrokes and pastes.
45message Input {
46  uint64 input_seq = 1;
47  uint64 action_id = 2;
48  bytes data = 3;
49}
50
51// Resize carries a geometry claim.
52message Resize {
53  uint32 cols = 1;
54  uint32 rows = 2;
55  uint32 pixel_width = 3;
56  uint32 pixel_height = 4;
57}
58
59// Theme carries the 57-byte fixed terminal theme block field by field.
60message Theme {
61  bool has_foreground = 1;
62  RGB foreground = 2;
63  bool has_background = 3;
64  RGB background = 4;
65  reserved 5;
66  reserved "true_color";
67  bool scheme_known = 6;
68  bool light = 7;
69  uint32 palette_known = 8;
70  repeated RGB palette = 9; // exactly 16 entries
71}
72
73// ImagePush carries one Kitty graphics payload.
74message ImagePush {
75  uint64 input_seq = 1;
76  string mime = 2;
77  bytes data = 3;
78}
79
80// ClientNotice is a fixed one-byte client signal.
81message ClientNotice {
82  // Closed action taxonomy: 1 = clipboard fallback, 2 = clipboard too
83  // large, 3 = link degraded, 4 = link connected.
84  uint32 action = 1;
85}
86
87// OutputResetRequest restarts the output chain. Empty marker.
88message OutputResetRequest {}
89
90// TerminalFocus reports a focus change of the client's terminal window.
91message TerminalFocus {
92  // Closed focus taxonomy: 1 = focused, 2 = unfocused.
93  uint32 focus = 1;
94}
95
96// SelectTab shows one exact tab of the attached session on this attachment.
97message SelectTab {
98  string tab_id = 1;
99}
100
101// UIFence orders UI operations by action.
102message UIFence {
103  uint64 action_id = 1;
104}
105
106// UIReceipt reports the processed output boundary.
107message UIReceipt {
108  uint64 action_id = 1;
109  uint64 epoch = 2;
110  uint64 state = 3;
111  uint64 view_publication = 4;
112  // Closed outcome taxonomy: 1 = processed, 2 = unavailable.
113  uint32 outcome = 5;
114}
115
116// UIViewUpdate publishes a view boundary without terminal data.
117message UIViewUpdate {
118  uint64 epoch = 1;
119  uint64 state = 2;
120  ViewContext context = 3;
121}
122
123// RemotePreviewRequest names a bounded exact-target viewport.
124message RemotePreviewRequest {
125  uint32 version = 1;
126  RemoteTarget target = 2;
127  uint32 width = 3;
128  uint32 height = 4;
129}
130
131// RemotePreviewWatch is a client first message: the server answers with a
132// stream of RemotePreview frames, at most one per min_interval_ms, until the
133// client closes the connection.
134message RemotePreviewWatch {
135  RemotePreviewRequest request = 1;
136  // Whole milliseconds inside [16, 1000].
137  uint32 min_interval_ms = 2;
138}
139
140// RemotePreview is a bounded row-major styled-cell viewport.
141message RemotePreview {
142  uint32 version = 1;
143  // Closed status taxonomy: 0 = ok, 1 = unavailable, 2 = no such target,
144  // 3 = stale, 4 = malformed, 5 = too large.
145  uint32 status = 2;
146  LifecycleID lifecycle_id = 3;
147  string tab_id = 4;
148  uint64 revision = 5;
149  uint32 width = 6;
150  uint32 height = 7;
151  repeated PreviewCell cells = 8;
152}