@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

package/types/public/typings/message.d.ts

@@ -0,0 +1,171 @@
+import { Handle, HandleId } from './handle';
+import { MessageContent } from './messageContent';
+import { Recipient } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Message that have been either sent or received.
+ *
+ * @interface Message
+ * @property {string} messageId Unique identifier of the message.
+ * @property {MessageState} state The current state of the message.
+ * @property {number} timestamp The time the message was sent or received.
+ * @property {Handle} senderHandle The message sender's handle.
+ * @property {boolean} isOwn True if the message was sent by the current handle, false if not.
+ * @property {MessageContent} content The message content object. See the {@link MessageContent}
+ *  type for all possible content types.
+ * @property {MessageReaction[]} reactions A list of all message reactions associated with the message.
+ * @property {MessageReceipt[]} receipts A list of all read-receipts associated with the message.
+ * @property {boolean} isVerified If available, true if the message sender's device was verified, false if not.
+ *  Verification information is not available for all messages, for example system messages. In this case the
+ *  field will be undefined.
+ */
+export interface Message {
+    messageId: string;
+    state: MessageState;
+    timestamp: number;
+    senderHandle: Handle;
+    isOwn: boolean;
+    content: MessageContent;
+    reactions: MessageReaction[];
+    receipts: MessageReceipt[];
+    isVerified?: boolean;
+}
+/**
+ * Representation of the message returned by performing server side unencrypted event search
+ *
+ * @interface SearchMessagesItem
+ * @property {string} messageId Unique identifier of the message.
+ * @property {Recipient} recipient The recipient chat that the message is located.
+ * @property {string} senderHandleId The handle identififer of the message sender.
+ * @property {string} repliedToMessageId The message identifier of the message this message
+ *  is replying to (if this message is a reply).
+ * @property {string} body The body text of the message.
+ * @property {string} filename The file name associated with a message attachment.
+ * @property {string} mimeType The MIME type associated with a message attachment.
+ * @property {number} timestamp The time the message was sent or received.
+ */
+export interface SearchMessagesItem {
+    messageId: string;
+    recipient: Recipient;
+    senderHandleId: HandleId;
+    repliedToMessageId?: string;
+    body: string;
+    filename?: string;
+    mimeType?: string;
+    timestamp: number;
+}
+/**
+ * The state of a message.
+ *
+ * @property PENDING: The message is in the process of being sent to the server.
+ * @property COMMITTED: The message is accepted by the server and has been synced
+ *  back to this client, and possibly other handles.
+ * @property FAILED: The message failed to send.
+ *
+ * @enum
+ */
+export declare enum MessageState {
+    PENDING = "PENDING",
+    COMMITTED = "COMMITTED",
+    FAILED = "FAILED"
+}
+/**
+ * Representation of the message reaction information.
+ *
+ * @interface MessageReaction
+ * @property {string} content The reaction content string. This may be an emoji or any other app-specific string.
+ * @property {number} count The total number of handles who reacted with this reaction.
+ * @property {HandleId[]} senderHandleIds The handle identifiers that reacted with this reaction.
+ */
+export interface MessageReaction {
+    content: string;
+    count: number;
+    senderHandleIds: HandleId[];
+}
+/**
+ * Representation of the message read receipt.
+ *
+ * @interface MessageReceipt
+ * @property {number} timestamp The timestamp of the receipt.
+ * @property {string} handleId The handle identifier that sent the receipt.
+ */
+export interface MessageReceipt {
+    timestamp: number;
+    handleId: HandleId;
+}
+/**
+ * Representation of a message handle mention.
+ *
+ * @interface HandleMention
+ * @property {string} type The type of the mention. Will be 'Handle' for
+ *  the case of a handle mention.
+ * @property {HandleId} handleId The handleId of the handle being mentioned.
+ * @property {string} name The name of the handle being mentioned.
+ */
+export interface HandleMention {
+    type: 'Handle';
+    handleId: HandleId;
+    name: string;
+}
+/**
+ * Representation of a message chat (Group or Channel) mention.
+ *
+ * @interface ChatMention
+ * @property {string} type The type of the mention. Will be 'Chat' for
+ *  the case of a chat mention.
+ */
+export interface ChatMention {
+    type: 'Chat';
+}
+/**
+ * Representation of a message mention type. This will either be a handle mention
+ *  or chat mention.
+ */
+export type MessageMention = HandleMention | ChatMention;
+/**
+ * Redaction reason for a user deleting their own message.
+ *
+ * @interface DeleteOwnRedactReason
+ * @property {string} type The redaction type.
+ * @property {string} threadId (Optional) The thread Id of the message being deleted.
+ */
+export interface DeleteOwnRedactReason {
+    type: 'deleteOwn';
+    threadId?: string;
+}
+/**
+ * Redaction reason for editing a reaction.
+ *
+ * @interface EditReactionRedactReason
+ * @property {string} type The redaction type.
+ */
+export interface EditReactionRedactReason {
+    type: 'editReaction';
+}
+/**
+ * Redaction reason due to moderation.
+ *
+ * @interface ModerationRedactReason
+ * @property {string} type The redaction type.
+ * @property {string} reason The moderation reason for the message deletion.
+ * @property {boolean} hide Whether the message should be hidden.
+ * @property {string} threadId (Optional) The thread Id of the message being deleted.
+ */
+export interface ModerationRedactReason {
+    type: 'moderation';
+    reason: string;
+    hide: boolean;
+    threadId?: string;
+}
+/**
+ * Unknown redaction reason.
+ *
+ * @interface UnknownRedactReason
+ * @property {string} type The redaction type.
+ */
+export interface UnknownRedactReason {
+    type: 'unknown';
+}
+/**
+ * Representation of a redaction reason. This will be one of several types indicating why a message was redacted.
+ */
+export type RedactReason = DeleteOwnRedactReason | EditReactionRedactReason | ModerationRedactReason | UnknownRedactReason;

package/types/public/typings/messageContent.d.ts

@@ -0,0 +1,245 @@
+import { IEvent, PollKind } from 'matrix-js-sdk';
+import { EncryptedFile } from 'matrix-js-sdk/lib/types';
+import { Handle } from './handle';
+import { AudioMedia, FileMedia, ImageMedia, VideoMedia } from './mediaInfo';
+import { MembershipState } from './member';
+/**
+ * Union type encompassing all possible message content types.
+ */
+export type MessageContent = BaseMessageContent | EncryptedMessage | RedactedMessage | SelfDestructedMessage | Text | Emote | Notice | Image | Video | Audio | File | Location | Poll | PollResponse | KeyVerificationRequest | MembershipChange;
+/**
+ * Base message content.
+ *
+ * @interface BaseMessageContent
+ * @property {string} type The type of the message content.
+ * @property {boolean} isEdited True if this message has been edited by the sender, false if not.
+ * @property {string} threadId The thread ID of the message (if this message is in a thread).
+ * @property {string} repliedToMessageId The message ID of the message this message is replying to (if this message is a reply).
+ */
+export interface BaseMessageContent {
+    type: string;
+    isEdited: boolean;
+    threadId?: string;
+    repliedToMessageId?: string;
+}
+/**
+ * Key verification request message content.
+ *
+ * @interface KeyVerificationRequest
+ * @property {string} body The body of the key verification request.
+ * @property {string} fromDevice The device ID of the sender.
+ * @property {string[]} methods The methods of the key verification request.
+ * @property {number} timestamp The timestamp of the key verification request.
+ */
+export interface KeyVerificationRequest extends BaseMessageContent {
+    body: string;
+    fromDevice: string;
+    methods: string[];
+    timestamp: number;
+}
+/**
+ * Redacted message content. Messages of this type have had their prevous content
+ * redacted by the sender or a chat moderator.
+ *
+ * @interface RedactedMessage
+ * @property {IEvent} redactedBecause The event that redacted the message.
+ */
+export interface RedactedMessage extends BaseMessageContent {
+    redactedBecause: IEvent;
+}
+/**
+ * Self-destructed message content. Messages of this type have had their previous content
+ * removed due to "self-destructing" after their expiry time.
+ *
+ * @interface SelfDestructedMessage
+ */
+export interface SelfDestructedMessage extends BaseMessageContent {
+}
+/**
+ * A user membership change message content.
+ *
+ * @interface MembershipChange
+ * @property {MembershipState} state The new membership state.
+ * @property {Handle} handle The handle of the user whose membership state has changed.
+ */
+export interface MembershipChange extends BaseMessageContent {
+    state: MembershipState;
+    handle: Handle;
+}
+/**
+ * Interface for messages that can self-destruct.
+ *
+ * @interface SelfDestructible
+ * @property {SelfDestructInfo} selfDestructInfo Self-destructing properties of a message.
+ */
+interface SelfDestructible extends BaseMessageContent {
+    selfDestructInfo?: SelfDestructInfo;
+}
+/**
+ * Emote message content.
+ *
+ * @interface Emote
+ * @property {string} emote The emote content.
+ */
+export interface Emote extends SelfDestructible {
+    emote: string;
+}
+/**
+ * Notice message content.
+ *
+ * @interface Notice
+ * @property {string} notice The notice content.
+ */
+export interface Notice extends SelfDestructible {
+    notice: string;
+}
+/**
+ * Text message content.
+ *
+ * @interface Text
+ * @property {string} text The message text.
+ */
+export interface Text extends SelfDestructible {
+    text: string;
+}
+/**
+ * Image message content.
+ *
+ * @interface Image
+ * @property {string} caption Optional caption text for the image.
+ * @property {string} uri The URI of the image.
+ * @property {ImageMedia} info The image information.
+ * @property {string} thumbnailUri The URI of the thumbnail image.
+ * @property {ThumbnailInfo} thumbnailInfo The thumbnail image information.
+ * @property {EncryptedFile} encryptedFile The encrypted file information.
+ */
+export interface Image extends SelfDestructible {
+    caption?: string;
+    uri: string;
+    info: ImageMedia;
+    thumbnailUri: string;
+    thumbnailInfo: ThumbnailInfo;
+    encryptedFile?: EncryptedFile;
+}
+/**
+ * Video message content.
+ *
+ * @interface Video
+ * @property {string} caption Optional caption text for the video.
+ * @property {string} uri The URI of the video.
+ * @property {VideoMedia} info The video information.
+ * @property {string} thumbnailUri The URI of the thumbnail image.
+ * @property {ThumbnailInfo} thumbnailInfo The thumbnail image information.
+ * @property {EncryptedFile} encryptedFile The encrypted file information.
+ */
+export interface Video extends SelfDestructible {
+    caption?: string;
+    uri: string;
+    info: VideoMedia;
+    thumbnailUri: string;
+    thumbnailInfo: ThumbnailInfo;
+    encryptedFile?: EncryptedFile;
+}
+/**
+ * Audio message content.
+ *
+ * @interface Audio
+ * @property {string} uri The URI of the audio file.
+ * @property {AudioMedia} info The audio information.
+ * @property {EncryptedFile} encryptedFile The encrypted file information.
+ */
+export interface Audio extends SelfDestructible {
+    uri: string;
+    info: AudioMedia;
+    encryptedFile?: EncryptedFile;
+}
+/**
+ * File message content.
+ *
+ * @interface File
+ * @property {string} uri The URI of the file.
+ * @property {FileMedia} info The file information.
+ * @property {EncryptedFile} encryptedFile The encrypted file information.
+ */
+export interface File extends SelfDestructible {
+    uri: string;
+    info: FileMedia;
+    encryptedFile?: EncryptedFile;
+}
+/**
+ * Location message content.
+ *
+ * @interface Location
+ * @property {string} description The description of the location.
+ * @property {string} geoUri The geo URI of the location.
+ */
+export interface Location extends SelfDestructible {
+    description: string;
+    geoUri: string;
+}
+/**
+ * Poll message content.
+ *
+ * @interface Poll
+ * @property {PollKind} kind The kind of poll, disclosed or undisclosed.
+ * @property {string} question The question of the poll.
+ * @property {string[]} answers The answers of the poll.
+ * @property {number} maxSelections The maximum number of selections for the poll.
+ */
+export interface Poll extends SelfDestructible {
+    kind: PollKind;
+    question: string;
+    answers: string[];
+    maxSelections: number;
+}
+/**
+ * Poll response message content.
+ *
+ * @interface PollResponse
+ * @property {string} pollId The ID of the poll start event.
+ * @property {string[]} answers The answers of the poll response.
+ */
+export interface PollResponse extends SelfDestructible {
+    pollId: string;
+    answers: string[];
+}
+/**
+ * Encrypted message content. Messages of this type are unable to be decrypted by this client.
+ *
+ * @interface EncryptedMessage
+ */
+export interface EncryptedMessage extends SelfDestructible {
+}
+/**
+ * Information about a thumbnail image.
+ *
+ * @interface ThumbnailInfo
+ * @property {number} width The width of the thumbnail in pixels.
+ * @property {number} height The height of the thumbnail in pixels.
+ * @property {string} blurHash The blur hash of the thumbnail. See [https://blurha.sh/](https://blurha.sh/).
+ * @property {string} mimeType The MIME type of the thumbnail.
+ * @property {number} size The size of the thumbnail in bytes.
+ */
+export interface ThumbnailInfo {
+    width: number;
+    height: number;
+    blurHash: string;
+    mimeType: string;
+    size: number;
+}
+/**
+ * Self-destruct information for a message.
+ *
+ * @interface SelfDestructInfo
+ * @property {number} clientDuration The length of time this message should be available.
+ *  If undefined, the message should be available indefinitely.
+ * @property {number} clientExpiry The client-side expiry time of this message.
+ * @property {number} serverExpiry The expiry time of this message on the server. After this time, the
+ *  server removes the contents of the message.
+ */
+export interface SelfDestructInfo {
+    clientDuration?: number;
+    clientExpiry?: number;
+    serverExpiry?: number;
+}
+export {};

package/types/public/typings/notification.d.ts

@@ -0,0 +1,50 @@
+import { HandleId } from './handle';
+import { Message } from './message';
+import { ChannelId, ChatId, GroupId, Recipient } from './recipient';
+export interface PlatformNotificationDataTemplate {
+    type: string;
+    handleId: string;
+    eventId: string;
+    roomId: string;
+    counts?: Record<string, number> | undefined;
+}
+export declare enum MessageNotificationLevel {
+    allMessages = "allMessages",
+    mentions = "mentionsAndKeywordsOnly",
+    mute = "mute"
+}
+export interface ChatNotificationRules {
+    messageLevel: MessageNotificationLevel;
+}
+export interface EventNotificationRules {
+    invitations: boolean;
+}
+export interface NotificationSettings {
+    defaultChatRules: ChatNotificationRules;
+    defaultEventRules: EventNotificationRules;
+    recipientChatRules: Record<string, ChatNotificationRules>;
+}
+export declare enum NotificationInfoType {
+    invite = "invite",
+    message = "message"
+}
+export interface NotificationInfo {
+    handleId: HandleId;
+    type: NotificationInfoType;
+    recipient: Recipient;
+}
+export interface Invite extends NotificationInfo {
+}
+export interface DirectChatInvite extends Invite {
+    chatId: ChatId;
+}
+export interface GroupInvite extends Invite {
+    groupId: GroupId;
+}
+export interface ChannelInvite extends Invite {
+    channelId: ChannelId;
+}
+export interface MessageNotification extends NotificationInfo {
+    recipient: Recipient;
+    message: Message;
+}

package/types/public/typings/poll.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The Sudo Platform SDK representation of tallied poll responses for a given poll.
+ *
+ * @interface PollResponses
+ * @property {Record<string, number>} talliedAnswers A record of all submitted answers and their corresponding
+ *  number of votes.
+ * @property {number} totalVotes The total number of votes for the poll.
+ * @property {number} endedAt The timestamp in which the poll ended. Will be `undefined` if the poll is still active.
+ */
+export interface PollResponses {
+    talliedAnswers: Record<string, number>;
+    totalVotes: number;
+    endedAt?: number;
+}
+/**
+ * The type of poll. Determines whether or not the poll participants can see the poll results.
+ *
+ * @property DISCLOSED: A poll where participants can see the poll results.
+ * @property UNDISCLOSED: A poll where participants cannot see the poll results.
+ *
+ * @enum
+ */
+export declare enum PollType {
+    DISCLOSED = "DISCLOSED",
+    UNDISCLOSED = "UNDISCLOSED"
+}

package/types/public/typings/recipient.d.ts

@@ -0,0 +1,33 @@
+/**
+ *  The Sudo Platform SDK representation of a base type for Groups, Channels or Direct Chats.
+ *
+ * @interface Recipient
+ * @property {string} value The value representing either a group, channel or direct chat.
+ */
+export interface Recipient {
+    value: string;
+}
+/**
+ * Identifier type representing a unique chat group.
+ */
+export declare class GroupId implements Recipient {
+    value: string;
+    constructor(value: string);
+    toString(): string;
+}
+/**
+ * Identifier type representing a unique channel.
+ */
+export declare class ChannelId implements Recipient {
+    value: string;
+    constructor(value: string);
+    toString(): string;
+}
+/**
+ * Identifier type representing a unique direct chat.
+ */
+export declare class ChatId implements Recipient {
+    value: string;
+    constructor(value: string);
+    toString(): string;
+}

package/types/public/typings/secureCommsSession.d.ts

@@ -0,0 +1,24 @@
+import { Owner } from '@sudoplatform/sudo-common';
+/**
+ * The Sudo Platform SDK representation of a Secure Comms Session.
+ *
+ * @interface SecureCommsSession
+ * @property {string} handleId Identifier associated with the Secure Comms handle.
+ * @property {string} handleName Name associated with the Secure Comms handle.
+ * @property {string} deviceId Identifier associated with the device that initiated the session.
+ * @property {string} owner Identifier of the user that owns the Secure Comms user.
+ * @property {Owner[]} owners List of identifiers of auxiliary owners for the Secure Comms user.
+ * @property {string} token Authentication token required to sign into Secure Comms server.
+ * @property {Date} createdAt Date for when the session was created.
+ * @property {Date} expiresAt Date for when the session will expire.
+ */
+export interface SecureCommsSession {
+    handleId: string;
+    handleName: string;
+    deviceId: string;
+    owner: string;
+    owners: Owner[];
+    token: string;
+    createdAt: Date;
+    expiresAt: Date;
+}