@simplito/privmx-webendpoint 2.5.1 → 2.6.0

package/service/KvdbApi.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { KvdbApiNative } from "../api/KvdbApiNative";
-import { PagingQuery, PagingList, UserWithPubKey, Kvdb, ContainerPolicy, KvdbEntry, DeleteEntriesResult } from "../Types";
+import { PagingQuery, PagingList, UserWithPubKey, Kvdb, ContainerPolicy, KvdbEntry, DeleteEntriesResult, KvdbEventSelectorType, KvdbEventType } from "../Types";
 export declare class KvdbApi extends BaseApi {
     protected native: KvdbApiNative;
     constructor(native: KvdbApiNative, ptr: number);
@@ -18,28 +18,28 @@ export declare class KvdbApi extends BaseApi {
      * Creates a new KVDB in given Context.
      *
      * @param {string} contextId ID of the Context to create the KVDB in
-     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Kvdb
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
      * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
-     * the created Kvdb
+     * the created KVDB
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {ContainerPolicy} policies Kvdb's policies
-     * @returns {string} ID of the created Kvdb
+     * @param {ContainerPolicy} policies KVDB's policies
+     * @returns {string} ID of the created KVDB
      */
     createKvdb(contextId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, policies?: ContainerPolicy): Promise<string>;
     /**
-     * Updates an existing Kvdb.
+     * Updates an existing KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to update
-     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Kvdb
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
      * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
-     * the created Kvdb
+     * the created KVDB
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {number} version current version of the updated Kvdb
+     * @param {number} version current version of the updated KVDB
      * @param {boolean} force force update (without checking version)
-     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Kvdb
-     * @param {ContainerPolicy} policies Kvdb's policies
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the KVDB
+     * @param {ContainerPolicy} policies KVDB's policies
      */
     updateKvdb(kvdbId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, version: number, force: boolean, forceGenerateNewKey: boolean, policies?: ContainerPolicy): Promise<void>;
     /**
@@ -52,7 +52,7 @@ export declare class KvdbApi extends BaseApi {
      * Gets a KVDB by given KVDB ID.
      *
      * @param {string} kvdbId ID of KVDB to get
-     * @returns {Kvdb} containing info about the Kvdb
+     * @returns {Kvdb} containing info about the KVDB
      */
     getKvdb(kvdbId: string): Promise<Kvdb>;
     /**
@@ -80,7 +80,7 @@ export declare class KvdbApi extends BaseApi {
      */
     hasEntry(kvdbId: string, key: string): Promise<boolean>;
     /**
-     * Gets a list of KVDB entries keys from a Kvdb.
+     * Gets a list of KVDB entries keys from a KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to list KVDB entries from
      * @param {PagingQuery} pagingQuery with list query parameters
@@ -88,7 +88,7 @@ export declare class KvdbApi extends BaseApi {
      */
     listEntriesKeys(kvdbId: string, pagingQuery: PagingQuery): Promise<PagingList<string>>;
     /**
-     * Gets a list of KVDB entries from a Kvdb.
+     * Gets a list of KVDB entries from a KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to list KVDB entries from
      * @param {PagingQuery} pagingQuery with list query parameters
@@ -96,7 +96,7 @@ export declare class KvdbApi extends BaseApi {
      */
     listEntries(kvdbId: string, pagingQuery: PagingQuery): Promise<PagingList<KvdbEntry>>;
     /**
-     * Sets a KVDB entry in the given Kvdb.
+     * Sets a KVDB entry in the given KVDB.
      * @param {string} kvdbId ID of the KVDB to set the entry to
      * @param {string} key KVDB entry key
      * @param {Uint8Array} publicMeta public KVDB entry metadata
@@ -122,21 +122,29 @@ export declare class KvdbApi extends BaseApi {
      */
     deleteEntries(kvdbId: string, keys: string[]): Promise<DeleteEntriesResult>;
     /**
-     * Subscribes for the KVDB module main events.
+     * Subscribe for the KVDB events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    subscribeForKvdbEvents(): Promise<void>;
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
     /**
-     * Unsubscribes from the KVDB module main events.
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    unsubscribeFromKvdbEvents(): Promise<void>;
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
     /**
-     * Subscribes for events in given Kvdb.
-     * @param {string} kvdbId ID of the KVDB to subscribe
+     * Generate subscription Query for the KVDB events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    subscribeForEntryEvents(kvdbId: string): Promise<void>;
+    buildSubscriptionQuery(eventType: KvdbEventType, selectorType: KvdbEventSelectorType, selectorId: string): Promise<string>;
     /**
-     * Unsubscribes from events in given Kvdb.
-     * @param {string} kvdbId ID of the KVDB to unsubscribe
+     * Generate subscription Query for the KVDB events for single KvdbEntry.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {string} kvdbId ID of the KVDB
+     * @param {string} kvdbEntryKey Key of Kvdb Entry
      */
-    unsubscribeFromEntryEvents(kvdbId: string): Promise<void>;
+    buildSubscriptionQueryForSelectedEntry(eventType: KvdbEventType, kvdbId: string, kvdbEntryKey: string): Promise<string>;
 }

package/service/KvdbApi.js

@@ -22,13 +22,13 @@ class KvdbApi extends BaseApi_1.BaseApi {
      * Creates a new KVDB in given Context.
      *
      * @param {string} contextId ID of the Context to create the KVDB in
-     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Kvdb
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
      * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
-     * the created Kvdb
+     * the created KVDB
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {ContainerPolicy} policies Kvdb's policies
-     * @returns {string} ID of the created Kvdb
+     * @param {ContainerPolicy} policies KVDB's policies
+     * @returns {string} ID of the created KVDB
      */
     async createKvdb(contextId, users, managers, publicMeta, privateMeta, policies) {
         return this.native.createKvdb(this.servicePtr, [
@@ -41,18 +41,18 @@ class KvdbApi extends BaseApi_1.BaseApi {
         ]);
     }
     /**
-     * Updates an existing Kvdb.
+     * Updates an existing KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to update
-     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Kvdb
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
      * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
-     * the created Kvdb
+     * the created KVDB
      * @param {Uint8Array} publicMeta public (unencrypted) metadata
      * @param {Uint8Array} privateMeta private (encrypted) metadata
-     * @param {number} version current version of the updated Kvdb
+     * @param {number} version current version of the updated KVDB
      * @param {boolean} force force update (without checking version)
-     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Kvdb
-     * @param {ContainerPolicy} policies Kvdb's policies
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the KVDB
+     * @param {ContainerPolicy} policies KVDB's policies
      */
     async updateKvdb(kvdbId, users, managers, publicMeta, privateMeta, version, force, forceGenerateNewKey, policies) {
         return this.native.updateKvdb(this.servicePtr, [
@@ -79,7 +79,7 @@ class KvdbApi extends BaseApi_1.BaseApi {
      * Gets a KVDB by given KVDB ID.
      *
      * @param {string} kvdbId ID of KVDB to get
-     * @returns {Kvdb} containing info about the Kvdb
+     * @returns {Kvdb} containing info about the KVDB
      */
     async getKvdb(kvdbId) {
         return this.native.getKvdb(this.servicePtr, [kvdbId]);
@@ -115,7 +115,7 @@ class KvdbApi extends BaseApi_1.BaseApi {
         return this.native.hasEntry(this.servicePtr, [kvdbId, key]);
     }
     /**
-     * Gets a list of KVDB entries keys from a Kvdb.
+     * Gets a list of KVDB entries keys from a KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to list KVDB entries from
      * @param {PagingQuery} pagingQuery with list query parameters
@@ -125,7 +125,7 @@ class KvdbApi extends BaseApi_1.BaseApi {
         return this.native.listEntriesKeys(this.servicePtr, [kvdbId, pagingQuery]);
     }
     /**
-     * Gets a list of KVDB entries from a Kvdb.
+     * Gets a list of KVDB entries from a KVDB.
      *
      * @param {string} kvdbId ID of the KVDB to list KVDB entries from
      * @param {PagingQuery} pagingQuery with list query parameters
@@ -135,7 +135,7 @@ class KvdbApi extends BaseApi_1.BaseApi {
         return this.native.listEntries(this.servicePtr, [kvdbId, pagingQuery]);
     }
     /**
-     * Sets a KVDB entry in the given Kvdb.
+     * Sets a KVDB entry in the given KVDB.
      * @param {string} kvdbId ID of the KVDB to set the entry to
      * @param {string} key KVDB entry key
      * @param {Uint8Array} publicMeta public KVDB entry metadata
@@ -176,33 +176,67 @@ class KvdbApi extends BaseApi_1.BaseApi {
             keys,
         ]);
     }
-    /**
-     * Subscribes for the KVDB module main events.
+    // /**
+    //  * Subscribes for the KVDB module main events.
+    //  */
+    // async subscribeForKvdbEvents(): Promise<void> {
+    //   return this.native.subscribeForKvdbEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Unsubscribes from the KVDB module main events.
+    //  */
+    // async unsubscribeFromKvdbEvents(): Promise<void> {
+    //   return this.native.unsubscribeFromKvdbEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Subscribes for events in given KVDB.
+    //  * @param {string} kvdbId ID of the KVDB to subscribe
+    //  */
+    // async subscribeForEntryEvents(kvdbId: string): Promise<void> {
+    //   return this.native.subscribeForEntryEvents(this.servicePtr, [kvdbId]);
+    // }
+    // /**
+    //  * Unsubscribes from events in given KVDB.
+    //  * @param {string} kvdbId ID of the KVDB to unsubscribe
+    //  */
+    // async unsubscribeFromEntryEvents(kvdbId: string): Promise<void> {
+    //   return this.native.unsubscribeFromEntryEvents(this.servicePtr, [
+    //     kvdbId,
+    //   ]);
+    // }
+    /**
+     * Subscribe for the KVDB events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    async subscribeForKvdbEvents() {
-        return this.native.subscribeForKvdbEvents(this.servicePtr, []);
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
     }
     /**
-     * Unsubscribes from the KVDB module main events.
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    async unsubscribeFromKvdbEvents() {
-        return this.native.unsubscribeFromKvdbEvents(this.servicePtr, []);
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
     }
     /**
-     * Subscribes for events in given Kvdb.
-     * @param {string} kvdbId ID of the KVDB to subscribe
+     * Generate subscription Query for the KVDB events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    async subscribeForEntryEvents(kvdbId) {
-        return this.native.subscribeForEntryEvents(this.servicePtr, [kvdbId]);
+    async buildSubscriptionQuery(eventType, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [eventType, selectorType, selectorId]);
     }
     /**
-     * Unsubscribes from events in given Kvdb.
-     * @param {string} kvdbId ID of the KVDB to unsubscribe
+     * Generate subscription Query for the KVDB events for single KvdbEntry.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {string} kvdbId ID of the KVDB
+     * @param {string} kvdbEntryKey Key of Kvdb Entry
      */
-    async unsubscribeFromEntryEvents(kvdbId) {
-        return this.native.unsubscribeFromEntryEvents(this.servicePtr, [
-            kvdbId,
-        ]);
+    async buildSubscriptionQueryForSelectedEntry(eventType, kvdbId, kvdbEntryKey) {
+        return this.native.buildSubscriptionQueryForSelectedEntry(this.servicePtr, [eventType, kvdbId, kvdbEntryKey]);
     }
 }
 exports.KvdbApi = KvdbApi;

package/service/StoreApi.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { StoreApiNative } from "../api/StoreApiNative";
-import { PagingQuery, PagingList, UserWithPubKey, Store, File, ContainerPolicy } from "../Types";
+import { PagingQuery, PagingList, UserWithPubKey, Store, File, ContainerPolicy, StoreEventSelectorType, StoreEventType } from "../Types";
 export declare class StoreApi extends BaseApi {
     private native;
     constructor(native: StoreApiNative, ptr: number);
@@ -70,9 +70,10 @@ export declare class StoreApi extends BaseApi {
      * @param {Uint8Array} publicMeta public file metadata
      * @param {Uint8Array} privateMeta private file metadata
      * @param {number} size size of the file
+     * @param {boolean} [randomWriteSupport] enable random write support for file
      * @returns {number} handle to write data
      */
-    createFile(storeId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, size: number): Promise<number>;
+    createFile(storeId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, size: number, randomWriteSupport?: boolean): Promise<number>;
     /**
      * Update an existing file in a Store.
      *
@@ -96,8 +97,9 @@ export declare class StoreApi extends BaseApi {
      *
      * @param {number} fileHandle handle to write file data
      * @param {Uint8Array} dataChunk file data chunk
+     * @param {boolean} [truncate] truncate the file from: current pos + dataChunk size
      */
-    writeToFile(fileHandle: number, dataChunk: Uint8Array): Promise<void>;
+    writeToFile(fileHandle: number, dataChunk: Uint8Array, truncate?: boolean): Promise<void>;
     /**
      * Deletes a file by given ID.
      *
@@ -150,21 +152,22 @@ export declare class StoreApi extends BaseApi {
      */
     closeFile(fileHandle: number): Promise<string>;
     /**
-     * Subscribes for the Store module main events.
-     */
-    subscribeForStoreEvents(): Promise<void>;
-    /**
-     * Unsubscribes from the Store module main events.
+     * Subscribe for the Store events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    unsubscribeFromStoreEvents(): Promise<void>;
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
     /**
-     * Subscribes for events in given Store.
-     * @param {string} storeId ID of the Store to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    subscribeForFileEvents(storeId: string): Promise<void>;
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
     /**
-     * Unsubscribes from events in given Store.
-     * @param {string} storeId ID of the Store to unsubscribe
+     * Generate subscription Query for the Store events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    unsubscribeFromFileEvents(storeId: string): Promise<void>;
+    buildSubscriptionQuery(eventType: StoreEventType, selectorType: StoreEventSelectorType, selectorId: string): Promise<string>;
 }

package/service/StoreApi.js

@@ -101,14 +101,16 @@ class StoreApi extends BaseApi_1.BaseApi {
      * @param {Uint8Array} publicMeta public file metadata
      * @param {Uint8Array} privateMeta private file metadata
      * @param {number} size size of the file
+     * @param {boolean} [randomWriteSupport] enable random write support for file
      * @returns {number} handle to write data
      */
-    async createFile(storeId, publicMeta, privateMeta, size) {
+    async createFile(storeId, publicMeta, privateMeta, size, randomWriteSupport = false) {
         return this.native.createFile(this.servicePtr, [
             storeId,
             publicMeta,
             privateMeta,
             size,
+            randomWriteSupport
         ]);
     }
     /**
@@ -147,9 +149,10 @@ class StoreApi extends BaseApi_1.BaseApi {
      *
      * @param {number} fileHandle handle to write file data
      * @param {Uint8Array} dataChunk file data chunk
+     * @param {boolean} [truncate] truncate the file from: current pos + dataChunk size
      */
-    async writeToFile(fileHandle, dataChunk) {
-        return this.native.writeToFile(this.servicePtr, [fileHandle, dataChunk]);
+    async writeToFile(fileHandle, dataChunk, truncate = false) {
+        return this.native.writeToFile(this.servicePtr, [fileHandle, dataChunk, truncate]);
     }
     /**
      * Deletes a file by given ID.
@@ -216,31 +219,56 @@ class StoreApi extends BaseApi_1.BaseApi {
     async closeFile(fileHandle) {
         return this.native.closeFile(this.servicePtr, [fileHandle]);
     }
+    // /**
+    //  * Subscribes for the Store module main events.
+    //  */
+    // async subscribeForStoreEvents(): Promise<void> {
+    //   return this.native.subscribeForStoreEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Unsubscribes from the Store module main events.
+    //  */
+    // async unsubscribeFromStoreEvents(): Promise<void> {
+    //   return this.native.unsubscribeFromStoreEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Subscribes for events in given Store.
+    //  * @param {string} storeId ID of the Store to subscribe
+    //  */
+    // async subscribeForFileEvents(storeId: string): Promise<void> {
+    //   return this.native.subscribeForFileEvents(this.servicePtr, [storeId]);
+    // }
+    // /**
+    //  * Unsubscribes from events in given Store.
+    //  * @param {string} storeId ID of the Store to unsubscribe
+    //  */
+    // async unsubscribeFromFileEvents(storeId: string): Promise<void> {
+    //   return this.native.unsubscribeFromFileEvents(this.servicePtr, [storeId]);
+    // }
     /**
-     * Subscribes for the Store module main events.
-     */
-    async subscribeForStoreEvents() {
-        return this.native.subscribeForStoreEvents(this.servicePtr, []);
-    }
-    /**
-     * Unsubscribes from the Store module main events.
+     * Subscribe for the Store events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    async unsubscribeFromStoreEvents() {
-        return this.native.unsubscribeFromStoreEvents(this.servicePtr, []);
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
     }
     /**
-     * Subscribes for events in given Store.
-     * @param {string} storeId ID of the Store to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    async subscribeForFileEvents(storeId) {
-        return this.native.subscribeForFileEvents(this.servicePtr, [storeId]);
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
     }
     /**
-     * Unsubscribes from events in given Store.
-     * @param {string} storeId ID of the Store to unsubscribe
+     * Generate subscription Query for the Store events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    async unsubscribeFromFileEvents(storeId) {
-        return this.native.unsubscribeFromFileEvents(this.servicePtr, [storeId]);
+    async buildSubscriptionQuery(eventType, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [eventType, selectorType, selectorId]);
     }
 }
 exports.StoreApi = StoreApi;

package/service/ThreadApi.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { ThreadApiNative } from "../api/ThreadApiNative";
-import { PagingQuery, PagingList, UserWithPubKey, Thread, Message, ContainerPolicy } from "../Types";
+import { PagingQuery, PagingList, UserWithPubKey, Thread, Message, ContainerPolicy, ThreadEventType, ThreadEventSelectorType } from "../Types";
 export declare class ThreadApi extends BaseApi {
     protected native: ThreadApiNative;
     constructor(native: ThreadApiNative, ptr: number);
@@ -104,21 +104,22 @@ export declare class ThreadApi extends BaseApi {
      */
     updateMessage(messageId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, data: Uint8Array): Promise<void>;
     /**
-     * Subscribes for the Thread module main events.
-     */
-    subscribeForThreadEvents(): Promise<void>;
-    /**
-     * Unsubscribes from the Thread module main events.
+     * Subscribe for the Thread events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    unsubscribeFromThreadEvents(): Promise<void>;
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
     /**
-     * Subscribes for events in given Thread.
-     * @param {string} threadId ID of the Thread to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    subscribeForMessageEvents(threadId: string): Promise<void>;
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
     /**
-     * Unsubscribes from events in given Thread.
-     * @param {string} threadId ID of the Thread to unsubscribe
+     * Generate subscription Query for the Thread events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    unsubscribeFromMessageEvents(threadId: string): Promise<void>;
+    buildSubscriptionQuery(eventType: ThreadEventType, selectorType: ThreadEventSelectorType, selectorId: string): Promise<string>;
 }

package/service/ThreadApi.js

@@ -154,33 +154,58 @@ class ThreadApi extends BaseApi_1.BaseApi {
             data,
         ]);
     }
+    // /**
+    //  * Subscribes for the Thread module main events.
+    //  */
+    // async subscribeForThreadEvents(): Promise<void> {
+    //   return this.native.subscribeForThreadEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Unsubscribes from the Thread module main events.
+    //  */
+    // async unsubscribeFromThreadEvents(): Promise<void> {
+    //   return this.native.unsubscribeFromThreadEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Subscribes for events in given Thread.
+    //  * @param {string} threadId ID of the Thread to subscribe
+    //  */
+    // async subscribeForMessageEvents(threadId: string): Promise<void> {
+    //   return this.native.subscribeForMessageEvents(this.servicePtr, [threadId]);
+    // }
+    // /**
+    //  * Unsubscribes from events in given Thread.
+    //  * @param {string} threadId ID of the Thread to unsubscribe
+    //  */
+    // async unsubscribeFromMessageEvents(threadId: string): Promise<void> {
+    //   return this.native.unsubscribeFromMessageEvents(this.servicePtr, [
+    //     threadId,
+    //   ]);
+    // }
     /**
-     * Subscribes for the Thread module main events.
-     */
-    async subscribeForThreadEvents() {
-        return this.native.subscribeForThreadEvents(this.servicePtr, []);
-    }
-    /**
-     * Unsubscribes from the Thread module main events.
+     * Subscribe for the Thread events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    async unsubscribeFromThreadEvents() {
-        return this.native.unsubscribeFromThreadEvents(this.servicePtr, []);
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
     }
     /**
-     * Subscribes for events in given Thread.
-     * @param {string} threadId ID of the Thread to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    async subscribeForMessageEvents(threadId) {
-        return this.native.subscribeForMessageEvents(this.servicePtr, [threadId]);
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
     }
     /**
-     * Unsubscribes from events in given Thread.
-     * @param {string} threadId ID of the Thread to unsubscribe
+     * Generate subscription Query for the Thread events.
+     * @param {EventType} eventType type of event which you listen for
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    async unsubscribeFromMessageEvents(threadId) {
-        return this.native.unsubscribeFromMessageEvents(this.servicePtr, [
-            threadId,
-        ]);
+    async buildSubscriptionQuery(eventType, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [eventType, selectorType, selectorId]);
     }
 }
 exports.ThreadApi = ThreadApi;

package/service/index.d.ts

@@ -8,4 +8,5 @@ import { Connection } from "./Connection";
 import { EventQueue } from "./EventQueue";
 import { BaseApi } from "./BaseApi";
 import { ExtKey } from "./ExtKey";
-export { EndpointFactory, ThreadApi, StoreApi, InboxApi, KvdbApi, CryptoApi, Connection, EventQueue, BaseApi, ExtKey };
+import { EventApi } from "./EventApi";
+export { EndpointFactory, ThreadApi, StoreApi, InboxApi, KvdbApi, CryptoApi, Connection, EventQueue, BaseApi, ExtKey, EventApi };

package/service/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtKey = exports.BaseApi = exports.EventQueue = exports.Connection = exports.CryptoApi = exports.KvdbApi = exports.InboxApi = exports.StoreApi = exports.ThreadApi = exports.EndpointFactory = void 0;
+exports.EventApi = exports.ExtKey = exports.BaseApi = exports.EventQueue = exports.Connection = exports.CryptoApi = exports.KvdbApi = exports.InboxApi = exports.StoreApi = exports.ThreadApi = exports.EndpointFactory = void 0;
 const EndpointFactory_1 = require("./EndpointFactory");
 Object.defineProperty(exports, "EndpointFactory", { enumerable: true, get: function () { return EndpointFactory_1.EndpointFactory; } });
 const ThreadApi_1 = require("./ThreadApi");
@@ -21,3 +21,5 @@ const BaseApi_1 = require("./BaseApi");
 Object.defineProperty(exports, "BaseApi", { enumerable: true, get: function () { return BaseApi_1.BaseApi; } });
 const ExtKey_1 = require("./ExtKey");
 Object.defineProperty(exports, "ExtKey", { enumerable: true, get: function () { return ExtKey_1.ExtKey; } });
+const EventApi_1 = require("./EventApi");
+Object.defineProperty(exports, "EventApi", { enumerable: true, get: function () { return EventApi_1.EventApi; } });

package/extra/__tests__/__mocks__/constants.d.ts

@@ -1,36 +0,0 @@
-export declare const MOCK_INBOX_CREATED_EVENT: {
-    readonly type: "inboxCreated";
-    readonly data: {};
-    readonly channel: "inbox";
-    readonly connectionId: 1;
-};
-export declare const MOCK_INBOX_ENTRY_DELETED_EVENT: (inboxID: string) => {
-    readonly type: "inboxEntryDeleted";
-    readonly data: {};
-    readonly channel: `inbox/${string}/entries`;
-    readonly connectionId: 1;
-};
-export declare const MOCK_STORE_CREATED_EVENT: {
-    readonly type: "storeUpdated";
-    readonly data: {};
-    readonly channel: "store";
-    readonly connectionId: 1;
-};
-export declare const MOCK_STORE_FILE_DELETED_EVENT: (storeID: string) => {
-    readonly type: "storeFileCreated";
-    readonly data: {};
-    readonly channel: `store/${string}/files`;
-    readonly connectionId: 1;
-};
-export declare const MOCK_THREAD_CREATED_EVENT: {
-    readonly type: "threadUpdated";
-    readonly data: {};
-    readonly channel: "thread";
-    readonly connectionId: 1;
-};
-export declare const MOCK_THREAD_MESSAGE_DELETED_EVENT: (threadID: string) => {
-    readonly type: "threadNewMessage";
-    readonly data: {};
-    readonly channel: `thread/${string}/messages`;
-    readonly connectionId: 1;
-};