protocol

type APIKey struct {
	ID        string `json:"id"`
	Name      string `json:"name"`
	Key       string `json:"key"`
	CreatedAt string `json:"createdAt"`
	ExpiresAt string `json:"expiresAt,omitempty"`
}

type APIKeyEnvelope struct {
	APIKey APIKey `json:"apiKey"`
}

type APIKeyInfo struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	CreatedAt  string `json:"createdAt"`
	LastUsedAt string `json:"lastUsedAt,omitempty"`
	ExpiresAt  string `json:"expiresAt,omitempty"`
}

type APIKeysEnvelope struct {
	APIKeys []APIKeyInfo `json:"apiKeys"`
}

type AccessCapabilitiesEnvelope struct {
	Operations OperationCapabilities        `json:"operations"`
	Fields     map[string]FieldCapabilities `json:"fields"`
}

type AuthActionEnvelope struct {
	Success bool `json:"success"`
}

type AuthBootstrapEnvelope struct {
	Available bool `json:"available"`
}

type AuthSession[User any] struct {
	// ID is the safe, non-secret identifier used for session management.
	ID string `json:"id"`
	// Collection is the auth-enabled collection that owns the user identity.
	Collection string `json:"collection"`
	// User is the current authenticated document.
	User User `json:"user"`
	// ExpiresAt is the session's RFC 3339 expiry timestamp.
	ExpiresAt string `json:"expiresAt"`
}

type AuthSessionInfo struct {
	ID         string `json:"id"`
	CreatedAt  string `json:"createdAt"`
	LastSeenAt string `json:"lastSeenAt"`
	ExpiresAt  string `json:"expiresAt"`
	IPAddress  string `json:"ipAddress,omitempty"`
	UserAgent  string `json:"userAgent,omitempty"`
	Current    bool   `json:"current"`
}

type AuthSessionsEnvelope struct {
	Sessions []AuthSessionInfo `json:"sessions"`
}

type BulkEnvelope[Document any] struct {
	Docs []Document `json:"docs"`
}

type CollectionSelectionEnvelope struct {
	Items     []CollectionSelectionItem `json:"items"`
	TotalDocs int                       `json:"totalDocs"`
}

type CollectionSelectionInput struct {
	Where json.RawMessage `json:"where,omitempty"`
	Trash bool            `json:"trash,omitempty"`
}

type CollectionSelectionItem struct {
	ID     string                     `json:"id"`
	Access AccessCapabilitiesEnvelope `json:"access"`
}

type CountEnvelope struct {
	TotalDocs int `json:"totalDocs"`
}

type DeleteEnvelope struct {
	ID      string `json:"id"`
	Deleted bool   `json:"deleted"`
}

type DocumentEnvelope[Document any] struct {
	Doc Document `json:"doc"`
}

type DocumentLock struct {
	DocumentID string `json:"documentId"`
	OwnerID    string `json:"ownerId"`
	OwnerLabel string `json:"ownerLabel"`
	CreatedAt  string `json:"createdAt"`
	UpdatedAt  string `json:"updatedAt"`
	ExpiresAt  string `json:"expiresAt"`
}

type DocumentLockEnvelope struct {
	Lock        *DocumentLock `json:"lock"`
	Owned       bool          `json:"owned"`
	Acquired    bool          `json:"acquired"`
	CanTakeOver bool          `json:"canTakeOver"`
}

type ErrorCode string

type ErrorEnvelope struct {
	Error ErrorPayload `json:"error"`
}

type ErrorPayload struct {
	Code      ErrorCode         `json:"code"`
	Status    int               `json:"status"`
	Message   string            `json:"message"`
	RequestID string            `json:"requestId,omitempty"`
	Issues    []ValidationIssue `json:"issues"`
	Details   json.RawMessage   `json:"details,omitempty"`
}

type FieldCapabilities struct {
	Read   bool `json:"read"`
	Create bool `json:"create"`
	Update bool `json:"update"`
}

type JoinMutationEnvelope[Document any] struct {
	Doc     Document `json:"doc"`
	Added   int      `json:"added"`
	Removed int      `json:"removed"`
}

type JoinMutationInput struct {
	Additions []string `json:"additions"`
	Removals  []string `json:"removals"`
}

type LiveValidationEmbeddedScope struct {
	Field       string       `json:"field"`
	TreeKey     string       `json:"treeKey"`
	CaseTag     string       `json:"caseTag"`
	VariantSlug string       `json:"variantSlug"`
	Identity    string       `json:"identity"`
	Data        store.Values `json:"data"`
}

type LiveValidationEnvelope struct {
	Evaluations []LiveValidationEvaluation `json:"evaluations"`
}

type LiveValidationEvaluation struct {
	Path   string            `json:"path"`
	Target string            `json:"target,omitempty"`
	Status string            `json:"status"`
	Issues []ValidationIssue `json:"issues"`
}

type LiveValidationRequest struct {
	// ID selects an existing collection document. Global requests must omit it.
	ID       string                        `json:"id,omitempty"`
	Data     store.Values                  `json:"data"`
	Fields   []string                      `json:"fields"`
	Embedded []LiveValidationEmbeddedScope `json:"embedded,omitempty"`
}

type LogoutEnvelope struct {
	LoggedOut bool `json:"loggedOut"`
}

type OperationCapabilities struct {
	Admin           bool `json:"admin"`
	Create          bool `json:"create"`
	Read            bool `json:"read"`
	ReadVersions    bool `json:"readVersions"`
	Update          bool `json:"update"`
	Delete          bool `json:"delete"`
	Duplicate       bool `json:"duplicate"`
	Publish         bool `json:"publish"`
	Unpublish       bool `json:"unpublish"`
	RestoreDeleted  bool `json:"restoreDeleted"`
	DeletePermanent bool `json:"deletePermanent"`
	SelectAll       bool `json:"selectAll"`
}

type PageEnvelope[Document any] struct {
	Docs       []Document `json:"docs"`
	Pagination Pagination `json:"pagination"`
}

type Pagination struct {
	Page        int  `json:"page"`
	Limit       int  `json:"limit"`
	TotalDocs   int  `json:"totalDocs"`
	TotalPages  int  `json:"totalPages"`
	HasNextPage bool `json:"hasNextPage"`
	HasPrevPage bool `json:"hasPrevPage"`
}

type PreferenceEnvelope[Value any] struct {
	Value Value `json:"value"`
}

type PreviewToken struct {
	Token      string `json:"token"`
	Resource   string `json:"resource"`
	Slug       string `json:"slug"`
	DocumentID string `json:"documentId"`
	ExpiresAt  string `json:"expiresAt"`
}

type PreviewTokenEnvelope struct {
	PreviewToken PreviewToken `json:"previewToken"`
}

type ScheduledPublish struct {
	ID               string `json:"id"`
	DocumentID       string `json:"documentId"`
	ExpectedRevision int    `json:"expectedRevision"`
	RunAt            string `json:"runAt"`
	Attempts         int    `json:"attempts"`
	LastError        string `json:"lastError,omitempty"`
	CreatedAt        string `json:"createdAt"`
}

type ScheduledPublishEnvelope struct {
	ScheduledPublish ScheduledPublish `json:"scheduledPublish"`
}

type ScheduledPublishesEnvelope struct {
	ScheduledPublishes []ScheduledPublish `json:"scheduledPublishes"`
}

type SchemaEnvelope struct {
	Schema schema.Snapshot `json:"schema"`
}

type SessionEnvelope[User any] struct {
	Session AuthSession[User] `json:"session"`
}

type ValidationIssue struct {
	Code    string `json:"code"`
	Path    string `json:"path"`
	Message string `json:"message"`
	// Target is an opaque schema/stable-occurrence correlation token for structured field issues.
	Target       string            `json:"target,omitempty"`
	FieldID      schema.StableID   `json:"fieldId,omitempty"`
	CollectionID schema.StableID   `json:"collectionId,omitempty"`
	GlobalID     schema.StableID   `json:"globalId,omitempty"`
	Locale       schema.LocaleCode `json:"locale,omitempty"`
}