snap

type Metadata struct {
	Date     time.Time `json:"date"`
	Endpoint string    `json:"endpoint"`
	Method   string    `json:"method"`
}

type Options struct {
	// ResponseHeaders is the list of response headers the snapper will record
	ResponseHeaders []string

	// Platform is the explicitly selected platform (optional, auto-detected if not set)
	Platform platform.Type

	// SpecPath is the path to the spec file (used for auto-detection)
	SpecPath string

	// Client is a pre-built API client the snapper uses instead of creating
	// one through the platform registry. Set it when the credentials come from
	// somewhere other than the process environment — for example a server
	// seeding each call with a short-lived installation token. When set, its
	// platform also resolves the snapshot defaults unless Platform is set
	// explicitly.
	Client platform.Client
}

type ParseOptions struct {
	Variables map[string]string
}

type Snapper struct {
	Options Options
	// contains filtered or unexported fields
}

type SnapperImplementation interface {
	ValidateSpec(*Spec) error
	GetClient(platform.Type) (platform.Client, error)
	CallAPI(context.Context, platform.Client, *Spec) (*http.Response, error)
	ParseResponse(*Options, *Spec, *http.Response) (*Snapshot, error)
	ApplyFieldMask(*Snapshot, []string) (*Snapshot, error)
}

type Snapshot struct {
	ID       string            `json:"id"`
	Name     string            `json:"name"`
	Url      string            `json:"url"`
	Type     string            `json:"type"`
	Metadata Metadata          `json:"metadata"`
	Headers  map[string]string `json:"headers"`
	Values   any               `json:"values"`
}

type Spec struct {
	// ID is the string that will be used to generate the subject's
	// hash when generating an attestation. It should identify the
	// object described by the data returned by the API call. This
	// ID MUST be unique for each instance the API returns.
	ID          string   `json:"id"`
	Name        string   `json:"name"`
	Url         string   `json:"url"`
	Type        string   `json:"type"`
	Endpoint    string   `json:"endpoint"`
	Method      string   `json:"method"`
	PayloadType string   `json:"payload" yaml:"payload"` //nolint:tagalign
	Mask        []string `json:"mask"`
	Data        string   `json:"data"`
	TrimNL      bool     `json:"trimNL"   yaml:"trimNL"`
}

type SpecParser struct{}