pages

type AssetHasher interface {
	// Hash returns the provider's asset hash for a file. name carries the extension
	// (some protocols fold it into the hash); contents is the raw file bytes.
	Hash(name string, contents []byte) string
}

type CredentialRequirement struct {
	Name        string
	Required    bool
	Description string
}

type DNSProvider string

type DeployOpts struct {
	Project string            // cloudflare project/site name (default: target id)
	Repo    string            // github OWNER/REPO (default: current repo)
	Domains []string          // custom domain(s) to attach, if any
	Include []string          // workspace allowlist globs (empty = keep everything)
	Exclude []string          // workspace denylist globs
	Env     map[string]string // resolved credentials to forward into the deploy
	DryRun  bool              // stage but do not externalize
}

type DeployResult struct {
	URL     string          // deployment URL (e.g. https://abc.project.pages.dev)
	Domains []DomainOutcome // one per requested custom domain; empty when none requested
	Notes   []string        // non-fatal provider notes (e.g. "Pages enabled from gh-pages")
}

type DomainOutcome struct {
	Name        string      // the requested custom domain
	Attached    bool        // the host accepted the custom-domain association
	DNSProvider DNSProvider // authoritative-NS classification (informational)
	Err         string      // non-fatal attach error text; empty on success
}

type Provider interface {
	// Prepare finalizes the workspace in place before deploy: applies include/exclude
	// and writes any provider-specific metadata (e.g. GitHub's CNAME/.nojekyll). Keeps
	// provider quirks out of the publish runner.
	Prepare(ws string, opts DeployOpts) error
	// Deploy publishes the workspace. A returned error means the SITE deploy itself
	// failed (the critical operation). Custom-domain configuration is an enhancement
	// carried in DeployResult.Domains and never surfaces as this error — a domain
	// problem must not retroactively fail a successful deploy.
	Deploy(ctx context.Context, ws string, opts DeployOpts) (DeployResult, error)
	// Credentials declares the env vars this provider needs (for diagnostics + forwarding).
	Credentials() []CredentialRequirement
}