@simplito/privmx-webendpoint 2.1.1 → 2.2.0

package/Types.d.ts

@@ -0,0 +1,407 @@
+/*!
+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.
+*/
+export type SortOrder = "desc" | "asc";
+/**
+ * Holds Event details
+ *
+ * @type {Event}
+ *
+ * @param {string} type event type
+ * @param {string} channel channel
+ * @param {number} connectionId id of source connection
+ *
+ */
+export interface Event {
+    type: string;
+    channel: string;
+    connectionId: number;
+    data?: unknown;
+}
+/**
+ * Contains query parameters for methods returning lists (PagingList)
+ *
+ * @type {PagingQuery}
+ *
+ * @param {number} skip number of elements to skip from result
+ * @param {number} limit limit of elements to return for query
+ * @param {SortOrder} sortOrder Order of elements in result. Use "asc" for ascending, "desc" for descening.
+ * @param {string} [lastId] id of the element from which query results should start
+ *
+ */
+export interface PagingQuery {
+    skip: number;
+    limit: number;
+    sortOrder: SortOrder;
+    lastId?: string;
+}
+/**
+* Contains results of listing methods
+*
+* @type {PagingList<T>}
+*
+* @param {number} totalAvailable total items available to get
+* @param {T[]} readItems list of items read during single method call
+*
+*/
+export interface PagingList<T> {
+    totalAvailable: number;
+    readItems: T[];
+}
+/**
+ * Contains base Context information
+ *
+ * @type {Context}
+ *
+ * @param {string} userId ID of user requesting information
+ * @param {string} contextId ID of context
+ *
+ */
+export interface Context {
+    userId: string;
+    contextId: string;
+}
+/**
+ * Contains ID of user and the corresponding public key
+ *
+ * @type {UserWithPubKey}
+ *
+ * @param {string} userId ID of the user
+ * @param {string} pubKey user's public key
+ *
+ */
+export interface UserWithPubKey {
+    userId: string;
+    pubKey: string;
+}
+/**
+ * Holds all available information about a Thread.
+ *
+ * @type {Thread}
+ *
+ * @param {string} contextId ID of the Context
+ * @param {string} threadId ID ot the Thread
+ * @param {number} createDate Thread creation timestamp
+ * @param {string} author ID of the user who created the Thread
+ * @param {number} lastModificationDate Thread last modification timestamp
+ * @param {string} lastModifier ID of the user who last modified the Thread
+ * @param {string[]} users list of users (their IDs) with access to the Thread
+ * @param {string[]} managers list of users (their IDs) with management rights
+ * @param {number} version version number (changes on updates)
+ * @param {number} lastMsgDate timestamp of last posted message
+ * @param {Uint8Array} publicMeta Thread's public meta data
+ * @param {Uint8Array} privateMeta Thread's private mata data
+ * @param {ContainerPolicy} policy Thread's policies
+ * @param {number} messagesCount total number of messages in the Thread
+ * @param {number} statusCode status code of retrival and decryption of the Thread
+ *
+ */
+export interface Thread {
+    contextId: string;
+    threadId: string;
+    createDate: number;
+    creator: string;
+    lastModificationDate: number;
+    lastModifier: string;
+    users: string[];
+    managers: string[];
+    version: number;
+    lastMsgDate: number;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    policy: ContainerPolicy;
+    messagesCount: number;
+    statusCode: number;
+}
+/**
+ * Holds information about the Message.
+ *
+ * @type {Message}
+ *
+ * @param {ServerMessageInfo} info message's information created by server
+ * @param {Uint8Array} publicMeta message's public meta data
+ * @param {Uint8Array} privateMeta message's private mata data
+ * @param {Uint8Array} data message's data
+ * @param {string} authorPubKey public key of an author of the message
+ * @param {number} statusCode status code of retrival and decryption of the message
+ *
+ */
+export interface Message {
+    info: ServerMessageInfo;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    data: Uint8Array;
+    authorPubKey: string;
+    statusCode: number;
+}
+/**
+ * Holds message's information created by server
+ *
+ * @type {ServerMessageInfo}
+ *
+ * @param {string} threadId ID of the Thread
+ * @param {string} messageId ID of the message
+ * @param {number} createDate message's creation timestamp
+ * @param {string} author ID of the user who created the message
+ *
+ */
+export interface ServerMessageInfo {
+    threadId: string;
+    messageId: string;
+    createDate: number;
+    author: string;
+}
+/**
+ * Holds all available information about a Store.
+ *
+ * @type {Store}
+ *
+ * @param {string} storeId ID ot the Store
+ * @param {string} contextId ID of the Context
+ * @param {number} createDate Store creation timestamp
+ * @param {string} creator ID of user who created the Store
+ * @param {number} lastModificationDate Thread last modification timestamp
+ * @param {number} lastFileDate timestamp of last created file
+ * @param {string} lastModifier ID of the user who last modified the Store
+ * @param {string[]} users list of users (their IDs) with access to the Store
+ * @param {string[]} managers list of users (their IDs) with management rights
+ * @param {number} version version number (changes on updates)
+ * @param {Uint8Array} publicMeta Store's public meta data
+ * @param {Uint8Array} privateMeta Store's private mata data
+ * @param {ContainerPolicy} policy Store's policies
+ * @param {number} filesCount total number of files in the Store
+ * @param {number} statusCode status code of retrival and decryption of the Store
+ *
+ */
+export interface Store {
+    storeId: string;
+    contextId: string;
+    createDate: number;
+    creator: string;
+    lastModificationDate: number;
+    lastFileDate: number;
+    lastModifier: string;
+    users: string[];
+    managers: string[];
+    version: number;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    policy: ContainerPolicy;
+    filesCount: number;
+    statusCode: number;
+}
+/**
+ * Holds information about the file.
+ *
+ * @type {File}
+ *
+ * @param {ServerFileInfo} info file's information created by server
+ * @param {Uint8Array} publicMeta file's public meta data
+ * @param {Uint8Array} privateMeta file's private mata data
+ * @param {number} size file's size
+ * @param {string} authorPubKey public key of an author of the file
+ * @param {number} tatusCode status code of retrival and decryption of the file
+ *
+ */
+export interface File {
+    info: ServerFileInfo;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    size: number;
+    authorPubKey: string;
+    statusCode: number;
+}
+/**
+ * Holds file's information created by server
+ *
+ * @type {ServerFileInfo}
+ *
+ * @param {string} storeId ID of the Store
+ * @param {string} fileId ID of the file
+ * @param {number} createDate file's creation timestamp
+ * @param {string} author ID of the user who created the file
+ *
+ */
+export interface ServerFileInfo {
+    storeId: string;
+    fileId: string;
+    createDate: number;
+    author: string;
+}
+/**
+ * Holds all available information about an Inbox.
+ *
+ * @type {Inbox}
+ *
+ * @param {string} inboxId ID ot the Inbox
+ * @param {string} contextId ID of the Context
+ * @param {number} createDate Inbox creation timestamp
+ * @param {string} creator ID of user who created the Inbox
+ * @param {number} lastModificationDate Inbox last modification timestamp
+ * @param {string} lastModifier ID of the user who last modified the Inbox
+ * @param {string[]} users list of users (their IDs) with access to the Inbox
+ * @param {string[]} managers list of users (their IDs) with management rights
+ * @param {number} version version number (changes on updates)
+ * @param {Uint8Array} publicMeta Inbox' public meta data
+ * @param {Uint8Array} privateMeta Inbox' private mata data
+ * @param {FilesConfig} filesConfig Inbox' files configuration
+ * @param {ContainerWithoutItemPolicy} policy Inbox' policies
+ * @param {number} statusCode status code of retrival and decryption of the Inbox
+ *
+ */
+export interface Inbox {
+    inboxId: string;
+    contextId: string;
+    createDate: number;
+    creator: string;
+    lastModificationDate: number;
+    lastModifier: string;
+    users: string[];
+    managers: string[];
+    version: number;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    filesConfig?: FilesConfig;
+    policy: ContainerWithoutItemPolicy;
+    statusCode: number;
+}
+/**
+ * Holds Inbox' public information
+ *
+ * @type {InboxPublicView}
+ *
+ * @param {string} inboxId ID of the Inbox
+ * @param {number} version version of the Inbox
+ * @param {Uint8Array} publicMeta Inbox' public meta data
+ *
+ */
+export interface InboxPublicView {
+    inboxId: string;
+    version: number;
+    publicMeta: Uint8Array;
+}
+/**
+ * Holds information about Inbox' entry
+ *
+ * @type {InboxEntry}
+ *
+ * @param {string} entryId ID of the entry
+ * @param {string} inboxId ID of the Inbox
+ * @param {Uint8Array} data entry data
+ * @param {File[]} files list of files attached to the entry
+ * @param {string} authorPubKey public key of the author of an entry
+ * @param {number} createDate Inbox entry creation timestamp
+ * @param {number} statusCode status code of retrival and decryption of the Inbox entry
+ */
+export interface InboxEntry {
+    entryId: string;
+    inboxId: string;
+    data: Uint8Array;
+    files: File[];
+    authorPubKey: string;
+    createDate: number;
+    statusCode: number;
+}
+/**
+ * Holds Inbox files configuration
+ *
+ * @type {FilesConfig}
+ *
+ * @param {int64_t} minCount minimum numer of files required when sending inbox entry
+ * @param {int64_t} maxCount maximum numer of files allowed when sending inbox entry
+ * @param {int64_t} maxFileSize maximum file size allowed when sending inbox entry
+ * @param {int64_t} maxWholeUploadSize maximum size of all files in total allowed when sending inbox entry
+ *
+ */
+export interface FilesConfig {
+    minCount: number;
+    maxCount: number;
+    maxFileSize: number;
+    maxWholeUploadSize: number;
+}
+/**
+ * Holds Container policies settings
+ *
+ * @type {ContainerWithoutItemPolicy}
+ *
+ * @param {PolicyEntry} get determine who can get a container
+ * @param {PolicyEntry} update determine who can update a container
+ * @param {PolicyEntry} delete determine who can delete a container
+ * @param {PolicyEntry} updatePolicy determine who can update the policy of a container
+ * @param {PolicyBooleanEntry} updaterCanBeRemovedFromManagers determine whether the updater can be removed from the list of managers
+ * @param {PolicyBooleanEntry} ownerCanBeRemovedFromManagers determine whether the owner can be removed from the list of managers
+ */
+export interface ContainerWithoutItemPolicy {
+    get?: PolicyEntry;
+    update?: PolicyEntry;
+    delete?: PolicyEntry;
+    updatePolicy?: PolicyEntry;
+    updaterCanBeRemovedFromManagers?: PolicyBooleanEntry;
+    ownerCanBeRemovedFromManagers?: PolicyBooleanEntry;
+}
+/**
+ * Holds Container policies settings
+ *
+ * @type {ContainerPolicy}
+ *
+ * @param {ItemPolicy} item item policies
+ */
+export interface ContainerPolicy extends ContainerWithoutItemPolicy {
+    item?: ItemPolicy;
+}
+/**
+ * @type {PolicyEntry}
+ */
+export type PolicyEntry = "inherit" | "yes" | "no" | "default" | "none" | "all" | "user" | "owner" | "manager" | "itemOwner" | "itemOwner&user" | "itemOwner&user,manager" | "owner&user" | "manager&owner" | "itemOwner,manager" | "itemOwner,owner" | "itemOwner,manager,owner" | "manager,owner" | (string & {
+    __policyEntry: never;
+});
+/**
+ * @type {PolicyBooleanEntry}
+ */
+export type PolicyBooleanEntry = "inherit" | "default" | "yes" | "no";
+/**
+ * Holds Container's item policies settings
+ *
+ * @type {ContainerWithoutItemPolicy}
+ *
+ * @param {PolicyEntry} get determine who can get an item
+ * @param {PolicyEntry} listMy determine who can list items created by me
+ * @param {PolicyEntry} listAll determine who can list all items
+ * @param {PolicyEntry} create determine who can create an item
+ * @param {PolicyEntry} update determine who can update an item
+ * @param {PolicyEntry} delete determine who can delete an item
+ */
+export interface ItemPolicy {
+    get?: PolicyEntry;
+    listMy?: PolicyEntry;
+    listAll?: PolicyEntry;
+    create?: PolicyEntry;
+    update?: PolicyEntry;
+    delete?: PolicyEntry;
+}
+/**
+ * Holds error details
+ *
+ * @type {Error}
+ *
+ * @param {number} code error code
+ * @param {string} name error name
+ * @param {string} scope error scope
+ * @param {string} description error description
+ * @param {string} full all available data about the error
+ *
+ */
+export interface Error {
+    code: number;
+    name: string;
+    scope: string;
+    description: string;
+    full: string;
+}

package/Types.js

@@ -0,0 +1,27 @@
+"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 });
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;
+;

package/api/Api.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.
+*/
+export declare class Api {
+    lib: any;
+    private promises;
+    private taskIdGenerator;
+    constructor(lib: any);
+    runAsync<T>(func: (taskId: number) => void): Promise<T>;
+    private resolveResult;
+    private generateId;
+    private setResultsCallback;
+}

package/api/Api.js

@@ -0,0 +1,48 @@
+"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.Api = void 0;
+const IdGenerator_1 = require("./IdGenerator");
+class Api {
+    lib;
+    promises;
+    taskIdGenerator;
+    constructor(lib) {
+        this.lib = lib;
+        this.taskIdGenerator = new IdGenerator_1.IdGenerator();
+        this.promises = new Map();
+        this.setResultsCallback();
+    }
+    async runAsync(func) {
+        return new Promise((resolve, reject) => {
+            const taskId = this.generateId();
+            this.promises.set(taskId, { resolve, reject });
+            func(taskId);
+        });
+    }
+    resolveResult(result) {
+        if (result.status == true) {
+            this.promises.get(result.taskId).resolve(result.result);
+        }
+        else {
+            this.promises.get(result.taskId).reject(result.error);
+        }
+        this.promises.delete(result.taskId);
+    }
+    generateId() {
+        return this.taskIdGenerator.generateId();
+    }
+    setResultsCallback() {
+        this.lib.setResultsCallback((result) => this.resolveResult(result));
+    }
+}
+exports.Api = Api;

package/api/BaseNative.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 { Api } from "./Api";
+export declare abstract class BaseNative {
+    protected _api: Api | null;
+    constructor(api: Api);
+    get api(): Api;
+    protected abstract newApi(connectionPtr: number, ...apisPtrs: number[]): Promise<number>;
+    abstract deleteApi(ptr: number): Promise<void>;
+    protected deleteApiRef(): void;
+    protected runAsync<T>(func: (taskId: number) => void): Promise<T>;
+}

package/api/BaseNative.js

@@ -0,0 +1,35 @@
+"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.BaseNative = void 0;
+class BaseNative {
+    _api;
+    constructor(api) {
+        this._api = api;
+    }
+    get api() {
+        if (!this._api) {
+            throw new Error("This API instance is no longer valid because the connection associated with it has been closed.");
+        }
+        return this._api;
+    }
+    deleteApiRef() {
+        this._api = null;
+    }
+    async runAsync(func) {
+        if (!this.api) {
+            throw new Error("This API instance is no longer valid because the connection associated with it has been closed.");
+        }
+        return this.api.runAsync(func);
+    }
+}
+exports.BaseNative = BaseNative;

package/api/ConnectionNative.d.ts

@@ -0,0 +1,24 @@
+/*!
+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 { PagingQuery, PagingList, Context } from "../Types";
+import { BaseNative } from "./BaseNative";
+export declare class ConnectionNative extends BaseNative {
+    protected lastConnectionId: number;
+    protected newApi(_connectionPtr: number): Promise<number>;
+    deleteApi(ptr: number): Promise<void>;
+    newConnection(): Promise<number>;
+    deleteConnection(ptr: number): Promise<void>;
+    connect(ptr: number, args: [string, string, string]): Promise<void>;
+    connectPublic(ptr: number, args: [string, string]): Promise<void>;
+    getConnectionId(ptr: number, args: []): Promise<number>;
+    listContexts(ptr: number, args: [PagingQuery]): Promise<PagingList<Context>>;
+    disconnect(ptr: number, args: []): Promise<void>;
+}

package/api/ConnectionNative.js

@@ -0,0 +1,51 @@
+"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.ConnectionNative = void 0;
+const BaseNative_1 = require("./BaseNative");
+class ConnectionNative extends BaseNative_1.BaseNative {
+    lastConnectionId = -1;
+    async newApi(_connectionPtr) {
+        throw new Error("Use the newConnection() - specialized version of method instead.");
+    }
+    async deleteApi(ptr) {
+        await this.runAsync((taskId) => this.api.lib.Connection_deleteConnection(taskId, ptr));
+        this.deleteApiRef();
+    }
+    async newConnection() {
+        return this.runAsync((taskId) => this.api.lib.Connection_newConnection(taskId));
+    }
+    async deleteConnection(ptr) {
+        await this.runAsync((taskId) => this.api.lib.Connection_deleteConnection(taskId, ptr));
+        this.deleteApiRef();
+    }
+    async connect(ptr, args) {
+        await this.runAsync((taskId) => this.api.lib.Connection_connect(taskId, ptr, args));
+        await this.getConnectionId(ptr, []);
+    }
+    async connectPublic(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.Connection_connectPublic(taskId, ptr, args));
+    }
+    async getConnectionId(ptr, args) {
+        if (this.lastConnectionId < 0) {
+            this.lastConnectionId = await this.runAsync((taskId) => this.api.lib.Connection_getConnectionId(taskId, ptr, args));
+        }
+        return this.lastConnectionId;
+    }
+    async listContexts(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.Connection_listContexts(taskId, ptr, args));
+    }
+    async disconnect(ptr, args) {
+        await this.runAsync((taskId) => this.api.lib.Connection_disconnect(taskId, ptr, args));
+    }
+}
+exports.ConnectionNative = ConnectionNative;

package/api/CryptoApiNative.d.ts

@@ -0,0 +1,25 @@
+/*!
+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 { BaseNative } from "./BaseNative";
+export declare class CryptoApiNative extends BaseNative {
+    newApi(): Promise<number>;
+    deleteApi(ptr: number): Promise<void>;
+    create(ptr: number, args: []): Promise<void>;
+    signData(ptr: number, args: [Uint8Array, string]): Promise<Uint8Array>;
+    generatePrivateKey(ptr: number, args: [string | undefined]): Promise<string>;
+    derivePrivateKey(ptr: number, args: [string, string]): Promise<string>;
+    derivePrivateKey2(ptr: number, args: [string, string]): Promise<string>;
+    derivePublicKey(ptr: number, args: [string]): Promise<string>;
+    generateKeySymmetric(ptr: number, args: []): Promise<Uint8Array>;
+    encryptDataSymmetric(ptr: number, args: [Uint8Array, Uint8Array]): Promise<Uint8Array>;
+    decryptDataSymmetric(ptr: number, args: [Uint8Array, Uint8Array]): Promise<Uint8Array>;
+    convertPEMKeytoWIFKey(ptr: number, args: [string]): Promise<string>;
+}