whsource

type Auth struct {
	Mode string `json:"mode"`
	// Preset names a sender's whole convention (#2223); the settings it
	// leaves unset are filled from it.
	Preset         string    `json:"preset,omitempty"`
	Secret         string    `json:"secret,omitempty"`
	PreviousSecret string    `json:"previous_secret,omitempty"`
	PreviousUntil  time.Time `json:"previous_until,omitzero"`

	// HMAC.
	Algorithm        string `json:"algorithm,omitempty"`
	SignatureHeader  string `json:"signature_header,omitempty"`
	Encoding         string `json:"encoding,omitempty"`
	Prefix           string `json:"prefix,omitempty"`
	TimestampHeader  string `json:"timestamp_header,omitempty"`
	ToleranceSeconds int    `json:"tolerance_seconds,omitempty"`
	Signed           string `json:"signed,omitempty"`
	// IDHeader carries the delivery id id.timestamp.body signs.
	IDHeader string `json:"id_header,omitempty"`
	// HeaderFormat is empty for a prefix and a signature, or "stripe".
	HeaderFormat string `json:"header_format,omitempty"`
	// HeaderPattern lays the signature header out over {signature} and
	// {timestamp}, as in "{timestamp}|{signature}" (#2223).
	HeaderPattern string `json:"header_pattern,omitempty"`
	// SecretEncoding is empty for the secret as written, or "base64".
	SecretEncoding string `json:"secret_encoding,omitempty"`
	// TimestampPath reads the timestamp from the body rather than a header,
	// in seconds or milliseconds (Linear's webhookTimestamp).
	TimestampPath string `json:"timestamp_path,omitempty"`

	// BodyToken: where in the body the token is. A path through "[*]"
	// requires every element to carry it.
	TokenPath string `json:"token_path,omitempty"`

	// HeaderToken.
	Header string `json:"header,omitempty"`

	// Basic.
	Username string `json:"username,omitempty"`
}

type Config struct {
	// Input is "http" (the default, posted to), "imap" (a polled mailbox,
	// configured under IMAP) or "form" (a form's submissions, under Form).
	Input string `json:"input,omitempty"`
	IMAP  *IMAP  `json:"imap,omitempty"`
	Form  *Form  `json:"form,omitempty"`

	Handshake string `json:"handshake,omitempty"`
	// ChallengeField is the body field a challenge_echo handshake reads;
	// empty is "challenge".
	ChallengeField string `json:"challenge_field,omitempty"`
	MaxBodyBytes   int64  `json:"max_body_bytes,omitempty"`
	Split          string `json:"split,omitempty"`
	EventIDPath    string `json:"event_id_path,omitempty"`
	EventTypePath  string `json:"event_type_path,omitempty"`
	KeyPath        string `json:"key_path,omitempty"`

	FlushMaxEvents     int   `json:"flush_max_events,omitempty"`
	FlushMaxIntervalMS int64 `json:"flush_max_interval_ms,omitempty"`
	FlushMaxBytes      int64 `json:"flush_max_bytes,omitempty"`
	BufferLimit        int   `json:"buffer_limit,omitempty"`

	// RateLimitPerMinute is zero for no limit. The limit is on the source,
	// not on a client address: a sender's requests arrive from whatever
	// addresses its infrastructure has.
	RateLimitPerMinute int `json:"rate_limit_per_minute,omitempty"`
	RateLimitBurst     int `json:"rate_limit_burst,omitempty"`

	// Persona is the persona whose members see the source's compacted windows
	// in Resources and search. Empty is the administrator persona, which keeps
	// them to administrators. Querying
	// the table is governed by the Trino connection, not by this. It is set
	// when the source is created and does not change: windows already written
	// stay where they were written.
	Persona string `json:"persona,omitempty"`

	// CompactEveryMinutes is the length of the window a source's events are
	// partitioned and compacted by: 60, the default, compacts each hour once
	// it has ended; a shorter window compacts sooner, into more files. It
	// divides an hour evenly, so windows start on the hour and an hour is
	// always a whole number of them.
	CompactEveryMinutes int `json:"compact_every_minutes,omitempty"`

	// RawRetentionDays is how long a raw segment is kept once the window it
	// belongs to is compacted. A compacted window's events are all in its
	// Parquet file, and a recompaction reads that file rather than the
	// segments, so they are a safety margin and nothing else; every day kept
	// is objects the raw table and retention list (#2134).
	RawRetentionDays int `json:"raw_retention_days,omitempty"`
	// CompactedRetentionDays is how long a compacted window is kept. Nil is
	// the default; zero keeps it forever.
	CompactedRetentionDays *int `json:"compacted_retention_days,omitempty"`

	// Index is how search indexes the source's compacted windows (#2111):
	// "full", "metadata" or "none". Empty leaves it to the operator's
	// resources.index rules, which can match these writes by origin webhook.
	// It applies to windows written from the next compaction on.
	Index string `json:"index,omitempty"`
}

type Encryptor interface {
	Encrypt(plaintext string) (string, error)
	Decrypt(ciphertext string) (string, error)
}

type Form struct {
	// ScriptID is the form script's id: the source follows the script, so an
	// endpoint renamed later still stores into the source made for it.
	ScriptID string `json:"script_id"`
	// Endpoint is the endpoint the form was bound to when its source was
	// made, which its name was derived from.
	Endpoint string `json:"endpoint"`
	// DecryptPersonas are the personas a script run may decrypt the form's
	// sensitive fields as (platform.decrypt, #2179); an administrator always
	// may, and so does the owner on the submissions view.
	DecryptPersonas []string `json:"decrypt_personas,omitempty"`
}

type IMAP struct {
	Host string `json:"host"`
	Port int    `json:"port,omitempty"`
	// TLS is "tls" (IMAPS, the default) or "starttls".
	TLS string `json:"tls,omitempty"`
	// Folders are the folders read, each with its own watermark. Required:
	// there is no all-folders default.
	Folders []string `json:"folders"`
	// AllowSenders are the addresses and @domain entries whose mail becomes
	// an event. Mail from anyone else is counted and never stored.
	AllowSenders []string `json:"allow_senders"`
	// RequireAuthPass trusts an allowed sender only when the receiving
	// server recorded an aligned SPF, DKIM or DMARC pass. Nil is true.
	RequireAuthPass *bool `json:"require_auth_pass,omitempty"`
	// TrustedAuthServID is the receiving server's authserv-id; only an
	// Authentication-Results header carrying it is read.
	TrustedAuthServID string `json:"trusted_authserv_id,omitempty"`
	// TLSCABundlePEM are certificates to trust for a private CA.
	TLSCABundlePEM     string `json:"tls_ca_bundle_pem,omitempty"`
	PollSeconds        int    `json:"poll_seconds,omitempty"`
	MaxMessageBytes    int64  `json:"max_message_bytes,omitempty"`
	MaxAttachmentBytes int64  `json:"max_attachment_bytes,omitempty"`
}

type Source struct {
	Name    string `json:"name"`
	Enabled bool   `json:"enabled"`
	Auth    Auth   `json:"auth"`
	Config  Config `json:"config"`
	// Connection is the Trino connection whose scratch catalog holds the
	// source's table. That catalog must read the managed-resources store,
	// because both the raw segments and the compacted windows are written
	// there.
	Connection string    `json:"connection"`
	CreatedBy  string    `json:"created_by"`
	CreatedAt  time.Time `json:"created_at"`
	UpdatedAt  time.Time `json:"updated_at"`
}

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