jmap

type Account struct {
	// Name is a user-friendly string for presenting this account,
	// e.g. the email address of the account owner.
	Name string `json:"name"`

	// IsPersonal is true if this account belongs to the authenticated user.
	IsPersonal bool `json:"isPersonal"`

	// IsReadOnly is true if the account is read-only.
	IsReadOnly bool `json:"isReadOnly"`

	// Capabilities maps capability URIs to their typed per-account config.
	// Populated during JSON unmarshalling from RawCapabilities.
	Capabilities map[URI]Capability `json:"-"`

	// RawCapabilities holds the unparsed JSON for each account capability.
	RawCapabilities map[URI]json.RawMessage `json:"accountCapabilities"`
}

type AddedItem struct {
	ID    ID     `json:"id"`
	Index uint64 `json:"index"`
}

type Capability interface {
	// URI returns the capability identifier, e.g. "urn:ietf:params:jmap:core".
	URI() URI

	// New returns a pointer to a new zero-value instance of this capability,
	// suitable for JSON unmarshalling.
	New() Capability
}

type Client struct {

	// HTTPClient is the underlying HTTP client used for all requests.
	// Set via WithBasicAuth or WithAccessToken for authentication.
	HTTPClient *http.Client

	// SessionEndpoint is the URL of the JMAP Session Resource.
	SessionEndpoint string

	// Session holds the current JMAP Session object, fetched automatically
	// on first request or via Authenticate().
	Session *Session
	// contains filtered or unexported fields
}

type CollationAlgo string

type CoreCapability struct {
	// MaxSizeUpload is the maximum file size in bytes for uploads.
	MaxSizeUpload uint64 `json:"maxSizeUpload"`

	// MaxConcurrentUpload is the max number of concurrent upload requests.
	MaxConcurrentUpload uint64 `json:"maxConcurrentUpload"`

	// MaxSizeRequest is the max size in bytes the server accepts for a request.
	MaxSizeRequest uint64 `json:"maxSizeRequest"`

	// MaxConcurrentRequests is the max number of concurrent API requests.
	MaxConcurrentRequests uint64 `json:"maxConcurrentRequests"`

	// MaxCallsInRequest is the max number of method calls in a single request.
	MaxCallsInRequest uint64 `json:"maxCallsInRequest"`

	// MaxObjectsInGet is the max number of objects in a /get call.
	MaxObjectsInGet uint64 `json:"maxObjectsInGet"`

	// MaxObjectsInSet is the max number of objects in a /set call.
	MaxObjectsInSet uint64 `json:"maxObjectsInSet"`

	// CollationAlgorithms lists the supported collation algorithms.
	CollationAlgorithms []CollationAlgo `json:"collationAlgorithms"`
}

type Echo struct {
	// Data can contain any JSON-serializable fields.
	Data map[string]any `json:"-"`
}

type EchoResponse struct {
	Data map[string]any `json:"-"`
}

type EventSource struct {
	// Client is the JMAP client to use for the connection.
	Client *Client

	// Handler is called for each StateChange event received.
	Handler func(*StateChange)

	// Events lists the event types to subscribe to. Defaults to AllEvents.
	Events []EventType

	// Ping is the requested ping interval in seconds. The server may ignore
	// this value. Set to 0 to disable pinging.
	Ping uint

	// CloseAfterState causes the connection to close after receiving a
	// state event.
	CloseAfterState bool
	// contains filtered or unexported fields
}

type EventType string

type ID string

type Invocation struct {
	// Name is the method name, e.g. "Email/get".
	Name string

	// Args contains the method arguments (request) or response data.
	Args any

	// CallID is a client-specified identifier echoed back in responses.
	CallID string
}

type Method interface {
	// Name returns the method name, e.g. "Email/get".
	Name() string

	// Requires returns the capability URIs required by this method.
	Requires() []URI
}

type MethodError struct {
	// Type is the error type, e.g. "invalidArguments", "serverFail".
	Type string `json:"type"`

	// Description provides additional detail about the error.
	Description *string `json:"description,omitempty"`
}

type MethodResponse interface {
	// Name returns the response method name, e.g. "Email/get".
	Name() string
}

type MethodResponseFactory func() MethodResponse

type Operator string

type Patch map[string]any

type PushKeys struct {
	// Public is the P-256 ECDH public key, base64url-encoded.
	Public string `json:"p256dh"`

	// Auth is the authentication secret, base64url-encoded.
	Auth string `json:"auth"`
}

type PushSubscription struct {
	// ID is the server-assigned identifier for this subscription.
	ID ID `json:"id,omitempty"`

	// DeviceClientID is a client-supplied identifier for the device.
	DeviceClientID string `json:"deviceClientId,omitempty"`

	// URL is the endpoint to deliver push notifications to.
	URL string `json:"url,omitempty"`

	// Keys contains the encryption keys for push delivery.
	Keys *PushKeys `json:"keys,omitempty"`

	// VerificationCode is set by the client after receiving a
	// PushVerification request.
	VerificationCode string `json:"verificationCode,omitempty"`

	// Expires is when this subscription will expire.
	Expires *time.Time `json:"expires,omitempty"`

	// Types lists the event types to subscribe to.
	Types []string `json:"types,omitempty"`
}

type PushSubscriptionGet struct {
	IDs        []ID     `json:"ids,omitempty"`
	Properties []string `json:"properties,omitempty"`
}

type PushSubscriptionGetResponse struct {
	List     []*PushSubscription `json:"list,omitempty"`
	NotFound []ID                `json:"notFound,omitempty"`
}

type PushSubscriptionSet struct {
	Create  map[ID]*PushSubscription `json:"create,omitempty"`
	Update  map[ID]*Patch            `json:"update,omitempty"`
	Destroy []ID                     `json:"destroy,omitempty"`
}

type PushSubscriptionSetResponse struct {
	Created      map[ID]*PushSubscription `json:"created,omitempty"`
	Updated      map[ID]*PushSubscription `json:"updated,omitempty"`
	Destroyed    []ID                     `json:"destroyed,omitempty"`
	NotCreated   map[ID]*SetError         `json:"notCreated,omitempty"`
	NotUpdated   map[ID]*SetError         `json:"notUpdated,omitempty"`
	NotDestroyed map[ID]*SetError         `json:"notDestroyed,omitempty"`
}

type PushVerification struct {
	// Type MUST be "PushVerification".
	Type string `json:"@type"`

	// PushSubscriptionID is the ID of the subscription being verified.
	PushSubscriptionID string `json:"pushSubscriptionId"`

	// VerificationCode must be set on the subscription to confirm ownership.
	VerificationCode string `json:"verificationCode"`
}

type Request struct {
	// Context is used for the HTTP request. Not serialized to JSON.
	Context context.Context `json:"-"`

	// Using lists the capability URIs required by the method calls.
	Using []URI `json:"using"`

	// Calls contains the method invocations to be processed sequentially.
	Calls []*Invocation `json:"methodCalls"`

	// CreatedIDs maps client-specified creation IDs to server-assigned IDs.
	CreatedIDs map[ID]ID `json:"createdIds,omitempty"`
}

type RequestError struct {
	// Type is the error type URI, e.g. "urn:ietf:params:jmap:error:limit".
	Type string `json:"type"`

	// Status is the HTTP status code of the response.
	Status int `json:"status"`

	// Detail is a human-readable description of the error.
	Detail string `json:"detail"`

	// Limit is present when Type is "urn:ietf:params:jmap:error:limit",
	// containing the name of the exceeded limit.
	Limit *string `json:"limit,omitempty"`
}

type Response struct {
	// Responses contains the method responses in the same order as the
	// request's method calls.
	Responses []*Invocation `json:"methodResponses"`

	// CreatedIDs maps client-specified creation IDs to server-assigned IDs.
	CreatedIDs map[ID]ID `json:"createdIds,omitempty"`

	// SessionState is the current state string of the Session object.
	SessionState string `json:"sessionState"`
}

type ResultReference struct {
	// ResultOf is the method call ID of the previous invocation.
	ResultOf string `json:"resultOf"`

	// Name is the required name of the response to that method call.
	Name string `json:"name"`

	// Path is a JSON Pointer (RFC 6901) into the response arguments,
	// with support for * to map through arrays.
	Path string `json:"path"`
}

type Session struct {
	// Capabilities maps capability URIs to their typed configuration.
	// Populated during JSON unmarshalling from RawCapabilities.
	Capabilities map[URI]Capability `json:"-"`

	// RawCapabilities holds the unparsed JSON for each capability.
	RawCapabilities map[URI]json.RawMessage `json:"capabilities"`

	// Accounts maps account IDs to Account objects.
	Accounts map[ID]Account `json:"accounts"`

	// PrimaryAccounts maps capability URIs to the primary account ID
	// for that capability.
	PrimaryAccounts map[URI]ID `json:"primaryAccounts"`

	// Username is the username associated with the authenticated credentials.
	Username string `json:"username"`

	// APIURL is the URL to use for JMAP API requests.
	APIURL string `json:"apiUrl"`

	// DownloadURL is the URL template for downloading blobs.
	DownloadURL string `json:"downloadUrl"`

	// UploadURL is the URL template for uploading blobs.
	UploadURL string `json:"uploadUrl"`

	// EventSourceURL is the URL for Server-Sent Events push.
	EventSourceURL string `json:"eventSourceUrl"`

	// State is a string representing the current state of this Session.
	State string `json:"state"`
}

type SetError struct {
	// Type is the error type, e.g. "invalidProperties", "notFound".
	Type string `json:"type"`

	// Description provides a debugging explanation of the problem.
	Description *string `json:"description,omitempty"`

	// Properties lists the invalid properties (for "invalidProperties" errors).
	Properties *[]string `json:"properties,omitempty"`
}

type StateChange struct {
	// Type MUST be the string "StateChange".
	Type string `json:"@type"`

	// Changed maps account IDs to their changed type states.
	Changed map[ID]TypeState `json:"changed"`
}

type TypeState map[string]string

type URI string

type UploadResponse struct {
	// AccountID is the account used for the upload.
	AccountID ID `json:"accountId"`

	// BlobID is the identifier for the uploaded binary data.
	BlobID ID `json:"blobId"`

	// Type is the media type of the uploaded file.
	Type string `json:"type"`

	// Size is the size of the uploaded file in octets.
	Size uint64 `json:"size"`
}

type VAPIDCapability struct {
	// ApplicationServerKey is the VAPID public key (base64url-encoded).
	ApplicationServerKey string `json:"applicationServerKey"`
}

type WebSocketCapability struct {
	// URL is the WebSocket endpoint URL.
	URL string `json:"url"`

	// SupportsPush indicates whether the server supports push over WebSocket.
	SupportsPush bool `json:"supportsPush"`
}

type WebSocketClient struct {

	// Client is the JMAP client used for session discovery.
	Client *Client

	// PushHandler is called when a StateChange push is received.
	PushHandler func(*StateChange)
	// contains filtered or unexported fields
}

type WebSocketPushDisable struct {
	Type string `json:"@type"` // Must be "WebSocketPushDisable"
}

type WebSocketPushEnable struct {
	Type      string      `json:"@type"` // Must be "WebSocketPushEnable"
	DataTypes []EventType `json:"dataTypes,omitempty"`
	PushState string      `json:"pushState,omitempty"`
}

type WebSocketRequest struct {
	Type string `json:"@type"` // Must be "Request"
	ID   string `json:"id,omitempty"`

	Using      []URI         `json:"using"`
	Calls      []*Invocation `json:"methodCalls"`
	CreatedIDs map[ID]ID     `json:"createdIds,omitempty"`
}

type WebSocketResponse struct {
	Type string `json:"@type"` // "Response" or "RequestError"
	// RequestID correlates the response to the request.
	RequestID string `json:"requestId,omitempty"`

	// Response fields (when @type is "Response")
	Responses    []*Invocation `json:"methodResponses,omitempty"`
	CreatedIDs   map[ID]ID     `json:"createdIds,omitempty"`
	SessionState string        `json:"sessionState,omitempty"`

	// Error fields (when @type is "RequestError")
	ErrorType string  `json:"type,omitempty"`
	Status    int     `json:"status,omitempty"`
	Detail    string  `json:"detail,omitempty"`
	Limit     *string `json:"limit,omitempty"`
}