@wireapp/core 29.0.6 → 29.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [29.1.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@29.0.6...@wireapp/core@29.1.0) (2022-07-28)
+
+
+### Features
+
+* add users to mls conversation (FS-851) ([#4340](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4340)) ([2889385](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/28893855ec9c42d59e1394142e8cf31252f2503a))
+
+
+
+
+
 ## [29.0.6](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@29.0.5...@wireapp/core@29.0.6) (2022-07-27)
 
 **Note:** Version bump only for package @wireapp/core

package/package.json

@@ -7,7 +7,7 @@
     "@otak/core-crypto": "0.3.0-beta-2",
     "@types/long": "4.0.1",
     "@types/node": "~14",
-    "@wireapp/api-client": "19.18.1",
+    "@wireapp/api-client": "19.19.0",
     "@wireapp/commons": "4.3.0",
     "@wireapp/cryptobox": "12.8.0",
     "@wireapp/store-engine-dexie": "1.6.10",
@@ -77,6 +77,6 @@
     "test:node": "nyc jasmine --config=jasmine.json",
     "watch": "tsc ---watch"
   },
-  "version": "29.0.6",
-  "gitHead": "3a5d82cac221738a5652a24756441b28e0b49072"
+  "version": "29.1.0",
+  "gitHead": "801c08df89e3374bc3019a13a91ba173c3f29ef0"
 }

package/src/main/conversation/ConversationService/ConversationService.d.ts

@@ -9,7 +9,7 @@ import type { CryptographyService } from '../../cryptography/';
 import type { ClearConversationMessage, DeleteMessage, HideMessage, OtrMessage } from '../message/OtrMessage';
 import { XOR } from '@wireapp/commons/src/main/util/TypeUtil';
 import type { NotificationService } from '../../notification';
-import { AddUsersParams, MessageSendingCallbacks, MessageSendingOptions, SendMlsMessageParams, SendProteusMessageParams } from './ConversationService.types';
+import { AddUsersParams, MessageSendingCallbacks, MessageSendingOptions, MLSReturnType, SendMlsMessageParams, SendProteusMessageParams } from './ConversationService.types';
 export declare class ConversationService {
     private readonly apiClient;
     private readonly config;
@@ -111,7 +111,7 @@ export declare class ConversationService {
      * @deprecated
      * @returns Promise
      */
-    createConversation(name: string, otherUserIds: string | string[]): Promise<Conversation>;
+    createProteusConversation(name: string, otherUserIds: string | string[]): Promise<Conversation>;
     /**
      * Create a group conversation.
      *
@@ -121,17 +121,13 @@ export declare class ConversationService {
      * @param conversationData Payload object for group creation
      * @returns Resolves when the conversation was created
      */
-    createConversation(conversationData: NewConversation): Promise<Conversation>;
-    private createMLSConversation;
+    createProteusConversation(conversationData: NewConversation): Promise<Conversation>;
     getConversations(conversationId: string): Promise<Conversation>;
     getConversations(conversationIds?: string[]): Promise<Conversation[]>;
     getAsset({ assetId, assetToken, otrKey, sha256 }: RemoteData): Promise<Uint8Array>;
     getUnencryptedAsset(assetId: string, assetToken?: string): Promise<ArrayBuffer>;
-    private addUsersToProteusGroup;
-    private addUsersToMLSGroup;
-    addUsers({ conversationId, protocol, userIds }: AddUsersParams): Promise<void | import("@wireapp/api-client/src/event").ConversationMemberJoinEvent>;
+    addUsersToProteusConversation({ conversationId, qualifiedUserIds }: Omit<AddUsersParams, 'groupId'>): Promise<import("@wireapp/api-client/src/event").ConversationMemberJoinEvent>;
     removeUser(conversationId: string, userId: string): Promise<string>;
-    private sendMlsMessage;
     private sendProteusMessage;
     /**
      * Sends a message to a conversation
@@ -145,4 +141,14 @@ export declare class ConversationService {
     setMemberConversationRole(conversationId: string, userId: string, conversationRole: DefaultConversationRoleName | string): Promise<void>;
     private isClearFromMismatch;
     private generateGenericMessage;
+    /**
+     *   ###############################################
+     *   ################ MLS Functions ################
+     *   ###############################################
+     */
+    private getCoreCryptoKeyPackagesPayload;
+    private addUsersToExistingMLSConversation;
+    createMLSConversation(conversationData: NewConversation): Promise<MLSReturnType>;
+    private sendMLSMessage;
+    addUsersToMLSConversation({ qualifiedUserIds, groupId, conversationId, }: Required<AddUsersParams>): Promise<MLSReturnType>;
 }

package/src/main/conversation/ConversationService/ConversationService.js

@@ -19,7 +19,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationService = void 0;
-const bazinga64_1 = require("bazinga64");
 const conversation_1 = require("@wireapp/api-client/src/conversation");
 const data_1 = require("@wireapp/api-client/src/conversation/data");
 const protocol_messaging_1 = require("@wireapp/protocol-messaging");
@@ -30,6 +29,7 @@ const MessageBuilder_1 = require("../message/MessageBuilder");
 const MessageService_1 = require("../message/MessageService");
 const MessageToProtoMapper_1 = require("../message/MessageToProtoMapper");
 const ConversationService_types_1 = require("./ConversationService.types");
+const bazinga64_1 = require("bazinga64");
 class ConversationService {
     constructor(apiClient, cryptographyService, config, coreCryptoClientProvider, notificationService) {
         this.apiClient = apiClient;
@@ -609,7 +609,7 @@ class ConversationService {
         }
         return Promise.all(conversationIds.map(conversationId => this.leaveConversation(conversationId)));
     }
-    createConversation(conversationData, otherUserIds) {
+    createProteusConversation(conversationData, otherUserIds) {
         let payload;
         if (typeof conversationData === 'string') {
             const ids = typeof otherUserIds === 'string' ? [otherUserIds] : otherUserIds;
@@ -622,66 +622,8 @@ class ConversationService {
         else {
             payload = conversationData;
         }
-        if (typeof conversationData !== 'string' && conversationData.protocol === conversation_1.ConversationProtocol.MLS) {
-            return this.createMLSConversation(conversationData);
-        }
         return this.apiClient.api.conversation.postConversation(payload);
     }
-    async createMLSConversation(conversationData) {
-        /**
-         * @note For creating MLS conversations the users & qualified_users
-         * field must be empty as backend is not aware which users
-         * are in a MLS conversation because of the MLS architecture.
-         */
-        const newConversation = await this.apiClient.api.conversation.postConversation(Object.assign(Object.assign({}, conversationData), { users: undefined, qualified_users: undefined }));
-        const { group_id: groupId } = newConversation;
-        const groupIdDecodedFromBase64 = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
-        const { qualified_users: qualifiedUsers = [], selfUserId } = conversationData;
-        if (!selfUserId) {
-            throw new Error('You need to pass self user qualified id in order to create an MLS conversation');
-        }
-        /**
-         * @note We need to fetch key packages for all the users
-         * we want to add to the new MLS conversations,
-         * includes self user too.
-         */
-        const keyPackages = await Promise.all([
-            this.apiClient.api.client.claimMLSKeyPackages(selfUserId.id, selfUserId.domain, 
-            /**
-             * we should skip fetching key packages for current self client,
-             * it's already added by the backend on the group creation time
-             */
-            conversationData.creator_client),
-            ...qualifiedUsers.map(qualifiedId => this.apiClient.api.client.claimMLSKeyPackages(qualifiedId.id, qualifiedId.domain)),
-        ]);
-        const coreCryptoClient = this.coreCryptoClientProvider();
-        const coreCryptoKeyPackagesPayload = keyPackages.reduce((previousValue, currentValue) => {
-            // skip users that have not uploaded their MLS key packages
-            if (currentValue.key_packages.length > 0) {
-                return [
-                    ...previousValue,
-                    ...currentValue.key_packages.map(keyPackage => ({
-                        id: bazinga64_1.Encoder.toBase64(keyPackage.client).asBytes,
-                        kp: bazinga64_1.Decoder.fromBase64(keyPackage.key_package).asBytes,
-                    })),
-                ];
-            }
-            return previousValue;
-        }, []);
-        await coreCryptoClient.createConversation(groupIdDecodedFromBase64);
-        const memberAddedMessages = await coreCryptoClient.addClientsToConversation(groupIdDecodedFromBase64, coreCryptoKeyPackagesPayload);
-        const sendingPromises = [];
-        if (memberAddedMessages === null || memberAddedMessages === void 0 ? void 0 : memberAddedMessages.welcome) {
-            sendingPromises.push(this.apiClient.api.conversation.postMlsWelcomeMessage(Uint8Array.from(memberAddedMessages.welcome)));
-        }
-        if (memberAddedMessages === null || memberAddedMessages === void 0 ? void 0 : memberAddedMessages.message) {
-            sendingPromises.push(this.apiClient.api.conversation.postMlsMessage(Uint8Array.from(memberAddedMessages.message)));
-        }
-        await Promise.all(sendingPromises);
-        await this.notificationService.saveConversationGroupId(newConversation);
-        // We fetch the fresh version of the conversation created on backend with the newly added users
-        return this.getConversations(newConversation.id);
-    }
     async getConversations(conversationIds) {
         if (!conversationIds || !conversationIds.length) {
             return this.apiClient.api.conversation.getAllConversations();
@@ -704,37 +646,14 @@ class ConversationService {
         const request = await this.apiClient.api.asset.getAssetV3(assetId, assetToken);
         return (await request.response).buffer;
     }
-    async addUsersToProteusGroup({ conversationId, userIds }) {
-        const response = await this.apiClient.api.conversation.postMembers(conversationId, userIds);
+    async addUsersToProteusConversation({ conversationId, qualifiedUserIds }) {
+        const response = await this.apiClient.api.conversation.postMembers(conversationId, qualifiedUserIds);
         return response;
     }
-    async addUsersToMLSGroup({ conversationId, userIds }) {
-        return console.info('addUsersToMLSGroup', conversationId, userIds);
-    }
-    async addUsers({ conversationId, protocol, userIds }) {
-        return protocol === conversation_1.ConversationProtocol.MLS
-            ? this.addUsersToMLSGroup({ conversationId, userIds })
-            : this.addUsersToProteusGroup({ conversationId, userIds });
-    }
     async removeUser(conversationId, userId) {
         await this.apiClient.api.conversation.deleteMember(conversationId, userId);
         return userId;
     }
-    async sendMlsMessage(params, genericMessage, content) {
-        var _a, _b;
-        const { groupId, onSuccess, payload } = params;
-        const groupIdBytes = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
-        const coreCryptoClient = this.coreCryptoClientProvider();
-        const encrypted = await coreCryptoClient.encryptMessage(groupIdBytes, protocol_messaging_1.GenericMessage.encode(genericMessage).finish());
-        try {
-            const { time = '' } = await this.apiClient.api.conversation.postMlsMessage(encrypted);
-            onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(genericMessage, (time === null || time === void 0 ? void 0 : time.length) > 0 ? time : new Date().toISOString());
-            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_a = genericMessage.ephemeral) === null || _a === void 0 ? void 0 : _a.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.OUTGOING_SENT });
-        }
-        catch (_c) {
-            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_b = genericMessage.ephemeral) === null || _b === void 0 ? void 0 : _b.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.CANCELLED });
-        }
-    }
     async sendProteusMessage(params, genericMessage, content) {
         var _a;
         const { userIds, sendAsProtobuf, conversationDomain, nativePush, targetMode, payload, onClientMismatch, onSuccess } = params;
@@ -770,7 +689,7 @@ class ConversationService {
             return Object.assign(Object.assign({}, payload), { state: conversation_2.PayloadBundleState.CANCELLED });
         }
         return isMLS(params)
-            ? this.sendMlsMessage(params, genericMessage, content)
+            ? this.sendMLSMessage(params, genericMessage, content)
             : this.sendProteusMessage(params, genericMessage, content);
     }
     sendTypingStart(conversationId) {
@@ -870,6 +789,108 @@ class ConversationService {
                 throw new Error(`No send method implemented for "${payload['type']}".`);
         }
     }
+    /**
+     *   ###############################################
+     *   ################ MLS Functions ################
+     *   ###############################################
+     */
+    async getCoreCryptoKeyPackagesPayload(qualifiedUsers) {
+        /**
+         * @note We need to fetch key packages for all the users
+         * we want to add to the new MLS conversations,
+         * includes self user too.
+         */
+        const keyPackages = await Promise.all([
+            ...qualifiedUsers.map(({ id, domain, skipOwn }) => this.apiClient.api.client.claimMLSKeyPackages(id, domain, skipOwn)),
+        ]);
+        const coreCryptoKeyPackagesPayload = keyPackages.reduce((previousValue, currentValue) => {
+            // skip users that have not uploaded their MLS key packages
+            if (currentValue.key_packages.length > 0) {
+                return [
+                    ...previousValue,
+                    ...currentValue.key_packages.map(keyPackage => ({
+                        id: bazinga64_1.Encoder.toBase64(keyPackage.client).asBytes,
+                        kp: bazinga64_1.Decoder.fromBase64(keyPackage.key_package).asBytes,
+                    })),
+                ];
+            }
+            return previousValue;
+        }, []);
+        return coreCryptoKeyPackagesPayload;
+    }
+    async addUsersToExistingMLSConversation(groupIdDecodedFromBase64, invitee) {
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        const memberAddedMessages = await coreCryptoClient.addClientsToConversation(groupIdDecodedFromBase64, invitee);
+        if (memberAddedMessages === null || memberAddedMessages === void 0 ? void 0 : memberAddedMessages.welcome) {
+            await this.apiClient.api.conversation.postMlsWelcomeMessage(Uint8Array.from(memberAddedMessages.welcome));
+        }
+        if (memberAddedMessages === null || memberAddedMessages === void 0 ? void 0 : memberAddedMessages.message) {
+            return this.apiClient.api.conversation.postMlsMessage(Uint8Array.from(memberAddedMessages.message));
+        }
+        return null;
+    }
+    async createMLSConversation(conversationData) {
+        /**
+         * @note For creating MLS conversations the users & qualified_users
+         * field must be empty as backend is not aware which users
+         * are in a MLS conversation because of the MLS architecture.
+         */
+        const newConversation = await this.apiClient.api.conversation.postConversation(Object.assign(Object.assign({}, conversationData), { users: undefined, qualified_users: undefined }));
+        const { group_id: groupId, qualified_id: qualifiedId } = newConversation;
+        const groupIdDecodedFromBase64 = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
+        const { qualified_users: qualifiedUsers = [], selfUserId } = conversationData;
+        if (!selfUserId) {
+            throw new Error('You need to pass self user qualified id in order to create an MLS conversation');
+        }
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        await coreCryptoClient.createConversation(groupIdDecodedFromBase64);
+        const coreCryptoKeyPackagesPayload = await this.getCoreCryptoKeyPackagesPayload([
+            {
+                id: selfUserId.id,
+                domain: selfUserId.domain,
+                /**
+                 * we should skip fetching key packages for current self client,
+                 * it's already added by the backend on the group creation time
+                 */
+                skipOwn: conversationData.creator_client,
+            },
+            ...qualifiedUsers,
+        ]);
+        const response = await this.addUsersToExistingMLSConversation(groupIdDecodedFromBase64, coreCryptoKeyPackagesPayload);
+        await this.notificationService.saveConversationGroupId(newConversation);
+        // We fetch the fresh version of the conversation created on backend with the newly added users
+        const conversation = await this.getConversations(qualifiedId.id);
+        return {
+            events: (response === null || response === void 0 ? void 0 : response.events) || [],
+            conversation,
+        };
+    }
+    async sendMLSMessage(params, genericMessage, content) {
+        var _a, _b;
+        const { groupId, onSuccess, payload } = params;
+        const groupIdBytes = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        const encrypted = await coreCryptoClient.encryptMessage(groupIdBytes, protocol_messaging_1.GenericMessage.encode(genericMessage).finish());
+        try {
+            const { time = '' } = await this.apiClient.api.conversation.postMlsMessage(encrypted);
+            onSuccess === null || onSuccess === void 0 ? void 0 : onSuccess(genericMessage, (time === null || time === void 0 ? void 0 : time.length) > 0 ? time : new Date().toISOString());
+            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_a = genericMessage.ephemeral) === null || _a === void 0 ? void 0 : _a.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.OUTGOING_SENT });
+        }
+        catch (_c) {
+            return Object.assign(Object.assign({}, payload), { content, messageTimer: ((_b = genericMessage.ephemeral) === null || _b === void 0 ? void 0 : _b.expireAfterMillis) || 0, state: conversation_2.PayloadBundleState.CANCELLED });
+        }
+    }
+    async addUsersToMLSConversation({ qualifiedUserIds, groupId, conversationId, }) {
+        const groupIdDecodedFromBase64 = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
+        const coreCryptoKeyPackagesPayload = await this.getCoreCryptoKeyPackagesPayload([...qualifiedUserIds]);
+        const response = await this.addUsersToExistingMLSConversation(groupIdDecodedFromBase64, coreCryptoKeyPackagesPayload);
+        console.info('addUsersToMLSGroup', conversationId, qualifiedUserIds, groupIdDecodedFromBase64, response);
+        const conversation = await this.getConversations(conversationId.id);
+        return {
+            events: (response === null || response === void 0 ? void 0 : response.events) || [],
+            conversation,
+        };
+    }
 }
 exports.ConversationService = ConversationService;
 //# sourceMappingURL=ConversationService.js.map

package/src/main/conversation/ConversationService/ConversationService.types.d.ts

@@ -1,6 +1,7 @@
 import { GenericMessage } from '@wireapp/protocol-messaging';
-import { QualifiedUserClients, ClientMismatch, ConversationProtocol, MessageSendingStatus, UserClients } from '@wireapp/api-client/src/conversation';
+import { QualifiedUserClients, ClientMismatch, ConversationProtocol, MessageSendingStatus, UserClients, Conversation } from '@wireapp/api-client/src/conversation';
 import { QualifiedId } from '@wireapp/api-client/src/user';
+import { MlsEvent } from '@wireapp/api-client/src/conversation/data/MlsEventData';
 export declare enum MessageTargetMode {
     NONE = 0,
     USERS = 1,
@@ -88,7 +89,15 @@ export declare type SendMlsMessageParams<T> = SendCommonParams<T> & {
      */
     groupId: string;
 };
-export declare type AddUsersParams = ProtocolParam & {
+export declare type QualifiedUsers = QualifiedId & {
+    skipOwn?: string;
+};
+export declare type AddUsersParams = {
     conversationId: QualifiedId;
-    userIds: QualifiedId[];
+    qualifiedUserIds: QualifiedId[];
+    groupId?: string;
+};
+export declare type MLSReturnType = {
+    events: MlsEvent[];
+    conversation: Conversation;
 };