screenshots

type AXeProvider struct{}

type CanvasOptions struct {
	Title         string
	Subtitle      string
	BGColor       string       // solid background hex color (e.g. "#ffffff"); text overlays default to a dark gradient
	TitleColor    string       // title text color; defaults to canvasDefaultTitleColor
	SubtitleColor string       // subtitle text color; defaults to canvasDefaultSubtitleColor
	Font          string       // font family for title and subtitle; empty uses Koubou's default (Arial)
	TextPosition  TextPosition // top (default) or bottom

	// TextBox draws a box behind each title and subtitle; nil draws none.
	TextBox *TextBoxOptions
	// FontFile, when set, replaces Font: the file is copied into the private
	// Koubou work root and referenced from the generated YAML.
	FontFile *FontFile
}

type CaptureRequest struct {
	Provider  string // ProviderAXe or ProviderMacOS
	BundleID  string
	UDID      string // simulator UDID or "booted"
	Name      string // output file name (without extension)
	OutputDir string // directory to write PNG
}

type CaptureResult struct {
	Path     string `json:"path"`
	Provider string `json:"provider"`
	Width    int    `json:"width"`
	Height   int    `json:"height"`
	BundleID string `json:"bundle_id"`
	UDID     string `json:"udid"`
}

type FontFile struct {
	Ext  string // lower-case .ttf, .otf, or .ttc
	Data []byte
}

type FrameAspectMismatch struct {
	InputWidth   int
	InputHeight  int
	ScreenWidth  int
	ScreenHeight int
}

type FrameDevice string

type FrameDeviceOption struct {
	ID                string   `json:"id"`
	Default           bool     `json:"default"`
	Family            string   `json:"family,omitempty"`
	DefaultFrameColor string   `json:"defaultFrameColor,omitempty"`
	FrameColors       []string `json:"frameColors,omitempty"`
}

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

type FrameRequest struct {
	InputPath  string         // required when ConfigPath is empty
	OutputPath string         // optional for custom config mode; required for input mode
	Device     string         // device slug; defaults to iphone-air when empty
	FrameColor string         // frame color variant; empty selects the device default
	ConfigPath string         // optional Koubou YAML config path
	Canvas     *CanvasOptions // optional text overlays and background

	// Kept for backwards compatibility; ignored in Koubou mode.
	FrameRoot   string
	ScreenBleed int
}

type FrameResult struct {
	OutputHash   string `json:"-"` // Digest of bytes published by this render.
	Path         string `json:"path"`
	FramePath    string `json:"frame_path"`
	Device       string `json:"device"`
	DisplayType  string `json:"display_type,omitempty"`
	UploadWidth  int    `json:"upload_width,omitempty"`
	UploadHeight int    `json:"upload_height,omitempty"`
	Normalized   bool   `json:"normalized"`
	Skipped      bool   `json:"skipped,omitempty"`
	Width        int    `json:"width"`
	Height       int    `json:"height"`
}

type FrameResumeEntry struct {
	Fingerprint string      `json:"fingerprint"`
	OutputHash  string      `json:"outputHash"`
	Result      FrameResult `json:"result"`
}

type FrameResumeFingerprint struct {
	SourceHash    string
	Device        string
	Title         string
	Subtitle      string
	TitleColor    string
	SubtitleColor string
	Background    string
	OverlayHash   string
	FrameColor    string
	Font          string
	TextPosition  string
	TextBox       string // TextBoxOptions settings; empty when no box is drawn
	FontFileHash  string // SHA-256 of a --font file; empty for a family name
}

type FrameResumeState struct {
	Files map[string]FrameResumeEntry `json:"files"`
}

type MatrixAppearance interface {
	Snapshot(ctx context.Context, udid string) (state string, err error)
	Set(ctx context.Context, udid, appearance string) error
	Restore(ctx context.Context, udid, state string) error
}

type MatrixCell struct {
	ID              string
	Device          string
	UDID            string
	Locale          string
	Appearance      string
	Content         string
	LaunchArguments []string
	RawDir          string
	FramedDir       string
	RawPaths        []string
	FramedPaths     []string
}

type MatrixCellError struct {
	Stage   string `json:"stage"`
	Code    string `json:"code"`
	Message string `json:"message"`
}

type MatrixCellResult struct {
	ID           string                   `json:"id"`
	Device       string                   `json:"device"`
	Locale       string                   `json:"locale"`
	Appearance   string                   `json:"appearance"`
	Content      string                   `json:"contentVariant"`
	Status       string                   `json:"status"`
	Attempts     int                      `json:"attempts"`
	DurationMS   int64                    `json:"durationMs"`
	RawPaths     []string                 `json:"rawPaths,omitempty"`
	FramedPaths  []string                 `json:"framedPaths,omitempty"`
	Screenshots  []MatrixScreenshotResult `json:"screenshots,omitempty"`
	Steps        []RunStepResult          `json:"steps,omitempty"`
	FailureStage string                   `json:"failureStage,omitempty"`
	FailureCode  string                   `json:"failureCode,omitempty"`
	Error        *MatrixCellError         `json:"error,omitempty"`
	// contains filtered or unexported fields
}

type MatrixContentVariant struct {
	ID              string   `json:"id"`
	LaunchArguments []string `json:"launch_arguments,omitempty"`
}

type MatrixDependencies struct {
	RunPlan func(context.Context, *Plan) (*RunResult, error)
	// RunPlanRooted is the matrix-only provider contract. The destination root
	// is retained for the whole attempt and must be used for every output write.
	// It is additive so existing test/integration callbacks keep compiling while
	// normal matrix execution avoids handing a replaceable pathname to adapters.
	// RunPlan and RunPlanRooted are mutually exclusive; supplying both is a
	// validation error rather than an implicit precedence choice.
	RunPlanRooted func(context.Context, *Plan, rootfs.Root) (*RunResult, error)
	Frame         func(context.Context, FrameRequest) (*FrameResult, error)
	// FrameRooted is the rooted counterpart of Frame. Implementations must use
	// the supplied root for the final output publication. Frame and FrameRooted
	// are mutually exclusive for the same reason as the plan callbacks.
	FrameRooted func(context.Context, FrameRequest, rootfs.Root) (*FrameResult, error)
	Appearance  MatrixAppearance
	CheckDevice func(context.Context, MatrixDevice) error
}

type MatrixDevice struct {
	ID   string `json:"id"`
	UDID string `json:"udid"`
}

type MatrixExecution struct {
	MaxConcurrency int    `json:"max_concurrency,omitempty"`
	MaxAttempts    int    `json:"max_attempts,omitempty"`
	RetryBackoffMS int    `json:"retry_backoff_ms,omitempty"`
	RetryBackoff   string `json:"retry_backoff,omitempty"`
	// contains filtered or unexported fields
}

type MatrixFrame struct {
	Enabled              bool              `json:"enabled"`
	DeviceByMatrixDevice map[string]string `json:"device_by_matrix_device,omitempty"`
}

type MatrixOptions struct {
	MaxConcurrency    int
	MaxConcurrencySet bool
	MaxAttempts       int
	MaxAttemptsSet    bool
	RetryBackoff      time.Duration
	RetryBackoffSet   bool
}

type MatrixOutput struct {
	RawDir    string      `json:"raw_dir,omitempty"`
	FramedDir string      `json:"framed_dir,omitempty"`
	ReviewDir string      `json:"review_dir,omitempty"`
	Frame     MatrixFrame `json:"frame,omitempty"`
}

type MatrixPlan struct {
	Version         int                    `json:"version"`
	BasePlan        string                 `json:"base_plan"`
	Devices         []MatrixDevice         `json:"devices"`
	Locales         []string               `json:"locales"`
	Appearances     []string               `json:"appearances"`
	ContentVariants []MatrixContentVariant `json:"content_variants"`
	Execution       MatrixExecution        `json:"execution,omitempty"`
	Output          MatrixOutput           `json:"output,omitempty"`
	// contains filtered or unexported fields
}

type MatrixResult struct {
	PlanPath      string              `json:"planPath"`
	BundleID      string              `json:"bundleId,omitempty"`
	RawDir        string              `json:"rawDir"`
	FramedDir     string              `json:"framedDir"`
	ReviewDir     string              `json:"reviewDir"`
	Status        string              `json:"status"`
	TotalCells    int                 `json:"totalCells"`
	Succeeded     int                 `json:"succeeded"`
	Failed        int                 `json:"failed"`
	Canceled      int                 `json:"canceled"`
	Retried       int                 `json:"retried"`
	CleanupFailed int                 `json:"cleanupFailed,omitempty"`
	Cells         []MatrixCellResult  `json:"cells"`
	Review        *MatrixReviewResult `json:"review,omitempty"`

	// Total is retained internally for callers that build reports directly;
	// the public output uses totalCells.
	Total int `json:"-"`
}

type MatrixReviewManifest = asc.MatrixReviewManifest

type MatrixReviewRequest struct {
	Result      *MatrixResult
	OutputDir   string
	LockContext context.Context
}

type MatrixReviewResult = asc.MatrixReviewResult

type MatrixScreenshotResult struct {
	Name       string `json:"name"`
	Status     string `json:"status"`
	RawPath    string `json:"rawPath,omitempty"`
	FramedPath string `json:"framedPath,omitempty"`
	Width      int    `json:"width,omitempty"`
	Height     int    `json:"height,omitempty"`
}

type MatrixValidationError struct {
	Err error
}

type OverlayConfig struct {
	Default OverlayEntry   `json:"default"`
	Data    []OverlayEntry `json:"data"`
}

type OverlayEntry struct {
	Filter     string `json:"filter,omitempty"`
	Title      string `json:"title,omitempty"`
	Keyword    string `json:"keyword,omitempty"`
	Background string `json:"background,omitempty"`

	// Text box keys mirror --text-box, --text-box-color, --text-box-padding,
	// and --text-box-radius for the inputs this entry matches.
	TextBox        bool   `json:"textBox,omitempty"`
	TextBoxColor   string `json:"textBoxColor,omitempty"`
	TextBoxPadding *int   `json:"textBoxPadding,omitempty"`
	TextBoxRadius  *int   `json:"textBoxRadius,omitempty"`
}

type Plan struct {
	Version  int          `json:"version"`
	App      PlanApp      `json:"app"`
	Defaults PlanDefaults `json:"defaults,omitempty"`
	Steps    []PlanStep   `json:"steps"`
}

type PlanApp struct {
	BundleID        string   `json:"bundle_id"`
	UDID            string   `json:"udid,omitempty"`
	OutputDir       string   `json:"output_dir,omitempty"`
	LaunchArguments []string `json:"launch_arguments,omitempty"`
	// contains filtered or unexported fields
}

type PlanDefaults struct {
	PostActionDelayMS int `json:"post_action_delay_ms,omitempty"`
}

type PlanStep struct {
	Action         StepAction `json:"action"`
	Name           *string    `json:"name,omitempty"`
	Label          *string    `json:"label,omitempty"`
	ID             *string    `json:"id,omitempty"`
	Contains       *string    `json:"contains,omitempty"`
	Text           *string    `json:"text,omitempty"`
	Keycodes       []int      `json:"keycodes,omitempty"`
	X              *float64   `json:"x,omitempty"`
	Y              *float64   `json:"y,omitempty"`
	DurationMS     *int       `json:"duration_ms,omitempty"`
	TimeoutMS      *int       `json:"timeout_ms,omitempty"`
	PollIntervalMS *int       `json:"poll_interval_ms,omitempty"`
}

type PlanValidationCode string

type PlanValidationError struct {
	Code    PlanValidationCode
	Step    int
	Message string
}

type Provider interface {
	Capture(ctx context.Context, req CaptureRequest) (pngPath string, err error)
}

type ReviewApproveRequest struct {
	OutputDir    string
	ManifestPath string
	ApprovalPath string
	AllReady     bool
	Keys         []string
	ScreenshotID string
	Locale       string
	Device       string
}

type ReviewApproveResult struct {
	ManifestPath  string   `json:"manifest_path"`
	ApprovalPath  string   `json:"approval_path"`
	Matched       int      `json:"matched"`
	Added         int      `json:"added"`
	TotalApproved int      `json:"total_approved"`
	Keys          []string `json:"keys,omitempty"`
}

type ReviewEntry struct {
	Key               string   `json:"key"`
	ScreenshotID      string   `json:"screenshot_id"`
	Locale            string   `json:"locale,omitempty"`
	Device            string   `json:"device,omitempty"`
	FramedPath        string   `json:"framed_path"`
	FramedRelative    string   `json:"framed_relative_path"`
	RawPath           string   `json:"raw_path,omitempty"`
	RawRelative       string   `json:"raw_relative_path,omitempty"`
	Width             int      `json:"width"`
	Height            int      `json:"height"`
	DisplayTypes      []string `json:"display_types,omitempty"`
	ValidAppStoreSize bool     `json:"valid_app_store_size"`
	Status            string   `json:"status"`
	Approved          bool     `json:"approved"`
	ApprovalState     string   `json:"approval_state"`
}

type ReviewManifest struct {
	GeneratedAt  string        `json:"generated_at"`
	RawDir       string        `json:"raw_dir,omitempty"`
	FramedDir    string        `json:"framed_dir"`
	OutputDir    string        `json:"output_dir"`
	ApprovalPath string        `json:"approval_path"`
	Summary      ReviewSummary `json:"summary"`
	Entries      []ReviewEntry `json:"entries"`
}

type ReviewOpenRequest struct {
	OutputDir string
	HTMLPath  string
	DryRun    bool
}

type ReviewOpenResult struct {
	HTMLPath string `json:"html_path"`
	Opened   bool   `json:"opened"`
}

type ReviewRequest struct {
	RawDir       string // optional; missing raw files are reported
	FramedDir    string // required
	OutputDir    string // optional, defaults to ./screenshots/review
	ApprovalPath string // optional, defaults to <output-dir>/approved.json
}

type ReviewResult struct {
	ManifestPath string `json:"manifest_path"`
	HTMLPath     string `json:"html_path"`
	ApprovalPath string `json:"approval_path"`
	FramedDir    string `json:"framed_dir"`
	Total        int    `json:"total"`
	Ready        int    `json:"ready"`
	MissingRaw   int    `json:"missing_raw"`
	InvalidSize  int    `json:"invalid_size"`
	Approved     int    `json:"approved"`
	Pending      int    `json:"pending"`
}

type ReviewSummary struct {
	Total           int `json:"total"`
	Ready           int `json:"ready"`
	MissingRaw      int `json:"missing_raw"`
	InvalidSize     int `json:"invalid_size"`
	Approved        int `json:"approved"`
	PendingApproval int `json:"pending_approval"`
}

type RunResult struct {
	BundleID  string          `json:"bundle_id"`
	UDID      string          `json:"udid"`
	OutputDir string          `json:"output_dir"`
	Steps     []RunStepResult `json:"steps"`
}

type RunStepResult struct {
	Index      int    `json:"index"`
	Action     string `json:"action"`
	Status     string `json:"status"`
	DurationMS int64  `json:"duration_ms"`
	Error      string `json:"error,omitempty"`
}

type StepAction string

type TextBoxOptions struct {
	Color   string // #RGB, #RRGGBB, or #RRGGBBAA; empty uses DefaultTextBoxColor
	Padding *int   // pixels; nil scales with each item's font size
	Radius  *int   // corner radius in pixels; nil lets Koubou use the padding
}

type TextPosition string

type WatchCycleResult struct {
	Name    string `json:"name"`
	Path    string `json:"path"`
	Success bool   `json:"success"`
	Error   string `json:"error,omitempty"`
}

type WatchOptions struct {
	// ReviewOutputDir, when non-empty, triggers automatic review HTML/manifest
	// regeneration after each successful kou generate cycle.
	ReviewOutputDir string
	// ReviewRawDir is the raw screenshots directory for review generation.
	ReviewRawDir string
}