pb

type AnswerRequest struct {
	RequestJson []byte            `protobuf:"bytes,1,opt,name=request_json,json=requestJson,proto3" json:"request_json,omitempty"`
	ValuesJson  []byte            `protobuf:"bytes,2,opt,name=values_json,json=valuesJson,proto3" json:"values_json,omitempty"`
	Secrets     map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

type AnswerResponse struct {
	ResponseJson []byte `protobuf:"bytes,1,opt,name=response_json,json=responseJson,proto3" json:"response_json,omitempty"`
	// contains filtered or unexported fields
}

type Caller struct {

	// driver_slug is the signed-in driver, or empty for nobody. It is set only
	// where the host holds a driver session, which is the host's to mint.
	DriverSlug string `protobuf:"bytes,1,opt,name=driver_slug,json=driverSlug,proto3" json:"driver_slug,omitempty"`
	// driver_name is that driver's name, so a plugin need not look it up to say
	// hello.
	DriverName string `protobuf:"bytes,2,opt,name=driver_name,json=driverName,proto3" json:"driver_name,omitempty"`
	// admin_email is the signed-in operator, or empty. A plugin serving an
	// operator-only page is told who is reading it.
	AdminEmail string `protobuf:"bytes,3,opt,name=admin_email,json=adminEmail,proto3" json:"admin_email,omitempty"`
	// remote is the address the request came from, as the host resolved it
	// behind whatever proxy the operator runs.
	Remote string `protobuf:"bytes,4,opt,name=remote,proto3" json:"remote,omitempty"`
	// contains filtered or unexported fields
}

type HeaderValues struct {
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

type NotifyRequest struct {
	EventJson  []byte `protobuf:"bytes,1,opt,name=event_json,json=eventJson,proto3" json:"event_json,omitempty"`
	ValuesJson []byte `protobuf:"bytes,2,opt,name=values_json,json=valuesJson,proto3" json:"values_json,omitempty"`
	// secrets maps a declared setting name to the credential the core holds for
	// it. Present only for the settings this plugin itself declared as secret:
	// no plugin ever receives another plugin's.
	Secrets map[string]string `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

type NotifyResponse struct {
	UsageJson []byte `protobuf:"bytes,1,opt,name=usage_json,json=usageJson,proto3" json:"usage_json,omitempty"`
	// contains filtered or unexported fields
}

type PluginClient interface {
	// Settings declares what the operator has to fill in. The host asks once,
	// when the plugin starts, and stores the answer so the panel can render the
	// form whether or not the plugin is running.
	Settings(ctx context.Context, in *SettingsRequest, opts ...grpc.CallOption) (*SettingsResponse, error)
	// Notify tells the plugin something happened. The host does not wait for the
	// answer before carrying on with its own work, but the answer still carries
	// what the call spent, because a plugin that burns the operator's tokens on
	// an event must be metered like any other call.
	Notify(ctx context.Context, in *NotifyRequest, opts ...grpc.CallOption) (*NotifyResponse, error)
	// Answer asks the plugin for something and waits. The deadline is on the
	// context; a plugin that misses it is skipped and the caller is told so.
	Answer(ctx context.Context, in *AnswerRequest, opts ...grpc.CallOption) (*AnswerResponse, error)
	// Serve hands over one HTTP request made to /plugin/<name>/..., and takes
	// back what to answer with. It is how a plugin puts a page or an endpoint on
	// the operator's server without being linked into it.
	//
	// One request, one response, both whole: there is no streaming and no
	// upgrade, so a plugin cannot hold a connection open against the host. The
	// host caps both bodies and the time this may take, and a plugin that misses
	// the deadline is answered for.
	Serve(ctx context.Context, in *ServeRequest, opts ...grpc.CallOption) (*ServeResponse, error)
}

type PluginServer interface {
	// Settings declares what the operator has to fill in. The host asks once,
	// when the plugin starts, and stores the answer so the panel can render the
	// form whether or not the plugin is running.
	Settings(context.Context, *SettingsRequest) (*SettingsResponse, error)
	// Notify tells the plugin something happened. The host does not wait for the
	// answer before carrying on with its own work, but the answer still carries
	// what the call spent, because a plugin that burns the operator's tokens on
	// an event must be metered like any other call.
	Notify(context.Context, *NotifyRequest) (*NotifyResponse, error)
	// Answer asks the plugin for something and waits. The deadline is on the
	// context; a plugin that misses it is skipped and the caller is told so.
	Answer(context.Context, *AnswerRequest) (*AnswerResponse, error)
	// Serve hands over one HTTP request made to /plugin/<name>/..., and takes
	// back what to answer with. It is how a plugin puts a page or an endpoint on
	// the operator's server without being linked into it.
	//
	// One request, one response, both whole: there is no streaming and no
	// upgrade, so a plugin cannot hold a connection open against the host. The
	// host caps both bodies and the time this may take, and a plugin that misses
	// the deadline is answered for.
	Serve(context.Context, *ServeRequest) (*ServeResponse, error)
	// contains filtered or unexported methods
}

type ServeRequest struct {

	// method is the HTTP method, uppercased.
	Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	// path is what follows /plugin/<name>, always beginning with a slash. The
	// plugin's own routing starts here.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// query is the raw query string, without the leading question mark.
	Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
	// headers are the request's headers, canonicalised, minus the ones that
	// belong to the host: no cookie of the host's own reaches a plugin, because
	// a plugin holding the operator's admin session would be the operator.
	Headers map[string]*HeaderValues `` /* 141-byte string literal not displayed */
	// body is the request body, already capped by the host.
	Body []byte `protobuf:"bytes,5,opt,name=body,proto3" json:"body,omitempty"`
	// caller is what the host knows about whoever made the request.
	Caller *Caller `protobuf:"bytes,6,opt,name=caller,proto3" json:"caller,omitempty"`
	// prefix is the address this plugin is mounted at, so that it can build
	// links and form actions that come back to itself.
	Prefix string `protobuf:"bytes,7,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// base_url is the operator's own public address, for the links a plugin
	// sends somewhere else and expects back.
	BaseUrl string `protobuf:"bytes,8,opt,name=base_url,json=baseUrl,proto3" json:"base_url,omitempty"`
	// values_json and secrets are the plugin's configuration, on the same terms
	// as every other call.
	ValuesJson []byte            `protobuf:"bytes,9,opt,name=values_json,json=valuesJson,proto3" json:"values_json,omitempty"`
	Secrets    map[string]string `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

type ServeResponse struct {

	// status is the HTTP status code. Zero means 200.
	Status uint32 `protobuf:"varint,1,opt,name=status,proto3" json:"status,omitempty"`
	// headers are the headers to write. The host refuses the ones that are its
	// own to decide, and allows a plugin to set only its own cookies.
	Headers map[string]*HeaderValues `` /* 141-byte string literal not displayed */
	// body is the response body, capped by the host.
	Body []byte `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// sign_in asks the host to establish a driver session for this browser, by
	// the driver's slug. It is how a plugin that authenticates drivers hands the
	// result back: the plugin says who, and the host mints the session. A plugin
	// never sees a session token and cannot make one.
	SignIn string `protobuf:"bytes,4,opt,name=sign_in,json=signIn,proto3" json:"sign_in,omitempty"`
	// sign_out ends whatever driver session this browser has.
	SignOut bool `protobuf:"varint,5,opt,name=sign_out,json=signOut,proto3" json:"sign_out,omitempty"`
	// usage_json is what serving the request cost, if anything, on the same
	// terms as every other call.
	UsageJson []byte `protobuf:"bytes,6,opt,name=usage_json,json=usageJson,proto3" json:"usage_json,omitempty"`
	// contains filtered or unexported fields
}

type SettingsRequest struct {
	// contains filtered or unexported fields
}

type SettingsResponse struct {
	SettingsJson []byte `protobuf:"bytes,1,opt,name=settings_json,json=settingsJson,proto3" json:"settings_json,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedPluginServer struct{}

type UnsafePluginServer interface {
	// contains filtered or unexported methods
}