roomserverapi

type BulkEvent struct {
	Events  []gomatrixserverlib.Event
	SvrName string
}

type EduApi interface {
	ProcessReceipt(edu *gomatrixserverlib.EDU)
	ProcessTyping(edu *gomatrixserverlib.EDU)
	ProcessProfile(edu *gomatrixserverlib.EDU)
}

type FederationEvent struct {
	ReqPath     string
	Destination string
	Reply       string
	RawEvent    RawEvent
	OutputEvent OutputEvent
	RoomState   []byte
	Extra       []byte
}

type GetAliasRoomIDRequest struct {
	// Alias we want to lookup
	Alias string `json:"alias"`
}

type GetAliasRoomIDResponse struct {
	// The room ID the alias refers to
	RoomID string `json:"room_id"`
}

type InputInviteEvent struct {
	Event gomatrixserverlib.Event `json:"event"`
}

type InputRoomEvent struct {
	// Whether this event is new, backfilled or an outlier.
	// This controls how the event is processed.
	Kind int `json:"kind"`
	// The event JSON for the event to add.
	Event gomatrixserverlib.Event `json:"event"`
	// The server name to use to push this event to other servers.
	// Or empty if this event shouldn't be pushed to other servers.
	SendAsServer string `json:"send_as_server"`
	// The transaction ID of the send request if sent by a local user and one
	// was specified
	TransactionID *roomservertypes.TransactionID `json:"transaction_id"`
}

type InputRoomEventsRequest struct {
	InputRoomEvents   []InputRoomEvent   `json:"input_room_events"`
	InputInviteEvents []InputInviteEvent `json:"input_invite_events"`
}

type InputRoomEventsResponse struct {
	ErrCode int    `json:"input_room_err_code,omitempty"`
	ErrMsg  string `json:"input_room_err_msg,omitempty"`
	N       int    `json:"n"`
}

type OutputEvent struct {
	// What sort of event this is.
	Type OutputType `json:"type"`
	// The content of event with type OutputTypeNewRoomEvent
	NewRoomEvent *OutputNewRoomEvent `json:"new_room_event,omitempty"`
	// The content of event with type OutputTypeNewInviteEvent
	NewInviteEvent *OutputNewInviteEvent `json:"new_invite_event,omitempty"`
	// The content of event with type OutputTypeRetireInviteEvent
	RetireInviteEvent *OutputRetireInviteEvent `json:"retire_invite_event,omitempty"`
}

type OutputNewInviteEvent struct {
	// The "m.room.member" invite event.
	Event gomatrixserverlib.ClientEvent `json:"event"`
}

type OutputNewRoomEvent struct {
	// The Event.
	Event gomatrixserverlib.ClientEvent `json:"event"`
	// The state event IDs that were added to the state of the room by this event.
	// Together with RemovesStateEventIDs this allows the receiver to keep an up to date
	// view of the current state of the room.
	AddsStateEventIDs []string `json:"adds_state_event_ids"`
	// The state event IDs that were removed from the state of the room by this event.
	RemovesStateEventIDs []string `json:"removes_state_event_ids"`
	// The server name to use to push this event to other servers.
	// Or empty if this event shouldn't be pushed to other servers.
	//
	// This is used by the federation sender component. We need to tell it what
	// event it needs to send because it can't tell on its own. Normally if an
	// event was created on this server then we are responsible for sending it.
	// However there are a couple of exceptions. The first is that when the
	// server joins a remote room through another matrix server, it is the job
	// of the other matrix server to send the event over federation. The second
	// is the reverse of the first, that is when a remote server joins a room
	// that we are in over federation using our server it is our responsibility
	// to send the join event to other matrix servers.
	//
	// We encode the server name that the event should be sent using here to
	// future proof the API for virtual hosting.
	SendAsServer string `json:"send_as_server"`
	// The transaction ID of the send request if sent by a local user and one
	// was specified
	TransactionID *roomservertypes.TransactionID `json:"transaction_id"`
	Joined        []string                       `json:"joined"`
}

type OutputRetireInviteEvent struct {
	// The ID of the "m.room.member" invite event.
	EventID string
	// The target user ID of the "m.room.member" invite event that was retired.
	TargetUserID string
	// Optional event ID of the event that replaced the invite.
	// This can be empty if the invite was rejected locally and we were unable
	// to reach the server that originally sent the invite.
	RetiredByEventID string
	// The "membership" of the user after retiring the invite. One of "join"
	// "leave" or "ban".
	Membership string
}

type OutputType string

type QueryBackFillEventsRequest gomatrixserverlib.BackfillRequest

type QueryBackFillEventsResponse gomatrixserverlib.BackfillResponse

type QueryEventAuthRequest struct {
	EventID string `json:"event_id"`
}

type QueryEventAuthResponse struct {
	AuthEvents []*gomatrixserverlib.Event
}

type QueryEventsByDomainOffsetRequest struct {
	RoomID       string `json:"room_id"`
	Domain       string `json:"domain"`
	DomainOffset int64  `json:"domain_offset"`
	EventID      string `json:"event_id"`
	Limit        int    `json:"limit"`
	UseEventID   bool   `json:"use_event_id"`
}

type QueryEventsByDomainOffsetResponse struct {
	Error string                    `json:"error"`
	PDUs  []gomatrixserverlib.Event `json:"pdus"`
}

type QueryEventsByIDRequest struct {
	// The event IDs to look up.
	EventIDs []string `json:"event_ids"`
}

type QueryEventsByIDResponse struct {
	// Copy of the request for debugging.
	EventIDs []string `json:"event_ids"`
	// A list of events with the requested IDs.
	// If the roomserver does not have a copy of a requested event
	// then it will omit that event from the list.
	// If the roomserver thinks it has a copy of the event, but
	// fails to read it from the database then it will fail
	// the entire request.
	// This list will be in an arbitrary order.
	Events []*gomatrixserverlib.Event `json:"events"`
}

type QueryJoinRoomsRequest struct {
	UserID string `json:"user_id"`
}

type QueryJoinRoomsResponse struct {
	UserID string   `json:"user_id"`
	Rooms  []string `json:"rooms"`
}

type QueryRoomEventByIDRequest struct {
	EventID string `json:"event_id"`
	RoomID  string `json:"room_id"`
}

type QueryRoomEventByIDResponse struct {
	// Copy of the request for debugging.
	EventID string                   `json:"event_id"`
	RoomID  string                   `json:"room_id"`
	Event   *gomatrixserverlib.Event `json:"event"`
}

type QueryRoomStateRequest struct {
	RoomID string `json:"room_id"`
}

type QueryRoomStateResponse struct {
	RoomID            string                              `json:"room_id"`
	RoomExists        bool                                `json:"room_exists"`
	Creator           *gomatrixserverlib.Event            `json:"create_ev"`
	JoinRule          *gomatrixserverlib.Event            `json:"join_rule_ev"`
	HistoryVisibility *gomatrixserverlib.Event            `json:"history_visibility_ev"`
	Visibility        *gomatrixserverlib.Event            `json:"visibility_ev"`
	Name              *gomatrixserverlib.Event            `json:"name_ev"`
	Topic             *gomatrixserverlib.Event            `json:"topic_ev"`
	Desc              *gomatrixserverlib.Event            `json:"desc_ev"`
	CanonicalAlias    *gomatrixserverlib.Event            `json:"canonical_alias_ev"`
	Power             *gomatrixserverlib.Event            `json:"power_ev"`
	Alias             *gomatrixserverlib.Event            `json:"alias_ev"`
	Join              map[string]*gomatrixserverlib.Event `json:"join_map"`
	Leave             map[string]*gomatrixserverlib.Event `json:"leave_map"`
	Invite            map[string]*gomatrixserverlib.Event `json:"invite_map"`
	ThirdInvite       map[string]*gomatrixserverlib.Event `json:"third_invite_map"`
	Avatar            *gomatrixserverlib.Event            `json:"avatar_ev"`
	GuestAccess       *gomatrixserverlib.Event            `json:"guest_access"`
}

type RawEvent struct {
	RoomID     string
	Kind       int
	Trust      bool
	Reply      string
	TxnID      *roomservertypes.TransactionID
	BulkEvents BulkEvent
	Query      []string
}

type RemoveRoomAliasRequest struct {
	// ID of the user removing the alias
	UserID string `json:"user_id"`
	// The room alias to remove
	Alias string `json:"alias"`
}

type RemoveRoomAliasResponse struct{}

type RoomserverAliasAPI interface {
	AllocRoomAlias(
		ctx context.Context,
		req *SetRoomAliasRequest,
		response *SetRoomAliasResponse,
	) error

	// Set a room alias
	SetRoomAlias(
		ctx context.Context,
		req *SetRoomAliasRequest,
		response *SetRoomAliasResponse,
	) error

	// Get the room ID for an alias
	GetAliasRoomID(
		ctx context.Context,
		req *GetAliasRoomIDRequest,
		response *GetAliasRoomIDResponse,
	) error

	// Remove a room alias
	RemoveRoomAlias(
		ctx context.Context,
		req *RemoveRoomAliasRequest,
		response *RemoveRoomAliasResponse,
	) error
}

type RoomserverAliasRequest struct {
	SetRoomAliasRequest    *SetRoomAliasRequest    `json:"set_room_alias,omitempty"`
	GetAliasRoomIDRequest  *GetAliasRoomIDRequest  `json:"get_room_alias,omitempty"`
	RemoveRoomAliasRequest *RemoveRoomAliasRequest `json:"rem_room_alias,omitempty"`
	AllocRoomAliasRequest  *SetRoomAliasRequest    `json:"alloc_room_alias,omitempty"`
	Reply                  string
}

type RoomserverInputAPI interface {
	InputRoomEvents(
		ctx context.Context,
		input *RawEvent,
	) (int, error)
}

type RoomserverQueryAPI interface {
	// Query a list of events by event ID.
	QueryEventsByID(
		ctx context.Context,
		request *QueryEventsByIDRequest,
		response *QueryEventsByIDResponse,
	) error

	QueryRoomEventByID(
		ctx context.Context,
		request *QueryRoomEventByIDRequest,
		response *QueryRoomEventByIDResponse,
	) error

	QueryJoinRooms(
		ctx context.Context,
		request *QueryJoinRoomsRequest,
		response *QueryJoinRoomsResponse,
	) error

	QueryRoomState(
		ctx context.Context,
		request *QueryRoomStateRequest,
		response *QueryRoomStateResponse,
	) error

	QueryBackFillEvents(
		ctx context.Context,
		request *QueryBackFillEventsRequest,
		response *QueryBackFillEventsResponse,
	) error

	QueryEventAuth(
		ctx context.Context,
		request *QueryEventAuthRequest,
		response *QueryEventAuthResponse,
	) error

	QueryEventsByDomainOffset(
		ctx context.Context,
		request *QueryEventsByDomainOffsetRequest,
		response *QueryEventsByDomainOffsetResponse,
	) error
}

type RoomserverRPCAPI interface {
	RoomserverAliasAPI
	RoomserverQueryAPI
	EduApi

	InputRoomEvents(context.Context, *RawEvent) (int, error)
}

type RoomserverRpcRequest struct {
	QueryEventsByID           *QueryEventsByIDRequest           `json:"qry_events_by_id,omitempty"`
	QueryRoomEventByID        *QueryRoomEventByIDRequest        `json:"qry_room_events_by_id,omitempty"`
	QueryJoinRooms            *QueryJoinRoomsRequest            `json:"qry_join_rooms,omitempty"`
	QueryRoomState            *QueryRoomStateRequest            `json:"qry_room_state,omitempty"`
	QueryBackFillEvents       *QueryBackFillEventsRequest       `json:"qry_back_fill,omitempty"`
	QueryEventAuth            *QueryEventAuthRequest            `json:"qry_event_auth,omitempty"`
	QueryEventsByDomainOffset *QueryEventsByDomainOffsetRequest `json:"qry_events_by_domain_offset,omitempty"`
	Reply                     string
}

type SetRoomAliasRequest struct {
	// ID of the user setting the alias
	UserID string `json:"user_id"`
	// New alias for the room
	Alias string `json:"alias"`
	// The room ID the alias is referring to
	RoomID string `json:"room_id"`
}

type SetRoomAliasResponse struct {
	// Does the alias already refer to a room?
	AliasExists bool `json:"alias_exists"`
}