@wireapp/core 29.3.0 → 30.0.0

package/CHANGELOG.md

@@ -3,6 +3,49 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [30.0.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@29.3.0...@wireapp/core@30.0.0) (2022-08-25)
+
+
+### Features
+
+* remove user from MLS conversation (#FS-561) ([#4366](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4366)) ([89da444](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/89da4449fa3caa0cbe41fbd595326f157e7e4011)), closes [#FS-561](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/FS-561) [#4367](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4367)
+
+
+### BREAKING CHANGES
+
+* renamed removeUser function to removeUserFromProteusConversation in @wireapp/core and
+changed the types of conversation and user ids in @wireapp/bot-api MessageHandler from string to QualifiedId.
+
+* chore: initial work on remove user from mls convo
+
+* fix: use FQCI ids for client ids
+
+* fix: use FQCI ids for client ids
+
+* runfix: encode client id straight to byte array
+
+* runfix: encode client id straight to byte array
+
+* feat: send client-removal commit messages
+
+* runfix: remove event from remove user from proteus convo func
+
+* refactor: rename proteus remove func
+
+* test: add test for fully qualified ids mapping function
+
+* refactor: more precise name for remove from proteus convo
+
+* refactor: apply CR suggestions
+
+* runfix: don't convert messages twice to uint8arr
+
+* runfix: wrapp commits into uint8arr
+
+
+
+
+
 # [29.3.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@29.2.4...@wireapp/core@29.3.0) (2022-08-25)
 
 

package/package.json

@@ -7,7 +7,7 @@
     "@otak/core-crypto": "0.3.0-es2017",
     "@types/long": "4.0.1",
     "@types/node": "~14",
-    "@wireapp/api-client": "19.21.6",
+    "@wireapp/api-client": "20.0.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.3.0",
-  "gitHead": "e9707c97b3cfa69fa1e51c21d0d0ca6923f57d4d"
+  "version": "30.0.0",
+  "gitHead": "080d1139d0b9e8c3053d42dd42492a1a9b523191"
 }

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

@@ -3,7 +3,7 @@ import type { APIClient } from '@wireapp/api-client';
 import { MessageSendingStatus, Conversation, DefaultConversationRoleName, MutedStatus, NewConversation, QualifiedUserClients, UserClients, ClientMismatch } from '@wireapp/api-client/src/conversation';
 import type { ConversationMemberLeaveEvent } from '@wireapp/api-client/src/event';
 import type { QualifiedId, UserPreKeyBundleMap } from '@wireapp/api-client/src/user';
-import { MessageTimer } from '../../conversation/';
+import { MessageTimer, RemoveUsersParams } from '../../conversation/';
 import type { RemoteData } from '../content';
 import type { CryptographyService } from '../../cryptography/';
 import type { ClearConversationMessage, DeleteMessage, HideMessage, OtrMessage } from '../message/OtrMessage';
@@ -102,7 +102,11 @@ export declare class ConversationService {
     getAllParticipantsClients(conversationId: string, conversationDomain?: string): Promise<UserClients | QualifiedUserClients>;
     deleteMessageLocal(conversationId: string, messageIdToHide: string, sendAsProtobuf?: boolean, conversationDomain?: string): Promise<HideMessage>;
     deleteMessageEveryone(conversationId: string, messageIdToDelete: string, userIds?: string[] | QualifiedId[] | UserClients | QualifiedUserClients, sendAsProtobuf?: boolean, conversationDomain?: string, callbacks?: MessageSendingCallbacks): Promise<DeleteMessage>;
-    leaveConversation(conversationId: string): Promise<ConversationMemberLeaveEvent>;
+    leaveConversation(conversationId: QualifiedId): Promise<ConversationMemberLeaveEvent>;
+    leaveMLSConversation(conversationId: QualifiedId): Promise<ConversationMemberLeaveEvent>;
+    /**
+     * @depricated seems not to be used and is outdated. use leaveConversation instead
+     */
     leaveConversations(conversationIds?: string[]): Promise<ConversationMemberLeaveEvent[]>;
     /**
      * Create a group conversation.
@@ -127,7 +131,7 @@ export declare class ConversationService {
     getAsset({ assetId, assetToken, otrKey, sha256 }: RemoteData): Promise<Uint8Array>;
     getUnencryptedAsset(assetId: string, assetToken?: string): Promise<ArrayBuffer>;
     addUsersToProteusConversation({ conversationId, qualifiedUserIds }: Omit<AddUsersParams, 'groupId'>): Promise<import("@wireapp/api-client/src/event").ConversationMemberJoinEvent>;
-    removeUser(conversationId: string, userId: string): Promise<string>;
+    removeUserFromProteusConversation(conversationId: QualifiedId, userId: QualifiedId): Promise<ConversationMemberLeaveEvent>;
     private sendProteusMessage;
     /**
      * Sends a message to a conversation
@@ -151,4 +155,6 @@ export declare class ConversationService {
     createMLSConversation(conversationData: NewConversation): Promise<MLSReturnType>;
     private sendMLSMessage;
     addUsersToMLSConversation({ qualifiedUserIds, groupId, conversationId, }: Required<AddUsersParams>): Promise<MLSReturnType>;
+    private sendCommitBundleRemovalMessages;
+    removeUsersFromMLSConversation({ groupId, conversationId, qualifiedUserIds, }: RemoveUsersParams): Promise<MLSReturnType>;
 }

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

@@ -30,6 +30,12 @@ const MessageService_1 = require("../message/MessageService");
 const MessageToProtoMapper_1 = require("../message/MessageToProtoMapper");
 const ConversationService_types_1 = require("./ConversationService.types");
 const bazinga64_1 = require("bazinga64");
+const mapQualifiedUserClientIdsToFullyQualifiedClientIds_1 = require("../../util/mapQualifiedUserClientIdsToFullyQualifiedClientIds");
+//@todo: this function is temporary, we wait for the update from core-crypto side
+//they are returning regular array instead of Uint8Array for commit and welcome messages
+const optionalToUint8Array = (array) => {
+    return Array.isArray(array) ? Uint8Array.from(array) : array;
+};
 class ConversationService {
     constructor(apiClient, cryptographyService, config, coreCryptoClientProvider, notificationService) {
         this.apiClient = apiClient;
@@ -598,8 +604,20 @@ class ConversationService {
         };
     }
     leaveConversation(conversationId) {
-        return this.apiClient.api.conversation.deleteMember(conversationId, this.apiClient.context.userId);
+        if (!this.apiClient.context || !this.apiClient.context.userId || !this.apiClient.context.domain) {
+            throw new Error('Cannot leave conversation without a userId and domain');
+        }
+        return this.apiClient.api.conversation.deleteMember(conversationId, {
+            domain: this.apiClient.context.domain,
+            id: this.apiClient.context.userId,
+        });
+    }
+    leaveMLSConversation(conversationId) {
+        return this.leaveConversation(conversationId);
     }
+    /**
+     * @depricated seems not to be used and is outdated. use leaveConversation instead
+     */
     async leaveConversations(conversationIds) {
         if (!conversationIds) {
             const conversation = await this.getConversations();
@@ -607,7 +625,7 @@ class ConversationService {
                 .filter(conversation => conversation.type === conversation_1.CONVERSATION_TYPE.REGULAR)
                 .map(conversation => conversation.id);
         }
-        return Promise.all(conversationIds.map(conversationId => this.leaveConversation(conversationId)));
+        return Promise.all(conversationIds.map(conversationId => { var _a, _b; return this.leaveConversation({ id: conversationId, domain: (_b = (_a = this.apiClient.context) === null || _a === void 0 ? void 0 : _a.domain) !== null && _b !== void 0 ? _b : '' }); }));
     }
     createProteusConversation(conversationData, otherUserIds) {
         let payload;
@@ -647,12 +665,10 @@ class ConversationService {
         return (await request.response).buffer;
     }
     async addUsersToProteusConversation({ conversationId, qualifiedUserIds }) {
-        const response = await this.apiClient.api.conversation.postMembers(conversationId, qualifiedUserIds);
-        return response;
+        return this.apiClient.api.conversation.postMembers(conversationId, qualifiedUserIds);
     }
-    async removeUser(conversationId, userId) {
-        await this.apiClient.api.conversation.deleteMember(conversationId, userId);
-        return userId;
+    async removeUserFromProteusConversation(conversationId, userId) {
+        return this.apiClient.api.conversation.deleteMember(conversationId, userId);
     }
     async sendProteusMessage(params, genericMessage, content) {
         var _a;
@@ -822,10 +838,13 @@ class ConversationService {
         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));
+            //@todo: it's temporary - we wait for core-crypto fix to return the actual Uint8Array instead of regular array
+            await this.apiClient.api.conversation.postMlsWelcomeMessage(optionalToUint8Array(memberAddedMessages.welcome));
         }
         if (memberAddedMessages === null || memberAddedMessages === void 0 ? void 0 : memberAddedMessages.commit) {
-            const messageResponse = await this.apiClient.api.conversation.postMlsMessage(Uint8Array.from(memberAddedMessages.commit));
+            const messageResponse = await this.apiClient.api.conversation.postMlsMessage(
+            //@todo: it's temporary - we wait for core-crypto fix to return the actual Uint8Array instead of regular array
+            optionalToUint8Array(memberAddedMessages.commit));
             await coreCryptoClient.commitAccepted(groupIdDecodedFromBase64);
             return messageResponse;
         }
@@ -897,6 +916,34 @@ class ConversationService {
             conversation,
         };
     }
+    async sendCommitBundleRemovalMessages(groupIdDecodedFromBase64, commitBundle) {
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        if (commitBundle === null || commitBundle === void 0 ? void 0 : commitBundle.welcome) {
+            //@todo: it's temporary - we wait for core-crypto fix to return the actual Uint8Array instead of regular array
+            await this.apiClient.api.conversation.postMlsWelcomeMessage(optionalToUint8Array(commitBundle.welcome));
+        }
+        if (commitBundle === null || commitBundle === void 0 ? void 0 : commitBundle.commit) {
+            const messageResponse = await this.apiClient.api.conversation.postMlsMessage(
+            //@todo: it's temporary - we wait for core-crypto fix to return the actual Uint8Array instead of regular array
+            optionalToUint8Array(commitBundle.commit));
+            await coreCryptoClient.commitAccepted(groupIdDecodedFromBase64);
+            return messageResponse;
+        }
+        return null;
+    }
+    async removeUsersFromMLSConversation({ groupId, conversationId, qualifiedUserIds, }) {
+        const coreCryptoClient = this.coreCryptoClientProvider();
+        const groupIdDecodedFromBase64 = bazinga64_1.Decoder.fromBase64(groupId).asBytes;
+        const clientsToRemove = await this.apiClient.api.user.postListClients({ qualified_users: qualifiedUserIds });
+        const fullyQualifiedClientIds = (0, mapQualifiedUserClientIdsToFullyQualifiedClientIds_1.mapQualifiedUserClientIdsToFullyQualifiedClientIds)(clientsToRemove.qualified_user_map);
+        const commitBundle = await coreCryptoClient.removeClientsFromConversation(groupIdDecodedFromBase64, fullyQualifiedClientIds);
+        const messageResponse = await this.sendCommitBundleRemovalMessages(groupIdDecodedFromBase64, commitBundle);
+        const conversation = await this.getConversations(conversationId.id);
+        return {
+            events: (messageResponse === null || messageResponse === void 0 ? void 0 : messageResponse.events) || [],
+            conversation,
+        };
+    }
 }
 exports.ConversationService = ConversationService;
 //# sourceMappingURL=ConversationService.js.map

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

@@ -97,6 +97,11 @@ export declare type AddUsersParams = {
     qualifiedUserIds: QualifiedId[];
     groupId?: string;
 };
+export declare type RemoveUsersParams = {
+    conversationId: QualifiedId;
+    qualifiedUserIds: QualifiedId[];
+    groupId: string;
+};
 export declare type MLSReturnType = {
     events: MlsEvent[];
     conversation: Conversation;

package/src/main/util/mapQualifiedUserClientIdsToFullyQualifiedClientIds.d.ts

@@ -0,0 +1,8 @@
+import { QualifiedUserClientMap } from '@wireapp/api-client/src/client';
+declare type UserId = string;
+declare type ClientId = string;
+declare type Domain = string;
+export declare type ClientIdStringType = `${UserId}:${ClientId}@${Domain}`;
+export declare const constructFullyQualifiedClientId: (userId: UserId, clientId: ClientId, domain: Domain) => ClientIdStringType;
+export declare const mapQualifiedUserClientIdsToFullyQualifiedClientIds: (qualifiedUserMap: QualifiedUserClientMap) => Uint8Array[];
+export {};

package/src/main/util/mapQualifiedUserClientIdsToFullyQualifiedClientIds.js

@@ -0,0 +1,32 @@
+"use strict";
+/*
+ * Wire
+ * Copyright (C) 2022 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapQualifiedUserClientIdsToFullyQualifiedClientIds = exports.constructFullyQualifiedClientId = void 0;
+const constructFullyQualifiedClientId = (userId, clientId, domain) => `${userId}:${clientId}@${domain}`;
+exports.constructFullyQualifiedClientId = constructFullyQualifiedClientId;
+const mapQualifiedUserClientIdsToFullyQualifiedClientIds = (qualifiedUserMap) => {
+    const encoder = new TextEncoder();
+    return Object.entries(qualifiedUserMap).flatMap(([domain, users]) => {
+        const clients = Object.entries(users);
+        return clients.flatMap(([userId, clients]) => clients.map(client => encoder.encode((0, exports.constructFullyQualifiedClientId)(userId, client.id, domain))));
+    });
+};
+exports.mapQualifiedUserClientIdsToFullyQualifiedClientIds = mapQualifiedUserClientIdsToFullyQualifiedClientIds;
+//# sourceMappingURL=mapQualifiedUserClientIdsToFullyQualifiedClientIds.js.map