@simplito/privmx-webendpoint 2.1.1 → 2.2.0

package/service/Connection.js

@@ -0,0 +1,57 @@
+"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.Connection = void 0;
+const BaseApi_1 = require("./BaseApi");
+class Connection extends BaseApi_1.BaseApi {
+    native;
+    apisRefs = {};
+    nativeApisDeps = {};
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    /**
+     * Gets the ID of the current connection.
+     *
+     * @returns {number} ID of the connection
+     */
+    async getConnectionId() {
+        return this.native.getConnectionId(this.servicePtr, []);
+    }
+    /**
+     * Gets a list of Contexts available for the user.
+     *
+     * @param pagingQuery struct with list query parameters
+     * @returns {PagingList<Context>} struct containing a list of Contexts
+     */
+    async listContexts(pagingQuery) {
+        return this.native.listContexts(this.servicePtr, [pagingQuery]);
+    }
+    /**
+     * Disconnects from the Platform backend.
+     *
+     */
+    async disconnect() {
+        await this.native.disconnect(this.servicePtr, []);
+        await this.freeApis();
+        await this.native.deleteConnection(this.servicePtr);
+    }
+    async freeApis() {
+        for (const apiId in this.apisRefs) {
+            if (this.nativeApisDeps[apiId]) {
+                await this.nativeApisDeps[apiId].deleteApi(this.apisRefs[apiId]._apiServicePtr);
+            }
+        }
+    }
+}
+exports.Connection = Connection;

package/service/CryptoApi.d.ts

@@ -0,0 +1,83 @@
+/*!
+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 { CryptoApiNative } from "../api/CryptoApiNative";
+export declare class CryptoApi extends BaseApi {
+    private native;
+    constructor(native: CryptoApiNative, ptr: number);
+    /**
+     * Creates a signature of data using given key.
+     *
+     * @param {Uint8Array} data buffer to sign
+     * @param {string} privateKey key used to sign data
+     * @returns {Uint8Array} signature
+     */
+    signData(data: Uint8Array, privateKey: string): Promise<Uint8Array>;
+    /**
+     * Generates a new private ECC key.
+     *
+     * @param {string} [randomSeed] optional string used as the base to generate the new key
+     * @returns {string} generated ECC key in WIF format
+     */
+    generatePrivateKey(randomSeed?: string | undefined): Promise<string>;
+    /**
+     * (deprecated) Generates a new private ECC key from a password using pbkdf2.
+     *
+     * @param {string} password the password used to generate the new key
+     * @param {string} salt random string (additional input for the hashing function)
+  
+     * @returns {string} generated ECC key in WIF format
+     */
+    derivePrivateKey(password: string, salt: string): Promise<string>;
+    /**
+     * Generates a new private ECC key from a password using pbkdf2.
+     *
+     * @param {string} password the password used to generate the new key
+     * @param {string} salt random string (additional input for the hashing function)
+
+     * @returns {string} generated ECC key in WIF format
+     */
+    derivePrivateKey2(password: string, salt: string): Promise<string>;
+    /**
+     * Generates a new public ECC key as a pair to an existing private key.
+     * @param {string} privateKey private ECC key in WIF format
+     * @returns {string} generated ECC key in BASE58DER format
+     */
+    derivePublicKey(privateKey: string): Promise<string>;
+    /**
+     * Generates a new symmetric key.
+     * @returns {Uint8Array} generated key.
+     */
+    generateKeySymmetric(): Promise<Uint8Array>;
+    /**
+     * Encrypts buffer with a given key using AES.
+     *
+     * @param {Uint8Array} data buffer to encrypt
+     * @param {Uint8Array} symmetricKey key used to encrypt data
+     * @returns {Uint8Array} encrypted data buffer
+     */
+    encryptDataSymmetric(data: Uint8Array, symmetricKey: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Decrypts buffer with a given key using AES.
+     *
+     * @param {Uint8Array} data buffer to decrypt
+     * @param {Uint8Array} symmetricKey key used to decrypt data
+     * @returns {Uint8Array} plain (decrypted) data buffer
+     */
+    decryptDataSymmetric(data: Uint8Array, symmetricKey: Uint8Array): Promise<Uint8Array>;
+    /**
+     * Converts given private key in PEM format to its WIF format.
+     *
+     * @param {string} pemKey private key to convert
+     * @returns {string} private key in WIF format
+     */
+    convertPEMKeytoWIFKey(pemKey: string): Promise<string>;
+}

package/service/CryptoApi.js

@@ -0,0 +1,113 @@
+"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.CryptoApi = void 0;
+const BaseApi_1 = require("./BaseApi");
+class CryptoApi extends BaseApi_1.BaseApi {
+    native;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    /**
+     * Creates a signature of data using given key.
+     *
+     * @param {Uint8Array} data buffer to sign
+     * @param {string} privateKey key used to sign data
+     * @returns {Uint8Array} signature
+     */
+    async signData(data, privateKey) {
+        return this.native.signData(this.servicePtr, [data, privateKey]);
+    }
+    /**
+     * Generates a new private ECC key.
+     *
+     * @param {string} [randomSeed] optional string used as the base to generate the new key
+     * @returns {string} generated ECC key in WIF format
+     */
+    async generatePrivateKey(randomSeed) {
+        return this.native.generatePrivateKey(this.servicePtr, [randomSeed]);
+    }
+    /**
+     * (deprecated) Generates a new private ECC key from a password using pbkdf2.
+     *
+     * @param {string} password the password used to generate the new key
+     * @param {string} salt random string (additional input for the hashing function)
+  
+     * @returns {string} generated ECC key in WIF format
+     */
+    async derivePrivateKey(password, salt) {
+        return this.native.derivePrivateKey(this.servicePtr, [password, salt]);
+    }
+    /**
+     * Generates a new private ECC key from a password using pbkdf2.
+     *
+     * @param {string} password the password used to generate the new key
+     * @param {string} salt random string (additional input for the hashing function)
+
+     * @returns {string} generated ECC key in WIF format
+     */
+    async derivePrivateKey2(password, salt) {
+        return this.native.derivePrivateKey2(this.servicePtr, [password, salt]);
+    }
+    /**
+     * Generates a new public ECC key as a pair to an existing private key.
+     * @param {string} privateKey private ECC key in WIF format
+     * @returns {string} generated ECC key in BASE58DER format
+     */
+    async derivePublicKey(privateKey) {
+        return this.native.derivePublicKey(this.servicePtr, [privateKey]);
+    }
+    /**
+     * Generates a new symmetric key.
+     * @returns {Uint8Array} generated key.
+     */
+    async generateKeySymmetric() {
+        return this.native.generateKeySymmetric(this.servicePtr, []);
+    }
+    /**
+     * Encrypts buffer with a given key using AES.
+     *
+     * @param {Uint8Array} data buffer to encrypt
+     * @param {Uint8Array} symmetricKey key used to encrypt data
+     * @returns {Uint8Array} encrypted data buffer
+     */
+    async encryptDataSymmetric(data, symmetricKey) {
+        return this.native.encryptDataSymmetric(this.servicePtr, [
+            data,
+            symmetricKey,
+        ]);
+    }
+    /**
+     * Decrypts buffer with a given key using AES.
+     *
+     * @param {Uint8Array} data buffer to decrypt
+     * @param {Uint8Array} symmetricKey key used to decrypt data
+     * @returns {Uint8Array} plain (decrypted) data buffer
+     */
+    async decryptDataSymmetric(data, symmetricKey) {
+        return this.native.decryptDataSymmetric(this.servicePtr, [
+            data,
+            symmetricKey,
+        ]);
+    }
+    /**
+     * Converts given private key in PEM format to its WIF format.
+     *
+     * @param {string} pemKey private key to convert
+     * @returns {string} private key in WIF format
+     */
+    async convertPEMKeytoWIFKey(pemKey) {
+        return this.native.convertPEMKeytoWIFKey(this.servicePtr, [pemKey]);
+    }
+}
+exports.CryptoApi = CryptoApi;

package/service/EndpointFactory.d.ts

@@ -0,0 +1,89 @@
+/*!
+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 { Connection } from "./Connection";
+import { CryptoApi } from "./CryptoApi";
+import { EventQueue } from "./EventQueue";
+import { InboxApi } from "./InboxApi";
+import { StoreApi } from "./StoreApi";
+import { ThreadApi } from "./ThreadApi";
+/**
+ * Contains static factory methods - generators for Connection and APIs.
+ */
+export declare class EndpointFactory {
+    private static api;
+    private static eventQueueInstance;
+    /**
+     * Load the Endpoint's WASM assets and initialize the Endpoint library.
+     *
+     * @param {string} [assetsBasePath] base path/url to the Endpoint's WebAssembly assets (like: endpoint-wasm-module.js, driver-web-context.js and others)
+     */
+    static setup(assetsBasePath?: string): Promise<void>;
+    private static loadScript;
+    /**
+     * //doc-gen:ignore
+     */
+    private static init;
+    /**
+     * Gets the EventQueue instance.
+     *
+     * @returns {EventQueue} instance of EventQueue
+     */
+    static getEventQueue(): Promise<EventQueue>;
+    /**
+     * Connects to the platform backend.
+     *
+     * @param {string} userPrivKey user's private key
+     * @param {string} solutionId ID of the Solution
+     * @param {string} bridgeUrl the Bridge Server URL
+     * @returns {Connection} instance of Connection
+     */
+    static connect(userPrivKey: string, solutionId: string, bridgeUrl: string): Promise<Connection>;
+    /**
+     * Connects to the Platform backend as a guest user.
+     *
+     * @param {string} solutionId ID of the Solution
+     * @param {string} bridgeUrl the Bridge Server URL
+     *
+     * @returns {Connection} instance of Connection
+     */
+    static connectPublic(solutionId: string, bridgeUrl: string): Promise<Connection>;
+    /**
+     * Creates an instance of the Thread API.
+     *
+     * @param {Connection} connection instance of Connection
+     *
+     * @returns {ThreadApi} instance of ThreadApi
+     */
+    static createThreadApi(connection: Connection): Promise<ThreadApi>;
+    /**
+     * Creates an instance of the Store API.
+     *
+     * @param {Connection} connection instance of Connection
+     *
+     * @returns {StoreApi} instance of StoreApi
+     */
+    static createStoreApi(connection: Connection): Promise<StoreApi>;
+    /**
+     * Creates an instance of the Inbox API.
+     *
+     * @param {Connection} connection instance of Connection
+     * @param {ThreadApi} threadApi instance of ThreadApi
+     * @param {StoreApi} storeApi instance of StoreApi
+     * @returns {InboxApi} instance of InboxApi
+     */
+    static createInboxApi(connection: Connection, threadApi: ThreadApi, storeApi: StoreApi): Promise<InboxApi>;
+    /**
+     * Creates an instance of the Crypto API.
+     *
+     * @returns {CryptoApi} instance of CryptoApi
+     */
+    static createCryptoApi(): Promise<CryptoApi>;
+}

package/service/EndpointFactory.js

@@ -0,0 +1,173 @@
+"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.EndpointFactory = void 0;
+const Api_1 = require("../api/Api");
+const ConnectionNative_1 = require("../api/ConnectionNative");
+const CryptoApiNative_1 = require("../api/CryptoApiNative");
+const EventQueueNative_1 = require("../api/EventQueueNative");
+const InboxApiNative_1 = require("../api/InboxApiNative");
+const StoreApiNative_1 = require("../api/StoreApiNative");
+const ThreadApiNative_1 = require("../api/ThreadApiNative");
+const Connection_1 = require("./Connection");
+const CryptoApi_1 = require("./CryptoApi");
+const EventQueue_1 = require("./EventQueue");
+const InboxApi_1 = require("./InboxApi");
+const StoreApi_1 = require("./StoreApi");
+const ThreadApi_1 = require("./ThreadApi");
+/**
+ * Contains static factory methods - generators for Connection and APIs.
+ */
+class EndpointFactory {
+    static api;
+    static eventQueueInstance;
+    /**
+     * Load the Endpoint's WASM assets and initialize the Endpoint library.
+     *
+     * @param {string} [assetsBasePath] base path/url to the Endpoint's WebAssembly assets (like: endpoint-wasm-module.js, driver-web-context.js and others)
+     */
+    static async setup(assetsBasePath) {
+        const basePath = assetsBasePath || document.currentScript.src.split("/").slice(0, -1).join("/");
+        const assets = ["driver-web-context.js", "endpoint-wasm-module.js"];
+        for (const asset of assets) {
+            await this.loadScript(basePath + "/" + asset);
+        }
+        const lib = await endpointWasmModule();
+        EndpointFactory.init(lib);
+    }
+    static async loadScript(url) {
+        return new Promise(resolve => {
+            const head = document.getElementsByTagName('head')[0];
+            const script = document.createElement('script');
+            script.type = 'text/javascript';
+            script.src = url;
+            script.onload = () => {
+                resolve();
+            };
+            head.appendChild(script);
+        });
+    }
+    /**
+     * //doc-gen:ignore
+     */
+    static init(lib) {
+        this.api = new Api_1.Api(lib);
+    }
+    /**
+     * Gets the EventQueue instance.
+     *
+     * @returns {EventQueue} instance of EventQueue
+     */
+    static async getEventQueue() {
+        if (!this.eventQueueInstance) {
+            const nativeApi = new EventQueueNative_1.EventQueueNative(this.api);
+            const ptr = await nativeApi.newEventQueue();
+            this.eventQueueInstance = new EventQueue_1.EventQueue(nativeApi, ptr);
+        }
+        return this.eventQueueInstance;
+    }
+    /**
+     * Connects to the platform backend.
+     *
+     * @param {string} userPrivKey user's private key
+     * @param {string} solutionId ID of the Solution
+     * @param {string} bridgeUrl the Bridge Server URL
+     * @returns {Connection} instance of Connection
+     */
+    static async connect(userPrivKey, solutionId, bridgeUrl) {
+        const nativeApi = new ConnectionNative_1.ConnectionNative(this.api);
+        const ptr = await nativeApi.newConnection();
+        await nativeApi.connect(ptr, [userPrivKey, solutionId, bridgeUrl]);
+        return new Connection_1.Connection(nativeApi, ptr);
+    }
+    /**
+     * Connects to the Platform backend as a guest user.
+     *
+     * @param {string} solutionId ID of the Solution
+     * @param {string} bridgeUrl the Bridge Server URL
+     *
+     * @returns {Connection} instance of Connection
+     */
+    static async connectPublic(solutionId, bridgeUrl) {
+        const nativeApi = new ConnectionNative_1.ConnectionNative(this.api);
+        const ptr = await nativeApi.newConnection();
+        await nativeApi.connectPublic(ptr, [solutionId, bridgeUrl]);
+        return new Connection_1.Connection(nativeApi, ptr);
+    }
+    /**
+     * Creates an instance of the Thread API.
+     *
+     * @param {Connection} connection instance of Connection
+     *
+     * @returns {ThreadApi} instance of ThreadApi
+     */
+    static async createThreadApi(connection) {
+        if ("threads" in connection.apisRefs) {
+            throw new Error("ThreadApi already registered for given connection.");
+        }
+        const nativeApi = new ThreadApiNative_1.ThreadApiNative(this.api);
+        const ptr = await nativeApi.newApi(connection.servicePtr);
+        await nativeApi.create(ptr, []);
+        connection.apisRefs["threads"] = { _apiServicePtr: ptr };
+        connection.nativeApisDeps["threads"] = nativeApi;
+        return new ThreadApi_1.ThreadApi(nativeApi, ptr);
+    }
+    /**
+     * Creates an instance of the Store API.
+     *
+     * @param {Connection} connection instance of Connection
+     *
+     * @returns {StoreApi} instance of StoreApi
+     */
+    static async createStoreApi(connection) {
+        if ("stores" in connection.apisRefs) {
+            throw new Error("StoreApi already registered for given connection.");
+        }
+        const nativeApi = new StoreApiNative_1.StoreApiNative(this.api);
+        const ptr = await nativeApi.newApi(connection.servicePtr);
+        connection.apisRefs["stores"] = { _apiServicePtr: ptr };
+        connection.nativeApisDeps["stores"] = nativeApi;
+        await nativeApi.create(ptr, []);
+        return new StoreApi_1.StoreApi(nativeApi, ptr);
+    }
+    /**
+     * Creates an instance of the Inbox API.
+     *
+     * @param {Connection} connection instance of Connection
+     * @param {ThreadApi} threadApi instance of ThreadApi
+     * @param {StoreApi} storeApi instance of StoreApi
+     * @returns {InboxApi} instance of InboxApi
+     */
+    static async createInboxApi(connection, threadApi, storeApi) {
+        if ("inboxes" in connection.apisRefs) {
+            throw new Error("InboxApi already registered for given connection.");
+        }
+        const nativeApi = new InboxApiNative_1.InboxApiNative(this.api);
+        const ptr = await nativeApi.newApi(connection.servicePtr, threadApi.servicePtr, storeApi.servicePtr);
+        connection.apisRefs["inboxes"] = { _apiServicePtr: ptr };
+        connection.nativeApisDeps["inboxes"] = nativeApi;
+        await nativeApi.create(ptr, []);
+        return new InboxApi_1.InboxApi(nativeApi, ptr);
+    }
+    /**
+     * Creates an instance of the Crypto API.
+     *
+     * @returns {CryptoApi} instance of CryptoApi
+     */
+    static async createCryptoApi() {
+        const nativeApi = new CryptoApiNative_1.CryptoApiNative(this.api);
+        const ptr = await nativeApi.newApi();
+        await nativeApi.create(ptr, []);
+        return new CryptoApi_1.CryptoApi(nativeApi, ptr);
+    }
+}
+exports.EndpointFactory = EndpointFactory;

package/service/EventQueue.d.ts

@@ -0,0 +1,20 @@
+/*!
+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 { EventQueueNative } from '../api/EventQueueNative';
+import { Event } from '../Types';
+export declare class EventQueue extends BaseApi {
+    private native;
+    private isPending;
+    constructor(native: EventQueueNative, ptr: number);
+    waitEvent(): Promise<Event>;
+    emitBreakEvent(): Promise<void>;
+}

package/service/EventQueue.js

@@ -0,0 +1,37 @@
+"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.EventQueue = void 0;
+const BaseApi_1 = require("./BaseApi");
+class EventQueue extends BaseApi_1.BaseApi {
+    native;
+    isPending = false;
+    constructor(native, ptr) {
+        super(ptr);
+        this.native = native;
+    }
+    async waitEvent() {
+        if (this.isPending) {
+            throw ("WaitEvent() is already in a pending state waiting for new events");
+        }
+        try {
+            return await this.native.waitEvent(this.servicePtr, []);
+        }
+        finally {
+            this.isPending = false;
+        }
+    }
+    async emitBreakEvent() {
+        return this.native.emitBreakEvent(this.servicePtr, []);
+    }
+}
+exports.EventQueue = EventQueue;