@sudoplatform/sudo-secure-communications 5.4.0 → 5.5.0

package/types/private/domain/entities/groups/groupEntity.d.ts

@@ -1,4 +1,5 @@
 import { GroupId } from '../../../../public';
+import { HandleEntity } from '../handle/handleEntity';
 /**
  * Core entity representation of a group business rule.
  *
@@ -10,6 +11,7 @@ import { GroupId } from '../../../../public';
  * @property {GroupPermissionsEntity} permissions Optional permissions describing what roles can perform
  *  certain actions within the group.
  * @property {number} memberCount The number of joined members of the group.
+ * @property {HandleEntity} inviter Optional handle of the inviter.
  */
 export interface GroupEntity {
     groupId: GroupId;
@@ -18,6 +20,7 @@ export interface GroupEntity {
     avatarUrl?: string;
     permissions?: GroupPermissionsEntity;
     memberCount: number;
+    inviter?: HandleEntity;
 }
 /**
  * The role of a member within a group, ranked in descending order.

package/types/private/domain/entities/messaging/messagingService.d.ts

@@ -230,6 +230,15 @@ export interface SearchMessagesOutput {
 export interface MarkAsReadInput {
     recipient: Recipient;
 }
+/**
+ * Input for `MessagingService.markAsUnread` method.
+ *
+ * @interface MarkAsUnreadInput
+ * @property {Recipient} recipient The target recipient.
+ */
+export interface MarkAsUnreadInput {
+    recipient: Recipient;
+}
 /**
  * Input for `MessagingService.sendTypingNotification` method.
  *

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

@@ -1,4 +1,5 @@
 import { RoomPowerLevelsEntity } from './roomPowerLevelsEntity';
+import { HandleEntity } from '../handle/handleEntity';
 /**
  * Core entity representation of a room business rule.
  *
@@ -12,6 +13,7 @@ import { RoomPowerLevelsEntity } from './roomPowerLevelsEntity';
  * @property {RoomPowerLevelsEntity} powerLevels Optional power levels indicating what roles can perform
  *  certain actions within the room.
  * @property {number} memberCount The number of joined members of the room.
+ * @property {HandleEntity} inviter Optional handle of the inviter.
  */
 export interface RoomEntity {
     roomId: string;
@@ -22,6 +24,7 @@ export interface RoomEntity {
     avatarUrl?: string;
     powerLevels?: RoomPowerLevelsEntity;
     memberCount: number;
+    inviter?: HandleEntity;
 }
 /**
  * The type of room based on the custom type state event.

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

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

package/types/public/modules/messagingModule.d.ts

@@ -64,6 +64,17 @@ export interface MarkAsReadInput {
     handleId: HandleId;
     recipient: Recipient;
 }
+/**
+ * Properties required to mark the chat with a recipient as unread.
+ *
+ * @interface MarkAsUnreadInput
+ * @property {HandleId} handleId Identifier of the handle owned by this client.
+ * @property {Recipient} recipient The target recipient.
+ */
+export interface MarkAsUnreadInput {
+    handleId: HandleId;
+    recipient: Recipient;
+}
 /**
  * Properties required to send a typing notification.
  *
@@ -432,6 +443,12 @@ export interface MessagingModule {
      * @param {MarkAsReadInput} input Parameters used to mark messages as read.
      */
     markAsRead(input: MarkAsReadInput): Promise<void>;
+    /**
+     * Marks the chat with a recipient as unread.
+     *
+     * @param {MarkAsUnreadInput} input Parameters used to mark messages as unread.
+     */
+    markAsUnread(input: MarkAsUnreadInput): Promise<void>;
     /**
      * Sends a typing notification for this handle.
      *
@@ -553,6 +570,7 @@ export declare class DefaultMessagingModule implements MessagingModule {
     searchMessages(input: SearchMessagesInput): Promise<ListOutput<SearchMessagesItem>>;
     getChatSummaries(input: GetChatSummariesInput): Promise<ChatSummary[]>;
     markAsRead(input: MarkAsReadInput): Promise<void>;
+    markAsUnread(input: MarkAsUnreadInput): Promise<void>;
     sendTypingNotification(input: SendTypingNotificationInput): Promise<void>;
     sendMessage(input: SendMessageInput): Promise<void>;
     editMessage(input: EditMessageInput): Promise<void>;

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

@@ -1,3 +1,4 @@
+import { Handle } from './handle';
 import { ChannelId } from './recipient';
 /**
  * The Sudo Platform SDK representation of a Channel. Model for a wrapper around a messaging channel with
@@ -16,6 +17,7 @@ import { ChannelId } from './recipient';
  * @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.
+ * @property {Handle} inviter Optional handle of the inviter.
  */
 export interface Channel {
     channelId: ChannelId;
@@ -29,6 +31,7 @@ export interface Channel {
     memberCount: number;
     createdAt: Date;
     updatedAt: Date;
+    inviter?: Handle;
 }
 /**
  * The Sudo Platform SDK representation of a Public Channel Search Result.

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

@@ -1,3 +1,4 @@
+import { Handle } from './handle';
 import { GroupId } from './recipient';
 /**
  * The Sudo Platform SDK representation of a Group. Model for a wrapper around a messaging group with
@@ -11,6 +12,7 @@ import { GroupId } from './recipient';
  * @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.
+ * @property {Handle} inviter Optional handle of the inviter.
  */
 export interface Group {
     groupId: GroupId;
@@ -19,6 +21,7 @@ export interface Group {
     avatarUrl?: string;
     permissions?: GroupPermissions;
     memberCount: number;
+    inviter?: Handle;
 }
 /**
  * The role of a member within a group, ranked in descending order.