n5i-plugin-proto 0.12.0-dev.2

Protobuf definitions for n5i 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

// SPDX-FileCopyrightText: 2024-2026 The n5i Project
//
// SPDX-License-Identifier: AGPL-3.0-or-later

syntax = "proto3";

package n5i_plugin;
import "common.proto";

message GetContextRequest {
  // The id of the app we're rendering the template for.
  string app_id = 1;
  // These permissions already have the <plugin-name>/ prefix removed.
  repeated string permissions = 2;
  // JSON-encoded data the app wants to share with the plugin.
  string additional_data = 3;
  UserState user_state = 4;
}

message AppContext {
  // JSON-encoded data
  // The built-in app.yml parser adds this to the Jinja context, but other plugins may handle it differently
  string context = 1;
}

message RegisterAppRequest {
  // The id of the app we're registering.
  string app_id = 1;
  // These permissions already have the <plugin-name>/ prefix removed.
  repeated string permissions = 2;
  // JSON-encoded data the app wants to share with the plugin.
  string additional_data = 3;
  UserState user_state = 4;
}

message UnregisterAppRequest {
  // The id of the app we're unregistering.
  string app_id = 1;
  UserState user_state = 2;
}

message RegisterAppResponse {}
message UnregisterAppResponse {}

// A context plugin enhances the "context" of apps with data
service ContextPlugin {
  // This method gets invoked whenever we install or change an app that has a permission this plugin cares about.
  rpc RegisterApp(RegisterAppRequest) returns (RegisterAppResponse) {}
  rpc UnregisterApp(UnregisterAppRequest) returns (UnregisterAppResponse) {}
  // This method gets invoked whenever we need to render a template that uses this plugin.
  rpc GetContext(GetContextRequest) returns (AppContext) {}
}