@wireapp/core 26.0.0 → 26.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.
 
+# [26.1.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@26.0.0...@wireapp/core@26.1.0) (2022-05-16)
+
+
+### Features
+
+* Allow consumer to set number of prekeys generated ([#4263](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4263)) ([648ecda](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/648ecdad260488e1d07965a84a28c346d6f015c3))
+
+
+
+
+
 # [26.0.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@25.3.1...@wireapp/core@26.0.0) (2022-05-16)
 
 

package/package.json

@@ -69,6 +69,6 @@
     "test:project": "yarn dist && yarn test",
     "test:node": "nyc jasmine --config=jasmine.json"
   },
-  "version": "26.0.0",
-  "gitHead": "730379c5b3701879632789ca73c1a9d55a9505ad"
+  "version": "26.1.0",
+  "gitHead": "3b458a889a4e5ebebf2c66429c8fac7f39119891"
 }

package/src/main/Account.d.ts

@@ -53,11 +53,26 @@ export interface Account {
     on(event: TOPIC.ERROR, listener: (payload: CoreError) => void): this;
 }
 export declare type CreateStoreFn = (storeName: string, context: Context) => undefined | Promise<CRUDEngine | undefined>;
+interface AccountOptions {
+    /** Used to store info in the database (will create a inMemory engine if returns undefined) */
+    createStore?: CreateStoreFn;
+    /** Number of prekeys to generate when creating a new device (defaults to 2)
+     * Prekeys are Diffie-Hellmann public keys which allow offline initiation of a secure Proteus session between two devices.
+     * Having a high value will:
+     *    - make creating a new device consuming more CPU resources
+     *    - make it less likely that all prekeys get consumed while the device is offline and the last resort prekey will not be used to create new session
+     * Having a low value will:
+     *    - make creating a new device fast
+     *    - make it likely that all prekeys get consumed while the device is offline and the last resort prekey will be used to create new session
+     */
+    nbPrekeys?: number;
+}
 export declare class Account extends EventEmitter {
     private readonly apiClient;
     private readonly logger;
     private readonly createStore;
     private storeEngine?;
+    private readonly nbPrekeys;
     static readonly TOPIC: typeof TOPIC;
     service?: {
         account: AccountService;
@@ -77,11 +92,9 @@ export declare class Account extends EventEmitter {
     backendFeatures: BackendFeatures;
     /**
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
-     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if returns undefined)
+     * @param storeEngineProvider
      */
-    constructor(apiClient?: APIClient, { createStore }?: {
-        createStore?: CreateStoreFn;
-    });
+    constructor(apiClient?: APIClient, { createStore, nbPrekeys }?: AccountOptions);
     private persistCookie;
     get clientId(): string;
     get userId(): string;

package/src/main/Account.js

@@ -70,9 +70,9 @@ var TOPIC;
 class Account extends events_1.EventEmitter {
     /**
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
-     * @param storeEngineProvider Used to store info in the database (will create a inMemory engine if returns undefined)
+     * @param storeEngineProvider
      */
-    constructor(apiClient = new api_client_1.APIClient(), { createStore = () => undefined } = {}) {
+    constructor(apiClient = new api_client_1.APIClient(), { createStore = () => undefined, nbPrekeys = 2 } = {}) {
         super();
         this.handlePayload = async (payload) => {
             switch (payload.type) {
@@ -90,6 +90,7 @@ class Account extends events_1.EventEmitter {
         };
         this.apiClient = apiClient;
         this.backendFeatures = this.apiClient.backendFeatures;
+        this.nbPrekeys = nbPrekeys;
         this.createStore = createStore;
         apiClient.on(api_client_1.APIClient.TOPIC.COOKIE_REFRESH, async (cookie) => {
             if (cookie && this.storeEngine) {
@@ -136,6 +137,7 @@ class Account extends events_1.EventEmitter {
         const cryptographyService = new cryptography_1.CryptographyService(this.apiClient, this.storeEngine, {
             // We want to encrypt with fully qualified session ids, only if the backend is federated with other backends
             useQualifiedIds: this.backendFeatures.isFederated,
+            nbPrekeys: this.nbPrekeys,
         });
         const clientService = new client_2.ClientService(this.apiClient, this.storeEngine, cryptographyService);
         const connectionService = new connection_1.ConnectionService(this.apiClient);

package/src/main/cryptography/CryptographyService.d.ts

@@ -20,8 +20,9 @@ export declare class CryptographyService {
     private readonly logger;
     cryptobox: Cryptobox;
     private readonly database;
-    constructor(apiClient: APIClient, storeEngine: CRUDEngine, config?: {
-        useQualifiedIds?: boolean;
+    constructor(apiClient: APIClient, storeEngine: CRUDEngine, config: {
+        useQualifiedIds: boolean;
+        nbPrekeys: number;
     });
     constructSessionId(userId: string | QualifiedId, clientId: string, domain?: string): string;
     static convertArrayRecipientsToBase64(recipients: OTRRecipients<Uint8Array>): OTRRecipients<string>;

package/src/main/cryptography/CryptographyService.js

@@ -32,11 +32,11 @@ const util_1 = require("../util");
 const CryptographyDatabaseRepository_1 = require("./CryptographyDatabaseRepository");
 const GenericMessageMapper_1 = require("./GenericMessageMapper");
 class CryptographyService {
-    constructor(apiClient, storeEngine, config = {}) {
+    constructor(apiClient, storeEngine, config) {
         this.apiClient = apiClient;
         this.storeEngine = storeEngine;
         this.config = config;
-        this.cryptobox = new cryptobox_1.Cryptobox(this.storeEngine);
+        this.cryptobox = new cryptobox_1.Cryptobox(this.storeEngine, config.nbPrekeys);
         this.database = new CryptographyDatabaseRepository_1.CryptographyDatabaseRepository(this.storeEngine);
         this.logger = (0, logdown_1.default)('@wireapp/core/cryptography/CryptographyService', {
             logger: console,