@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

package/types/private/domain/use-cases/messaging/getPollResponsesUseCase.d.ts

@@ -0,0 +1,24 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { PollResponsesEntity } from '../../entities/messaging/pollEntity';
+/**
+ * Input for `GetPollResponsesUseCase`.
+ *
+ * @interface GetPollResponsesUseCaseInput
+ */
+interface GetPollResponsesUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    pollId: string;
+}
+/**
+ * Application business logic for tallying the responses for a poll.
+ */
+export declare class GetPollResponsesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetPollResponsesUseCaseInput): Promise<PollResponsesEntity>;
+    private getPollResponses;
+}
+export {};

package/types/private/domain/use-cases/messaging/markAsReadUseCase.d.ts

@@ -0,0 +1,22 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `MarkAsReadUseCase`.
+ *
+ * @interface MarkAsReadUseCaseInput
+ */
+interface MarkAsReadUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+}
+/**
+ * Application business logic for marking messages from a recipient as read.
+ */
+export declare class MarkAsReadUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: MarkAsReadUseCaseInput): Promise<void>;
+    private markAsRead;
+}
+export {};

package/types/private/domain/use-cases/messaging/pinUnpinMessageUseCase.d.ts

@@ -0,0 +1,26 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `PinUnpinMessageUseCase`.
+ *
+ * @interface PinUnpinMessageUseCaseInput
+ */
+interface PinUnpinMessageUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    messageId: string;
+}
+/**
+ * Application business logic to pin or unpin an existing message for a given recipient.
+ * Depends on whether said message is already pinned.
+ *
+ * NOTE: This use case is used for both `messagingModule.pinMessage` and `messagingModule.unpinMessage`
+ */
+export declare class PinUnpinMessageUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: PinUnpinMessageUseCaseInput): Promise<void>;
+    pinUnpinMessage(input: PinUnpinMessageUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/messaging/searchMessagesUseCase.d.ts

@@ -0,0 +1,35 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { SearchMessagesItemEntity } from '../../entities/messaging/messageEntity';
+/**
+ * Input for `SearchMessagesUseCase`.
+ *
+ * @interface SearchMessagesUseCaseInput
+ */
+interface SearchMessagesUseCaseInput {
+    handleId: HandleId;
+    searchText: string;
+    limit?: number | undefined;
+    nextToken?: string | undefined;
+}
+/**
+ * Output for `SearchMessagesUseCase`.
+ *
+ * @interface SearchMessagesUseCaseOutput
+ */
+interface SearchMessagesUseCaseOutput {
+    messages: SearchMessagesItemEntity[];
+    nextToken?: string;
+}
+/**
+ * Application business logic for retrieving a list of messages from all
+ * unencrypted rooms matching search keywords.
+ */
+export declare class SearchMessagesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SearchMessagesUseCaseInput): Promise<SearchMessagesUseCaseOutput>;
+    private searchMessages;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendMediaUseCase.d.ts

@@ -0,0 +1,34 @@
+import { HandleId, Recipient, ThumbnailInfo } from '../../../../public';
+import { MediaCredentialManager } from '../../../data/media/mediaCredentialManager';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SendMediaUseCase`.
+ *
+ * @interface SendMediaUseCaseInput
+ */
+interface SendMediaUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    file: ArrayBuffer;
+    fileName: string;
+    fileType: string;
+    fileSize: number;
+    thumbnail?: ArrayBuffer;
+    thumbnailInfo?: ThumbnailInfo;
+    threadId?: string;
+    replyToMessageId?: string;
+    clientMessageDuration?: number;
+    serverMessageDuration?: number;
+}
+/**
+ * Application business logic for sending a media message to a recipient.
+ */
+export declare class SendMediaUseCase {
+    private readonly sessionManager;
+    private readonly mediaCredentialManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager, mediaCredentialManager: MediaCredentialManager);
+    execute(input: SendMediaUseCaseInput): Promise<void>;
+    sendMedia(input: SendMediaUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendMessageUseCase.d.ts

@@ -0,0 +1,27 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { MessageMentionEntity } from '../../entities/messaging/messageEntity';
+/**
+ * Input for `SendMessageUseCase`.
+ *
+ * @interface SendMessageUseCaseInput
+ */
+interface SendMessageUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    message: string;
+    mentions: MessageMentionEntity[];
+    clientMessageDuration?: number;
+    serverMessageDuration?: number;
+}
+/**
+ * Application business logic for sending a message to a recipient.
+ */
+export declare class SendMessageUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SendMessageUseCaseInput): Promise<void>;
+    private sendMessage;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendPollResponseUseCase.d.ts

@@ -0,0 +1,24 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SendPollResponseUseCase`.
+ *
+ * @interface SendPollResponseUseCaseInput
+ */
+interface SendPollResponseUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    pollId: string;
+    answers: string[];
+}
+/**
+ * Application business logic for sending a response to a poll.
+ */
+export declare class SendPollResponseUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SendPollResponseUseCaseInput): Promise<void>;
+    private sendPollResponse;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendReplyMessageUseCase.d.ts

@@ -0,0 +1,28 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { MessageMentionEntity } from '../../entities/messaging/messageEntity';
+/**
+ * Input for `SendReplyMessageUseCase`.
+ *
+ * @interface SendReplyMessageUseCaseInput
+ */
+interface SendReplyMessageUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    message: string;
+    replyToMessageId: string;
+    mentions: MessageMentionEntity[];
+    clientMessageDuration?: number;
+    serverMessageDuration?: number;
+}
+/**
+ * Application business logic for sending a reply message to a recipient.
+ */
+export declare class SendReplyMessageUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SendReplyMessageUseCaseInput): Promise<void>;
+    private sendReply;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendThreadMessageUseCase.d.ts

@@ -0,0 +1,28 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { MessageMentionEntity } from '../../entities/messaging/messageEntity';
+/**
+ * Input for `SendThreadMessageUseCase`.
+ *
+ * @interface SendThreadMessageUseCaseInput
+ */
+interface SendThreadMessageUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    message: string;
+    threadId: string;
+    mentions: MessageMentionEntity[];
+    clientMessageDuration?: number;
+    serverMessageDuration?: number;
+}
+/**
+ * Application business logic for sending a thread message to a recipient.
+ */
+export declare class SendThreadMessageUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SendThreadMessageUseCaseInput): Promise<void>;
+    private sendThread;
+}
+export {};

package/types/private/domain/use-cases/messaging/sendTypingNotificationUseCase.d.ts

@@ -0,0 +1,23 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SendTypingNotificationUseCase`.
+ *
+ * @interface SendTypingNotificationUseCaseInput
+ */
+interface SendTypingNotificationUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    isTyping: boolean;
+}
+/**
+ * Application business logic for sending a typing notification to a recipient.
+ */
+export declare class SendTypingNotificationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SendTypingNotificationUseCaseInput): Promise<void>;
+    private sendTypingNotification;
+}
+export {};

package/types/private/domain/use-cases/messaging/toggleReactionUseCase.d.ts

@@ -0,0 +1,24 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `ToggleReactionUseCase`.
+ *
+ * @interface ToggleReactionUseCaseInput
+ */
+interface ToggleReactionUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    messageId: string;
+    content: string;
+}
+/**
+ * Application business logic for toggling a reaction on a message.
+ */
+export declare class ToggleReactionUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: ToggleReactionUseCaseInput): Promise<void>;
+    toggleReaction(input: ToggleReactionUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/notifications/clearRecipientChatRulesUseCase.d.ts

@@ -0,0 +1,21 @@
+import { HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `ClearRecipientChatRulesUseCase`.
+ *
+ * @interface ClearRecipientChatRulesUseCaseInput
+ */
+interface ClearRecipientChatRulesUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+}
+/**
+ * Use case for clearing recipient chat rules.
+ */
+export declare class ClearRecipientChatRulesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: ClearRecipientChatRulesUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/notifications/getDecodedInfoUseCase.d.ts

@@ -0,0 +1,22 @@
+import { HandleId, NotificationInfo } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `GetDecodedInfoUseCase`.
+ *
+ * @interface GetDecodedInfoUseCaseInput
+ */
+interface GetDecodedInfoUseCaseInput {
+    handleId: HandleId;
+    eventId: string;
+    roomId: string;
+}
+/**
+ * Use case for decoding a notification content.
+ */
+export declare class GetDecodedInfoUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetDecodedInfoUseCaseInput): Promise<NotificationInfo>;
+}
+export {};

package/types/private/domain/use-cases/notifications/getSettingsUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId, NotificationSettings } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `GetSettingsUseCase`.
+ *
+ * @interface GetSettingsUseCaseInput
+ */
+interface GetSettingsUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for getting notification settings.
+ */
+export declare class GetSettingsUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetSettingsUseCaseInput): Promise<NotificationSettings>;
+}
+export {};

package/types/private/domain/use-cases/notifications/setDefaultChatRulesUseCase.d.ts

@@ -0,0 +1,21 @@
+import { ChatNotificationRules, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SetDefaultChatRulesUseCase`.
+ *
+ * @interface SetDefaultChatRulesUseCaseInput
+ */
+interface SetDefaultChatRulesUseCaseInput {
+    handleId: HandleId;
+    chatRules: ChatNotificationRules;
+}
+/**
+ * Use case for setting default chat rules.
+ */
+export declare class SetDefaultChatRulesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SetDefaultChatRulesUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/notifications/setDefaultEventRulesUseCase.d.ts

@@ -0,0 +1,21 @@
+import { EventNotificationRules, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SetDefaultEventRulesUseCase`.
+ *
+ * @interface SetDefaultEventRulesUseCaseInput
+ */
+interface SetDefaultEventRulesUseCaseInput {
+    handleId: HandleId;
+    eventRules: EventNotificationRules;
+}
+/**
+ * Use case for setting default event rules.
+ */
+export declare class SetDefaultEventRulesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SetDefaultEventRulesUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/notifications/setRecipientChatRulesUseCase.d.ts

@@ -0,0 +1,22 @@
+import { ChatNotificationRules, HandleId, Recipient } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `SetRecipientChatRulesUseCase`.
+ *
+ * @interface SetRecipientChatRulesUseCaseInput
+ */
+interface SetRecipientChatRulesUseCaseInput {
+    handleId: HandleId;
+    recipient: Recipient;
+    chatRules: ChatNotificationRules;
+}
+/**
+ * Use case for setting override chat rules.
+ */
+export declare class SetRecipientChatRulesUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: SetRecipientChatRulesUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/acceptVerificationUseCase.d.ts

@@ -0,0 +1,22 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `AcceptVerificationUseCase`.
+ *
+ * @interface AcceptVerificationUseCaseInput
+ */
+interface AcceptVerificationUseCaseInput {
+    handleId: HandleId;
+    senderId: HandleId;
+    flowId: string;
+}
+/**
+ * Use case for accepting a verification request.
+ */
+export declare class AcceptVerificationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: AcceptVerificationUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/approveVerificationUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `ApproveVerificationUseCase`.
+ *
+ * @interface ApproveVerificationUseCaseInput
+ */
+interface ApproveVerificationUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for approving verification.
+ */
+export declare class ApproveVerificationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: ApproveVerificationUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/cancelVerificationUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `CancelVerificationUseCase`.
+ *
+ * @interface CancelVerificationUseCaseInput
+ */
+interface CancelVerificationUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for canceling verification.
+ */
+export declare class CancelVerificationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: CancelVerificationUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/createBackupUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `CreateBackupUseCase`.
+ *
+ * @interface CreateBackupUseCaseInput
+ */
+interface CreateBackupUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for creating a backup.
+ */
+export declare class CreateBackupUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: CreateBackupUseCaseInput): Promise<string>;
+}
+export {};

package/types/private/domain/use-cases/security/declineVerificationUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `DeclineVerificationUseCase`.
+ *
+ * @interface DeclineVerificationUseCaseInput
+ */
+interface DeclineVerificationUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for declining verification.
+ */
+export declare class DeclineVerificationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: DeclineVerificationUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/getBackupStateUseCase.d.ts

@@ -0,0 +1,20 @@
+import { BackupState, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `GetBackupStateUseCase`.
+ *
+ * @interface GetBackupStateUseCaseInput
+ */
+interface GetBackupStateUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for getting backup state.
+ */
+export declare class GetBackupStateUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetBackupStateUseCaseInput): Promise<BackupState>;
+}
+export {};

package/types/private/domain/use-cases/security/isVerifiedUseCase.d.ts

@@ -0,0 +1,20 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `IsVerifiedUseCase`.
+ *
+ * @interface IsVerifiedUseCaseInput
+ */
+interface IsVerifiedUseCaseInput {
+    handleId: HandleId;
+}
+/**
+ * Use case for checking if current session is verified.
+ */
+export declare class IsVerifiedUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: IsVerifiedUseCaseInput): Promise<boolean>;
+}
+export {};

package/types/private/domain/use-cases/security/onSessionVerificationChangedUseCase.d.ts

@@ -0,0 +1,21 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `OnSessionVerificationChangedUseCase`.
+ *
+ * @interface OnSessionVerificationChangedUseCaseInput
+ */
+interface OnSessionVerificationChangedUseCaseInput {
+    handleId: HandleId;
+    handler: (state: boolean) => void;
+}
+/**
+ * Use case for registering a handler for session verification changed events.
+ */
+export declare class OnSessionVerificationChangedUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: OnSessionVerificationChangedUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/onVerificationRequestReceivedUseCase.d.ts

@@ -0,0 +1,22 @@
+import { VerificationRequest } from 'matrix-js-sdk/lib/crypto-api';
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `OnVerificationRequestReceivedUseCase`.
+ *
+ * @interface OnVerificationRequestReceivedUseCaseInput
+ */
+interface OnVerificationRequestReceivedUseCaseInput {
+    handleId: HandleId;
+    handler: (state: VerificationRequest) => void;
+}
+/**
+ * Use case for registering a handler for verification request received events.
+ */
+export declare class OnVerificationRequestReceivedUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: OnVerificationRequestReceivedUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/security/recoverUseCase.d.ts

@@ -0,0 +1,21 @@
+import { HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `RecoverUseCase`.
+ *
+ * @interface RecoverUseCaseInput
+ */
+interface RecoverUseCaseInput {
+    handleId: HandleId;
+    backupKey: string;
+}
+/**
+ * Use case for recovering a backup.
+ */
+export declare class RecoverUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: RecoverUseCaseInput): Promise<void>;
+}
+export {};