writegate

type CommitPoint struct {
	// Key identifies the operation as the step's replay cache does: its
	// position, words, and page.
	Key string `json:"key"`
	// Op is the operation's position in with.do, Operation its words, and
	// Page the page it ran on.
	Op        int    `json:"op"`
	Operation string `json:"operation"`
	Page      string `json:"page,omitempty"`
	Signature string `json:"signature"`
	Approved  bool   `json:"approved"`
	// Actions are what the operation did on the page, recorded as the
	// browser runtime replays them; an approved commit act replays them
	// and asks no model.
	Actions json.RawMessage `json:"actions,omitempty"`
	// Example is the write as it was last seen.
	Example    *Event     `json:"example,omitempty"`
	SeenAt     time.Time  `json:"seen_at"`
	ApprovedAt *time.Time `json:"approved_at,omitempty"`
}

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

type Config struct {
	// Token is a random value that prefixes the control paths.
	Token string `json:"token"`
	// CDPURL is the DevTools address of the browser, such as
	// http://127.0.0.1:9333.
	CDPURL string `json:"cdp_url"`
	Mode   string `json:"mode"`
	Policy Policy `json:"policy"`
	// Secrets holds the values of the secrets the policy's rules name, by
	// name.
	Secrets map[string]string `json:"secrets,omitempty"`
	// ExtensionDir is where the socket-blocking extension is written.
	ExtensionDir string `json:"extension_dir"`
	// BodyLimit is how much of a write's body the gate keeps; zero means
	// DefaultBodyLimit.
	BodyLimit int `json:"body_limit,omitempty"`
}

type Event struct {
	Seq  int64     `json:"seq"`
	At   time.Time `json:"at"`
	Kind string    `json:"kind"`
	// Method and URL are the request's, with sensitive query values
	// hidden.
	Method       string `json:"method,omitempty"`
	URL          string `json:"url"`
	ResourceType string `json:"resource_type,omitempty"`
	Class        string `json:"class,omitempty"`
	Outcome      string `json:"outcome,omitempty"`
	// Signature identifies the kind of write across runs, apart from the
	// values it carries.
	Signature   string `json:"signature,omitempty"`
	ContentType string `json:"content_type,omitempty"`
	// Fields are the names of the body's fields.
	Fields []string `json:"fields,omitempty"`
	// Body is the start of the body, with sensitive fields hidden.
	Body string `json:"body,omitempty"`
	// BodyBytes is the size of the whole body as the browser reported it.
	BodyBytes int64 `json:"body_bytes,omitempty"`
	// Target is the kind of worker that opened a socket.
	Target string `json:"target,omitempty"`
	// Status is the HTTP status a sent write was answered with, and
	// Response the start of the answer, with sensitive fields hidden.
	// ResponseError is the network error a sent write got in place of an
	// answer.
	Status        int    `json:"status,omitempty"`
	Response      string `json:"response,omitempty"`
	ResponseError string `json:"response_error,omitempty"`
}

type Handle struct {
	// URL is the base of the gate's control paths.
	URL string `json:"url"`
	PID int    `json:"pid"`
	// StartedAt is the process's start time in Unix milliseconds, which
	// tells it apart from a later process reusing PID.
	StartedAt int64 `json:"started_at"`
}

type Policy struct {
	// SignIn are the sign-in endpoints whose writes are sent.
	SignIn []Rule `json:"sign_in,omitempty" yaml:"sign_in,omitempty"`
	// Writes declare requests that save although their method only reads,
	// such as a delete link.
	Writes []Rule `json:"writes,omitempty" yaml:"writes,omitempty"`
	// NoiseHosts are hosts whose writes, such as analytics, are blocked
	// without counting as the work's writes.
	NoiseHosts []string `json:"noise_hosts,omitempty" yaml:"noise_hosts,omitempty"`
}

type Ready struct {
	// Port is the port of the control paths.
	Port int `json:"port"`
}

type Rule struct {
	// Host is a host pattern, as the hostpattern package matches it.
	Host string `json:"host" yaml:"host"`
	// Path is the request path; one ending in * matches every path it
	// starts. Empty matches every path.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`
	// Secret names a secret whose value the request must carry, as a
	// sign-in carries its password.
	Secret string `json:"secret,omitempty" yaml:"secret,omitempty"`
}