@simplito/privmx-webendpoint 2.0.5 → 2.2.0

package/service/InboxApi.d.ts

@@ -0,0 +1,183 @@
+/*!
+PrivMX Web Endpoint.
+Copyright © 2024 Simplito sp. z o.o.
+
+This file is part of the PrivMX Platform (https://privmx.dev).
+This software is Licensed under the PrivMX Free License.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import { BaseApi } from "./BaseApi";
+import { InboxApiNative } from "../api/InboxApiNative";
+import { PagingQuery, PagingList, UserWithPubKey, Inbox, InboxPublicView, InboxEntry, FilesConfig, ContainerWithoutItemPolicy } from "../Types";
+export declare class InboxApi extends BaseApi {
+    private native;
+    constructor(native: InboxApiNative, ptr: number);
+    /**
+     * Creates a new Inbox.
+     *
+     * @param {string} contextId ID of the Context of the new Inbox
+     * @param {UserWithPubKey[]} users vector of UserWithPubKey structs which indicates who will have access to the created Inbox
+     * @param {UserWithPubKey[]} managers vector of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Inbox
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {FilesConfig} filesConfig struct to override default file configuration
+     * @param {ContainerWithoutItemPolicy} policies Inbox policies
+     * @returns {string} ID of the created Inbox
+     */
+    createInbox(contextId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, filesConfig?: FilesConfig, policies?: ContainerWithoutItemPolicy): Promise<string>;
+    /**
+     * Updates an existing Inbox.
+     *
+     * @param {string} inboxId ID of the Inbox to update
+     * @param {UserWithPubKey[]} users vector of UserWithPubKey structs which indicates who will have access to the created Inbox
+     * @param {UserWithPubKey[]} managers vector of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Inbox
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {FilesConfig} filesConfig struct to override default files configuration
+     * @param {number} version current version of the updated Inbox
+     * @param {boolean} force force update (without checking version)
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Inbox
+     * @param {ContainerWithoutItemPolicy} policies Inbox policies
+     */
+    updateInbox(inboxId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, filesConfig: FilesConfig | undefined, version: number, force: boolean, forceGenerateNewKey: boolean, policies?: ContainerWithoutItemPolicy): Promise<void>;
+    /**
+     * Gets a single Inbox by given Inbox ID.
+     *
+     * @param {string} inboxId ID of the Inbox to get
+     * @returns {Inbox} struct containing information about the Inbox
+     */
+    getInbox(inboxId: string): Promise<Inbox>;
+    /**
+     * Gets s list of Inboxes in given Context.
+     *
+     * @param {string} contextId ID of the Context to get Inboxes from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Inbox>} struct containing list of Inboxes
+     */
+    listInboxes(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Inbox>>;
+    /**
+     * Gets public data of given Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxId ID of the Inbox to get
+     * @returns {InboxPublicView} struct containing public accessible information about the Inbox
+     */
+    getInboxPublicView(inboxId: string): Promise<InboxPublicView>;
+    /**
+     * Deletes an Inbox by given Inbox ID.
+     *
+     * @param {string} inboxId ID of the Inbox to delete
+     */
+    deleteInbox(inboxId: string): Promise<void>;
+    /**
+     * Prepares a request to send data to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxId ID of the Inbox to which the request applies
+     * @param {Uint8Array} data entry data to send
+     * @param {number[]} [inboxFileHandles] optional list of file handles that will be sent with the request
+     * @param {string} [userPrivKey] optional sender's private key which can be used later to encrypt data for that sender
+     * @returns {number} Inbox handle
+     */
+    prepareEntry(inboxId: string, data: Uint8Array, inboxFileHandles: number[], userPrivKey?: string | undefined): Promise<number>;
+    /**
+     * Sends data to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxHandle ID of the Inbox to which the request applies
+     */
+    sendEntry(inboxHandle: number): Promise<void>;
+    /**
+     * Gets an entry from an Inbox.
+     *
+     * @param {string} inboxEntryId ID of an entry to read from the Inbox
+     * @returns {InboxEntry} struct containing data of the selected entry stored in the Inbox
+     */
+    readEntry(inboxEntryId: string): Promise<InboxEntry>;
+    /**
+     * Gets list of entries in given Inbox.
+     *
+     * @param {string} inboxId ID of the Inbox
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<InboxEntry>} struct containing list of entries
+     */
+    listEntries(inboxId: string, pagingQuery: PagingQuery): Promise<PagingList<InboxEntry>>;
+    /**
+     * Delete an entry from an Inbox.
+     *
+     * @param {string} inboxEntryId ID of an entry to delete from the Inbox
+     */
+    deleteEntry(inboxEntryId: string): Promise<void>;
+    /**
+     * Creates a file handle to send a file to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {Uint8Array} publicMeta public file metadata
+     * @param {Uint8Array} privateMeta private file metadata
+     * @param {number} fileSize size of the file to send
+     * @returns {number} file handle
+     */
+    createFileHandle(publicMeta: Uint8Array, privateMeta: Uint8Array, fileSize: number): Promise<number>;
+    /**
+     * Sends a file's data chunk to an Inbox.
+     * (note: To send the entire file - divide it into pieces of the desired size and call the function for each fragment.)
+     * You do not have to be logged in to call this function.
+     *
+     * @param {number} inboxHandle Handle to the prepared Inbox entry
+     * @param {number} inboxFileHandle handle to the file where the uploaded chunk belongs
+     * @param {Uint8Array} dataChunk - file chunk to send
+     */
+    writeToFile(inboxHandle: number, inboxFileHandle: number, dataChunk: Uint8Array): Promise<void>;
+    /**
+     * Opens a file to read.
+     *
+     * @param {string} fileId ID of the file to read
+     * @returns {number} handle to read file data
+     */
+    openFile(fileId: string): Promise<number>;
+    /**
+     * Reads file data.
+     * Single read call moves the files's cursor position by declared length or set it at the end of the file.
+     *
+     * @param {number} fileHandle handle to the file
+     * @param {number} length size of data to read
+     * @returns {Uint8Array} buffer with file data chunk
+     */
+    readFromFile(fileHandle: number, length: number): Promise<Uint8Array>;
+    /**
+     * Moves file's read cursor.
+     *
+     * @param {number} fileHandle handle to the file
+     * @param {number} position sets new cursor position
+     */
+    seekInFile(fileHandle: number, position: number): Promise<void>;
+    /**
+     * Closes a file by given handle.
+     *
+     * @param {number} fileHandle handle to the file
+     * @returns {string} ID of closed file
+     */
+    closeFile(fileHandle: number): Promise<string>;
+    /**
+     * Subscribes for the Inbox module main events.
+     */
+    subscribeForInboxEvents(): Promise<void>;
+    /**
+     * Unsubscribes from the Inbox module main events.
+     */
+    unsubscribeFromInboxEvents(): Promise<void>;
+    /**
+     * Subscribes for events in given Inbox.
+     * @param {string} inboxId ID of the Inbox to subscribe
+     */
+    subscribeForEntryEvents(inboxId: string): Promise<void>;
+    /**
+     * Unsubscribes from events in given Inbox.
+     * @param {string} inboxId ID of the Inbox to unsubscribe
+     */
+    unsubscribeFromEntryEvents(inboxId: string): Promise<void>;
+}

package/service/InboxApi.js

@@ -0,0 +1,262 @@
+"use strict";
+/*!
+PrivMX Web Endpoint.
+Copyright © 2024 Simplito sp. z o.o.
+
+This file is part of the PrivMX Platform (https://privmx.dev).
+This software is Licensed under the PrivMX Free License.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InboxApi = void 0;
+const BaseApi_1 = require("./BaseApi");
+class InboxApi extends BaseApi_1.BaseApi {
+    native;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    /**
+     * Creates a new Inbox.
+     *
+     * @param {string} contextId ID of the Context of the new Inbox
+     * @param {UserWithPubKey[]} users vector of UserWithPubKey structs which indicates who will have access to the created Inbox
+     * @param {UserWithPubKey[]} managers vector of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Inbox
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {FilesConfig} filesConfig struct to override default file configuration
+     * @param {ContainerWithoutItemPolicy} policies Inbox policies
+     * @returns {string} ID of the created Inbox
+     */
+    async createInbox(contextId, users, managers, publicMeta, privateMeta, filesConfig, policies) {
+        return this.native.createInbox(this.servicePtr, [
+            contextId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            filesConfig,
+            policies,
+        ]);
+    }
+    /**
+     * Updates an existing Inbox.
+     *
+     * @param {string} inboxId ID of the Inbox to update
+     * @param {UserWithPubKey[]} users vector of UserWithPubKey structs which indicates who will have access to the created Inbox
+     * @param {UserWithPubKey[]} managers vector of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Inbox
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {FilesConfig} filesConfig struct to override default files configuration
+     * @param {number} version current version of the updated Inbox
+     * @param {boolean} force force update (without checking version)
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Inbox
+     * @param {ContainerWithoutItemPolicy} policies Inbox policies
+     */
+    async updateInbox(inboxId, users, managers, publicMeta, privateMeta, filesConfig, version, force, forceGenerateNewKey, policies) {
+        return this.native.updateInbox(this.servicePtr, [
+            inboxId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            filesConfig,
+            version,
+            force,
+            forceGenerateNewKey,
+            policies,
+        ]);
+    }
+    /**
+     * Gets a single Inbox by given Inbox ID.
+     *
+     * @param {string} inboxId ID of the Inbox to get
+     * @returns {Inbox} struct containing information about the Inbox
+     */
+    async getInbox(inboxId) {
+        return this.native.getInbox(this.servicePtr, [inboxId]);
+    }
+    /**
+     * Gets s list of Inboxes in given Context.
+     *
+     * @param {string} contextId ID of the Context to get Inboxes from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Inbox>} struct containing list of Inboxes
+     */
+    async listInboxes(contextId, pagingQuery) {
+        return this.native.listInboxes(this.servicePtr, [contextId, pagingQuery]);
+    }
+    /**
+     * Gets public data of given Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxId ID of the Inbox to get
+     * @returns {InboxPublicView} struct containing public accessible information about the Inbox
+     */
+    async getInboxPublicView(inboxId) {
+        return this.native.getInboxPublicView(this.servicePtr, [inboxId]);
+    }
+    /**
+     * Deletes an Inbox by given Inbox ID.
+     *
+     * @param {string} inboxId ID of the Inbox to delete
+     */
+    async deleteInbox(inboxId) {
+        return this.native.deleteInbox(this.servicePtr, [inboxId]);
+    }
+    /**
+     * Prepares a request to send data to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxId ID of the Inbox to which the request applies
+     * @param {Uint8Array} data entry data to send
+     * @param {number[]} [inboxFileHandles] optional list of file handles that will be sent with the request
+     * @param {string} [userPrivKey] optional sender's private key which can be used later to encrypt data for that sender
+     * @returns {number} Inbox handle
+     */
+    async prepareEntry(inboxId, data, inboxFileHandles, userPrivKey) {
+        return this.native.prepareEntry(this.servicePtr, [
+            inboxId,
+            data,
+            inboxFileHandles,
+            userPrivKey,
+        ]);
+    }
+    /**
+     * Sends data to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {string} inboxHandle ID of the Inbox to which the request applies
+     */
+    async sendEntry(inboxHandle) {
+        return this.native.sendEntry(this.servicePtr, [inboxHandle]);
+    }
+    /**
+     * Gets an entry from an Inbox.
+     *
+     * @param {string} inboxEntryId ID of an entry to read from the Inbox
+     * @returns {InboxEntry} struct containing data of the selected entry stored in the Inbox
+     */
+    async readEntry(inboxEntryId) {
+        return this.native.readEntry(this.servicePtr, [inboxEntryId]);
+    }
+    /**
+     * Gets list of entries in given Inbox.
+     *
+     * @param {string} inboxId ID of the Inbox
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<InboxEntry>} struct containing list of entries
+     */
+    async listEntries(inboxId, pagingQuery) {
+        return this.native.listEntries(this.servicePtr, [inboxId, pagingQuery]);
+    }
+    /**
+     * Delete an entry from an Inbox.
+     *
+     * @param {string} inboxEntryId ID of an entry to delete from the Inbox
+     */
+    async deleteEntry(inboxEntryId) {
+        return this.native.deleteEntry(this.servicePtr, [inboxEntryId]);
+    }
+    /**
+     * Creates a file handle to send a file to an Inbox.
+     * You do not have to be logged in to call this function.
+     *
+     * @param {Uint8Array} publicMeta public file metadata
+     * @param {Uint8Array} privateMeta private file metadata
+     * @param {number} fileSize size of the file to send
+     * @returns {number} file handle
+     */
+    async createFileHandle(publicMeta, privateMeta, fileSize) {
+        return this.native.createFileHandle(this.servicePtr, [
+            publicMeta,
+            privateMeta,
+            fileSize,
+        ]);
+    }
+    /**
+     * Sends a file's data chunk to an Inbox.
+     * (note: To send the entire file - divide it into pieces of the desired size and call the function for each fragment.)
+     * You do not have to be logged in to call this function.
+     *
+     * @param {number} inboxHandle Handle to the prepared Inbox entry
+     * @param {number} inboxFileHandle handle to the file where the uploaded chunk belongs
+     * @param {Uint8Array} dataChunk - file chunk to send
+     */
+    async writeToFile(inboxHandle, inboxFileHandle, dataChunk) {
+        return this.native.writeToFile(this.servicePtr, [
+            inboxHandle,
+            inboxFileHandle,
+            dataChunk,
+        ]);
+    }
+    /**
+     * Opens a file to read.
+     *
+     * @param {string} fileId ID of the file to read
+     * @returns {number} handle to read file data
+     */
+    async openFile(fileId) {
+        return this.native.openFile(this.servicePtr, [fileId]);
+    }
+    /**
+     * Reads file data.
+     * Single read call moves the files's cursor position by declared length or set it at the end of the file.
+     *
+     * @param {number} fileHandle handle to the file
+     * @param {number} length size of data to read
+     * @returns {Uint8Array} buffer with file data chunk
+     */
+    async readFromFile(fileHandle, length) {
+        return this.native.readFromFile(this.servicePtr, [fileHandle, length]);
+    }
+    /**
+     * Moves file's read cursor.
+     *
+     * @param {number} fileHandle handle to the file
+     * @param {number} position sets new cursor position
+     */
+    async seekInFile(fileHandle, position) {
+        return this.native.seekInFile(this.servicePtr, [fileHandle, position]);
+    }
+    /**
+     * Closes a file by given handle.
+     *
+     * @param {number} fileHandle handle to the file
+     * @returns {string} ID of closed file
+     */
+    async closeFile(fileHandle) {
+        return this.native.closeFile(this.servicePtr, [fileHandle]);
+    }
+    /**
+     * Subscribes for the Inbox module main events.
+     */
+    async subscribeForInboxEvents() {
+        return this.native.subscribeForInboxEvents(this.servicePtr, []);
+    }
+    /**
+     * Unsubscribes from the Inbox module main events.
+     */
+    async unsubscribeFromInboxEvents() {
+        return this.native.unsubscribeFromInboxEvents(this.servicePtr, []);
+    }
+    /**
+     * Subscribes for events in given Inbox.
+     * @param {string} inboxId ID of the Inbox to subscribe
+     */
+    async subscribeForEntryEvents(inboxId) {
+        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) {
+        return this.native.unsubscribeFromEntryEvents(this.servicePtr, [inboxId]);
+    }
+}
+exports.InboxApi = InboxApi;

package/service/StoreApi.d.ts

@@ -0,0 +1,170 @@
+/*!
+PrivMX Web Endpoint.
+Copyright © 2024 Simplito sp. z o.o.
+
+This file is part of the PrivMX Platform (https://privmx.dev).
+This software is Licensed under the PrivMX Free License.
+
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+import { BaseApi } from "./BaseApi";
+import { StoreApiNative } from "../api/StoreApiNative";
+import { PagingQuery, PagingList, UserWithPubKey, Store, File, ContainerPolicy } from "../Types";
+export declare class StoreApi extends BaseApi {
+    private native;
+    constructor(native: StoreApiNative, ptr: number);
+    /**
+     * Creates a new Store in given Context.
+     *
+     * @param {string} contextId ID of the Context to create the Store in
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Store
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to the
+     * created Store
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {ContainerPolicy} policies Store's policies
+     * @returns {string} created Store ID
+     */
+    createStore(contextId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, policies?: ContainerPolicy): Promise<string>;
+    /**
+     * Updates an existing Store.
+     *
+     * @param {string} storeId ID of the Store to update
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Store
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to the
+     * created Store
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {number} version current version of the updated Store
+     * @param {boolean} force force update (without checking version)
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Store
+     * @param {ContainerPolicy} policies Store's policies
+     */
+    updateStore(storeId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, version: number, force: boolean, forceGenerateNewKey: boolean, policies?: ContainerPolicy): Promise<void>;
+    /**
+     * Deletes a Store by given Store ID.
+     *
+     * @param {string} storeId ID of the Store to delete
+     */
+    deleteStore(storeId: string): Promise<void>;
+    /**
+     * Gets a single Store by given Store ID.
+     *
+     * @param {string} storeId ID of the Store to get
+     * @returns {Store} struct containing information about the Store
+     */
+    getStore(storeId: string): Promise<Store>;
+    /**
+     * Gets a list of Stores in given Context.
+     *
+     * @param {string} contextId ID of the Context to get the Stores from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Store>} struct containing list of Stores
+     */
+    listStores(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Store>>;
+    /**
+     * Creates a new file in a Store.
+     *
+     * @param {string} storeId ID of the Store to create the file in
+     * @param {Uint8Array} publicMeta public file metadata
+     * @param {Uint8Array} privateMeta private file metadata
+     * @param {number} size size of the file
+     * @returns {number} handle to write data
+     */
+    createFile(storeId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, size: number): Promise<number>;
+    /**
+     * Update an existing file in a Store.
+     *
+     * @param {string} fileId ID of the file to update
+     * @param {Uint8Array} publicMeta public file metadata
+     * @param {Uint8Array} privateMeta private file metadata
+     * @param {number} size size of the file
+     * @returns {number} handle to write file data
+     */
+    updateFile(fileId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, size: number): Promise<number>;
+    /**
+     * Update metadata of an existing file in a Store.
+     *
+     * @param {string} fileId ID of the file to update
+     * @param {Uint8Array} publicMeta public file metadata
+     * @param {Uint8Array} privateMeta private file metadata
+     */
+    updateFileMeta(fileId: string, publicMeta: Uint8Array, privateMeta: Uint8Array): Promise<void>;
+    /**
+     * Writes a file data.
+     *
+     * @param {number} fileHandle handle to write file data
+     * @param {Uint8Array} dataChunk file data chunk
+     */
+    writeToFile(fileHandle: number, dataChunk: Uint8Array): Promise<void>;
+    /**
+     * Deletes a file by given ID.
+     *
+     * @param {string} fileId ID of the file to delete
+     */
+    deleteFile(fileId: string): Promise<void>;
+    /**
+     * Gets a single file by the given file ID.
+     *
+     * @param {string} fileId ID of the file to get
+     * @returns {File} struct containing information about the file
+     */
+    getFile(fileId: string): Promise<File>;
+    /**
+     * Gets a list of files in given Store.
+     *
+     * @param {string} storeId ID of the Store to get files from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<File>} struct containing list of files
+     */
+    listFiles(storeId: string, pagingQuery: PagingQuery): Promise<PagingList<File>>;
+    /**
+     * Opens a file to read.
+     *
+     * @param {string} fileId ID of the file to read
+     * @returns {number} handle to read file data
+     */
+    openFile(fileId: string): Promise<number>;
+    /**
+     * Reads file data.
+     * Single read call moves the files's cursor position by declared length or set it at the end of the file.
+     *
+     * @param {string} fileHandle handle to write file data
+     * @param {number} length size of data to read
+     * @returns {Uint8Array} array buffer with file data chunk
+     */
+    readFromFile(fileHandle: number, length: number): Promise<Uint8Array>;
+    /**
+     * Moves read cursor.
+     *
+     * @param {string} fileHandle handle to write file data
+     * @param {number} position new cursor position
+     */
+    seekInFile(fileHandle: number, position: number): Promise<void>;
+    /**
+     * Closes the file handle.
+     *
+     * @param {string} fileHandle handle to read/write file data
+     * @returns {string} ID of closed file
+     */
+    closeFile(fileHandle: number): Promise<string>;
+    /**
+     * Subscribes for the Store module main events.
+     */
+    subscribeForStoreEvents(): Promise<void>;
+    /**
+     * Unsubscribes from the Store module main events.
+     */
+    unsubscribeFromStoreEvents(): Promise<void>;
+    /**
+     * Subscribes for events in given Store.
+     * @param {string} storeId ID of the Store to subscribe
+     */
+    subscribeForFileEvents(storeId: string): Promise<void>;
+    /**
+     * Unsubscribes from events in given Store.
+     * @param {string} storeId ID of the Store to unsubscribe
+     */
+    unsubscribeFromFileEvents(storeId: string): Promise<void>;
+}