session-desktop/ts/types/Message.ts

import { Attachment } from './Attachment';


export type Message
  = IncomingMessage
  | OutgoingMessage
  | VerifiedChangeMessage;

export type IncomingMessage = Readonly<{
  type: 'incoming';
  // Required
  attachments: Array<Attachment>;
  id: string;
  received_at: number;

  // Optional
  body?: string;
  decrypted_at?: number;
  errors?: Array<any>;
  flags?: number;
  source?: string;
  sourceDevice?: number;
} & SharedMessageProperties & Message4 & ExpirationTimerUpdate>;

export type OutgoingMessage = Readonly<{
  type: 'outgoing';

  // Required
  attachments: Array<Attachment>;
  delivered: number;
  delivered_to: Array<string>;
  destination: string; // PhoneNumber
  expirationStartTimestamp: number;
  id: string;
  received_at: number;
  sent: boolean;
  sent_to: Array<string>; // Array<PhoneNumber>

  // Optional
  body?: string;
  expires_at?: number;
  expireTimer?: number;
  recipients?: Array<string>; // Array<PhoneNumber>
  synced: boolean;
} & SharedMessageProperties & Message4 & ExpirationTimerUpdate>;

export type VerifiedChangeMessage = Readonly<{
  type: 'verified-change';
} & SharedMessageProperties & Message4 & ExpirationTimerUpdate>;

type SharedMessageProperties = Readonly<{
  conversationId: string;
  sent_at: number;
  timestamp: number;
}>;

type ExpirationTimerUpdate = Readonly<{
  expirationTimerUpdate?: Readonly<{
    expireTimer: number;
    fromSync: boolean;
    source: string; // PhoneNumber
  }>,
}>;

type Message4 = Readonly<{
  numAttachments?: number;
  numVisualMediaAttachments?: number;
  numFileAttachments?: number;
}>;