@myronsi/messenger-api 2.0.0-alpha.1.next.1

package/dist/ws-events.d.ts

@@ -0,0 +1,526 @@
+/* Generated from api/openapi.yaml 2.0.0-alpha.1. Do not edit. */
+
+/**
+ * Any WebSocket event, in either direction.
+ */
+export type WebSocketEvent = ClientEvent | ServerEvent;
+/**
+ * Every event a client may send.
+ */
+export type ClientEvent =
+  | ClientDeleteEvent
+  | ClientEditEvent
+  | ClientMessageEvent
+  | ClientReactionAddEvent
+  | ClientReactionRemoveEvent
+  | ClientReadEvent
+  | ClientResendEvent
+  | ClientTypingEvent;
+/**
+ * Client-generated ID that makes sending idempotent and ties acks and errors to the send.
+ */
+export type ClientTempId = string;
+/**
+ * Decimal ID as a string (Snowflake IDs exceed 2^53).
+ */
+export type Id = string;
+/**
+ * Every event the server may send.
+ */
+export type ServerEvent =
+  | ServerAckEvent
+  | ServerApprovalRequestCreatedEvent
+  | ServerChatCreatedEvent
+  | ServerChatDeletedEvent
+  | ServerChatListUpdateEvent
+  | ServerDeleteEvent
+  | ServerEditEvent
+  | ServerErrorEvent
+  | ServerGroupCreatedEvent
+  | ServerGroupUpdatedEvent
+  | ServerHelloEvent
+  | ServerMessageEvent
+  | ServerPresenceEvent
+  | ServerReactionAddEvent
+  | ServerReactionRemoveEvent
+  | ServerReadEvent
+  | ServerTypingEvent;
+export type Timestamp = string;
+export type ApprovalRequestType = "direct_message" | "group_invite";
+export type ApprovalRequestStatus = "pending" | "approved" | "rejected";
+export type Username = string;
+export type ChatType = "direct" | "group";
+export type MessageType = "text" | "file" | "voice" | "system";
+export type AttachmentKind = "image" | "audio" | "voice" | "video" | "file";
+export type GroupRole = "owner" | "admin" | "member";
+/**
+ * Stable machine-readable error code. New codes can appear in MINOR versions; unknown
+ * codes must be treated like `internal_error`.
+ *
+ */
+export type ErrorCode =
+  | "invalid_request"
+  | "validation_failed"
+  | "unauthenticated"
+  | "invalid_credentials"
+  | "two_factor_required"
+  | "invalid_two_factor_code"
+  | "token_expired"
+  | "forbidden"
+  | "not_found"
+  | "conflict"
+  | "already_exists"
+  | "payload_too_large"
+  | "unsupported_media_type"
+  | "rate_limited"
+  | "client_outdated"
+  | "invalid_client_version"
+  | "blocked_by_user"
+  | "approval_required"
+  | "internal_error";
+
+/**
+ * Delete a message for yourself or for everyone.
+ */
+export interface ClientDeleteEvent {
+  type: "delete";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    scope: "me" | "everyone";
+  };
+}
+/**
+ * Edit your own text message.
+ */
+export interface ClientEditEvent {
+  type: "edit";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    content: string;
+  };
+}
+/**
+ * Send a message. Idempotent per `client_temp_id`; answered with `ack` or `error`.
+ */
+export interface ClientMessageEvent {
+  type: "message";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: TextMessageData | AttachmentMessageData;
+}
+export interface TextMessageData {
+  type: "text";
+  content: string;
+  reply_to?: Id | null;
+}
+/**
+ * `file` and `voice` messages reference an uploaded attachment by ID, never by URL.
+ */
+export interface AttachmentMessageData {
+  type: "file" | "voice";
+  /**
+   * Optional caption
+   */
+  content?: string | null;
+  attachment_id: Id;
+  reply_to?: Id | null;
+}
+/**
+ * Add a reaction.
+ */
+export interface ClientReactionAddEvent {
+  type: "reaction_add";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    emoji: string;
+  };
+}
+/**
+ * Remove your reaction.
+ */
+export interface ClientReactionRemoveEvent {
+  type: "reaction_remove";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    emoji: string;
+  };
+}
+/**
+ * Mark messages as read up to and including `message_id`.
+ */
+export interface ClientReadEvent {
+  type: "read";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+  };
+}
+/**
+ * Ask the server to deliver a message again that was saved but not delivered.
+ */
+export interface ClientResendEvent {
+  type: "resend";
+  client_temp_id: ClientTempId;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+  };
+}
+/**
+ * Tell the chat that you are (not) typing. Not acknowledged, so it carries no `client_temp_id`.
+ */
+export interface ClientTypingEvent {
+  type: "typing";
+  chat_id: Id;
+  data: {
+    is_typing: boolean;
+  };
+}
+/**
+ * The server accepted the client event with this `client_temp_id`.
+ */
+export interface ServerAckEvent {
+  type: "ack";
+  event_id: Id;
+  chat_id: Id | null;
+  /**
+   * Result of the client event. A `message` is answered with the stored `message_id` and `created_at`; every other event with an empty object.
+   */
+  data: MessageAckData | EmptyAckData;
+  client_temp_id: ClientTempId;
+}
+export interface MessageAckData {
+  message_id: Id;
+  created_at: Timestamp;
+}
+export interface EmptyAckData {
+  message_id?: {
+    [k: string]: unknown | undefined;
+  };
+  created_at?: {
+    [k: string]: unknown | undefined;
+  };
+}
+/**
+ * A new request waits in your inbox.
+ */
+export interface ServerApprovalRequestCreatedEvent {
+  type: "approval_request_created";
+  event_id: Id;
+  chat_id: null;
+  data: {
+    request: ApprovalRequest;
+  };
+}
+export interface ApprovalRequest {
+  id: Id;
+  type: ApprovalRequestType;
+  status: ApprovalRequestStatus;
+  requester: User;
+  /**
+   * Only for `group_invite`
+   */
+  group_name?: string | null;
+  /**
+   * First message of a direct-message request
+   */
+  preview?: string | null;
+  created_at: Timestamp;
+}
+/**
+ * A user as visible to the requesting user; hidden fields are `null`.
+ */
+export interface User {
+  id: Id;
+  username: Username;
+  display_name: string;
+  /**
+   * The requesting user's own name for this user, if set.
+   */
+  contact_name?: string | null;
+  /**
+   * Path of the avatar, always same-origin (`/api/v2/users/{id}/avatar`).
+   */
+  avatar_url: string | null;
+  bio: string | null;
+  is_online: boolean;
+  last_seen: Timestamp | null;
+  is_deleted: boolean;
+}
+/**
+ * A chat was created with you.
+ */
+export interface ServerChatCreatedEvent {
+  type: "chat_created";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    chat: Chat;
+  };
+}
+export interface Chat {
+  id: Id;
+  type: ChatType;
+  /**
+   * Display name of the peer or the group
+   */
+  name: string;
+  avatar_url: string | null;
+  /**
+   * The other user of a direct chat; `null` for groups.
+   */
+  peer: User | null;
+  is_pinned: boolean;
+  unread_count: number;
+  last_message: Message | null;
+  /**
+   * Only for groups.
+   */
+  my_role?: GroupRole | null;
+  created_at: Timestamp;
+}
+export interface Message {
+  id: Id;
+  chat_id: Id;
+  type: MessageType;
+  /**
+   * `null` for system messages.
+   */
+  sender: User | null;
+  /**
+   * Text, or the caption of a file; `null` when deleted.
+   */
+  content: string | null;
+  attachment: Attachment | null;
+  reply_to: Id | null;
+  forwarded_from: ForwardedFrom | null;
+  reactions: Reaction[];
+  read_by: ReadReceipt[];
+  created_at: Timestamp;
+  edited_at: Timestamp | null;
+  is_deleted: boolean;
+  client_temp_id?: ClientTempId;
+}
+export interface Attachment {
+  id: Id;
+  kind: AttachmentKind;
+  filename: string;
+  /**
+   * Detected by the server
+   */
+  content_type: string;
+  /**
+   * Bytes
+   */
+  size: number;
+  /**
+   * Same-origin path (`/api/v2/attachments/{id}/content`) set by the server.
+   */
+  url: string;
+  width?: number | null;
+  height?: number | null;
+  thumbnail_url?: string | null;
+  duration_ms?: number | null;
+  waveform?: number[] | null;
+}
+export interface ForwardedFrom {
+  message_id: Id;
+  sender_id: Id | null;
+  sender_name: string;
+}
+export interface Reaction {
+  emoji: string;
+  user_id: Id;
+}
+export interface ReadReceipt {
+  user_id: Id;
+  read_at: Timestamp;
+}
+/**
+ * A chat was deleted, or you were removed from it.
+ */
+export interface ServerChatDeletedEvent {
+  type: "chat_deleted";
+  event_id: Id;
+  chat_id: Id;
+  data: {};
+}
+/**
+ * The chat-list entry changed (last message, unread count, pin).
+ */
+export interface ServerChatListUpdateEvent {
+  type: "chat_list_update";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    chat: Chat;
+  };
+}
+/**
+ * A message was deleted for everyone (deleting for yourself is only sent to your other devices).
+ */
+export interface ServerDeleteEvent {
+  type: "delete";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    scope: "me" | "everyone";
+  };
+}
+/**
+ * A message was edited.
+ */
+export interface ServerEditEvent {
+  type: "edit";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message: Message;
+  };
+}
+/**
+ * The server rejected the client event with this `client_temp_id`, or a connection-level error occurred.
+ */
+export interface ServerErrorEvent {
+  type: "error";
+  event_id: Id;
+  chat_id: Id | null;
+  data: {
+    code: ErrorCode;
+    message?: string;
+  };
+  client_temp_id?: ClientTempId;
+}
+/**
+ * You were added to a new group.
+ */
+export interface ServerGroupCreatedEvent {
+  type: "group_created";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    group: Group;
+  };
+}
+export interface Group {
+  id: Id;
+  name: string;
+  description: string | null;
+  avatar_url: string | null;
+  owner_id: Id;
+  my_role: GroupRole;
+  members: GroupMember[];
+  created_at: Timestamp;
+}
+export interface GroupMember {
+  user: User;
+  role: GroupRole;
+  joined_at: Timestamp;
+}
+/**
+ * Name, description, avatar, members or roles of a group changed.
+ */
+export interface ServerGroupUpdatedEvent {
+  type: "group_updated";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    group: Group;
+  };
+}
+/**
+ * First event after connecting, so clients that reconnect after a deploy learn the current contract.
+ */
+export interface ServerHelloEvent {
+  type: "hello";
+  event_id: Id;
+  chat_id: null;
+  data: {
+    api_version: string;
+    min_client_api_version: string;
+    user_id: Id;
+  };
+}
+/**
+ * A new message in a chat.
+ */
+export interface ServerMessageEvent {
+  type: "message";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message: Message;
+  };
+}
+/**
+ * A user came online or went offline, as far as their privacy settings allow.
+ */
+export interface ServerPresenceEvent {
+  type: "presence";
+  event_id: Id;
+  chat_id: null;
+  data: {
+    user_id: Id;
+    is_online: boolean;
+    last_seen: Timestamp | null;
+  };
+}
+/**
+ * A reaction was added.
+ */
+export interface ServerReactionAddEvent {
+  type: "reaction_add";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    reaction: Reaction;
+  };
+}
+/**
+ * A reaction was removed.
+ */
+export interface ServerReactionRemoveEvent {
+  type: "reaction_remove";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    reaction: Reaction;
+  };
+}
+/**
+ * A user read messages up to and including `message_id` (not sent when the reader turned read receipts off).
+ */
+export interface ServerReadEvent {
+  type: "read";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    message_id: Id;
+    user_id: Id;
+    read_at: Timestamp;
+  };
+}
+/**
+ * A user started or stopped typing.
+ */
+export interface ServerTypingEvent {
+  type: "typing";
+  event_id: Id;
+  chat_id: Id;
+  data: {
+    user_id: Id;
+    is_typing: boolean;
+  };
+}