@wireapp/core 20.2.0 → 20.5.0

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [20.5.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@20.4.1...@wireapp/core@20.5.0) (2022-01-10)
+
+
+### Features
+
+* **core:** Add method to download v4 assets ([#4206](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4206)) ([41ab95a](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/41ab95ab1d70e2f5bee4e0b4f7d81f058a381792))
+
+
+
+
+
+## [20.4.1](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@20.4.0...@wireapp/core@20.4.1) (2022-01-06)
+
+**Note:** Version bump only for package @wireapp/core
+
+
+
+
+
+# [20.4.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@20.3.0...@wireapp/core@20.4.0) (2021-12-17)
+
+
+### Features
+
+* **core:** Allow broadcasting to a limited set of users ([99dca26](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/99dca265bc38e84b6279ca5ac9a928e6ef7e3239))
+
+
+
+
+
+# [20.3.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@20.2.0...@wireapp/core@20.3.0) (2021-12-17)
+
+
+### Features
+
+* **core:** Add lastRead and Countly message to the core ([#4204](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4204)) ([64a2336](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/64a2336f9de1f7ada34bd88652c624e28ac8169d))
+
+
+
+
+
 # [20.2.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@20.1.3...@wireapp/core@20.2.0) (2021-12-16)
 
 

package/package.json

@@ -5,7 +5,7 @@
   "dependencies": {
     "@types/long": "4.0.1",
     "@types/node": "~14",
-    "@wireapp/api-client": "16.2.0",
+    "@wireapp/api-client": "16.4.0",
     "@wireapp/cryptobox": "12.7.1",
     "bazinga64": "5.10.0",
     "hash.js": "1.1.7",
@@ -69,6 +69,6 @@
     "test:project": "yarn dist && yarn test",
     "test:node": "nyc jasmine --config=jasmine.json"
   },
-  "version": "20.2.0",
-  "gitHead": "5ff57f8efd8713ae9767f12c103ea918acbbaa3b"
+  "version": "20.5.0",
+  "gitHead": "951a884827988fb5d805cc16da6f96fb7352c555"
 }

package/src/main/broadcast/BroadcastService.d.ts

@@ -1,5 +1,5 @@
 import type { APIClient } from '@wireapp/api-client';
-import { ClientMismatch } from '@wireapp/api-client/src/conversation';
+import { ClientMismatch, UserClients } from '@wireapp/api-client/src/conversation';
 import type { UserPreKeyBundleMap } from '@wireapp/api-client/src/user/';
 import { GenericMessage } from '@wireapp/protocol-messaging';
 import type { CryptographyService } from '../cryptography/';
@@ -9,5 +9,5 @@ export declare class BroadcastService {
     private readonly messageService;
     constructor(apiClient: APIClient, cryptographyService: CryptographyService);
     getPreKeyBundlesFromTeam(teamId: string, skipOwnClients?: boolean): Promise<UserPreKeyBundleMap>;
-    broadcastGenericMessage(genericMessage: GenericMessage, preKeyBundles: UserPreKeyBundleMap, sendAsProtobuf?: boolean): Promise<ClientMismatch>;
+    broadcastGenericMessage(genericMessage: GenericMessage, recipients: UserPreKeyBundleMap | UserClients, sendAsProtobuf?: boolean): Promise<ClientMismatch>;
 }

package/src/main/broadcast/BroadcastService.js

@@ -43,10 +43,11 @@ class BroadcastService {
             return bundleMap;
         }, {});
     }
-    async broadcastGenericMessage(genericMessage, preKeyBundles, sendAsProtobuf) {
+    async broadcastGenericMessage(genericMessage, recipients, sendAsProtobuf) {
         const plainTextArray = protocol_messaging_1.GenericMessage.encode(genericMessage).finish();
-        return this.messageService.sendMessage(this.apiClient.validatedClientId, preKeyBundles, plainTextArray, {
+        return this.messageService.sendMessage(this.apiClient.validatedClientId, recipients, plainTextArray, {
             sendAsProtobuf,
+            reportMissing: Object.keys(recipients),
         });
     }
 }

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

@@ -3,9 +3,44 @@ import type { APIClient } from '@wireapp/api-client';
 import type { AssetOptions } from '@wireapp/api-client/src/asset';
 import type { ProgressCallback, RequestCancelable } from '@wireapp/api-client/src/http';
 import type { EncryptedAssetUploaded } from '../cryptography/';
+export interface AssetDataV4 {
+    assetKey: string;
+    assetToken: string;
+    assetDomain: string;
+    forceCaching: boolean;
+    version: 4;
+}
+export interface AssetDataV3 {
+    assetKey: string;
+    assetToken: string;
+    forceCaching: boolean;
+    version: 3;
+}
+export interface AssetDataV2 {
+    assetId: string;
+    conversationId: string;
+    forceCaching: boolean;
+    version: 2;
+}
+export interface AssetDataV1 {
+    assetId: string;
+    conversationId: string;
+    forceCaching: boolean;
+    version: 1;
+}
+export declare type AssetUrlData = AssetDataV1 | AssetDataV2 | AssetDataV3 | AssetDataV4;
 export declare class AssetService {
     private readonly apiClient;
     constructor(apiClient: APIClient);
+    /**
+     * Will download an asset on the server.
+     * Will route the request to the right endpoint depending on the asset version
+     *
+     * @param assetData The versioned asset data
+     * @param progressCallback?
+     * @return Resolves when the asset has been uploaded
+     */
+    downloadAsset(assetData: AssetUrlData, progressCallback?: ProgressCallback): RequestCancelable<import("@wireapp/api-client/src/asset").AssetResponse>;
     /**
      * Uploads a raw asset to the backend without encrypting it
      *

package/src/main/conversation/AssetService.js

@@ -24,6 +24,27 @@ class AssetService {
     constructor(apiClient) {
         this.apiClient = apiClient;
     }
+    /**
+     * Will download an asset on the server.
+     * Will route the request to the right endpoint depending on the asset version
+     *
+     * @param assetData The versioned asset data
+     * @param progressCallback?
+     * @return Resolves when the asset has been uploaded
+     */
+    downloadAsset(assetData, progressCallback) {
+        const { forceCaching } = assetData;
+        switch (assetData.version) {
+            case 1:
+                return this.apiClient.asset.api.getAssetV1(assetData.assetId, assetData.conversationId, forceCaching, progressCallback);
+            case 2:
+                return this.apiClient.asset.api.getAssetV2(assetData.assetId, assetData.conversationId, forceCaching, progressCallback);
+            case 3:
+                return this.apiClient.asset.api.getAssetV3(assetData.assetKey, assetData.assetToken, forceCaching, progressCallback);
+            case 4:
+                return this.apiClient.asset.api.getAssetV4(assetData.assetKey, assetData.assetToken, assetData.assetDomain, forceCaching, progressCallback);
+        }
+    }
     /**
      * Uploads a raw asset to the backend without encrypting it
      *

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

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 import type { APIClient } from '@wireapp/api-client';
-import { MessageSendingStatus, Conversation, DefaultConversationRoleName, MutedStatus, 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 { MessageSendingStatus, Conversation, DefaultConversationRoleName, MutedStatus, 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 { GenericMessage } from '@wireapp/protocol-messaging';
 import { MessageTimer } from '../conversation/';
 import type { RemoteData } from '../conversation/content/';
@@ -63,6 +63,7 @@ export declare class ConversationService {
     private readonly apiClient;
     readonly messageTimer: MessageTimer;
     private readonly messageService;
+    private selfConversationId?;
     constructor(apiClient: APIClient, cryptographyService: CryptographyService);
     private createEphemeral;
     private getConversationQualifiedMembers;
@@ -76,7 +77,7 @@ export declare class ConversationService {
      */
     private getQualifiedPreKeyBundle;
     getPreKeyBundleMap(conversationId: string, userIds?: string[] | UserClients): Promise<UserPreKeyBundleMap>;
-    private getSelfConversation;
+    private getSelfConversationId;
     private getQualifiedRecipientsForConversation;
     private getRecipientsForConversation;
     /**
@@ -105,7 +106,33 @@ export declare class ConversationService {
     private generateSessionResetGenericMessage;
     private generateCallGenericMessage;
     private generateTextGenericMessage;
-    clearConversation(conversationId: string, timestamp?: number | Date, messageId?: string, sendAsProtobuf?: boolean, conversationDomain?: string): Promise<ClearConversationMessage>;
+    clearConversation(conversationId: string, timestamp?: number | Date, messageId?: string, sendAsProtobuf?: boolean): Promise<ClearConversationMessage>;
+    /**
+     * Sends a LastRead message to the current user's self conversation.
+     * This will allow all the user's devices to compute which messages are unread
+     *
+     * @param conversationId The conversation which has been read
+     * @param lastReadTimestamp The timestamp at which the conversation was read
+     * @param sendAsProtobuf?
+     * @return Resolves when the message has been sent
+     */
+    sendLastRead(conversationId: string, lastReadTimestamp: number, sendAsProtobuf?: boolean): Promise<(MessageSendingStatus & {
+        errored?: boolean | undefined;
+    }) | (ClientMismatch & {
+        errored?: boolean | undefined;
+    })>;
+    /**
+     * Syncs all self user's devices with the countly id
+     *
+     * @param countlyId The countly id of the current device
+     * @param sendAsProtobuf?
+     * @return Resolves when the message has been sent
+     */
+    sendCountlySync(countlyId: string, sendAsProtobuf?: boolean): Promise<(MessageSendingStatus & {
+        errored?: boolean | undefined;
+    }) | (ClientMismatch & {
+        errored?: boolean | undefined;
+    })>;
     /**
      * Get a fresh list from backend of clients for all the participants of the conversation.
      * This is a hacky way of getting all the clients for a conversation.

package/src/main/conversation/ConversationService.js

@@ -19,8 +19,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationService = exports.MessageTargetMode = void 0;
-const conversation_1 = require("@wireapp/api-client/src/conversation/");
-const data_1 = require("@wireapp/api-client/src/conversation/data/");
+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");
 const conversation_2 = require("../conversation/");
 const AssetCryptography_1 = require("../cryptography/AssetCryptography");
@@ -134,9 +134,13 @@ class ConversationService {
             return bundleMap;
         }, {});
     }
-    getSelfConversation() {
-        const { userId } = this.apiClient.context;
-        return this.apiClient.conversation.api.getConversation(userId);
+    async getSelfConversationId() {
+        if (!this.selfConversationId) {
+            const { userId } = this.apiClient.context;
+            const { qualified_id, id } = await this.apiClient.conversation.api.getConversation(userId);
+            this.selfConversationId = qualified_id || { id, domain: '' };
+        }
+        return this.selfConversationId;
     }
     async getQualifiedRecipientsForConversation(conversationId, userIds) {
         if ((0, TypePredicateUtil_1.isQualifiedUserClients)(userIds)) {
@@ -426,7 +430,7 @@ class ConversationService {
         const expireAfterMillis = this.messageTimer.getMessageTimer(payloadBundle.conversation);
         return expireAfterMillis > 0 ? this.createEphemeral(genericMessage, expireAfterMillis) : genericMessage;
     }
-    async clearConversation(conversationId, timestamp = new Date(), messageId = MessageBuilder_1.MessageBuilder.createId(), sendAsProtobuf, conversationDomain) {
+    async clearConversation(conversationId, timestamp = new Date(), messageId = MessageBuilder_1.MessageBuilder.createId(), sendAsProtobuf) {
         if (timestamp instanceof Date) {
             timestamp = timestamp.getTime();
         }
@@ -439,9 +443,9 @@ class ConversationService {
             [conversation_2.GenericMessageType.CLEARED]: clearedMessage,
             messageId,
         });
-        const { id: selfConversationId } = await this.getSelfConversation();
+        const { id: selfConversationId, domain } = await this.getSelfConversationId();
         await this.sendGenericMessage(this.apiClient.validatedClientId, selfConversationId, genericMessage, {
-            conversationDomain,
+            conversationDomain: domain,
             sendAsProtobuf,
         });
         return {
@@ -456,6 +460,53 @@ class ConversationService {
             type: conversation_2.PayloadBundleType.CONVERSATION_CLEAR,
         };
     }
+    /**
+     * Sends a LastRead message to the current user's self conversation.
+     * This will allow all the user's devices to compute which messages are unread
+     *
+     * @param conversationId The conversation which has been read
+     * @param lastReadTimestamp The timestamp at which the conversation was read
+     * @param sendAsProtobuf?
+     * @return Resolves when the message has been sent
+     */
+    async sendLastRead(conversationId, lastReadTimestamp, sendAsProtobuf) {
+        const lastRead = new protocol_messaging_1.LastRead({
+            conversationId,
+            lastReadTimestamp,
+        });
+        const genericMessage = protocol_messaging_1.GenericMessage.create({
+            [conversation_2.GenericMessageType.LAST_READ]: lastRead,
+            messageId: MessageBuilder_1.MessageBuilder.createId(),
+        });
+        const { id: selfConversationId, domain: selfConversationDomain } = await this.getSelfConversationId();
+        return this.sendGenericMessage(this.apiClient.validatedClientId, selfConversationId, genericMessage, {
+            conversationDomain: selfConversationDomain,
+            sendAsProtobuf,
+        });
+    }
+    /**
+     * Syncs all self user's devices with the countly id
+     *
+     * @param countlyId The countly id of the current device
+     * @param sendAsProtobuf?
+     * @return Resolves when the message has been sent
+     */
+    async sendCountlySync(countlyId, sendAsProtobuf) {
+        const { id: selfConversationId, domain: selfConversationDomain } = await this.getSelfConversationId();
+        const dataTransfer = new protocol_messaging_1.DataTransfer({
+            trackingIdentifier: {
+                identifier: countlyId,
+            },
+        });
+        const genericMessage = new protocol_messaging_1.GenericMessage({
+            [conversation_2.GenericMessageType.DATA_TRANSFER]: dataTransfer,
+            messageId: MessageBuilder_1.MessageBuilder.createId(),
+        });
+        return this.sendGenericMessage(this.apiClient.validatedClientId, selfConversationId, genericMessage, {
+            conversationDomain: selfConversationDomain,
+            sendAsProtobuf,
+        });
+    }
     /**
      * Get a fresh list from backend of clients for all the participants of the conversation.
      * This is a hacky way of getting all the clients for a conversation.
@@ -500,7 +551,7 @@ class ConversationService {
             [conversation_2.GenericMessageType.HIDDEN]: content,
             messageId,
         });
-        const { id: selfConversationId } = await this.getSelfConversation();
+        const { id: selfConversationId } = await this.getSelfConversationId();
         await this.sendGenericMessage(this.apiClient.validatedClientId, selfConversationId, genericMessage, {
             sendAsProtobuf,
             conversationDomain,
@@ -577,7 +628,7 @@ class ConversationService {
         return this.apiClient.conversation.api.getConversationsByIds(conversationIds);
     }
     async getAsset({ assetId, assetToken, otrKey, sha256 }) {
-        const request = await this.apiClient.asset.api.getAssetV3(assetId, assetToken);
+        const request = this.apiClient.asset.api.getAssetV3(assetId, assetToken);
         const encryptedBuffer = (await request.response).buffer;
         return (0, AssetCryptography_1.decryptAsset)({
             cipherText: Buffer.from(encryptedBuffer),

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

@@ -10,6 +10,7 @@ export declare enum GenericMessageType {
     CLIENT_ACTION = "clientAction",
     COMPOSITE = "composite",
     CONFIRMATION = "confirmation",
+    DATA_TRANSFER = "dataTransfer",
     DELETED = "deleted",
     EDITED = "edited",
     EPHEMERAL = "ephemeral",

package/src/main/conversation/GenericMessageType.js

@@ -33,6 +33,7 @@ var GenericMessageType;
     GenericMessageType["CLIENT_ACTION"] = "clientAction";
     GenericMessageType["COMPOSITE"] = "composite";
     GenericMessageType["CONFIRMATION"] = "confirmation";
+    GenericMessageType["DATA_TRANSFER"] = "dataTransfer";
     GenericMessageType["DELETED"] = "deleted";
     GenericMessageType["EDITED"] = "edited";
     GenericMessageType["EPHEMERAL"] = "ephemeral";