domain

Documentation

Overview

Package domain defines the core domain models, constants, and shared types for the Neru application.

This package contains the fundamental building blocks that define the Neru domain, including mode definitions, action types, and other shared constants and types that are used across multiple packages in the application.

Index

• Constants
• func ActionFromString(actionStr string) (action.Type, bool)
• func ActionString(actionType action.Type) string
• func ModeString(mode Mode) string
• type BaseManager
  • func (m *BaseManager) CurrentInput() string
  • func (m *BaseManager) Reset()
  • func (m *BaseManager) SetCurrentInput(input string)
• type Mode
• type Router
  • func NewRouter(logger *zap.Logger) *Router
  • func NewRouterWithExitKeys(logger *zap.Logger, exitKeys []string) *Router
  • func (r *Router) IsExitKey(key string) bool

Constants

const (
	ModeNameIdle     = "idle"
	ModeNameHints    = "hints"
	ModeNameGrid     = "grid"
	ModeNameScroll   = "scroll"
	ModeNameQuadGrid = "quadgrid"
)

Mode names as strings.

const (
	CommandPing              = "ping"
	CommandStart             = "start"
	CommandStop              = "stop"
	CommandAction            = "action"
	CommandStatus            = "status"
	CommandConfig            = "config"
	CommandReloadConfig      = "reload"
	CommandHealth            = "health"
	CommandMetrics           = "metrics"
	CommandToggleScreenShare = "toggle-screen-share"
)

IPC Commands.

const (
	UnknownAction = "unknown"
	UnknownMode   = "unknown"
)

Mode-related constants.

const (
	BundleIDDock               = "com.apple.dock"
	BundleIDNotificationCenter = "com.apple.notificationcenterui"
)

Bundle ID constants for macOS system applications.

const (
	DefaultHintCharacters = "asdfghjkl"
	DefaultExitKey        = "escape"
)

Default values.

const (
	SubgridRows = 3
	SubgridCols = 3
)

Grid subgrid dimensions.

const (
	ShellCommandTimeout = 30 * time.Second
)

Timeout constants.

Functions

func ActionFromString

func ActionFromString(actionStr string) (action.Type, bool)

ActionFromString converts a string to its action.Type representation.

func ActionString

func ActionString(actionType action.Type) string

ActionString converts an action.Type to its string representation.

func ModeString

func ModeString(mode Mode) string

ModeString converts a Mode to its string representation.

Types

type BaseManager

type BaseManager struct {
	Logger *zap.Logger
	// contains filtered or unexported fields
}

BaseManager provides common functionality for domain managers. It contains shared fields and methods used across different domain managers.

func (*BaseManager) CurrentInput

func (m *BaseManager) CurrentInput() string

CurrentInput returns the current input string.

func (*BaseManager) Reset

func (m *BaseManager) Reset()

Reset resets the base manager to its initial state.

func (*BaseManager) SetCurrentInput

func (m *BaseManager) SetCurrentInput(input string)

SetCurrentInput sets the current input string.

type Mode

type Mode int

Mode is the current mode of the application.

const (
	// ModeIdle represents the idle mode.
	ModeIdle Mode = iota
	// ModeHints represents the hints mode.
	ModeHints
	// ModeGrid represents the grid mode.
	ModeGrid
	// ModeScroll represents the scroll mode.
	ModeScroll
	// ModeQuadGrid represents the quad-grid navigation mode.
	ModeQuadGrid
)

type Router

type Router struct {
	Logger       *zap.Logger
	ModeExitKeys []string // Keys that exit the mode
}

Router provides common routing functionality for mode-based key handling. It can be embedded by specific routers (grid, hint) to share common logic.

func NewRouter

func NewRouter(logger *zap.Logger) *Router

NewRouter creates a new base router with the specified logger.

func NewRouterWithExitKeys

func NewRouterWithExitKeys(logger *zap.Logger, exitKeys []string) *Router

NewRouterWithExitKeys creates a new base router with custom exit keys.

func (*Router) IsExitKey

func (r *Router) IsExitKey(key string) bool

IsExitKey checks if the given key is an exit key. Returns true if the key should trigger mode exit.