@simplito/privmx-webendpoint 2.1.1 → 2.2.1

package/service/StoreApi.js

@@ -0,0 +1,246 @@
+"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.StoreApi = void 0;
+const BaseApi_1 = require("./BaseApi");
+class StoreApi extends BaseApi_1.BaseApi {
+    native;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    /**
+     * 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
+     */
+    async createStore(contextId, users, managers, publicMeta, privateMeta, policies) {
+        return this.native.createStore(this.servicePtr, [
+            contextId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            policies
+        ]);
+    }
+    /**
+     * 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
+     */
+    async updateStore(storeId, users, managers, publicMeta, privateMeta, version, force, forceGenerateNewKey, policies) {
+        return this.native.updateStore(this.servicePtr, [
+            storeId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            version,
+            force,
+            forceGenerateNewKey,
+            policies
+        ]);
+    }
+    /**
+     * Deletes a Store by given Store ID.
+     *
+     * @param {string} storeId ID of the Store to delete
+     */
+    async deleteStore(storeId) {
+        return this.native.deleteStore(this.servicePtr, [storeId]);
+    }
+    /**
+     * 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
+     */
+    async getStore(storeId) {
+        return this.native.getStore(this.servicePtr, [storeId]);
+    }
+    /**
+     * 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
+     */
+    async listStores(contextId, pagingQuery) {
+        return this.native.listStores(this.servicePtr, [contextId, pagingQuery]);
+    }
+    /**
+     * 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
+     */
+    async createFile(storeId, publicMeta, privateMeta, size) {
+        return this.native.createFile(this.servicePtr, [
+            storeId,
+            publicMeta,
+            privateMeta,
+            size,
+        ]);
+    }
+    /**
+     * 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
+     */
+    async updateFile(fileId, publicMeta, privateMeta, size) {
+        return this.native.updateFile(this.servicePtr, [
+            fileId,
+            publicMeta,
+            privateMeta,
+            size,
+        ]);
+    }
+    /**
+     * 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
+     */
+    async updateFileMeta(fileId, publicMeta, privateMeta) {
+        return this.native.updateFileMeta(this.servicePtr, [
+            fileId,
+            publicMeta,
+            privateMeta,
+        ]);
+    }
+    /**
+     * Writes a file data.
+     *
+     * @param {number} fileHandle handle to write file data
+     * @param {Uint8Array} dataChunk file data chunk
+     */
+    async writeToFile(fileHandle, dataChunk) {
+        return this.native.writeToFile(this.servicePtr, [fileHandle, dataChunk]);
+    }
+    /**
+     * Deletes a file by given ID.
+     *
+     * @param {string} fileId ID of the file to delete
+     */
+    async deleteFile(fileId) {
+        return this.native.deleteFile(this.servicePtr, [fileId]);
+    }
+    /**
+     * 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
+     */
+    async getFile(fileId) {
+        return this.native.getFile(this.servicePtr, [fileId]);
+    }
+    /**
+     * 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
+     */
+    async listFiles(storeId, pagingQuery) {
+        return this.native.listFiles(this.servicePtr, [storeId, pagingQuery]);
+    }
+    /**
+     * 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 {string} fileHandle handle to write file data
+     * @param {number} length size of data to read
+     * @returns {Uint8Array} array buffer with file data chunk
+     */
+    async readFromFile(fileHandle, length) {
+        return this.native.readFromFile(this.servicePtr, [fileHandle, length]);
+    }
+    /**
+     * Moves read cursor.
+     *
+     * @param {string} fileHandle handle to write file data
+     * @param {number} position new cursor position
+     */
+    async seekInFile(fileHandle, position) {
+        return this.native.seekInFile(this.servicePtr, [fileHandle, position]);
+    }
+    /**
+     * Closes the file handle.
+     *
+     * @param {string} fileHandle handle to read/write file data
+     * @returns {string} ID of closed file
+     */
+    async closeFile(fileHandle) {
+        return this.native.closeFile(this.servicePtr, [fileHandle]);
+    }
+    /**
+     * Subscribes for the Store module main events.
+     */
+    async subscribeForStoreEvents() {
+        return this.native.subscribeForStoreEvents(this.servicePtr, []);
+    }
+    /**
+     * Unsubscribes from the Store module main events.
+     */
+    async unsubscribeFromStoreEvents() {
+        return this.native.unsubscribeFromStoreEvents(this.servicePtr, []);
+    }
+    /**
+     * Subscribes for events in given Store.
+     * @param {string} storeId ID of the Store to subscribe
+     */
+    async subscribeForFileEvents(storeId) {
+        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) {
+        return this.native.unsubscribeFromFileEvents(this.servicePtr, [storeId]);
+    }
+}
+exports.StoreApi = StoreApi;

package/service/ThreadApi.d.ts

@@ -0,0 +1,124 @@
+/*!
+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 { ThreadApiNative } from "../api/ThreadApiNative";
+import { PagingQuery, PagingList, UserWithPubKey, Thread, Message, ContainerPolicy } from "../Types";
+export declare class ThreadApi extends BaseApi {
+    protected native: ThreadApiNative;
+    constructor(native: ThreadApiNative, ptr: number);
+    /**
+     * Creates a new Thread in given Context.
+     *
+     * @param {string} contextId ID of the Context to create the Thread in
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Thread
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Thread
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {ContainerPolicy} policies Thread's policies
+     * @returns {string} ID of the created Thread
+     */
+    createThread(contextId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, policies?: ContainerPolicy): Promise<string>;
+    /**
+     * Updates an existing Thread.
+     *
+     * @param {string} threadId ID of the Thread to update
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Thread
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Thread
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {number} version current version of the updated Thread
+     * @param {boolean} force force update (without checking version)
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Thread
+     * @param {ContainerPolicy} policies Thread's policies
+     */
+    updateThread(threadId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, version: number, force: boolean, forceGenerateNewKey: boolean, policies?: ContainerPolicy): Promise<void>;
+    /**
+     * Deletes a Thread by given Thread ID.
+     *
+     * @param {string} threadId ID of the Thread to delete
+     */
+    deleteThread(threadId: string): Promise<void>;
+    /**
+     * Gets a Thread by given Thread ID.
+     *
+     * @param {string} threadId ID of Thread to get
+     * @returns {Thread} struct containing info about the Thread
+     */
+    getThread(threadId: string): Promise<Thread>;
+    /**
+     * Gets a list of Threads in given Context.
+     *
+     * @param {string} contextId ID of the Context to get the Threads from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Thread>} struct containing a list of Threads
+     */
+    listThreads(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Thread>>;
+    /**
+     * Gets a message by given message ID.
+     *
+     * @param {string} messageId ID of the message to get
+     * @returns {Message} struct containing the message
+     */
+    getMessage(messageId: string): Promise<Message>;
+    /**
+     * Gets a list of messages from a Thread.
+     *
+     * @param {string} threadId ID of the Thread to list messages from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Message>} struct containing a list of messages
+     */
+    listMessages(threadId: string, pagingQuery: PagingQuery): Promise<PagingList<Message>>;
+    /**
+     * Sends a message in a Thread.
+     *
+     * @param {string} threadId ID of the Thread to send message to
+     * @param {Uint8Array} publicMeta public message metadata
+     * @param {Uint8Array} privateMeta private message metadata
+     * @param {Uint8Array} data content of the message
+     * @returns {string} ID of the new message
+     */
+    sendMessage(threadId: string, publicMeta: Uint8Array, privateMeta: Uint8Array, data: Uint8Array): Promise<string>;
+    /**
+     * Deletes a message by given message ID.
+     *
+     * @param {string} messageId ID of the message to delete
+     */
+    deleteMessage(messageId: string): Promise<void>;
+    /**
+     * Update message in a Thread.
+     *
+     * @param {string} messageId ID of the message to update
+     * @param {Uint8Array} publicMeta public message metadata
+     * @param {Uint8Array} privateMeta private message metadata
+     * @param {Uint8Array} data content of the message
+     */
+    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.
+     */
+    unsubscribeFromThreadEvents(): Promise<void>;
+    /**
+     * Subscribes for events in given Thread.
+     * @param {string} threadId ID of the Thread to subscribe
+     */
+    subscribeForMessageEvents(threadId: string): Promise<void>;
+    /**
+     * Unsubscribes from events in given Thread.
+     * @param {string} threadId ID of the Thread to unsubscribe
+     */
+    unsubscribeFromMessageEvents(threadId: string): Promise<void>;
+}

package/service/ThreadApi.js

@@ -0,0 +1,186 @@
+"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.ThreadApi = void 0;
+const BaseApi_1 = require("./BaseApi");
+class ThreadApi extends BaseApi_1.BaseApi {
+    native;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    /**
+     * Creates a new Thread in given Context.
+     *
+     * @param {string} contextId ID of the Context to create the Thread in
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Thread
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Thread
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {ContainerPolicy} policies Thread's policies
+     * @returns {string} ID of the created Thread
+     */
+    async createThread(contextId, users, managers, publicMeta, privateMeta, policies) {
+        return this.native.createThread(this.servicePtr, [
+            contextId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            policies,
+        ]);
+    }
+    /**
+     * Updates an existing Thread.
+     *
+     * @param {string} threadId ID of the Thread to update
+     * @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created Thread
+     * @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
+     * the created Thread
+     * @param {Uint8Array} publicMeta public (unencrypted) metadata
+     * @param {Uint8Array} privateMeta private (encrypted) metadata
+     * @param {number} version current version of the updated Thread
+     * @param {boolean} force force update (without checking version)
+     * @param {boolean} forceGenerateNewKey force to regenerate a key for the Thread
+     * @param {ContainerPolicy} policies Thread's policies
+     */
+    async updateThread(threadId, users, managers, publicMeta, privateMeta, version, force, forceGenerateNewKey, policies) {
+        return this.native.updateThread(this.servicePtr, [
+            threadId,
+            users,
+            managers,
+            publicMeta,
+            privateMeta,
+            version,
+            force,
+            forceGenerateNewKey,
+            policies,
+        ]);
+    }
+    /**
+     * Deletes a Thread by given Thread ID.
+     *
+     * @param {string} threadId ID of the Thread to delete
+     */
+    async deleteThread(threadId) {
+        return this.native.deleteThread(this.servicePtr, [threadId]);
+    }
+    /**
+     * Gets a Thread by given Thread ID.
+     *
+     * @param {string} threadId ID of Thread to get
+     * @returns {Thread} struct containing info about the Thread
+     */
+    async getThread(threadId) {
+        return this.native.getThread(this.servicePtr, [threadId]);
+    }
+    /**
+     * Gets a list of Threads in given Context.
+     *
+     * @param {string} contextId ID of the Context to get the Threads from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Thread>} struct containing a list of Threads
+     */
+    async listThreads(contextId, pagingQuery) {
+        return this.native.listThreads(this.servicePtr, [contextId, pagingQuery]);
+    }
+    /**
+     * Gets a message by given message ID.
+     *
+     * @param {string} messageId ID of the message to get
+     * @returns {Message} struct containing the message
+     */
+    async getMessage(messageId) {
+        return this.native.getMessage(this.servicePtr, [messageId]);
+    }
+    /**
+     * Gets a list of messages from a Thread.
+     *
+     * @param {string} threadId ID of the Thread to list messages from
+     * @param {PagingQuery} pagingQuery struct with list query parameters
+     * @returns {PagingList<Message>} struct containing a list of messages
+     */
+    async listMessages(threadId, pagingQuery) {
+        return this.native.listMessages(this.servicePtr, [threadId, pagingQuery]);
+    }
+    /**
+     * Sends a message in a Thread.
+     *
+     * @param {string} threadId ID of the Thread to send message to
+     * @param {Uint8Array} publicMeta public message metadata
+     * @param {Uint8Array} privateMeta private message metadata
+     * @param {Uint8Array} data content of the message
+     * @returns {string} ID of the new message
+     */
+    async sendMessage(threadId, publicMeta, privateMeta, data) {
+        return this.native.sendMessage(this.servicePtr, [
+            threadId,
+            publicMeta,
+            privateMeta,
+            data,
+        ]);
+    }
+    /**
+     * Deletes a message by given message ID.
+     *
+     * @param {string} messageId ID of the message to delete
+     */
+    async deleteMessage(messageId) {
+        return this.native.deleteMessage(this.servicePtr, [messageId]);
+    }
+    /**
+     * Update message in a Thread.
+     *
+     * @param {string} messageId ID of the message to update
+     * @param {Uint8Array} publicMeta public message metadata
+     * @param {Uint8Array} privateMeta private message metadata
+     * @param {Uint8Array} data content of the message
+     */
+    async updateMessage(messageId, publicMeta, privateMeta, data) {
+        return this.native.updateMessage(this.servicePtr, [
+            messageId,
+            publicMeta,
+            privateMeta,
+            data,
+        ]);
+    }
+    /**
+     * Subscribes for the Thread module main events.
+     */
+    async subscribeForThreadEvents() {
+        return this.native.subscribeForThreadEvents(this.servicePtr, []);
+    }
+    /**
+     * Unsubscribes from the Thread module main events.
+     */
+    async unsubscribeFromThreadEvents() {
+        return this.native.unsubscribeFromThreadEvents(this.servicePtr, []);
+    }
+    /**
+     * Subscribes for events in given Thread.
+     * @param {string} threadId ID of the Thread to subscribe
+     */
+    async subscribeForMessageEvents(threadId) {
+        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) {
+        return this.native.unsubscribeFromMessageEvents(this.servicePtr, [
+            threadId,
+        ]);
+    }
+}
+exports.ThreadApi = ThreadApi;

package/service/index.d.ts

@@ -0,0 +1,9 @@
+import { EndpointFactory } from "./EndpointFactory";
+import { ThreadApi } from "./ThreadApi";
+import { StoreApi } from "./StoreApi";
+import { InboxApi } from "./InboxApi";
+import { CryptoApi } from "./CryptoApi";
+import { Connection } from "./Connection";
+import { EventQueue } from "./EventQueue";
+import { BaseApi } from "./BaseApi";
+export { EndpointFactory, ThreadApi, StoreApi, InboxApi, CryptoApi, Connection, EventQueue, BaseApi };

package/service/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApi = exports.EventQueue = exports.Connection = exports.CryptoApi = 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");
+Object.defineProperty(exports, "ThreadApi", { enumerable: true, get: function () { return ThreadApi_1.ThreadApi; } });
+const StoreApi_1 = require("./StoreApi");
+Object.defineProperty(exports, "StoreApi", { enumerable: true, get: function () { return StoreApi_1.StoreApi; } });
+const InboxApi_1 = require("./InboxApi");
+Object.defineProperty(exports, "InboxApi", { enumerable: true, get: function () { return InboxApi_1.InboxApi; } });
+const CryptoApi_1 = require("./CryptoApi");
+Object.defineProperty(exports, "CryptoApi", { enumerable: true, get: function () { return CryptoApi_1.CryptoApi; } });
+const Connection_1 = require("./Connection");
+Object.defineProperty(exports, "Connection", { enumerable: true, get: function () { return Connection_1.Connection; } });
+const EventQueue_1 = require("./EventQueue");
+Object.defineProperty(exports, "EventQueue", { enumerable: true, get: function () { return EventQueue_1.EventQueue; } });
+const BaseApi_1 = require("./BaseApi");
+Object.defineProperty(exports, "BaseApi", { enumerable: true, get: function () { return BaseApi_1.BaseApi; } });