@sudoplatform/sudo-secure-communications 0.0.1 → 5.0.1

package/types/private/data/messaging/matrixMessagingService.d.ts

@@ -0,0 +1,36 @@
+import { ChatSummaryEntity } from '../../domain/entities/messaging/chatSummaryEntity';
+import { MessageEntity } from '../../domain/entities/messaging/messageEntity';
+import { CreatePollInput, DeleteMessageInput, EditMessageInput, EditPollInput, EndPollInput, GetChatSummariesInput, GetMessageInput, GetPinnedMessagesInput, GetPollResponsesInput, ListMessagesInput, ListMessagesOutput, MarkAsReadInput, MessagingService, PinUnpinMessageInput, SearchMessagesInput, SearchMessagesOutput, SendMediaInput, SendMessageInput, SendPollResponseInput, SendReplyMessageInput, SendThreadMessageInput, SendTypingNotificationInput, ToggleReactionInput } from '../../domain/entities/messaging/messagingService';
+import { PollResponsesEntity } from '../../domain/entities/messaging/pollEntity';
+import { MatrixClientManager } from '../common/matrixClientManager';
+import { MatrixMediaService } from '../media/matrixMediaService';
+export declare class MatrixMessagingService implements MessagingService {
+    private readonly matrixClient;
+    private readonly matrixMediaService?;
+    constructor(matrixClient: MatrixClientManager, matrixMediaService?: MatrixMediaService | undefined);
+    sendMessage(input: SendMessageInput): Promise<void>;
+    sendThread(input: SendThreadMessageInput): Promise<void>;
+    sendReply(input: SendReplyMessageInput): Promise<void>;
+    sendMedia(input: SendMediaInput): Promise<void>;
+    get(input: GetMessageInput): Promise<MessageEntity | undefined>;
+    edit(input: EditMessageInput): Promise<void>;
+    delete(input: DeleteMessageInput): Promise<void>;
+    list(input: ListMessagesInput): Promise<ListMessagesOutput>;
+    searchMessages(input: SearchMessagesInput): Promise<SearchMessagesOutput>;
+    getChatSummaries(input: GetChatSummariesInput): Promise<ChatSummaryEntity[]>;
+    markAsRead(input: MarkAsReadInput): Promise<void>;
+    sendTypingNotification(input: SendTypingNotificationInput): Promise<void>;
+    toggleReaction(input: ToggleReactionInput): Promise<void>;
+    pinUnpinMessage(input: PinUnpinMessageInput): Promise<void>;
+    getPinnedMessages(input: GetPinnedMessagesInput): Promise<MessageEntity[]>;
+    private buildMessageContent;
+    private generateThumbnail;
+    private handleEncryptedFile;
+    private handleUnencryptedFile;
+    private handleRedactReason;
+    createPoll(input: CreatePollInput): Promise<void>;
+    sendPollResponse(input: SendPollResponseInput): Promise<void>;
+    editPoll(input: EditPollInput): Promise<void>;
+    endPoll(input: EndPollInput): Promise<void>;
+    getPollResponses(input: GetPollResponsesInput): Promise<PollResponsesEntity>;
+}

package/types/private/data/messaging/transformer/chatSummaryTransformer.d.ts

@@ -0,0 +1,6 @@
+import { ChatSummary } from '../../../../public';
+import { ChatSummaryEntity } from '../../../domain/entities/messaging/chatSummaryEntity';
+export declare class ChatSummaryTransformer {
+    fromAPIToEntity(data: ChatSummary): ChatSummaryEntity;
+    fromEntityToAPI(entity: ChatSummaryEntity): ChatSummary;
+}

package/types/private/data/messaging/transformer/messageMentionTransformer.d.ts

@@ -0,0 +1,5 @@
+import { MessageMention } from '../../../../public';
+import { MessageMentionEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class MessageMentionTransformer {
+    fromAPIToEntity(data: MessageMention): MessageMentionEntity;
+}

package/types/private/data/messaging/transformer/messageReactionTransformer.d.ts

@@ -0,0 +1,6 @@
+import { MessageReaction } from '../../../../public';
+import { MessageReactionEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class MessageReactionTransformer {
+    fromAPIToEntity(data: MessageReaction): MessageReactionEntity;
+    fromEntityToAPI(entity: MessageReactionEntity): MessageReaction;
+}

package/types/private/data/messaging/transformer/messageReceiptTransformer.d.ts

@@ -0,0 +1,8 @@
+import { CachedReceipt } from 'matrix-js-sdk';
+import { MessageReceipt } from '../../../../public';
+import { MessageReceiptEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class MessageReceiptTransformer {
+    fromAPIToEntity(data: MessageReceipt): MessageReceiptEntity;
+    fromEntityToAPI(entity: MessageReceiptEntity): MessageReceipt;
+    fromMatrixToEntity(receipt: CachedReceipt): MessageReceiptEntity;
+}

package/types/private/data/messaging/transformer/messageStateTransformer.d.ts

@@ -0,0 +1,6 @@
+import { MessageState } from '../../../../public';
+import { MessageStateEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class MessageStateTransformer {
+    fromAPIToEntity(data: MessageState): MessageStateEntity;
+    fromEntityToAPI(entity: MessageStateEntity): MessageState;
+}

package/types/private/data/messaging/transformer/messageTransformer.d.ts

@@ -0,0 +1,15 @@
+import { MatrixEvent } from 'matrix-js-sdk/lib/matrix';
+import { Message } from '../../../../public';
+import { MessageEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class MessageTransformer {
+    fromAPIToEntity(data: Message): MessageEntity;
+    fromEntityToAPI(entity: MessageEntity): Message;
+    fromMatrixToEntity(userId: string, event: MatrixEvent): MessageEntity | undefined;
+    private messageContentFromMemberEvent;
+    private messageContentFromPollEvent;
+    private messageContentFromMessageEvent;
+    private getImageContent;
+    private getFileContent;
+    private getAudioContent;
+    private getVideoContent;
+}

package/types/private/data/messaging/transformer/pollResponsesTransformer.d.ts

@@ -0,0 +1,6 @@
+import { PollResponses } from '../../../../public/typings/poll';
+import { PollResponsesEntity } from '../../../domain/entities/messaging/pollEntity';
+export declare class PollResponsesTransformer {
+    fromAPIToEntity(data: PollResponses): PollResponsesEntity;
+    fromEntityToAPI(entity: PollResponsesEntity): PollResponses;
+}

package/types/private/data/messaging/transformer/pollTypeTransformer.d.ts

@@ -0,0 +1,8 @@
+import { PollKind } from 'matrix-js-sdk/lib/@types/polls';
+import { PollType } from '../../../../public';
+import { PollTypeEntity } from '../../../domain/entities/messaging/pollEntity';
+export declare class PollTypeTransformer {
+    fromAPIToEntity(data: PollType): PollTypeEntity;
+    fromEntityToAPI(entity: PollTypeEntity): PollType;
+    fromEntityToMatrix(entity: PollTypeEntity): PollKind;
+}

package/types/private/data/messaging/transformer/searchMessagesItemTransformer.d.ts

@@ -0,0 +1,7 @@
+import { IEventWithRoomId } from 'matrix-js-sdk/lib/matrix';
+import { SearchMessagesItem } from '../../../../public';
+import { SearchMessagesItemEntity } from '../../../domain/entities/messaging/messageEntity';
+export declare class SearchMessagesItemTransformer {
+    fromEntityToAPI(entity: SearchMessagesItemEntity): SearchMessagesItem;
+    fromMatrixToEntity(event: IEventWithRoomId): SearchMessagesItemEntity;
+}

package/types/private/data/notification/defaultNotificationService.d.ts

@@ -0,0 +1,19 @@
+import { NotificationInfo, NotificationSettings } from '../../../public';
+import { ClearRecipientChatRulesInput, GetDecodedInfoInput, NotificationService, SetDefaultChatRulesInput, SetDefaultEventRulesInput, SetRecipientChatRulesInput } from '../../domain/entities/notification/notificationService';
+import { RoomsService } from '../../domain/entities/rooms/roomsService';
+import { MatrixClientManager } from '../common/matrixClientManager';
+export declare class DefaultNotificationService implements NotificationService {
+    private readonly matrixClient;
+    private readonly roomService;
+    constructor(matrixClient: MatrixClientManager, roomService: RoomsService);
+    getDecodedInfo(input: GetDecodedInfoInput): Promise<NotificationInfo>;
+    private getInviteInfo;
+    private getMessageInfo;
+    getSettings(): Promise<NotificationSettings>;
+    private isInviteForMeEnabled;
+    private setInviteForMeEnabled;
+    setDefaultChatRules(input: SetDefaultChatRulesInput): Promise<void>;
+    setDefaultEventRules(input: SetDefaultEventRulesInput): Promise<void>;
+    setRecipientChatRules(input: SetRecipientChatRulesInput): Promise<void>;
+    clearRecipientChatRules(input: ClearRecipientChatRulesInput): Promise<void>;
+}

package/types/private/data/rooms/matrixRoomsService.d.ts

@@ -0,0 +1,30 @@
+import { ChannelInvitationRequestEntity } from '../../domain/entities/channels/channelInvitationRequestEntity';
+import { MembershipStateEntity, RoomMemberEntity } from '../../domain/entities/common/memberEntity';
+import { RoomEntity } from '../../domain/entities/rooms/roomEntity';
+import { BanHandleInput, CreateRoomInput, GetMembershipStateInput, KickHandleInput, KnockRoomInput, RoomsService, SendInvitationsInput, UnbanHandleInput, UpdateRoomInput, UpdateRoomMemberPowerLevelInput } from '../../domain/entities/rooms/roomsService';
+import { MatrixClientManager } from '../common/matrixClientManager';
+import { MatrixMediaService } from '../media/matrixMediaService';
+export declare class MatrixRoomsService implements RoomsService {
+    private readonly matrixClient;
+    private readonly matrixMediaService?;
+    private readonly membershipStateTransformer;
+    constructor(matrixClient: MatrixClientManager, matrixMediaService?: MatrixMediaService | undefined);
+    create(input: CreateRoomInput): Promise<RoomEntity>;
+    get(roomId: string): Promise<RoomEntity | undefined>;
+    update(input: UpdateRoomInput): Promise<RoomEntity>;
+    list(roomIds: string[]): Promise<RoomEntity[]>;
+    getMembers(roomId: string): Promise<RoomMemberEntity[]>;
+    join(roomId: string): Promise<void>;
+    leave(roomId: string): Promise<void>;
+    sendInvitations(input: SendInvitationsInput): Promise<void>;
+    knockRoom(input: KnockRoomInput): Promise<void>;
+    listInvitedRooms(): Promise<RoomEntity[]>;
+    listJoinedRoomIds(): Promise<string[]>;
+    listKnockedRooms(): Promise<RoomEntity[]>;
+    listKnockRequests(roomId: string): Promise<ChannelInvitationRequestEntity[]>;
+    getMembershipState(input: GetMembershipStateInput): Promise<MembershipStateEntity | undefined>;
+    updateRoomMemberPowerLevel(input: UpdateRoomMemberPowerLevelInput): Promise<void>;
+    kickHandle(input: KickHandleInput): Promise<void>;
+    banHandle(input: BanHandleInput): Promise<void>;
+    unbanHandle(input: UnbanHandleInput): Promise<void>;
+}

package/types/private/data/rooms/transformer/roomPowerLevelsTransformer.d.ts

@@ -0,0 +1,5 @@
+import { PowerLevelsEntity } from '../../../domain/entities/common/powerLevelsEntity';
+import { RoomPowerLevelsEntity } from '../../../domain/entities/rooms/roomPowerLevelsEntity';
+export declare class RoomPowerLevelsTransformer {
+    fromEntityPowerLevelToRoomPowerLevel(powerLevel: PowerLevelsEntity): RoomPowerLevelsEntity;
+}

package/types/private/data/security/matrixSecurityService.d.ts

@@ -0,0 +1,22 @@
+import { VerificationRequest } from 'matrix-js-sdk/lib/crypto-api';
+import { BackupState } from '../../../public';
+import { AcceptVerificationRequestInput, RecoverInput, SecurityService } from '../../domain/entities/security/securityService';
+import { MatrixClientManager } from '../common/matrixClientManager';
+export declare class MatrixSecurityService implements SecurityService {
+    private readonly matrixClient;
+    constructor(matrixClient: MatrixClientManager);
+    isVerified(): Promise<boolean>;
+    onSessionVerificationChanged(handler: (state: boolean) => void): void;
+    getBackupState(): Promise<BackupState>;
+    createBackup(): Promise<string>;
+    recover(input: RecoverInput): Promise<void>;
+    rotateBackupKey(): Promise<string>;
+    resetBackupKey(): Promise<string>;
+    onVerificationRequestReceived(handler: (verificationRequest: VerificationRequest) => void): void;
+    requestVerification(): Promise<void>;
+    acceptVerificationRequest(input: AcceptVerificationRequestInput): Promise<void>;
+    startVerification(): Promise<void>;
+    approveVerification(): Promise<void>;
+    declineVerification(): Promise<void>;
+    cancelVerification(): Promise<void>;
+}

package/types/private/data/session/defaultSessionService.d.ts

@@ -0,0 +1,10 @@
+import { SecureCommsSessionEntity } from '../../domain/entities/session/secureCommsSessionEntity';
+import { CreateSessionInput, GetSessionInput, SessionService } from '../../domain/entities/session/sessionService';
+import { ApiClient } from '../common/apiClient';
+export declare class DefaultSessionService implements SessionService {
+    private readonly appSync;
+    private readonly sessionTransformer;
+    constructor(appSync: ApiClient);
+    create(input: CreateSessionInput): Promise<SecureCommsSessionEntity>;
+    get(input: GetSessionInput): Promise<SecureCommsSessionEntity>;
+}

package/types/private/data/session/sessionManager.d.ts

@@ -0,0 +1,15 @@
+import { HandleId, StorageModule } from '../../../public';
+import { SessionService } from '../../domain/entities/session/sessionService';
+import { MatrixClientManager } from '../common/matrixClientManager';
+export declare class SessionManager {
+    private readonly sessionService;
+    private readonly storageModule;
+    private readonly log;
+    private readonly sessions;
+    constructor(sessionService: SessionService, storageModule: StorageModule);
+    deleteSession(handleId: HandleId, deleteStorage?: boolean): Promise<void>;
+    reset(): Promise<void>;
+    getMatrixClient(handleId: HandleId): Promise<MatrixClientManager>;
+    ensureValidSession(handleId: HandleId, storePassphrase?: string): Promise<string>;
+    private createMatrixClient;
+}

package/types/private/data/session/transformer/sessionTransformer.d.ts

@@ -0,0 +1,7 @@
+import { SecureCommsSession as SecureCommsSessionGraphQL } from '../../../../gen/graphqlTypes';
+import { SecureCommsSession } from '../../../../public';
+import { SecureCommsSessionEntity } from '../../../domain/entities/session/secureCommsSessionEntity';
+export declare class SessionTransformer {
+    fromEntityToAPI(entity: SecureCommsSessionEntity): SecureCommsSession;
+    fromGraphQLToEntity(data: SecureCommsSessionGraphQL): SecureCommsSessionEntity;
+}

package/types/private/data/storage/handleStorage.d.ts

@@ -0,0 +1,11 @@
+import { IStore } from 'matrix-js-sdk/lib/store';
+import { HandleStorage, StorageProvider } from '../../../public';
+import { SecureCommsStore } from '../../../public';
+export declare class DefaultHandleStorage implements HandleStorage {
+    private readonly log;
+    private readonly storageProvider;
+    private readonly _secureCommsStore;
+    constructor(storageProvider: StorageProvider);
+    get matrixStore(): IStore;
+    get secureCommsStore(): SecureCommsStore;
+}

package/types/private/data/storage/indexeddb/indexeddbStorageProvider.d.ts

@@ -0,0 +1,20 @@
+import { IndexedDBStore } from 'matrix-js-sdk/lib/matrix';
+import { StorageProvider } from '../../../../public';
+export declare class IndexedDBStorageProvider implements StorageProvider {
+    private readonly log;
+    private readonly dbName;
+    private readonly _matrixStore;
+    private db?;
+    private static readonly migrations;
+    constructor(handleId: string);
+    get matrixStore(): IndexedDBStore;
+    openDB(): Promise<void>;
+    closeDB(): Promise<void>;
+    destroyDB(): Promise<void>;
+    private ensureDbOpen;
+    createItem(store: string, key: string, value: any): Promise<void>;
+    getItem<T>(store: string, key: string): Promise<T | undefined>;
+    getItems<T>(store: string, key: string, limit?: number, offset?: number): Promise<T[]>;
+    updateItem(store: string, key: string, value: any): Promise<void>;
+    deleteItem(store: string, key: string): Promise<void>;
+}

package/types/private/data/storage/secureCommsStore.d.ts

@@ -0,0 +1,34 @@
+import { StorageProvider } from '../../../public';
+import { SecureCommsStore } from '../../../public';
+/**
+ * SessionAPIs is a collection of APIs for session storage.
+ *
+ * @interface SessionAPIs - used by secure comms SDK
+ * @property {getAccessToken} getAccessToken - get the access token
+ * @property {saveAccessToken} saveAccessToken - save the access token
+ * @property {deleteAccessToken} deleteAccessToken - delete the access token
+ */
+export interface SessionAPIs {
+    /**
+     * Get the access token
+     * @returns {Promise<string | undefined>} - the access token
+     */
+    getAccessToken(): Promise<string | undefined>;
+    /**
+     * Save the access token
+     * @param {string} accessToken - the access token
+     */
+    saveAccessToken(accessToken: string): Promise<void>;
+    /**
+     * Delete the access token
+     */
+    deleteAccessToken(): Promise<void>;
+}
+export declare class DefaultSecureCommsStore implements SecureCommsStore {
+    private readonly log;
+    private readonly storageProvider;
+    constructor(storageProvider: StorageProvider);
+    closeStorage(): Promise<void>;
+    destroyStorage(): Promise<void>;
+    sessionAPIs: SessionAPIs;
+}

package/types/private/data/wordValidation/defaultWordValidationService.d.ts

@@ -0,0 +1,7 @@
+import { WordValidationService } from '../../domain/entities/wordValidation/wordValidationService';
+import { ApiClient } from '../common/apiClient';
+export declare class DefaultWordValidationService implements WordValidationService {
+    private readonly appSync;
+    constructor(appSync: ApiClient);
+    checkWordValidity(words: Set<string>): Promise<Set<string>>;
+}

package/types/private/domain/entities/channels/channelEntity.d.ts

@@ -0,0 +1,192 @@
+import { ChannelId } from '../../../../public';
+/**
+ * Core entity representation of a channel business rule.
+ *
+ * @interface ChannelEntity
+ * @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 {ChannelJoinRuleEntity} joinRule Optional rule for joining and whether the channel is searchable, if known.
+ * @property {string[]} tags A list of words to help searchability.
+ * @property {ChannelPermissionsEntity} 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 {ChannelRoleEntity} 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 ChannelEntity {
+    channelId: ChannelId;
+    name?: string;
+    description?: string;
+    avatarUrl?: string;
+    joinRule?: ChannelJoinRuleEntity;
+    tags: string[];
+    permissions?: ChannelPermissionsEntity;
+    defaultMemberRole?: ChannelRoleEntity;
+    memberCount: number;
+    createdAt: Date;
+    updatedAt: Date;
+}
+/**
+ * Core entity representation of a public channel search result business rule.
+ *
+ * @interface PublicChannelSearchResultEntity
+ * @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 {PublicChannelJoinRuleEntity} 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 PublicChannelSearchResultEntity {
+    channelId: ChannelId;
+    name: string;
+    description?: string;
+    avatarUrl?: string;
+    joinRule: PublicChannelJoinRuleEntity;
+    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 ChannelJoinRuleEntity {
+    PRIVATE = "PRIVATE",
+    PUBLIC = "PUBLIC",
+    PUBLIC_WITH_INVITE = "PUBLIC_WITH_INVITE"
+}
+/**
+ * Utility to check if a channel is searchable.
+ */
+export declare function isChannelVisible(joinRule: ChannelJoinRuleEntity): boolean;
+/**
+ * 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 PublicChannelJoinRuleEntity {
+    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 ChannelRoleEntity {
+    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 ChannelRoleEntity} for handles to be able to execute.
+ */
+export declare class ChannelPermissionsEntity {
+    sendMessages: ChannelRoleEntity;
+    inviteHandles: ChannelRoleEntity;
+    kickHandles: ChannelRoleEntity;
+    banHandles: ChannelRoleEntity;
+    changeChannelName: ChannelRoleEntity;
+    changeChannelDescription: ChannelRoleEntity;
+    changeChannelAvatar: ChannelRoleEntity;
+    deleteOthersMessages: ChannelRoleEntity;
+    /**
+     * Constructs a new instance of channel permissions with role-based access control.
+     *
+     * @interface ChannelPermissionsEntity
+     * @property {ChannelRoleEntity} sendMessages What role can send messages in the chat.
+     * @property {ChannelRoleEntity} inviteHandles What role can invite other handles.
+     * @property {ChannelRoleEntity} kickHandles What role can kick other handles.
+     * @property {ChannelRoleEntity} banHandles What role can ban other handles.
+     * @property {ChannelRoleEntity} changeChannelName What role can change the channel's name.
+     * @property {ChannelRoleEntity} changeChannelDescription What role can change the channel's description.
+     * @property {ChannelRoleEntity} changeChannelAvatar What role can change the channel's avatar.
+     * @property {ChannelRoleEntity} deleteOthersMessages What role can delete anyone's messages.
+     */
+    constructor(sendMessages: ChannelRoleEntity, inviteHandles: ChannelRoleEntity, kickHandles: ChannelRoleEntity, banHandles: ChannelRoleEntity, changeChannelName: ChannelRoleEntity, changeChannelDescription: ChannelRoleEntity, changeChannelAvatar: ChannelRoleEntity, deleteOthersMessages: ChannelRoleEntity);
+    /**
+     * Default required roles necessary to perform each action for new channels if not overridden
+     * with {@link ChannelPermissionsInputEntity}.
+     */
+    static default: ChannelPermissionsEntity;
+}
+/**
+ * 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 ChannelPermissionsInputEntity
+ */
+export interface ChannelPermissionsInputEntity {
+    sendMessages?: ChannelRoleEntity;
+    inviteHandles?: ChannelRoleEntity;
+    kickHandles?: ChannelRoleEntity;
+    banHandles?: ChannelRoleEntity;
+    changeChannelName?: ChannelRoleEntity;
+    changeChannelDescription?: ChannelRoleEntity;
+    changeChannelAvatar?: ChannelRoleEntity;
+    deleteOthersMessages?: ChannelRoleEntity;
+}
+/**
+ * Representation of the fields and direction to sort channels.
+ *
+ * @interface ChannelSortOrderEntity
+ * @property {ChannelSortFieldEntity} field The field names that search order can be applied to.
+ * @property {ChannelSortDirectionEntity} direction The direction of the sorting on the field attribute.
+ */
+export interface ChannelSortOrderEntity {
+    field: ChannelSortFieldEntity;
+    direction: ChannelSortDirectionEntity;
+}
+/**
+ * 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 ChannelSortFieldEntity {
+    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 ChannelSortDirectionEntity {
+    ASCENDING = "ASCENDING",
+    DESCENDING = "DESCENDING"
+}

package/types/private/domain/entities/channels/channelInvitationRequestEntity.d.ts

@@ -0,0 +1,16 @@
+import { ChannelId, HandleId } from '../../../../public';
+/**
+ * Core entity representation of a channel invitation request business rule.
+ *
+ * @interface ChannelInvitationRequestEntity
+ * @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 ChannelInvitationRequestEntity {
+    channelId: ChannelId;
+    handleId: HandleId;
+    reason?: string;
+    createdAt?: Date;
+}