application

Documentation

Index

• type Cleaner
• type Command
  • func NewCommand(executable string, args []string, dir string) Command
  • func (c Command) WithEnv(env []string) Command
  • func (c Command) WithTimeout(duration time.Duration) Command
• type CommandExecutor
• type CommandResult
  • func NewCommandResult(stdout, stderr string, exitCode int, duration time.Duration) CommandResult
• type CompileOptions
  • func NewCompileOptions(engine, outputPath, workingDir string) CompileOptions
  • func (opts CompileOptions) WithCleanup(cleanup bool) CompileOptions
  • func (opts CompileOptions) WithDebug(debug bool) CompileOptions
  • func (opts CompileOptions) WithJobName(jobName string) CompileOptions
  • func (opts CompileOptions) WithLatexmk(useLatexmk bool) CompileOptions
  • func (opts CompileOptions) WithPasses(passes int) CompileOptions
• type Converter
• type FileInfo
• type FileSystem
• type FontValidator
• type LaTeXCompiler
• type LogField
  • func NewLogField(key string, value interface{}) LogField
• type Logger
• type PathOperations
• type RebuildResult
• type RebuildService
• type TemplateProcessor
• type ValidationResult

Types

type Cleaner

type Cleaner interface {
	Clean(ctx context.Context, pdfPath string) error
}

Cleaner removes auxiliary files Pure transport types - no domain dependencies

type Command

type Command struct {
	Executable string
	Args       []string
	Dir        string
	Env        []string
	Timeout    time.Duration
}

Command is a Value Object representing a command to execute

func NewCommand

func NewCommand(executable string, args []string, dir string) Command

NewCommand creates a validated command

func (Command) WithEnv

func (c Command) WithEnv(env []string) Command

WithEnv sets environment variables for the command

func (Command) WithTimeout

func (c Command) WithTimeout(duration time.Duration) Command

WithTimeout sets the timeout for the command

type CommandExecutor

type CommandExecutor interface {
	// Execute runs a command and returns output
	Execute(ctx context.Context, cmd Command) (CommandResult, error)
}

CommandExecutor abstracts command execution (DIP for AutoPDF) This ensures the application layer doesn't depend on os/exec package

type CommandResult

type CommandResult struct {
	Stdout   string
	Stderr   string
	ExitCode int
	Duration time.Duration
	Success  bool
}

CommandResult represents the result of a command execution

func NewCommandResult

func NewCommandResult(stdout, stderr string, exitCode int, duration time.Duration) CommandResult

NewCommandResult creates a command result

type CompileOptions

type CompileOptions struct {
	Engine     string // pdflatex, xelatex, lualatex
	OutputPath string
	WorkingDir string
	Passes     int  // Number of compilation passes
	UseLatexmk bool // Whether to use latexmk
	JobName    string
	Cleanup    bool // Whether to cleanup aux files
	Debug      bool // Whether debug mode is enabled
}

CompileOptions represents LaTeX compilation parameters Value Object following DDD principles - immutable and validated

func NewCompileOptions

func NewCompileOptions(engine, outputPath, workingDir string) CompileOptions

NewCompileOptions creates a validated CompileOptions with defaults

func (CompileOptions) WithCleanup

func (opts CompileOptions) WithCleanup(cleanup bool) CompileOptions

WithCleanup sets cleanup behavior

func (CompileOptions) WithDebug

func (opts CompileOptions) WithDebug(debug bool) CompileOptions

WithDebug sets debug mode

func (CompileOptions) WithJobName

func (opts CompileOptions) WithJobName(jobName string) CompileOptions

WithJobName sets the job name

func (CompileOptions) WithLatexmk

func (opts CompileOptions) WithLatexmk(useLatexmk bool) CompileOptions

WithLatexmk enables latexmk usage

func (CompileOptions) WithPasses

func (opts CompileOptions) WithPasses(passes int) CompileOptions

WithPasses sets the number of compilation passes

type Converter

type Converter interface {
	ConvertToImages(ctx context.Context, pdfPath string, formats []string) ([]string, error)
}

Converter converts PDFs to images Pure transport types - no domain dependencies

type FileInfo

type FileInfo interface {
	Name() string
	Size() int64
	Mode() fs.FileMode
	ModTime() time.Time
	IsDir() bool
	Sys() interface{}
}

FileInfo abstracts file information

type FileSystem

type FileSystem interface {
	// File operations
	WriteFile(ctx context.Context, path string, data []byte, perm fs.FileMode) error
	ReadFile(ctx context.Context, path string) ([]byte, error)
	Remove(ctx context.Context, path string) error
	Stat(ctx context.Context, path string) (FileInfo, error)
	IsNotExist(err error) bool

	// Directory operations
	MkdirAll(ctx context.Context, path string, perm fs.FileMode) error

	// Symlink operations
	Symlink(ctx context.Context, oldname, newname string) error

	// Synchronization
	Sync(ctx context.Context) error
}

FileSystem abstracts file system operations (DIP for AutoPDF) This ensures the application layer doesn't depend on os package

type FontValidator

type FontValidator interface {
	ValidateFonts(ctx context.Context, fontNames []string) (ValidationResult, error)
}

FontValidator checks if required fonts are available

type LaTeXCompiler

type LaTeXCompiler interface {
	Compile(ctx context.Context, content string, opts CompileOptions) (string, error)
}

LaTeXCompiler compiles LaTeX content to PDF Pure transport types - no domain dependencies

type LogField

type LogField struct {
	Key   string
	Value interface{}
}

LogField represents a single logging field (key-value pair)

func NewLogField

func NewLogField(key string, value interface{}) LogField

NewLogField creates a new log field

type Logger

type Logger interface {
	// Debug logs a debug-level message
	Debug(ctx context.Context, msg string, fields ...LogField)
	// Info logs an info-level message
	Info(ctx context.Context, msg string, fields ...LogField)
	// Warn logs a warning-level message
	Warn(ctx context.Context, msg string, fields ...LogField)
	// Error logs an error-level message
	Error(ctx context.Context, msg string, fields ...LogField)
}

Logger provides structured logging capabilities (DIP for logging) This ensures adapters can log without depending on concrete logging libraries

type PathOperations

type PathOperations interface {
	// Path manipulation
	Dir(path string) string
	Base(path string) string
	Ext(path string) string
	Join(elem ...string) string
	IsAbs(path string) bool
	Clean(path string) string
}

PathOperations abstracts path manipulation operations (DIP for AutoPDF) This ensures the application layer doesn't depend on path/filepath package

type RebuildResult

type RebuildResult struct {
	PDFPath string
	Success bool
	Error   error
}

RebuildResult represents the result of a rebuild operation

type RebuildService

type RebuildService interface {
	Rebuild(ctx context.Context, templatePath, configPath string) (RebuildResult, error)
}

RebuildService orchestrates document rebuilding from file changes This port abstracts rebuild orchestration following DIP principle Pure transport types - no domain dependencies

type TemplateProcessor

type TemplateProcessor interface {
	Process(ctx context.Context, templatePath string, variables map[string]string) (string, error)
}

TemplateProcessor processes templates with variables Pure transport types - no domain dependencies

type ValidationResult

type ValidationResult struct {
	AllAvailable bool
	Missing      []string
	Available    []string
}

ValidationResult represents font validation results