outbox

type AuditDataProvider interface {
	AuditData() any
}

type AuditOperationNamer interface {
	AuditOperation() string
}

type ClientCoded interface {
	ClientCode() string
}

type Config struct {
	// ClientID is stored in every row's client_id column (the outbox
	// processor does not read it; it is for the application's own
	// partitioning). May be empty.
	ClientID string
	// ClientCode is the client's identifier slug, written as clientCode in
	// event and audit payloads so the platform attributes them to that
	// client (a domain event implementing ClientCoded overrides it). Empty
	// leaves it out: the platform then scopes by the credential (an anchor
	// writes platform-scoped rows, a single-client credential its client).
	// Dispatch jobs that name no client of their own default to it, except
	// under PlatformClientCode.
	ClientCode string
	// ApplicationCode is written as each audit row's applicationCode. The
	// platform requires it of an application-scoped credential.
	ApplicationCode string
	// Now is the clock for created_at/updated_at. Default time.Now.
	Now func() time.Time
}

type DispatchJob struct {
	// ID is the job id, [0-9A-Za-z_-]{1,17}; generated (a 13-character TSID)
	// when empty. It is in the payload, so a batch the processor sends again
	// creates a job with the same id.
	ID        string
	Kind      string // EVENT or TASK; default TASK
	Code      string // {application}:{rest}, at most 255 characters
	Source    string // default: the code's application segment
	Subject   string
	TargetURL string // absolute http(s) URL with a host and no user info

	// Payload is the body delivered to TargetURL, with PayloadContentType.
	// Default: {} as application/json.
	Payload            string
	PayloadContentType string
	DataOnly           bool

	ExternalID    string
	EventID       string
	CorrelationID string

	// PlatformClientID is the platform's client id (never a slug). ClientCode
	// is the client's identifier slug, which the platform resolves at ingest
	// (an unknown code refuses the whole batch: 400 for an anchor, 403
	// otherwise). Set at most one. Without either, DispatchJobRow gives the
	// job the writer's Config.ClientCode (none for PlatformClientCode).
	PlatformClientID string
	ClientCode       string

	SubscriptionID   string
	ServiceAccountID string
	DispatchPoolID   string
	MessageGroup     string
	Mode             string // IMMEDIATE, NEXT_ON_ERROR or BLOCK_ON_ERROR
	// Sequence, TimeoutSeconds and MaxRetries are at least 1 when set (the
	// platform turns 0 into its default, so 0 cannot be sent); nil leaves
	// them to the platform (99, 30 and 3).
	Sequence       *int
	TimeoutSeconds *int
	MaxRetries     *int
	Metadata       []MetadataEntry
	Queue          string // DEFAULT or HIGH_PRIORITY
	Descriptor     string

	// ConnectionID is the connection the job is delivered through: pausing it
	// holds the job, and (with no subscription) its service account signs the
	// delivery. Must be global or the job's client's, shared or the job's
	// application's; the platform refuses the whole batch otherwise.
	ConnectionID string
	// IdempotencyKey makes the create idempotent: the first job with a key,
	// within its application (the code's first segment) and client, wins it; a
	// repeat answers that job's id and creates nothing. Written exactly as
	// given; when set, not blank and at most 100 bytes of UTF-8; kept 7 days.
	// An ID is not an idempotency key.
	IdempotencyKey string
	// contains filtered or unexported fields
}

type MetadataEntry struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type Placeholder int

type Push struct {
	// ID is the row id and the payload's pushId (the platform writes a pushId once); a 13-character
	// TSID is generated when empty. At most 26 characters [0-9A-Za-z_-].
	ID string
	// Topic is {application}:{segment}(:{segment})*, the first segment [a-z][a-z0-9-]* the
	// application (which the writer's credential must be allowed to push for), the others
	// [0-9A-Za-z_.-]+, at most 255 characters.
	Topic string
	// Type is [a-z][a-z0-9-]*(.[a-z][a-z0-9-]*)*, at most 100 characters; reset, auth-expired,
	// subscribed and fw.* are reserved.
	Type string
	// Data is the JSON object the listeners receive, as compact JSON.
	Data json.RawMessage
	// ClientCode is the client the push is for, by identifier. Empty: the writer's
	// Config.ClientCode (none for PlatformClientCode, which leaves the credential to decide: an
	// anchor pushes for the platform client).
	ClientCode string
	// MessageGroup is the outbox message group. Empty: the topic, so the pushes of one topic
	// reach the gateway in order (the processor sends a group's rows one at a time, in order).
	// With Ungrouped it is ignored.
	MessageGroup string
	// Ungrouped writes the row with no message group: the processor batches such rows into
	// concurrent calls, which is faster and keeps no order. For signal-only topics.
	Ungrouped bool
	// MaxDataBytes is the data limit (default DefaultPushMaxDataBytes, at most MaxPushDataBytes);
	// set it to the application's push.max-data-bytes.
	MaxDataBytes int
	// contains filtered or unexported fields
}

type PushError struct{ Code, Message string }

type Row struct {
	ID           string
	Type         string
	MessageGroup string
	Payload      []byte
	ClientID     string
	CreatedAt    time.Time
}