jxscouttypes

type Asset = assetservice.Asset

type AssetFetcher = assetfetcher.AssetFetcher

type AssetService = assetservice.AssetService

type DBEventBus = *dbeventbus.EventBus

type EventBus = eventbus.EventBus

type EventBusMessage = eventbus.Message

type FileService = assetservice.FileService

type HTTPServer interface {
	SendSuccessResponse(w http.ResponseWriter, status int, result any)
	SendErrorResponse(w http.ResponseWriter, message string, status int)
}

type JXScout interface {
	Start() error
	RegisterModule(Module) error
}

type Module interface {
	Initialize(sdk *ModuleSDK) error
}

type ModuleSDK struct {
	Ctx              context.Context
	InMemoryEventBus EventBus
	DBEventBus       DBEventBus
	Router           Router
	AssetService     AssetService
	AssetFetcher     AssetFetcher
	Options          Options
	HTTPServer       HTTPServer
	WebsocketServer  *websocket.WebsocketServer // used to communitate with VSCode
	Logger           *slog.Logger
	Scope            Scope
	FileService      FileService
	Database         *sqlx.DB
}

type Options struct {
	Port                             int                 `yaml:"port"`
	Hostname                         string              `yaml:"hostname"`
	ProjectName                      string              `yaml:"project-name"`
	ScopePatterns                    goflags.StringSlice `yaml:"scope"`
	Debug                            bool                `yaml:"debug"`
	AssetSaveConcurrency             int                 `yaml:"save-concurrency"`
	AssetFetchConcurrency            int                 `yaml:"fetch-concurrency"`
	BeautifierConcurrency            int                 `yaml:"beautifier-concurrency"`
	ChunkDiscovererConcurrency       int                 `yaml:"chunk-discoverer-concurrency"`
	ASTAnalyzerConcurrency           int                 `yaml:"ast-analyzer-concurrency"`
	ChunkDiscovererBruteForceLimit   int                 `yaml:"chunk-discoverer-bruteforce-limit"`
	JavascriptRequestsCacheTTL       time.Duration       `yaml:"js-requests-cache-ttl"`
	HTMLRequestsCacheTTL             time.Duration       `yaml:"html-requests-cache-ttl"`
	RateLimitingMaxRequestsPerSecond int                 `yaml:"rate-limiter-max-requests-per-second"`
	RateLimitingMaxRequestsPerMinute int                 `yaml:"rate-limiter-max-requests-per-minute"`
	DownloadReferedJS                bool                `yaml:"download-refered-js"`
	LogBufferSize                    int                 `yaml:"log-buffer-size"`
	LogFileMaxSizeMB                 int                 `yaml:"log-file-max-size-mb"`
	CaidoHostname                    string              `yaml:"caido-hostname"`
	CaidoPort                        int                 `yaml:"caido-port"`
	OverrideContentCheckInterval     time.Duration       `yaml:"override-content-check-interval"`
}

type Router = chi.Router

type Scope interface {
	IsInScope(url string) bool
}