@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

package/types/private/domain/entities/rooms/roomsService.d.ts

@@ -0,0 +1,264 @@
+import { RoomEntity } from './roomEntity';
+import { RoomPowerLevelsEntity } from './roomPowerLevelsEntity';
+import { Input } from '../../../../public/secureCommsClient';
+import { ChannelInvitationRequestEntity } from '../channels/channelInvitationRequestEntity';
+import { MembershipStateEntity, RoomMemberEntity } from '../common/memberEntity';
+import { PowerLevelsEntity } from '../common/powerLevelsEntity';
+import { MediaCredentialEntity } from '../media/mediaCredentialEntity';
+/**
+ * Input containing properties required to upload an avatar.
+ *
+ * @interface AvatarInput
+ * @property {ArrayBuffer} file The file to use as the avatar.
+ * @property {string} fileName The name of the file.
+ * @property {string} fileType The MIME type of the file.
+ */
+export interface AvatarInput {
+    file: ArrayBuffer;
+    fileName: string;
+    fileType: string;
+    mediaCredential: MediaCredentialEntity;
+}
+/**
+ * Input for `RoomsService.create` method.
+ *
+ * @interface CreateRoomInput
+ * @property {string} name Optional display name for the room.
+ * @property {string} description Optional description of the room.
+ * @property {InvitedHandleIds[]} invitedHandleIds The handles that should be invited to the room after it is created.
+ * @property {PowerLevelsEntity} powerLevels The minimum levels required to perform each action and the default level of handles in the room.
+ * @property {string} avatarUrl Optional avatar image URL.
+ */
+export interface CreateRoomInput {
+    name?: string;
+    description?: string;
+    invitedHandleIds: string[];
+    powerLevels?: PowerLevelsEntity;
+    avatarUrl?: string;
+}
+/**
+ * Input for `RoomsService.update` method.
+ *
+ * @interface UpdateRoomInput
+ * @property {string} roomId Identifier of the room to update.
+ * @property {Input<string | undefined>} name The display name for the room.
+ * @property {Input<string | undefined>} description The description of the room.
+ * @property {Input<AvatarInput | undefined>} avatar The avatar of the room.
+ * @property {Input<boolean | undefined>} isVisible Whether the room is findable in search.
+ * @property {Input<RoomPowerLevelsEntity | undefined>} powerLevels The power levels indicating
+ *  what roles can perform certain actions within the room.
+ */
+export interface UpdateRoomInput {
+    roomId: string;
+    name?: Input<string | undefined>;
+    description?: Input<string | undefined>;
+    avatar?: Input<AvatarInput | undefined>;
+    isVisible?: Input<boolean | undefined>;
+    powerLevels?: Input<RoomPowerLevelsEntity | undefined>;
+}
+/**
+ * Input for `RoomsService.sendInvitations` method.
+ *
+ * @interface SendInvitationsInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string[]} targetHandleIds The list of handle identifiers to invite.
+ */
+export interface SendInvitationsInput {
+    roomId: string;
+    targetHandleIds: string[];
+}
+/**
+ * Input for `RoomService.knock` method.
+ *
+ * @interface KnockRoomInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string} reason Optional reason for the knock.
+ */
+export interface KnockRoomInput {
+    roomId: string;
+    reason?: string;
+}
+/**
+ * Input for `RoomsService.getMembershipState` method.
+ *
+ * @interface GetMembershipStateInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string} handleId The identifier associated with the handle.
+ */
+export interface GetMembershipStateInput {
+    roomId: string;
+    handleId: string;
+}
+/**
+ * Input for `RoomsService.updateRoomMemberPowerLevel` method.
+ *
+ * @interface UpdateRoomMemberPowerLevelInput
+ */
+export interface UpdateRoomMemberPowerLevelInput {
+    roomId: string;
+    targetHandleId: string;
+    powerLevel: number;
+}
+/**
+ * Input for `RoomsService.kickHandle` method.
+ *
+ * @interface KickHandleInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string} targetHandleId The identifier of the handle intended to be kicked.
+ * @property {string} reason Optional reason associated with the action.
+ */
+export interface KickHandleInput {
+    roomId: string;
+    targetHandleId: string;
+    reason?: string;
+}
+/**
+ * Input for `RoomsService.banHandle` method.
+ *
+ * @interface BanHandleInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string} targetHandleId The identifier of the handle intended to be banned.
+ * @property {string} reason Optional reason associated with the action.
+ */
+export interface BanHandleInput {
+    roomId: string;
+    targetHandleId: string;
+    reason?: string;
+}
+/**
+ * Input for `RoomsService.unbanHandle` method.
+ *
+ * @interface UnbanHandleInput
+ * @property {string} roomId The identifier associated with the room.
+ * @property {string} targetHandleId The identifier of the handle intended to be unbanned.
+ * @property {string} reason Optional reason associated with the action.
+ */
+export interface UnbanHandleInput {
+    roomId: string;
+    targetHandleId: string;
+    reason?: string;
+}
+/**
+ * Core entity representation of a room service used in business logic. Used to perform CRUD operations for rooms.
+ *
+ * @interface RoomsService
+ */
+export interface RoomsService {
+    /**
+     * Create a room.
+     *
+     * @param {CreateChannelInput} input Parameters used to create a room.
+     * @returns {RoomEntity} The room that was created.
+     */
+    create(input: CreateRoomInput): Promise<RoomEntity>;
+    /**
+     * Retrieve a room.
+     *
+     * @param {string} roomId The identifier used to retrieve the desired room.
+     * @returns {RoomEntity | undefined} The retrieved room, or undefined if not found.
+     */
+    get(roomId: string): Promise<RoomEntity | undefined>;
+    /**
+     * Update a room.
+     *
+     * @param {UpdateRoomInput} input Parameters used to update a room.
+     * @returns {RoomEntity} The room that was updated.
+     */
+    update(input: UpdateRoomInput): Promise<RoomEntity>;
+    /**
+     * Retrieve a list of rooms.
+     *
+     * @param {string[]} roomIds A list of identifers used to retrieve the desired rooms.
+     * @returns {RoomEntity[]} A list of rooms matching the supplied identifiers, less
+     *  any identifiers that did not correspond to a room.
+     */
+    list(roomIds: string[]): Promise<RoomEntity[]>;
+    /**
+     * Retrieve a list of all members for a room.
+     *
+     * @param {string} roomId The identifier associated with the room to query.
+     * @returns {RoomMemberEntity[]} The list of room members in the room.
+     */
+    getMembers(roomId: string): Promise<RoomMemberEntity[]>;
+    /**
+     * Add a handle to a room.
+     *
+     * @param {string} roomId The identifier of the desired room to add the handle to.
+     */
+    join(roomId: string): Promise<void>;
+    /**
+     * Remove a handle from a room.
+     *
+     * @param {string} roomId The identifier of the desired room to remove the handle from.
+     */
+    leave(roomId: string): Promise<void>;
+    /**
+     * Invite handles to join a room.
+     *
+     * @param {SendInvitationsInput} input Parameters used to invite handles to join a room.
+     */
+    sendInvitations(input: SendInvitationsInput): Promise<void>;
+    /**
+     * Knock a room.
+     *
+     * @param {KnockRoomInput} input Parameters used to knock a room.
+     */
+    knockRoom(input: KnockRoomInput): Promise<void>;
+    /**
+     * Retrieve a list of all rooms the handle has an active invitation for.
+     *
+     * @returns {RoomEntity[]} The list of rooms that have an active invitation for
+     *  the handle.
+     */
+    listInvitedRooms(): Promise<RoomEntity[]>;
+    /**
+     * Retrieve a list of all identifiers of rooms the handle has joined.
+     *
+     * @returns {string[]} The list of identifiers of rooms that the handle has joined.
+     */
+    listJoinedRoomIds(): Promise<string[]>;
+    /**
+     * Retrieve a list of rooms that the handle has requested to join.
+     *
+     * @returns {RoomEntity[]} The list of rooms that the handle has requested to join.
+     */
+    listKnockedRooms(): Promise<RoomEntity[]>;
+    /**
+     * Retrieve a list of invitation requests to join a room (knock).
+     *
+     * @returns {ChannelInvitationRequestEntity[]} The list of invitations that the handle has sent.
+     */
+    listKnockRequests(roomId: string): Promise<ChannelInvitationRequestEntity[]>;
+    /**
+     * Retrieve the membership state for a specific member of a room.
+     *
+     * @param {GetMembershipStateInput} input Parameters used to retrieve the membership state for a specific member of a room.
+     * @returns {MembershipStateEntity | undefined} The membership state for the user in the room, or undefined if not found.
+     */
+    getMembershipState(input: GetMembershipStateInput): Promise<MembershipStateEntity | undefined>;
+    /**
+     * Updates the power level for a specific member of a room.
+     *
+     * @param {UpdateRoomMemberPowerLevelInput} input Parameters used to update the power level for
+     *  a specific member of a room.
+     */
+    updateRoomMemberPowerLevel(input: UpdateRoomMemberPowerLevelInput): Promise<void>;
+    /**
+     * Kick a handle from a room.
+     *
+     * @param {KickHandleInput} input Parameters used to kick a handle from a room.
+     */
+    kickHandle(input: KickHandleInput): Promise<void>;
+    /**
+     * Ban a handle from a room.
+     *
+     * @param {BanHandleInput} input Parameters used to ban a handle from a room.
+     */
+    banHandle(input: BanHandleInput): Promise<void>;
+    /**
+     * Unban a handle from a room.
+     *
+     * @param {UnbanHandleInput} input Parameters used to unban a handle from a room.
+     */
+    unbanHandle(input: UnbanHandleInput): Promise<void>;
+}

package/types/private/domain/entities/security/securityService.d.ts

@@ -0,0 +1,99 @@
+import { VerificationRequest } from 'matrix-js-sdk/lib/crypto-api';
+import { HandleId } from '../../../..';
+import { BackupState } from '../../../../public';
+/**
+ * Input for `SecurityService.recover` method.
+ *
+ * @interface RecoverInput
+ * @property {string} backupKey The backup key.
+ */
+export interface RecoverInput {
+    backupKey: string;
+}
+/**
+ * Input for `SecurityService.acceptVerificationRequest` method.
+ *
+ * @interface AcceptVerificationRequestInput
+ * @property {HandleId} senderId The handle ID of the sender.
+ * @property {string} flowId The verification flow ID.
+ */
+export interface AcceptVerificationRequestInput {
+    senderId: HandleId;
+    flowId: string;
+}
+export interface SecurityService {
+    /**
+     * Get the verification state.
+     *
+     * @returns {Promise<boolean>} The verification state.
+     */
+    isVerified(): Promise<boolean>;
+    /**
+     * Register a handler for session verification changed events.
+     *
+     * @param {Function} handler - The handler to be called when a session verification changes.
+     */
+    onSessionVerificationChanged(handler: (state: boolean) => void): void;
+    /**
+     * Get the recovery key backup state.
+     *
+     * @returns {Promise<BackupState>} The backup state.
+     */
+    getBackupState(): Promise<BackupState>;
+    /**
+     * Create a recovery key backup.
+     *
+     * @returns {Promise<string>} The backup key.
+     */
+    createBackup(): Promise<string>;
+    /**
+     * Recover the recovery key backup.
+     *
+     * @param {RecoverInput} input Parameters used to recover the recovery key backup.
+     */
+    recover(input: RecoverInput): Promise<void>;
+    /**
+     * Rotate the recovery key.
+     *
+     * @returns {Promise<string>} The backup key.
+     */
+    rotateBackupKey(): Promise<string>;
+    /**
+     * Reset the recovery key backup key.
+     *
+     * @returns {Promise<string>} The backup key.
+     */
+    resetBackupKey(): Promise<string>;
+    /**
+     * Register a handler for verification request received events.
+     *
+     * @param {Function} handler - The handler to be called when a verification request is received.
+     */
+    onVerificationRequestReceived(handler: (verificationRequest: VerificationRequest) => void): void;
+    /**
+     * Request verification.
+     */
+    requestVerification(): Promise<void>;
+    /**
+     * Accept a verification request.
+     *
+     * @param {AcceptVerificationRequestInput} input Parameters used to accept a verification request.
+     */
+    acceptVerificationRequest(input: AcceptVerificationRequestInput): Promise<void>;
+    /**
+     * Start verification.
+     */
+    startVerification(): Promise<void>;
+    /**
+     * Approve verification.
+     */
+    approveVerification(): Promise<void>;
+    /**
+     * Decline verification.
+     */
+    declineVerification(): Promise<void>;
+    /**
+     * Cancel verification.
+     */
+    cancelVerification(): Promise<void>;
+}

package/types/private/domain/entities/session/secureCommsSessionEntity.d.ts

@@ -0,0 +1,24 @@
+import { OwnerEntity } from '../common/ownerEntity';
+/**
+ * Core entity representation of a Secure Comms session business rule.
+ *
+ * @interface SecureCommsSessionEntity
+ * @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 {OwnerEntity[]} owners List of identifers 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 SecureCommsSessionEntity {
+    handleId: string;
+    handleName: string;
+    deviceId: string;
+    owner: string;
+    owners: OwnerEntity[];
+    token: string;
+    createdAt: Date;
+    expiresAt: Date;
+}

package/types/private/domain/entities/session/sessionService.d.ts

@@ -0,0 +1,44 @@
+import { SecureCommsSessionEntity } from './secureCommsSessionEntity';
+/**
+ * Input for `SessionService.create` method.
+ *
+ * @interface CreateSessionInput
+ * @property {string} name Name of the Secure Comms handle.
+ * @property {string} deviceId Identifier of the device that initiated this session.
+ */
+export interface CreateSessionInput {
+    name: string;
+    deviceId: string;
+}
+/**
+ * Input for `SessionService.get` method.
+ *
+ * @interface GetSessionInput
+ * @property {string} handleId Identifier of the Secure Comms handle.
+ * @property {string} deviceId Identifier of the device that initiated this session.
+ */
+export interface GetSessionInput {
+    handleId: string;
+    deviceId: string;
+}
+/**
+ * Core entity representation of a session service used in business logic. Used to perform CRUD operations for sessions.
+ *
+ * @interface SessionService
+ */
+export interface SessionService {
+    /**
+     * Create a session.
+     *
+     * @param {CreateSessionInput} input Parameters used to create a session.
+     * @returns {SecureCommsSessionEntity} The session that was created.
+     */
+    create(input: CreateSessionInput): Promise<SecureCommsSessionEntity>;
+    /**
+     * Retrieve a session.
+     *
+     * @param {GetSessionInput} input Parameters used to retrieve session information.
+     * @returns {SecureCommsSessionEntity} The retrieved session.
+     */
+    get(input: GetSessionInput): Promise<SecureCommsSessionEntity>;
+}

package/types/private/domain/entities/wordValidation/wordValidationService.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Core entity representation of a word validation service used in business logic.
+ *
+ * @interface WordValidationService
+ */
+export interface WordValidationService {
+    /**
+     * Checks for the validity of a word used as a handle or channel name, keyword or tag.
+     *
+     * @param {Set<string>} words A set of words to check for validity.
+     * @returns {Set<string>} An set of valid words based on the input.
+     */
+    checkWordValidity(words: Set<string>): Promise<Set<string>>;
+}

package/types/private/domain/use-cases/channels/acceptInvitationUseCase.d.ts

@@ -0,0 +1,22 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `AcceptInvitationUseCase`.
+ *
+ * @interface AcceptInvitationUseCaseInput
+ */
+interface AcceptInvitationUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for accepting an invitation to join a channel.
+ */
+export declare class AcceptInvitationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: AcceptInvitationUseCaseInput): Promise<void>;
+    private acceptInvitation;
+}
+export {};

package/types/private/domain/use-cases/channels/banHandleUseCase.d.ts

@@ -0,0 +1,24 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `BanHandleUseCase`.
+ *
+ * @interface BanHandleUseCaseInput
+ */
+interface BanHandleUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+    targetHandleId: HandleId;
+    reason?: string;
+}
+/**
+ * Application business logic for banning a handle from a channel.
+ */
+export declare class BanHandleUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: BanHandleUseCaseInput): Promise<void>;
+    private banHandle;
+}
+export {};

package/types/private/domain/use-cases/channels/createChannelUseCase.d.ts

@@ -0,0 +1,30 @@
+import { HandleId } from '../../../../public';
+import { ChannelEntity, ChannelJoinRuleEntity, ChannelPermissionsInputEntity, ChannelRoleEntity } from '../../entities/channels/channelEntity';
+import { ChannelsService } from '../../entities/channels/channelsService';
+import { WordValidationService } from '../../entities/wordValidation/wordValidationService';
+/**
+ * Input for `CreateChannelUseCase`.
+ *
+ * @interface CreateChannelUseCaseInput
+ */
+interface CreateChannelUseCaseInput {
+    handleId: HandleId;
+    name?: string;
+    description?: string;
+    joinRule: ChannelJoinRuleEntity;
+    tags: string[];
+    invitedHandleIds: HandleId[];
+    permissions: ChannelPermissionsInputEntity;
+    defaultMemberRole: ChannelRoleEntity;
+}
+/**
+ * Application business logic for creating a channel.
+ */
+export declare class CreateChannelUseCase {
+    private readonly channelsService;
+    private readonly wordValidationService;
+    private readonly log;
+    constructor(channelsService: ChannelsService, wordValidationService: WordValidationService);
+    execute(input: CreateChannelUseCaseInput): Promise<ChannelEntity>;
+}
+export {};

package/types/private/domain/use-cases/channels/declineInvitationUseCase.d.ts

@@ -0,0 +1,22 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+/**
+ * Input for `DeclineInvitationUseCase`.
+ *
+ * @interface DeclineInvitationUseCaseInput
+ */
+interface DeclineInvitationUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for declining an invitation to join a channel.
+ */
+export declare class DeclineInvitationUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: DeclineInvitationUseCaseInput): Promise<void>;
+    private declineInvitation;
+}
+export {};

package/types/private/domain/use-cases/channels/deleteChannelUseCase.d.ts

@@ -0,0 +1,21 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { ChannelsService } from '../../entities/channels/channelsService';
+/**
+ * Input for `DeleteChannelUseCase`.
+ *
+ * @interface DeleteChannelUseCaseInput
+ */
+interface DeleteChannelUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for deleting a channel.
+ */
+export declare class DeleteChannelUseCase {
+    private readonly channelsService;
+    private readonly log;
+    constructor(channelsService: ChannelsService);
+    execute(input: DeleteChannelUseCaseInput): Promise<void>;
+}
+export {};

package/types/private/domain/use-cases/channels/getChannelMembersUseCase.d.ts

@@ -0,0 +1,23 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { ChannelMemberEntity } from '../../entities/common/memberEntity';
+/**
+ * Input for `GetChannelMembersUseCase`.
+ *
+ * @interface GetChannelMembersUseCaseInput
+ */
+interface GetChannelMembersUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for retrieving a list of channel members in a channel.
+ */
+export declare class GetChannelMembersUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetChannelMembersUseCaseInput): Promise<ChannelMemberEntity[]>;
+    private getChannelMembers;
+}
+export {};

package/types/private/domain/use-cases/channels/getChannelMembershipUseCase.d.ts

@@ -0,0 +1,23 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { MembershipStateEntity } from '../../entities/common/memberEntity';
+/**
+ * Input for `GetChannelMembershipUseCase`.
+ *
+ * @interface GetChannelMembershipUseCaseInput
+ */
+interface GetChannelMembershipUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for querying for the channel membership of this handle.
+ */
+export declare class GetChannelMembershipUseCase {
+    private readonly sessionManager;
+    private readonly log;
+    constructor(sessionManager: SessionManager);
+    execute(input: GetChannelMembershipUseCaseInput): Promise<MembershipStateEntity | undefined>;
+    private getChannelMembership;
+}
+export {};

package/types/private/domain/use-cases/channels/getChannelUseCase.d.ts

@@ -0,0 +1,25 @@
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { ChannelEntity } from '../../entities/channels/channelEntity';
+import { ChannelsService } from '../../entities/channels/channelsService';
+/**
+ * Input for `GetChannelUseCase`.
+ *
+ * @interface GetChannelUseCaseInput
+ */
+interface GetChannelUseCaseInput {
+    handleId: HandleId;
+    channelId: ChannelId;
+}
+/**
+ * Application business logic for retrieving a channel.
+ */
+export declare class GetChannelUseCase {
+    private readonly channelsService;
+    private readonly sessionManager;
+    private readonly log;
+    constructor(channelsService: ChannelsService, sessionManager: SessionManager);
+    execute(input: GetChannelUseCaseInput): Promise<ChannelEntity | undefined>;
+    private getRoom;
+}
+export {};

package/types/private/domain/use-cases/channels/getChannelsUseCase.d.ts

@@ -0,0 +1,27 @@
+import { Logger } from '@sudoplatform/sudo-common';
+import { ChannelId, HandleId } from '../../../../public';
+import { SessionManager } from '../../../data/session/sessionManager';
+import { ChannelEntity } from '../../entities/channels/channelEntity';
+import { ChannelsService, ListChannelsOutput } from '../../entities/channels/channelsService';
+/**
+ * Input for `GetChannelsUseCase`.
+ *
+ * @interface GetChannelsUseCaseInput
+ */
+interface ListChannelsUseCaseInput {
+    handleId: HandleId;
+    channelIds: ChannelId[];
+}
+/**
+ * Application business logic for retrieving a list of channels.
+ */
+export declare class GetChannelsUseCase {
+    private readonly channelsService;
+    private readonly sessionManager;
+    private readonly log;
+    constructor(channelsService: ChannelsService, sessionManager: SessionManager);
+    execute(input: ListChannelsUseCaseInput): Promise<ChannelEntity[]>;
+    private getRooms;
+}
+export declare function processChannelsResult(result: ListChannelsOutput, channelsService: ChannelsService, log: Logger): Promise<ChannelEntity[]>;
+export {};