importerapi

type ImportOptions struct {
	// Required, editor type
	EditorType pluginapi.EditorType
	// Required, input stream, contains the keymap config for different editors
	InputStream io.Reader
	// Optional, existing onekeymap base setting
	Base keymap.Keymap
}

type ImportResult struct {
	// The converted keymap setting.
	Setting keymap.Keymap
	// Any issues that arose during the import process.
	Report *validateapi.ValidationReport

	// The changes to the keymap setting.
	Changes *KeymapChanges

	SkipReport pluginapi.ImportSkipReport
}

type Importer interface {
	// Import converts keymaps from a source stream. It returns the converted
	// settings and a report detailing any conflicts or unmapped actions.
	Import(ctx context.Context, opts ImportOptions) (*ImportResult, error)
}

type KeymapChanges struct {
	// The keymaps that are added.
	Add []keymap.Action
	// The keymaps that are removed.
	Remove []keymap.Action
	// The keymaps that are updated.
	Update []KeymapDiff
}

type KeymapDiff struct {
	Before keymap.Action
	After  keymap.Action
}