@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

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

@@ -0,0 +1,189 @@
+import { ChannelId } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Channel. Model for a wrapper around a messaging channel with
+ * extra fields for discoverability and customization.
+ *
+ * @interface Channel
+ * @property {ChannelId} channelId Unique identifier of the channel.
+ * @property {string} name Optional display name for the channel.
+ * @property {string} description Optional explanation about what the channel is about.
+ * @property {string} avatarUrl Optional url for associated avatar image.
+ * @property {ChannelJoinRule} joinRule Optional rule for joining and whether the channel is searchable, if known.
+ * @property {string[]} tags A list of words to help searchability.
+ * @property {ChannelPermissions} permissions Mapping of which channel-related change action can be performed by
+ *  which channel role. Will be undefined if the handle hasn't joined the channel.
+ * @property {ChannelRole} defaultMemberRole The default role members inherit when joining the channel.
+ * @property {number} memberCount The number of joined members of the channel.
+ * @property {Date} createdAt Date for when the channel was created.
+ * @property {Date} updatedAt Date for when the channel was last updated.
+ */
+export interface Channel {
+    channelId: ChannelId;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    joinRule?: ChannelJoinRule;
+    tags: string[];
+    permissions?: ChannelPermissions;
+    defaultMemberRole?: ChannelRole;
+    memberCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * The Sudo Platform SDK representation of a Public Channel Search Result.
+ *
+ * @interface PublicChannelSearchResult
+ * @property {ChannelId} channelId Unique identifier of the public channel.
+ * @property {string} name Display name of the public channel.
+ * @property {string} description Optional explanation about what the channel is about.
+ * @property {string} avatarUrl Optional url for associated avatar image.
+ * @property {PublicChannelJoinRule} joinRule Optional rule for joining.
+ * @property {string[]} tags  A list of words to help searchability.
+ * @property {number} memberCount The number of joined members of the public channel.
+ * @property {Date} createdAt Date for when the public channel was created.
+ * @property {Date} updatedAt Date for when the public channel was last updated.
+ */
+export interface PublicChannelSearchResult {
+    channelId: ChannelId;
+    name: string;
+    description?: string;
+    avatarUrl?: string;
+    joinRule: PublicChannelJoinRule;
+    tags: string[];
+    memberCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Enumeration that defines rules for searching and joining a channel.
+ *
+ * @property PRIVATE: Channels with this rule are not searchable and can only be joined
+ *  if explicitly invited.
+ * @property PUBLIC: Channels with this rule are searchable and can be joined without
+ *  an invitation.
+ * @property PUBLIC_WITH_INVITE: Channels with this rule are searchable, but unlike
+ *  PUBLIC they can only be joined if explicitly invited or by being approved after
+ *  requesting to join.
+ *
+ * @enum
+ */
+export declare enum ChannelJoinRule {
+    PRIVATE = "PRIVATE",
+    PUBLIC = "PUBLIC",
+    PUBLIC_WITH_INVITE = "PUBLIC_WITH_INVITE"
+}
+/**
+ * Enumeration that defines whether channel search is for public or public
+ * with invite channels.
+ *
+ * @property PUBLIC: Search for public channels only.
+ * @property PUBLIC_WITH_INVITE: Search for public with invite channels only.
+ *
+ * @enum
+ */
+export declare enum PublicChannelJoinRule {
+    PUBLIC = "PUBLIC",
+    PUBLIC_WITH_INVITE = "PUBLIC_WITH_INVITE"
+}
+/**
+ * The role of a member within a channel, ranked in descending order.
+ * Higher ranked roles are granted permissions of lower ranked roles.
+ *
+ * @property ADMIN: The handle has power to make any changes to the channel
+ * @property MODERATOR: The handle has elevated power over making changes to the channel.
+ * @property PARTICIPANT: The handle has basic power of making changes to the channel.
+ * @property REACT_ONLY_PARTICIPANT: The handle can only react to messages in the chat.
+ *
+ * @enum
+ */
+export declare enum ChannelRole {
+    ADMIN = "ADMIN",
+    MODERATOR = "MODERATOR",
+    PARTICIPANT = "PARTICIPANT",
+    REACT_ONLY_PARTICIPANT = "REACT_ONLY_PARTICIPANT"
+}
+/**
+ * Permissions of certain channel chat functions and capabilities. Each chat capability requires a minimum
+ * {@link ChannelRole} for handles to be able to execute.
+ */
+export declare class ChannelPermissions {
+    sendMessages: ChannelRole;
+    inviteHandles: ChannelRole;
+    kickHandles: ChannelRole;
+    banHandles: ChannelRole;
+    changeChannelName: ChannelRole;
+    changeChannelDescription: ChannelRole;
+    changeChannelAvatar: ChannelRole;
+    deleteOthersMessages: ChannelRole;
+    /**
+     * Constructs a new instance of channel permissions with role-based access control.
+     *
+     * @interface ChannelPermissions
+     * @property {ChannelRole} sendMessages What role can send messages in the chat.
+     * @property {ChannelRole} inviteHandles What role can invite other handles.
+     * @property {ChannelRole} kickHandles What role can kick other handles.
+     * @property {ChannelRole} banHandles What role can ban other handles.
+     * @property {ChannelRole} changeChannelName What role can change the channel's name.
+     * @property {ChannelRole} changeChannelDescription What role can change the channel's description.
+     * @property {ChannelRole} changeChannelAvatar What role can change the channel's avatar.
+     * @property {ChannelRole} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(sendMessages: ChannelRole, inviteHandles: ChannelRole, kickHandles: ChannelRole, banHandles: ChannelRole, changeChannelName: ChannelRole, changeChannelDescription: ChannelRole, changeChannelAvatar: ChannelRole, deleteOthersMessages: ChannelRole);
+    /**
+     * Default required roles necessary to perform each action for new channels if not overridden
+     * with {@link ChannelPermissionsInput}.
+     */
+    static default: ChannelPermissions;
+}
+/**
+ * An enumeration of all role customizable channel actions that can be updated
+ * If undefined is set for a particular field the option will remain unchanged.
+ *
+ * @interface ChannelPermissionsInput
+ */
+export interface ChannelPermissionsInput {
+    sendMessages?: ChannelRole;
+    inviteHandles?: ChannelRole;
+    kickHandles?: ChannelRole;
+    banHandles?: ChannelRole;
+    changeChannelName?: ChannelRole;
+    changeChannelDescription?: ChannelRole;
+    changeChannelAvatar?: ChannelRole;
+    deleteOthersMessages?: ChannelRole;
+}
+/**
+ * Representation of the fields and direction to sort channels.
+ *
+ * @interface ChannelSortOrder
+ * @property {ChannelSortField} field The field names that search order can be applied to.
+ * @property {ChannelSortDirection} direction The direction of the sorting on the field attribute.
+ */
+export interface ChannelSortOrder {
+    field: ChannelSortField;
+    direction: ChannelSortDirection;
+}
+/**
+ * Enumeration that defines the attributes that ordering can be applied to.
+ *
+ * @property NAME: Order should be applied to the channel name attribute.
+ * @property MEMBER_COUNT: Order should be applied to the channel member count attribute.
+ *
+ * @enum
+ */
+export declare enum ChannelSortField {
+    NAME = "NAME",
+    MEMBER_COUNT = "MEMBER_COUNT"
+}
+/**
+ * Enumeration that defines the direction of sort ordering.
+ *
+ * @property ASCENDING: Ascending order, smallest to largest or A-Z.
+ * @property DESCENDING: Descending order, largest to smallest or Z-A.
+ *
+ * @enum
+ */
+export declare enum ChannelSortDirection {
+    ASCENDING = "ASCENDING",
+    DESCENDING = "DESCENDING"
+}

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

@@ -0,0 +1,18 @@
+import { HandleId } from './handle';
+import { ChannelId } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Channel Invitation Request. This represents an invitation
+ * request sent to a channel.
+ *
+ * @interface ChannelInvitationRequest
+ * @property {ChannelId} channelId The identifier of the channel the invitation request was sent to.
+ * @property {HandleId} handleId The identifier of the handle that sent this invitation request.
+ * @property {string} reason The reason for the invitation request, or undefined if not provided.
+ * @property {Date} createdAt Date for when the invitation request was sent, or undefined if not available.
+ */
+export interface ChannelInvitationRequest {
+    channelId: ChannelId;
+    handleId: HandleId;
+    reason?: string;
+    createdAt?: Date;
+}

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

@@ -0,0 +1,30 @@
+import { Message } from './message';
+import { Recipient } from './recipient';
+/**
+ * The Sudo Platform SDK representation of the unread count breakdown by message category.
+ *
+ * @interface UnreadCount
+ * @property {number} all The total number of unread messages.
+ * @property {number} mentions The total number of unread messages that mention this handle.
+ */
+export interface UnreadCount {
+    all: number;
+    mentions: number;
+}
+/**
+ * The Sudo Platform SDK representation of a Chat Summary.
+ *
+ * @interface ChatSummary
+ * @property {Recipient} recipient The recipient identifier for this chat summary.
+ * @property {boolean} hasUnreadMessages True if this handle has unread messages in this chat.
+ * @property {UnreadCount} unreadCount The unread messages counts in the chat, including from any threads.
+ * @property {Record<string, UnreadCount>} threadUnreadCount A map of thread IDs to the unread message counts for that thread.
+ * @property {Message} latestMessage The latest message in this chat, or undefined if one cannot be found.
+ */
+export interface ChatSummary {
+    recipient: Recipient;
+    hasUnreadMessages: boolean;
+    unreadCount: UnreadCount;
+    threadUnreadCount: Record<string, UnreadCount>;
+    latestMessage?: Message;
+}

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

@@ -0,0 +1,43 @@
+import { Handle } from './handle';
+import { ChatId } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Direct Chat.
+ * Contains the identifiers of a direct chat with another handle.
+ *
+ * @interface DirectChat
+ * @property {ChatId} id The identifier of the direct chat.
+ * @property {Handle} otherHandle The handle that is participating in the direct chat.
+ */
+export interface DirectChat {
+    id: ChatId;
+    otherHandle: Handle;
+}
+/**
+ * The role of a member within a direct chat, ranked in descending order.
+ *
+ * @property PARTICIPANT: The handle has power of making changes to the direct chat.
+ * @property NOBODY: The handle has no power to make any changes to the direct chat.
+ *
+ * @enum
+ */
+export declare enum DirectChatRole {
+    PARTICIPANT = "PARTICIPANT",
+    NOBODY = "NOBODY"
+}
+/**
+ * Permissions of certain direct chat functions and capabilities. Each capability requires a minimum
+ * {@link DirectChatRole} for handles to be able to execute.
+ */
+export declare class DirectChatPermissions {
+    deleteOthersMessages: DirectChatRole;
+    /**
+     * Constructs a new instance of direct chat permissions with role-based access control.
+     *
+     * @property {DirectChatRole} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(deleteOthersMessages: DirectChatRole);
+    /**
+     * The default permissions for a group.
+     */
+    static default: DirectChatPermissions;
+}

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

@@ -0,0 +1,14 @@
+import { Handle } from './handle';
+import { ChatId } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Direct Chat Invitation.
+ * Contains the indentifiers of an invitation to a direct chat with another handle.
+ *
+ * @interface DirectChatInvitation
+ * @property {ChatId} chatId The identifier of the direct chat.
+ * @property {Handle} inviterHandle The other handle participating in the direct chat.
+ */
+export interface DirectChatInvitation {
+    chatId: ChatId;
+    inviterHandle: Handle;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * A representation of the information used to encrypt a file.
+ *
+ * @interface FileEncryptionInfo
+ * @property {any} key A web key object containing the key used to encrypt.
+ * @property {string} iv The 128-bit unique initialization vector used by AES-CTR, encoded as unpadded base64.
+ * @property {string} v The optional version of the encrypted payload protocol.
+ * @property {HashAlgorithm} hashes A map from an algorithm name to a hash of the ciphertext, encoded as unpadded base64.
+ *  Clients should support the SHA-256 hash, which uses the key sha256.
+ */
+export interface FileEncryptionInfo {
+    key: any;
+    iv: string;
+    v?: string;
+    hashes?: HashAlgorithmMap;
+}
+/**
+ * A map from an algorithm name to a hash of the ciphertext.
+ *
+ * @property {string} sha256 The sha256 hash ciphertext.
+ */
+export interface HashAlgorithmMap {
+    sha256?: string;
+}

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

@@ -0,0 +1,68 @@
+import { GroupId } from './recipient';
+/**
+ * The Sudo Platform SDK representation of a Group. Model for a wrapper around a messaging group with
+ * extra fields for discoverability and customization.
+ *
+ * @interface Group
+ * @property {GroupId} groupId Unique identifier of the group.
+ * @property {string} name Optional display name for the group.
+ * @property {string} description Optional explanation about what the group is about.
+ * @property {string} avatarUrl Optional url for associated avatar image.
+ * @property {GroupPermissions} permissions Optional permissions describing what roles can perform
+ *  certain actions within the group.
+ * @property {number} memberCount The number of joined members of the group.
+ */
+export interface Group {
+    groupId: GroupId;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    permissions?: GroupPermissions;
+    memberCount: number;
+}
+/**
+ * The role of a member within a group, ranked in descending order.
+ * Higher ranked roles are granted permissions of lower ranked roles.
+ *
+ * @property ADMIN: The handle has power to make any changes to the group.
+ * @property PARTICIPANT: The handle has basic power of making changes to the group.
+ * @property NOBODY: The handle has no power to make any changes to the group.
+ *
+ * @enum
+ */
+export declare enum GroupRole {
+    ADMIN = "ADMIN",
+    PARTICIPANT = "PARTICIPANT",
+    NOBODY = "NOBODY"
+}
+/**
+ * Permissions of certain group functions and capabilities. Each capability requires a minimum
+ * {@link GroupRole} for handles to be able to execute.
+ */
+export declare class GroupPermissions {
+    sendMessages: GroupRole;
+    inviteHandles: GroupRole;
+    kickHandles: GroupRole;
+    banHandles: GroupRole;
+    changeGroupName: GroupRole;
+    changeGroupDescription: GroupRole;
+    changeGroupAvatar: GroupRole;
+    deleteOthersMessages: GroupRole;
+    /**
+     * Constructs a new instance of group permissions with role-based access control.
+     *
+     * @property {GroupRole} sendMessages What role can send messages in the chat.
+     * @property {GroupRole} inviteHandles What role can invite other handles.
+     * @property {GroupRole} kickHandles What role can kick other handles.
+     * @property {GroupRole} banHandles What role can ban other handles.
+     * @property {GroupRole} changeGroupName What role can change the group's name.
+     * @property {GroupRole} changeGroupDescription What role can change the group's description.
+     * @property {GroupRole} changeGroupAvatar What role can change the group's avatar.
+     * @property {GroupRole} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(sendMessages: GroupRole, inviteHandles: GroupRole, kickHandles: GroupRole, banHandles: GroupRole, changeGroupName: GroupRole, changeGroupDescription: GroupRole, changeGroupAvatar: GroupRole, deleteOthersMessages: GroupRole);
+    /**
+     * The default permissions for a group.
+     */
+    static default: GroupPermissions;
+}

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

@@ -0,0 +1,33 @@
+import { Owner } from '@sudoplatform/sudo-common';
+/**
+ * The Sudo Platform SDK representation of a Handle.
+ *
+ * @interface Handle
+ * @property {HandleId} handleId Unique identifier associated with the handle.
+ * @property {string} name The name of the handle that will be publicly visible to other users.
+ */
+export interface Handle {
+    handleId: HandleId;
+    name: string;
+}
+/**
+ * The Sudo Platform SDK representation of a Handle owned by this client's user.
+ *
+ * @interface OwnedHandle
+ * @property {HandleId} handleId See {@link Handle.handleId}.
+ * @property {string} name See {@link Handle.name}.
+ * @property {string} owner Identifier of the user that owns the handle.
+ * @property {Owner[]} owners List of identifiers of the user/sudo associated with this handle.
+ */
+export interface OwnedHandle extends Handle {
+    owner: string;
+    owners: Owner[];
+}
+/**
+ * Identifier type representing a unique handle.
+ */
+export declare class HandleId {
+    value: string;
+    constructor(value: string);
+    toString(): string;
+}

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

@@ -0,0 +1,16 @@
+export * from './channel';
+export * from './channelInvitationRequest';
+export * from './chatSummary';
+export * from './directChat';
+export * from './directChatInvitation';
+export * from './fileEncryptionInfo';
+export * from './group';
+export * from './handle';
+export * from './mediaInfo';
+export * from './member';
+export * from './message';
+export * from './messageContent';
+export * from './notification';
+export * from './poll';
+export * from './recipient';
+export * from './secureCommsSession';

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

@@ -0,0 +1,58 @@
+/**
+ * Union type encompassing all metadata types for media content messages.
+ */
+export type MediaInfo = ImageMedia | VideoMedia | AudioMedia | FileMedia;
+/**
+ * Interface representing metadata for media content messages.
+ *
+ * @interface BaseMediaInfo
+ * @property {string} mimeType The MIME type of the media.
+ * @property {number} size The size of the media in bytes.
+ * @property {string} filename The filename of the media.
+ */
+interface BaseMediaInfo {
+    mimeType: string;
+    size: number;
+    filename: string;
+}
+/**
+ * Information about an image.
+ *
+ * @interface ImageMedia
+ * @property {number} width The width of the image in pixels.
+ * @property {number} height The height of the image in pixels.
+ */
+export interface ImageMedia extends BaseMediaInfo {
+    width: number;
+    height: number;
+}
+/**
+ * Information about a video.
+ *
+ * @interface VideoMedia
+ * @property {number} width The width of the image in pixels.
+ * @property {number} height The height of the image in pixels.
+ * @property {number} duration The duration of the video.
+ */
+export interface VideoMedia extends BaseMediaInfo {
+    width: number;
+    height: number;
+    duration: number;
+}
+/**
+ * Information about an audio file.
+ *
+ * @interface AudioMedia
+ * @property {number} duration The duration of the audio.
+ */
+export interface AudioMedia extends BaseMediaInfo {
+    duration: number;
+}
+/**
+ * Information about a file.
+ *
+ * @interface FileMedia
+ */
+export interface FileMedia extends BaseMediaInfo {
+}
+export {};

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

@@ -0,0 +1,56 @@
+import { ChannelRole } from './channel';
+import { GroupRole } from './group';
+import { Handle } from './handle';
+/**
+ * The Sudo Platform SDK representation of a Member.
+ *
+ * @interface Member
+ * @property {Handle} handle Handle associated with the member.
+ * @property {MembershipState} membership The membership state for this handle. See {@link MembershipState}.
+ */
+export interface Member {
+    handle: Handle;
+    membership: MembershipState;
+}
+/**
+ * The state of a member.
+ *
+ * @property INVITED: The handle was invited to the channel/group.
+ * @property REQUESTED: The handle has requested to join the channel.
+ * @property JOINED: The handle has joined the channel/group.
+ * @property LEFT: The handle was previously a member of the channel/group but chose to leave or was kicked.
+ * @property BANNED: The handle was banned from the channel/group.
+ *
+ * @enum
+ */
+export declare enum MembershipState {
+    INVITED = "INVITED",
+    REQUESTED = "REQUESTED",
+    JOINED = "JOINED",
+    LEFT = "LEFT",
+    BANNED = "BANNED"
+}
+/**
+ * The Sudo Platform SDK representation of a Channel Member. Model representing a handle's state as a member
+ * of a channel.
+ *
+ * @interface ChannelMember
+ * @property {HandleId} handleId See {@link Member}.
+ * @property {MembershipState} membership See {@link Member}.
+ * @property {ChannelRole} role The role this channel member is assigned. See {@link ChannelRole}.
+ */
+export interface ChannelMember extends Member {
+    role: ChannelRole;
+}
+/**
+ * The Sudo Platform SDK representation of a Group Member. Model representing a handle's state as a member
+ * of a group.
+ *
+ * @interface GroupMember
+ * @property {HandleId} handleId See {@link Member}.
+ * @property {MembershipState} membership See {@link Member}.
+ * @property {GroupRole} role The role this group member is assigned, see {@link GroupRole}.
+ */
+export interface GroupMember extends Member {
+    role: GroupRole;
+}