bcode_command 0.0.1-alpha.0

Command contract types and service interface for bcode
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

// BPDL reference contract for Bcode command registry services.
//
// This is the first small Bcode service modeled in BPDL so future command
// registry clients/providers can use generated request/response bindings
// instead of handwritten envelopes.

plugin bcode.cmd version 1;

capability COMMAND_REGISTRY = bcode.cmd.registry;

@capability(COMMAND_REGISTRY)
interface command-registry-query {
    enum command-surface {
        palette,
        slash,
        keybinding,
    }

    enum command-owner-kind {
        host,
        plugin_owner,
    }

    record command-owner {
        kind: command-owner-kind,
        plugin_id: string?,
    }

    enum command-action-kind {
        host,
        plugin_action,
        service,
    }

    record command-action {
        kind: command-action-kind,
        route: string?,
        plugin_id: string?,
        command_name: string?,
        interface_id: string?,
        operation: string?,
        payload: bytes?,
    }

    record command-contribution {
        id: string,
        title: string,
        description: string?,
        category: string?,
        surfaces: list<command-surface>,
        slash_name: string?,
        slash_aliases: list<string>,
        argument_names: list<string>,
        session_requirement: string,
        owner: command-owner,
        action: command-action,
    }

    record list-commands-input {
        surface: command-surface?,
    }

    record list-commands-output {
        commands: list<command-contribution>,
    }

    query list-commands(request: list-commands-input) -> list-commands-output;
}

@capability(COMMAND_REGISTRY)
interface command-registry-command {
    record command-contribution {
        id: string,
        title: string,
        description: string?,
        category: string?,
        slash_name: string?,
        slash_aliases: list<string>,
        argument_names: list<string>,
        session_requirement: string,
    }

    record register-command-input {
        contribution: command-contribution,
    }

    record invoke-command-input {
        command_id: string,
        args_json: string?,
    }

    record invoke-command-output {
        output_json: string?,
    }

    command register(request: register-command-input) -> unit;
    command invoke(request: invoke-command-input) -> invoke-command-output;
}