@simplito/privmx-webendpoint 2.5.1 → 2.6.0

package/extra/subscriptions.d.ts

@@ -0,0 +1,165 @@
+import { Types } from "..";
+import { ThreadEventSelectorType, ThreadEventType } from "../Types";
+import { GenericEvent } from "./managers";
+export type ThreadCallbackPayload = {
+    [Types.ThreadEventType.THREAD_CREATE]: Types.Thread;
+    [Types.ThreadEventType.THREAD_UPDATE]: Types.Thread;
+    [Types.ThreadEventType.THREAD_DELETE]: {
+        threadId: string;
+    };
+    [Types.ThreadEventType.THREAD_STATS]: {
+        lastMsgDate: number;
+        messagesCount: number;
+        threadId: string;
+    };
+    [Types.ThreadEventType.MESSAGE_CREATE]: Types.Message;
+    [Types.ThreadEventType.MESSAGE_UPDATE]: Types.Message;
+    [Types.ThreadEventType.MESSAGE_DELETE]: {
+        threadId: string;
+        messageId: string;
+    };
+    [Types.ThreadEventType.COLLECTION_CHANGE]: Types.CollectionChangedEventData;
+};
+export type StoreCallbackPayload = {
+    [Types.StoreEventType.STORE_CREATE]: Types.Store;
+    [Types.StoreEventType.STORE_UPDATE]: Types.Store;
+    [Types.StoreEventType.STORE_DELETE]: {
+        storeId: string;
+    };
+    [Types.StoreEventType.STORE_STATS]: {
+        contextId: string;
+        storeId: string;
+        lastFileDate: number;
+        filesCount: number;
+    };
+    [Types.StoreEventType.FILE_CREATE]: Types.File;
+    [Types.StoreEventType.FILE_UPDATE]: Types.File;
+    [Types.StoreEventType.FILE_DELETE]: {
+        contextId: string;
+        storeId: string;
+        fileId: string;
+    };
+    [Types.StoreEventType.COLLECTION_CHANGE]: Types.CollectionChangedEventData;
+};
+export type InboxCallbackPayload = {
+    [Types.InboxEventType.INBOX_CREATE]: Types.Inbox;
+    [Types.InboxEventType.INBOX_UPDATE]: Types.Inbox;
+    [Types.InboxEventType.INBOX_DELETE]: {
+        inboxId: string;
+    };
+    [Types.InboxEventType.ENTRY_CREATE]: Types.InboxEntry;
+    [Types.InboxEventType.ENTRY_DELETE]: {
+        contextId: string;
+        inboxId: string;
+        entryId: string;
+    };
+    [Types.InboxEventType.COLLECTION_CHANGE]: Types.CollectionChangedEventData;
+};
+export type KvdbCallbackPayload = {
+    [Types.KvdbEventType.KVDB_STATS]: {
+        lastEntryDate: number;
+        entryCount: number;
+        kvdbId: string;
+    };
+    [Types.KvdbEventType.KVDB_CREATE]: Types.Kvdb;
+    [Types.KvdbEventType.KVDB_UPDATE]: Types.Kvdb;
+    [Types.KvdbEventType.KVDB_DELETE]: {
+        kvdbId: string;
+    };
+    [Types.KvdbEventType.ENTRY_UPDATE]: Types.KvdbEntry;
+    [Types.KvdbEventType.ENTRY_CREATE]: Types.KvdbEntry;
+    [Types.KvdbEventType.ENTRY_DELETE]: {
+        contextId: string;
+        kvdbId: string;
+        entryId: string;
+    };
+    [Types.KvdbEventType.COLLECTION_CHANGE]: Types.CollectionChangedEventData;
+};
+export type EventCallback = {
+    callback: (e: Types.Event) => void;
+    symbol: Symbol;
+};
+export interface Subscription<T, S> {
+    type: T;
+    selector: S;
+    id: string;
+    callbacks: EventCallback[];
+}
+export declare function createThreadSubscription<T extends Types.ThreadEventType, S extends Types.ThreadEventSelectorType>(s: {
+    type: T;
+    selector: S;
+    id: string;
+    callbacks: ((arg: GenericEvent<ThreadCallbackPayload[T]>) => void)[];
+}): {
+    callbacks: EventCallback[];
+    type: T;
+    selector: S;
+    id: string;
+};
+export declare function createStoreSubscription<T extends Types.StoreEventType, S extends Types.StoreEventSelectorType>(s: {
+    type: T;
+    selector: S;
+    id: string;
+    callbacks: ((arg: GenericEvent<StoreCallbackPayload[T]>) => void)[];
+}): {
+    callbacks: EventCallback[];
+    type: T;
+    selector: S;
+    id: string;
+};
+export declare function createKvdbSubscription<T extends Types.KvdbEventType, S extends Types.KvdbEventSelectorType>(s: {
+    type: T;
+    selector: S;
+    id: string;
+    callbacks: ((arg: GenericEvent<KvdbCallbackPayload[T]>) => void)[];
+}): {
+    callbacks: EventCallback[];
+    type: T;
+    selector: S;
+    id: string;
+};
+export declare function createInboxSubscription<T extends Types.InboxEventType, S extends Types.InboxEventSelectorType>(s: {
+    type: T;
+    selector: S;
+    id: string;
+    callbacks: ((arg: GenericEvent<InboxCallbackPayload[T]>) => void)[];
+}): {
+    callbacks: EventCallback[];
+    type: T;
+    selector: S;
+    id: string;
+};
+export declare enum ConnectionEventType {
+    LIB_DISCONNECTED = 0,
+    LIB_PLATFORM_DISCONNECTED = 1,
+    LIB_CONNECTED = 2
+}
+export declare function createConnectionSubscription(s: {
+    type: ConnectionEventType;
+    callbacks: ((arg: GenericEvent<undefined>) => void)[];
+}): {
+    callbacks: EventCallback[];
+    type: ConnectionEventType;
+};
+export interface EventSubscriber<E, S> {
+    /**
+     * Subscribe for the Thread events on the given subscription query.
+     * @param {string[]} subscriptionQueries list of queries
+     */
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
+    /**
+     * Unsubscribes from events for the given subscriptionId.
+     */
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
+    /**
+     * 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
+     */
+    buildSubscriptionQuery(eventType: E, selectorType: S, selectorId: string): Promise<string>;
+}
+export type SubscriberForThreadsEvents = EventSubscriber<ThreadEventType, ThreadEventSelectorType>;
+export type SubscriberForStoreEvents = EventSubscriber<Types.StoreEventType, Types.StoreEventSelectorType>;
+export type SubscriberForInboxEvents = EventSubscriber<Types.InboxEventType, Types.InboxEventSelectorType>;
+export type SubscriberForKvdbEvents = EventSubscriber<Types.KvdbEventType, Types.KvdbEventSelectorType>;

package/extra/subscriptions.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionEventType = void 0;
+exports.createThreadSubscription = createThreadSubscription;
+exports.createStoreSubscription = createStoreSubscription;
+exports.createKvdbSubscription = createKvdbSubscription;
+exports.createInboxSubscription = createInboxSubscription;
+exports.createConnectionSubscription = createConnectionSubscription;
+const __1 = require("..");
+function toEventCallback(f) {
+    return {
+        callback: f,
+        symbol: Symbol()
+    };
+}
+function createThreadSubscription(s) {
+    return {
+        ...s,
+        callbacks: s.callbacks.map(toEventCallback)
+    };
+}
+function createStoreSubscription(s) {
+    return {
+        ...s,
+        callbacks: s.callbacks.map(toEventCallback)
+    };
+}
+function createKvdbSubscription(s) {
+    return {
+        ...s,
+        callbacks: s.callbacks.map(toEventCallback)
+    };
+}
+function createInboxSubscription(s) {
+    return {
+        ...s,
+        callbacks: s.callbacks.map(toEventCallback)
+    };
+}
+var ConnectionEventType;
+(function (ConnectionEventType) {
+    ConnectionEventType[ConnectionEventType["LIB_DISCONNECTED"] = 0] = "LIB_DISCONNECTED";
+    ConnectionEventType[ConnectionEventType["LIB_PLATFORM_DISCONNECTED"] = 1] = "LIB_PLATFORM_DISCONNECTED";
+    ConnectionEventType[ConnectionEventType["LIB_CONNECTED"] = 2] = "LIB_CONNECTED";
+})(ConnectionEventType || (exports.ConnectionEventType = ConnectionEventType = {}));
+function createConnectionSubscription(s) {
+    return {
+        ...s,
+        callbacks: s.callbacks.map(toEventCallback)
+    };
+}

package/extra/utils.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.strToUint8 = exports.uint8ToStr = exports.deserializeObject = exports.serializeObject = void 0;
+exports.serializeObject = serializeObject;
+exports.deserializeObject = deserializeObject;
+exports.uint8ToStr = uint8ToStr;
+exports.strToUint8 = strToUint8;
 /**
  * Helper function to convert objects to Uint8Array
  * @param {Record<string, any>} object - The object to serialize
@@ -14,7 +17,6 @@ function serializeObject(object) {
     const parsed = JSON.stringify(object);
     return encoder.encode(parsed);
 }
-exports.serializeObject = serializeObject;
 /**
  * Helper function to convert Uint8Array to objects
  * @param {Uint8Array} data - The data to deserialize
@@ -41,7 +43,6 @@ function deserializeObject(data) {
         }
     }
 }
-exports.deserializeObject = deserializeObject;
 /**
  * Convert Uint8Array to a string
  * @param {Uint8Array} arr - The array to convert
@@ -53,7 +54,6 @@ function uint8ToStr(arr) {
     }
     return new TextDecoder().decode(arr);
 }
-exports.uint8ToStr = uint8ToStr;
 /**
  * Convert a string to Uint8Array
  * @param {string} text - The text to convert
@@ -65,4 +65,3 @@ function strToUint8(text) {
     }
     return new TextEncoder().encode(text);
 }
-exports.strToUint8 = strToUint8;

package/index.d.ts

@@ -9,6 +9,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { EndpointFactory } from "./service/EndpointFactory";
-import { EventQueue, StoreApi, ThreadApi, InboxApi, KvdbApi, Connection, CryptoApi, BaseApi, ExtKey } from "./service";
+import { EventQueue, StoreApi, ThreadApi, InboxApi, KvdbApi, Connection, CryptoApi, BaseApi, ExtKey, EventApi } from "./service";
 import * as Types from "./Types";
-export { EndpointFactory as Endpoint, Types, EventQueue, StoreApi, ThreadApi, InboxApi, KvdbApi, CryptoApi, Connection, BaseApi, ExtKey };
+export { EndpointFactory as Endpoint, Types, EventQueue, StoreApi, ThreadApi, InboxApi, KvdbApi, CryptoApi, Connection, BaseApi, ExtKey, EventApi };

package/index.js

@@ -10,7 +10,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtKey = exports.BaseApi = exports.Connection = exports.CryptoApi = exports.KvdbApi = exports.InboxApi = exports.ThreadApi = exports.StoreApi = exports.EventQueue = exports.Types = exports.Endpoint = void 0;
+exports.EventApi = exports.ExtKey = exports.BaseApi = exports.Connection = exports.CryptoApi = exports.KvdbApi = exports.InboxApi = exports.ThreadApi = exports.StoreApi = exports.EventQueue = exports.Types = exports.Endpoint = void 0;
 const EndpointFactory_1 = require("./service/EndpointFactory");
 Object.defineProperty(exports, "Endpoint", { enumerable: true, get: function () { return EndpointFactory_1.EndpointFactory; } });
 const service_1 = require("./service");
@@ -23,5 +23,6 @@ Object.defineProperty(exports, "Connection", { enumerable: true, get: function (
 Object.defineProperty(exports, "CryptoApi", { enumerable: true, get: function () { return service_1.CryptoApi; } });
 Object.defineProperty(exports, "BaseApi", { enumerable: true, get: function () { return service_1.BaseApi; } });
 Object.defineProperty(exports, "ExtKey", { enumerable: true, get: function () { return service_1.ExtKey; } });
+Object.defineProperty(exports, "EventApi", { enumerable: true, get: function () { return service_1.EventApi; } });
 const Types = require("./Types");
 exports.Types = Types;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplito/privmx-webendpoint",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "description": "PrivMX Web Endpoint library",
   "author": "Simplito",
   "license": "PrivMX Free License",
@@ -37,7 +37,7 @@
     "./extra": "./extra/index.js"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "compile": "tsc",
     "build": "npm run clean && npm run build:bundle && npm run build:mjs && npm run build:fixup",
     "clean": "rm -rf ./dist",
@@ -50,31 +50,30 @@
     "node": ">=4"
   },
   "devDependencies": {
+    "@babel/core": "^7.26.0",
+    "@babel/preset-env": "^7.26.0",
+    "@types/jest": "^29.5.14",
     "@types/node": "^20.9.0",
     "@types/webpack": "^5.28.5",
     "assert": "^2.1.0",
+    "babel-jest": "^29.7.0",
     "buffer": "^6.0.3",
     "crypto-browserify": "^3.12.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
+    "ts-jest": "^29.2.5",
     "ts-loader": "^9.5.1",
     "ts-node": "^10.9.1",
     "tslib": "^2.6.2",
-    "typescript": "^5.2.2",
+    "typescript": "5.8",
     "vm-browserify": "^1.1.2",
     "webpack": "^5.89.0",
     "webpack-cli": "^5.1.4",
-    "webpack-dev-server": "^4.15.1",
-    "@babel/core": "^7.26.0",
-    "@babel/preset-env": "^7.26.0",
-    "@types/jest": "^29.5.14",
-    "babel-jest": "^29.7.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.4.2",
-    "ts-jest": "^29.2.5"
+    "webpack-dev-server": "^4.15.1"
   },
   "dependencies": {
-      "elliptic": "^6.6.1"
+    "elliptic": "^6.6.1"
   }
 }
-

package/service/Connection.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { ConnectionNative } from "../api/ConnectionNative";
-import { PagingQuery, PagingList, Context, UserInfo } from "../Types";
+import { PagingQuery, PagingList, Context, UserInfo, ConnectionEventType, ConnectionEventSelectorType } from "../Types";
 import { BaseNative } from "../api/BaseNative";
 import { UserVerifierInterface } from "./UserVerifierInterface";
 export declare class Connection extends BaseApi {
@@ -50,7 +50,26 @@ export declare class Connection extends BaseApi {
      *
      * @returns a list of the UserInfo objects
      */
-    getContextUsers(contextId: string): Promise<UserInfo[]>;
+    listContextUsers(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<UserInfo>>;
+    /**
+     * Subscribe for the Context events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in matching order to subscriptionQueries
+     */
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
+    /**
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
+     */
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
+    /**
+     * Generate subscription Query for the Context 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
+     */
+    buildSubscriptionQuery(eventType: ConnectionEventType, selectorType: ConnectionEventSelectorType, selectorId: string): Promise<string>;
     /**
      * Disconnects from the Platform backend.
      *

package/service/Connection.js

@@ -50,8 +50,33 @@ class Connection extends BaseApi_1.BaseApi {
      *
      * @returns a list of the UserInfo objects
      */
-    async getContextUsers(contextId) {
-        return this.native.getContextUsers(this.servicePtr, [contextId]);
+    async listContextUsers(contextId, pagingQuery) {
+        return this.native.listContextUsers(this.servicePtr, [contextId, pagingQuery]);
+    }
+    /**
+     * Subscribe for the Context events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in matching order to subscriptionQueries
+     */
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
+    }
+    /**
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
+     */
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
+    }
+    /**
+     * Generate subscription Query for the Context 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 buildSubscriptionQuery(eventType, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [eventType, selectorType, selectorId]);
     }
     /**
      * Disconnects from the Platform backend.

package/service/CryptoApi.d.ts

@@ -101,7 +101,7 @@ export declare class CryptoApi extends BaseApi {
     /**
      * Generates ECC key using BIP-39 mnemonic.
      *
-     * @param {string} mnemonic the BIP-39 entropy used to generate the Key
+     * @param {string} mnemonic the BIP-39 mnemonic used to generate the Key
      * @param {string} password the password used to generate the Key
      * @return BIP39_t object containing ECC Key and associated with it BIP-39 mnemonic and entropy
      */

package/service/CryptoApi.js

@@ -133,7 +133,7 @@ class CryptoApi extends BaseApi_1.BaseApi {
     /**
      * Generates ECC key using BIP-39 mnemonic.
      *
-     * @param {string} mnemonic the BIP-39 entropy used to generate the Key
+     * @param {string} mnemonic the BIP-39 mnemonic used to generate the Key
      * @param {string} password the password used to generate the Key
      * @return BIP39_t object containing ECC Key and associated with it BIP-39 mnemonic and entropy
      */

package/service/EventApi.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { EventApiNative } from "../api/EventApiNative";
-import { UserWithPubKey } from "../Types";
+import { EventsEventSelectorType, UserWithPubKey } from "../Types";
 export declare class EventApi extends BaseApi {
     private native;
     constructor(native: EventApiNative, ptr: number);
@@ -24,17 +24,22 @@ export declare class EventApi extends BaseApi {
      */
     emitEvent(contextId: string, channelName: string, eventData: Uint8Array, users: UserWithPubKey[]): Promise<void>;
     /**
-     * Subscribe for the custom events on the given channel.
+     * Subscribe for the custom events on the given subscription query.
      *
-     * @param {string} contextId ID of the Context
-     * @param {string} channelName name of the Channel
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    subscribeForCustomEvents(contextId: string, channelName: string): Promise<void>;
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
     /**
-     * Unsubscribe from the custom events on the given channel.
-     *
-     * @param {string} contextId ID of the Context
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
+     */
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
+    /**
+     * Generate subscription Query for the custom events.
      * @param {string} channelName name of the Channel
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    unsubscribeFromCustomEvents(contextId: string, channelName: string): Promise<void>;
+    buildSubscriptionQuery(channelName: string, selectorType: EventsEventSelectorType, selectorId: string): Promise<string>;
 }

package/service/EventApi.js

@@ -38,23 +38,48 @@ class EventApi extends BaseApi_1.BaseApi {
     async emitEvent(contextId, channelName, eventData, users) {
         return this.native.emitEvent(this.servicePtr, [contextId, channelName, eventData, users]);
     }
+    // /**
+    //  * Subscribe for the custom events on the given channel.
+    //  * 
+    //  * @param {string} contextId ID of the Context
+    //  * @param {string} channelName name of the Channel
+    //  */
+    // async subscribeForCustomEvents(contextId: string, channelName: string) {
+    //   return this.native.subscribeForCustomEvents(this.servicePtr, [contextId, channelName]);
+    // }
+    // /**
+    //  * Unsubscribe from the custom events on the given channel.
+    //  * 
+    //  * @param {string} contextId ID of the Context
+    //  * @param {string} channelName name of the Channel
+    //  */
+    // async unsubscribeFromCustomEvents(contextId: string, channelName: string) {
+    //   return this.native.unsubscribeFromCustomEvents(this.servicePtr, [contextId, channelName]);
+    // }
     /**
-     * Subscribe for the custom events on the given channel.
+     * Subscribe for the custom events on the given subscription query.
      *
-     * @param {string} contextId ID of the Context
-     * @param {string} channelName name of the Channel
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    async subscribeForCustomEvents(contextId, channelName) {
-        return this.native.subscribeForCustomEvents(this.servicePtr, [contextId, channelName]);
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
     }
     /**
-     * Unsubscribe from the custom events on the given channel.
-     *
-     * @param {string} contextId ID of the Context
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
+     */
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
+    }
+    /**
+     * Generate subscription Query for the custom events.
      * @param {string} channelName name of the Channel
+     * @param {EventSelectorType} selectorType scope on which you listen for events
+     * @param {string} selectorId ID of the selector
      */
-    async unsubscribeFromCustomEvents(contextId, channelName) {
-        return this.native.unsubscribeFromCustomEvents(this.servicePtr, [contextId, channelName]);
+    async buildSubscriptionQuery(channelName, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [channelName, selectorType, selectorId]);
     }
 }
 exports.EventApi = EventApi;

package/service/InboxApi.d.ts

@@ -10,7 +10,7 @@ limitations under the License.
 */
 import { BaseApi } from "./BaseApi";
 import { InboxApiNative } from "../api/InboxApiNative";
-import { PagingQuery, PagingList, UserWithPubKey, Inbox, InboxPublicView, InboxEntry, FilesConfig, ContainerWithoutItemPolicy } from "../Types";
+import { PagingQuery, PagingList, UserWithPubKey, Inbox, InboxPublicView, InboxEntry, FilesConfig, ContainerWithoutItemPolicy, InboxEventType, InboxEventSelectorType } from "../Types";
 export declare class InboxApi extends BaseApi {
     private native;
     constructor(native: InboxApiNative, ptr: number);
@@ -163,21 +163,22 @@ export declare class InboxApi extends BaseApi {
      */
     closeFile(fileHandle: number): Promise<string>;
     /**
-     * Subscribes for the Inbox module main events.
-     */
-    subscribeForInboxEvents(): Promise<void>;
-    /**
-     * Unsubscribes from the Inbox module main events.
+     * Subscribe for the Inbox events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    unsubscribeFromInboxEvents(): Promise<void>;
+    subscribeFor(subscriptionQueries: string[]): Promise<string[]>;
     /**
-     * Subscribes for events in given Inbox.
-     * @param {string} inboxId ID of the Inbox to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    subscribeForEntryEvents(inboxId: string): Promise<void>;
+    unsubscribeFrom(subscriptionIds: string[]): Promise<void>;
     /**
-     * Unsubscribes from events in given Inbox.
-     * @param {string} inboxId ID of the Inbox to unsubscribe
+     * Generate subscription Query for the Inbox 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
      */
-    unsubscribeFromEntryEvents(inboxId: string): Promise<void>;
+    buildSubscriptionQuery(eventType: InboxEventType, selectorType: InboxEventSelectorType, selectorId: string): Promise<string>;
 }

package/service/InboxApi.js

@@ -232,31 +232,56 @@ class InboxApi extends BaseApi_1.BaseApi {
     async closeFile(fileHandle) {
         return this.native.closeFile(this.servicePtr, [fileHandle]);
     }
+    // /**
+    //  * Subscribes for the Inbox module main events.
+    //  */
+    // async subscribeForInboxEvents(): Promise<void> {
+    //   return this.native.subscribeForInboxEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Unsubscribes from the Inbox module main events.
+    //  */
+    // async unsubscribeFromInboxEvents(): Promise<void> {
+    //   return this.native.unsubscribeFromInboxEvents(this.servicePtr, []);
+    // }
+    // /**
+    //  * Subscribes for events in given Inbox.
+    //  * @param {string} inboxId ID of the Inbox to subscribe
+    //  */
+    // async subscribeForEntryEvents(inboxId: string): Promise<void> {
+    //   return this.native.subscribeForEntryEvents(this.servicePtr, [inboxId]);
+    // }
+    // /**
+    //  * Unsubscribes from events in given Inbox.
+    //  * @param {string} inboxId ID of the Inbox to unsubscribe
+    //  */
+    // async unsubscribeFromEntryEvents(inboxId: string): Promise<void> {
+    //   return this.native.unsubscribeFromEntryEvents(this.servicePtr, [inboxId]);
+    // }
     /**
-     * Subscribes for the Inbox module main events.
-     */
-    async subscribeForInboxEvents() {
-        return this.native.subscribeForInboxEvents(this.servicePtr, []);
-    }
-    /**
-     * Unsubscribes from the Inbox module main events.
+     * Subscribe for the Inbox events on the given subscription query.
+     *
+     * @param {string[]} subscriptionQueries list of queries
+     * @return list of subscriptionIds in maching order to subscriptionQueries
      */
-    async unsubscribeFromInboxEvents() {
-        return this.native.unsubscribeFromInboxEvents(this.servicePtr, []);
+    async subscribeFor(subscriptionQueries) {
+        return this.native.subscribeFor(this.servicePtr, [subscriptionQueries]);
     }
     /**
-     * Subscribes for events in given Inbox.
-     * @param {string} inboxId ID of the Inbox to subscribe
+     * Unsubscribe from events for the given subscriptionId.
+     * @param {string[]} subscriptionIds list of subscriptionId
      */
-    async subscribeForEntryEvents(inboxId) {
-        return this.native.subscribeForEntryEvents(this.servicePtr, [inboxId]);
+    async unsubscribeFrom(subscriptionIds) {
+        return this.native.unsubscribeFrom(this.servicePtr, [subscriptionIds]);
     }
     /**
-     * Unsubscribes from events in given Inbox.
-     * @param {string} inboxId ID of the Inbox to unsubscribe
+     * Generate subscription Query for the Inbox 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 unsubscribeFromEntryEvents(inboxId) {
-        return this.native.unsubscribeFromEntryEvents(this.servicePtr, [inboxId]);
+    async buildSubscriptionQuery(eventType, selectorType, selectorId) {
+        return this.native.buildSubscriptionQuery(this.servicePtr, [eventType, selectorType, selectorId]);
     }
 }
 exports.InboxApi = InboxApi;