covey-plugin 0.0.1

APIs for creating Covey plugins
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

syntax = "proto2";
package plugin;

import "google/protobuf/empty.proto";

service Plugin {
  // Initialise the service, given some initialisation info.
  //
  // It is guaranteed that this function will be called and completed
  // before any of the others are run.
  rpc Initialise(InitialiseRequest) returns (google.protobuf.Empty);
  rpc Query(QueryRequest) returns (QueryResponse);
  rpc Activate(ActivationRequest) returns (stream ActivationResponse);
}

message InitialiseRequest { required string json = 1; }

message QueryRequest { required string query = 1; }

message QueryResponse {
  repeated ListItem items = 1;
  // The kind of list to show.
  //
  // If this is not provided, the list style will be the default set
  // by the user. Plugins should only set one if the content makes the
  // most sense with one of these styles.
  oneof list_style {
    // Show one item per row.
    google.protobuf.Empty rows = 2;
    // A grid with an adaptive size.
    google.protobuf.Empty grid = 3;
    // A grid with a specific number of columns per row.
    uint32 grid_with_columns = 4;
  }
}

message ListItem {
  // Must be unique within the plugin - duplicates across multiple
  // plugins is fine.
  required uint64 id = 1;
  required string title = 2;
  required string description = 3;
  oneof icon {
    // A named icon, taken from the system.
    string NAME = 4;
    // Just some text. It should be very short.
    string TEXT = 5;
  }
  // The command IDs that can be activated on this list item.
  repeated string available_commands = 6;
}

message ActivationResponse { required Action action = 1; }

message Action {
  // Required.
  oneof action {
    google.protobuf.Empty close = 1;
    string copy = 2;
    Input set_input = 3;
    string display_error = 9;
  };
}

message Command {
  required string cmd = 1;
  repeated string args = 2;
}

message Input {
  required string query = 1;
  required uint32 range_lb = 2;
  required uint32 range_ub = 3;
}

message ActivationRequest {
  required uint64 selection_id = 1;
  required string command_name = 2;
}