bmux_workspaces_plugin_api 0.0.1-alpha.4

Typed public API of the bmux workspaces plugin
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

// Public typed contract for named workspace metadata above tabs.
plugin bmux.workspaces version 1;

capability WORKSPACES_READ = bmux.workspaces.read;
capability WORKSPACES_WRITE = bmux.workspaces.write;

@capability(WORKSPACES_READ)
interface workspaces-state {
    record workspace-summary {
        id: uuid,
        name: string,
        tab-ids: list<uuid>,
        active: bool,
    }

    record workspace-selector {
        id: uuid?,
        name: string?,
    }

    variant workspace-query-error {
        not-found,
        invalid-selector { reason: string },
    }

    query list-workspaces() -> list<workspace-summary>;
    query get-workspace(selector: workspace-selector)
        -> result<workspace-summary, workspace-query-error>;
    query current-workspace() -> workspace-summary?;
}

@capability(WORKSPACES_WRITE)
interface workspaces-commands {
    record workspace-ack {
        id: uuid,
        selected-context-id: uuid?,
    }

    variant workspace-command-error {
        not-found,
        invalid-name { reason: string },
        no-previous-workspace,
        denied { reason: string },
        failed { reason: string },
    }

    command new-workspace(name: string?)
        -> result<workspace-ack, workspace-command-error>;
    command rename-workspace(selector: workspaces-state.workspace-selector, name: string)
        -> result<workspace-ack, workspace-command-error>;
    command kill-workspace(selector: workspaces-state.workspace-selector)
        -> result<workspace-ack, workspace-command-error>;
    command switch-workspace(selector: workspaces-state.workspace-selector)
        -> result<workspace-ack, workspace-command-error>;
    command next-workspace()
        -> result<workspace-ack, workspace-command-error>;
    command prev-workspace()
        -> result<workspace-ack, workspace-command-error>;
    command last-workspace()
        -> result<workspace-ack, workspace-command-error>;
    command move-tab-to-workspace(
        context-id: uuid,
        workspace: workspaces-state.workspace-selector,
    ) -> result<workspace-ack, workspace-command-error>;
}

@capability(WORKSPACES_WRITE)
interface workspaces-activation-v1 {
    // Exact durable target activation, independent of the current workspace.
    // No fallback target is selected when this ID no longer exists.
    command activate-tab(context-id: uuid)
        -> result<workspaces-commands.workspace-ack, workspaces-commands.workspace-command-error>;
}

interface workspaces-events {
    variant workspace-event {
        created { workspace-id: uuid, name: string },
        removed { workspace-id: uuid },
        selected {
            workspace-id: uuid,
            context-id: uuid,
            initiator-client-id: uuid?,
        },
        renamed { workspace-id: uuid, name: string },
    }

    events workspace-event;
}

interface workspaces-list {
    record workspace-list-snapshot {
        workspaces: list<workspaces-state.workspace-summary>,
        revision: u64,
    }

    @state events workspace-list-snapshot;
}