keymapv1

type Action struct {

	// Action name should follow "keymap/{keymap}/action/{name}" pattern, e.g. keymap/1/action/actions.editor.copy
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The key bindings that trigger the action.
	// e.g. ctrl+s, ctrl+shift+s
	Bindings []*KeybindingReadable `protobuf:"bytes,2,rep,name=bindings,proto3" json:"bindings,omitempty"`
	// The action config
	ActionConfig *ActionConfig `protobuf:"bytes,3,opt,name=action_config,json=actionConfig,proto3" json:"action_config,omitempty"`
	// Optional, user-provided comment for this keymap.
	Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

type ActionConfig struct {

	// name of the action
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// description of the action
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// category of the action
	// e.g. "Editor", "Terminal"
	// Has subcategories if category has ".", e.g. "Editor.Clipboard"
	Category string `protobuf:"bytes,3,opt,name=category,proto3" json:"category,omitempty"`
	// editor support information for this action
	EditorSupport []*EditorSupport `protobuf:"bytes,4,rep,name=editor_support,json=editorSupport,proto3" json:"editor_support,omitempty"`
	// contains filtered or unexported fields
}

type ActionDiff struct {

	// The keymap before the change.
	Origin *Action `protobuf:"bytes,1,opt,name=origin,proto3" json:"origin,omitempty"`
	// The keymap after the change.
	Updated *Action `protobuf:"bytes,2,opt,name=updated,proto3" json:"updated,omitempty"`
	// contains filtered or unexported fields
}

type ConfigDetectRequest struct {

	// The editor type.
	EditorType EditorType `protobuf:"varint,1,opt,name=editor_type,json=editorType,proto3,enum=keymap.v1.EditorType" json:"editor_type,omitempty"`
	// contains filtered or unexported fields
}

type ConfigDetectResponse struct {

	// The default config paths.
	Paths []string `protobuf:"bytes,1,rep,name=paths,proto3" json:"paths,omitempty"`
	// contains filtered or unexported fields
}

type DanglingAction struct {

	// The action that is dangling.
	Action string `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The keybinding that is dangling.
	Keybinding string `protobuf:"bytes,2,opt,name=keybinding,proto3" json:"keybinding,omitempty"`
	// The suggestion for the dangling action.
	Suggestion string `protobuf:"bytes,3,opt,name=suggestion,proto3" json:"suggestion,omitempty"`
	// contains filtered or unexported fields
}

type DuplicateMapping struct {

	// The action that has duplicate mappings.
	Action string `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The keybinding that is duplicated.
	Keybinding string `protobuf:"bytes,2,opt,name=keybinding,proto3" json:"keybinding,omitempty"`
	// A message describing the issue.
	Message string `protobuf:"bytes,3,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type EditorSupport struct {

	// The editor type
	EditorType EditorType `protobuf:"varint,1,opt,name=editor_type,json=editorType,proto3,enum=keymap.v1.EditorType" json:"editor_type,omitempty"`
	// Whether this action is supported by the editor
	Supported bool `protobuf:"varint,2,opt,name=supported,proto3" json:"supported,omitempty"`
	// Special note of why not supported or supportness
	Note string `protobuf:"bytes,3,opt,name=note,proto3" json:"note,omitempty"`
	// contains filtered or unexported fields
}

type EditorType int32

type ExportKeymapRequest struct {

	// The editor type.
	EditorType EditorType `protobuf:"varint,1,opt,name=editor_type,json=editorType,proto3,enum=keymap.v1.EditorType" json:"editor_type,omitempty"`
	// The keymap to export.
	Keymap *Keymap `protobuf:"bytes,2,opt,name=keymap,proto3" json:"keymap,omitempty"`
	// The base keymap to compare against.
	Base string `protobuf:"bytes,3,opt,name=base,proto3" json:"base,omitempty"`
	// The diff type to use for the export.
	DiffType ExportKeymapRequest_DiffType `` /* 130-byte string literal not displayed */
	// Optional, file path for the keymap config
	FilePath string `protobuf:"bytes,5,opt,name=file_path,json=filePath,proto3" json:"file_path,omitempty"`
	// contains filtered or unexported fields
}

type ExportKeymapRequest_DiffType int32

type ExportKeymapResponse struct {

	// The exported keymap config, editor-specific.
	Keymap string `protobuf:"bytes,1,opt,name=keymap,proto3" json:"keymap,omitempty"`
	// The diff between the original editor-specific keymap config and the exported keymap.
	Diff string `protobuf:"bytes,2,opt,name=diff,proto3" json:"diff,omitempty"`
	// contains filtered or unexported fields
}

type GetKeymapRequest struct {

	// The config content.
	Config string `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// Whether to return all keymaps even when there are no bindings yet.
	ReturnAll bool `protobuf:"varint,2,opt,name=return_all,json=returnAll,proto3" json:"return_all,omitempty"`
	// contains filtered or unexported fields
}

type GetKeymapResponse struct {

	// The loaded keymap.
	Keymap *Keymap `protobuf:"bytes,1,opt,name=keymap,proto3" json:"keymap,omitempty"`
	// contains filtered or unexported fields
}

type ImportKeymapRequest struct {

	// The editor type.
	EditorType EditorType `protobuf:"varint,1,opt,name=editor_type,json=editorType,proto3,enum=keymap.v1.EditorType" json:"editor_type,omitempty"`
	// The source keymap file content in editor-specific config syntax
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// The base keymap to compare against in onekeymap config syntax
	Base string `protobuf:"bytes,3,opt,name=base,proto3" json:"base,omitempty"`
	// contains filtered or unexported fields
}

type ImportKeymapResponse struct {

	// The imported keymap.
	Keymap *Keymap `protobuf:"bytes,1,opt,name=keymap,proto3" json:"keymap,omitempty"`
	// The changes between the base and the imported keymap.
	Changes *KeymapChanges `protobuf:"bytes,2,opt,name=changes,proto3" json:"changes,omitempty"`
	// contains filtered or unexported fields
}

type KeyChord struct {

	// The primary, non-modifier key being pressed.
	KeyCode KeyCode `protobuf:"varint,1,opt,name=key_code,json=keyCode,proto3,enum=keymap.v1.KeyCode" json:"key_code,omitempty"`
	// A list of modifier keys held down with the primary key.
	Modifiers []KeyModifier `protobuf:"varint,2,rep,packed,name=modifiers,proto3,enum=keymap.v1.KeyModifier" json:"modifiers,omitempty"`
	// contains filtered or unexported fields
}

type KeyCode int32

type KeyModifier int32

type KeybindConflict struct {

	// The keybinding that is in conflict.
	Keybinding string `protobuf:"bytes,1,opt,name=keybinding,proto3" json:"keybinding,omitempty"`
	// The actions that are in conflict.
	Actions []*KeybindConflict_Action `protobuf:"bytes,2,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

type KeybindConflict_Action struct {

	// The action identifier.
	Action string `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The editor command.
	EditorCommand string `protobuf:"bytes,2,opt,name=editor_command,json=editorCommand,proto3" json:"editor_command,omitempty"`
	// contains filtered or unexported fields
}

type Keybinding struct {

	// The sequence of key chords.
	Chords []*KeyChord `protobuf:"bytes,1,rep,name=chords,proto3" json:"chords,omitempty"`
	// contains filtered or unexported fields
}

type KeybindingReadable struct {

	// The key binding that triggers an action.
	KeyChords *Keybinding `protobuf:"bytes,1,opt,name=key_chords,json=keyChords,proto3" json:"key_chords,omitempty"`
	// The readable key binding that triggers an action. e.g. "ctrl+s"
	KeyChordsReadable string `protobuf:"bytes,2,opt,name=key_chords_readable,json=keyChordsReadable,proto3" json:"key_chords_readable,omitempty"`
	// contains filtered or unexported fields
}

type Keymap struct {

	// Keymap name should follow "users/{user}/keymaps/{keymap}" pattern, e.g. users/1234/keymaps/1
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// (-- api-linter: core::0122::embedded-resource=disabled
	//
	//	aip.dev/not-precedent: Action is a value object, not a separately managed resource --)
	//
	// The actions.
	// One action may correspond to multiple keybindings. Then there would be multiple Action
	// with the same keybinding but different id.
	// Clients should merge Action that share the same `id` if necessary.
	Actions []*Action `protobuf:"bytes,2,rep,name=actions,proto3" json:"actions,omitempty"`
	// contains filtered or unexported fields
}

type KeymapChanges struct {

	// The keymaps that are added.
	Add []*Action `protobuf:"bytes,1,rep,name=add,proto3" json:"add,omitempty"`
	// The keymaps that are removed.
	Remove []*Action `protobuf:"bytes,2,rep,name=remove,proto3" json:"remove,omitempty"`
	// The keymaps that are updated.
	Update []*ActionDiff `protobuf:"bytes,3,rep,name=update,proto3" json:"update,omitempty"`
	// contains filtered or unexported fields
}

type OnekeymapServiceClient interface {
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ImportKeymap imports editor-specific config file
	ImportKeymap(ctx context.Context, in *ImportKeymapRequest, opts ...grpc.CallOption) (*ImportKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ExportKeymap exports the current keymap settings.
	ExportKeymap(ctx context.Context, in *ExportKeymapRequest, opts ...grpc.CallOption) (*ExportKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ConfigDetect returns the default config path.
	ConfigDetect(ctx context.Context, in *ConfigDetectRequest, opts ...grpc.CallOption) (*ConfigDetectResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// (-- api-linter: core::0131::response-message-name=disabled
	//
	//	aip.dev/not-precedent: GetKeymap is not a standard Get method, it loads from config content --)
	//
	// (-- api-linter: core::0131::request-unknown-fields=disabled
	//
	//	aip.dev/not-precedent: GetKeymap uses config content, not resource name --)
	//
	// (-- api-linter: core::0131::request-name-required=disabled
	//
	//	aip.dev/not-precedent: GetKeymap uses config content, not resource name --)
	//
	// GetKeymap loads a keymap from a text content.
	GetKeymap(ctx context.Context, in *GetKeymapRequest, opts ...grpc.CallOption) (*GetKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// SaveKeymap saves the current keymap settings to a text content.
	SaveKeymap(ctx context.Context, in *SaveKeymapRequest, opts ...grpc.CallOption) (*SaveKeymapResponse, error)
}

type OnekeymapServiceServer interface {
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ImportKeymap imports editor-specific config file
	ImportKeymap(context.Context, *ImportKeymapRequest) (*ImportKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ExportKeymap exports the current keymap settings.
	ExportKeymap(context.Context, *ExportKeymapRequest) (*ExportKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// ConfigDetect returns the default config path.
	ConfigDetect(context.Context, *ConfigDetectRequest) (*ConfigDetectResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// (-- api-linter: core::0131::response-message-name=disabled
	//
	//	aip.dev/not-precedent: GetKeymap is not a standard Get method, it loads from config content --)
	//
	// (-- api-linter: core::0131::request-unknown-fields=disabled
	//
	//	aip.dev/not-precedent: GetKeymap uses config content, not resource name --)
	//
	// (-- api-linter: core::0131::request-name-required=disabled
	//
	//	aip.dev/not-precedent: GetKeymap uses config content, not resource name --)
	//
	// GetKeymap loads a keymap from a text content.
	GetKeymap(context.Context, *GetKeymapRequest) (*GetKeymapResponse, error)
	// (-- api-linter: core::0127::http-annotation=disabled
	//
	//	aip.dev/not-precedent: OnekeymapService only support grpc --)
	//
	// SaveKeymap saves the current keymap settings to a text content.
	SaveKeymap(context.Context, *SaveKeymapRequest) (*SaveKeymapResponse, error)
	// contains filtered or unexported methods
}

type Platform int32

type PotentialShadowing struct {

	// The keybinding that might cause shadowing.
	Keybinding string `protobuf:"bytes,1,opt,name=keybinding,proto3" json:"keybinding,omitempty"`
	// The action mapped to this keybinding.
	Action string `protobuf:"bytes,2,opt,name=action,proto3" json:"action,omitempty"`
	// The target editor where shadowing might occur.
	TargetEditor string `protobuf:"bytes,3,opt,name=target_editor,json=targetEditor,proto3" json:"target_editor,omitempty"`
	// A message describing the potential issue.
	Message string `protobuf:"bytes,4,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type SaveKeymapRequest struct {

	// The keymap to save.
	Keymap *Keymap `protobuf:"bytes,1,opt,name=keymap,proto3" json:"keymap,omitempty"`
	// contains filtered or unexported fields
}

type SaveKeymapResponse struct {

	// The saved config content.
	Config string `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// contains filtered or unexported fields
}

type Summary struct {

	// The total number of mappings processed.
	MappingsProcessed int32 `protobuf:"varint,1,opt,name=mappings_processed,json=mappingsProcessed,proto3" json:"mappings_processed,omitempty"`
	// The number of mappings that succeeded.
	MappingsSucceeded int32 `protobuf:"varint,2,opt,name=mappings_succeeded,json=mappingsSucceeded,proto3" json:"mappings_succeeded,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedOnekeymapServiceServer struct{}

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

type UnsupportedAction struct {

	// The action that is unsupported.
	Action string `protobuf:"bytes,1,opt,name=action,proto3" json:"action,omitempty"`
	// The keybinding that is unsupported.
	Keybinding string `protobuf:"bytes,2,opt,name=keybinding,proto3" json:"keybinding,omitempty"`
	// The target editor that the action is unsupported for.
	TargetEditor string `protobuf:"bytes,3,opt,name=target_editor,json=targetEditor,proto3" json:"target_editor,omitempty"`
	// contains filtered or unexported fields
}

type ValidationIssue struct {

	// Types that are valid to be assigned to Issue:
	//
	//	*ValidationIssue_KeybindConflict
	//	*ValidationIssue_DanglingAction
	//	*ValidationIssue_UnsupportedAction
	//	*ValidationIssue_DuplicateMapping
	//	*ValidationIssue_PotentialShadowing
	Issue isValidationIssue_Issue `protobuf_oneof:"issue"`
	// contains filtered or unexported fields
}

type ValidationIssue_DanglingAction struct {
	// DanglingAction is that an action is mapped to a keybinding that does not exist.
	DanglingAction *DanglingAction `protobuf:"bytes,2,opt,name=dangling_action,json=danglingAction,proto3,oneof"`
}

type ValidationIssue_DuplicateMapping struct {
	// DuplicateMapping is that the same action and keybinding combination appears multiple times.
	DuplicateMapping *DuplicateMapping `protobuf:"bytes,4,opt,name=duplicate_mapping,json=duplicateMapping,proto3,oneof"`
}

type ValidationIssue_KeybindConflict struct {
	// KeybindConflict is that multiple actions are mapped to the same keybinding.
	KeybindConflict *KeybindConflict `protobuf:"bytes,1,opt,name=keybind_conflict,json=keybindConflict,proto3,oneof"`
}

type ValidationIssue_PotentialShadowing struct {
	// PotentialShadowing is that a keybinding might shadow a critical system shortcut.
	PotentialShadowing *PotentialShadowing `protobuf:"bytes,5,opt,name=potential_shadowing,json=potentialShadowing,proto3,oneof"`
}

type ValidationIssue_UnsupportedAction struct {
	// UnsupportedAction is that an action is mapped to a keybinding that is not supported by the target editor.
	UnsupportedAction *UnsupportedAction `protobuf:"bytes,3,opt,name=unsupported_action,json=unsupportedAction,proto3,oneof"`
}

type ValidationReport struct {

	// The source editor of the validation run.
	SourceEditor string `protobuf:"bytes,1,opt,name=source_editor,json=sourceEditor,proto3" json:"source_editor,omitempty"`
	// The summary of the validation run.
	Summary *Summary `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
	// The issues detected during the validation run.
	Issues []*ValidationIssue `protobuf:"bytes,3,rep,name=issues,proto3" json:"issues,omitempty"`
	// The warnings issued during the validation run.
	// Warnings are just issues that tend to not harm
	Warnings []*ValidationIssue `protobuf:"bytes,4,rep,name=warnings,proto3" json:"warnings,omitempty"`
	// contains filtered or unexported fields
}