@simplito/privmx-webendpoint 2.3.0 → 2.5.2

package/Types.d.ts

@@ -35,6 +35,7 @@ export interface Event {
  * @param {number} limit limit of elements to return for query
  * @param {SortOrder} sortOrder Order of elements in result. Use "asc" for ascending, "desc" for descending.
  * @param {string} [lastId] id of the element from which query results should start
+ * @param {string} [sortBy] field name to sort elements by
  * @param {string} [queryAsJson] extra query parameters in serialized JSON
  */
 export interface PagingQuery {
@@ -42,6 +43,7 @@ export interface PagingQuery {
     limit: number;
     sortOrder: SortOrder;
     lastId?: string;
+    sortBy?: string;
     queryAsJson?: string;
 }
 /**
@@ -341,6 +343,93 @@ export interface FilesConfig {
     maxFileSize: number;
     maxWholeUploadSize: number;
 }
+/**
+ * Holds all available information about a KVDB.
+ *
+ * @type {Kvdb}
+ *
+ * @param {string} contextId ID of the Context
+ * @param {string} kvdbId ID ot the KVDB
+ * @param {number} createDate KVDB creation timestamp
+ * @param {string} author ID of the user who created the KVDB
+ * @param {number} lastModificationDate KVDB last modification timestamp
+ * @param {string} lastModifier ID of the user who last modified the KVDB
+ * @param {string[]} users list of users (their IDs) with access to the KVDB
+ * @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 KVDB's public meta data
+ * @param {Uint8Array} privateMeta KVDB's private mata data
+ * @param {ContainerPolicy} policy KVDB's policies
+ * @param {number} entries total number of entries in the KVDB
+ * @param {number} statusCode status code of retrival and decryption of the KVDB
+ * @param {number} schemaVersion Version of the KVDB data structure and how it is encoded/encrypted
+ */
+export interface Kvdb {
+    contextId: string;
+    kvdbId: string;
+    createDate: number;
+    creator: string;
+    lastModificationDate: number;
+    lastModifier: string;
+    users: string[];
+    managers: string[];
+    version: number;
+    lastMsgDate: number;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    policy: ContainerPolicy;
+    entries: number;
+    statusCode: number;
+    schemaVersion: number;
+}
+/**
+ * Holds information about the KvdbEntry.
+ *
+ * @type {KvdbEntry}
+ *
+ * @param {ServerKvdbEntryInfo} info KVDB entry's information created by server
+ * @param {Uint8Array} publicMeta KVDB entry's public meta data
+ * @param {Uint8Array} privateMeta KVDB entry's private mata data
+ * @param {Uint8Array} data KVDB entry's data
+ * @param {string} authorPubKey public key of an author of the KVDB entry
+ * @param {number} version version of the KVDB entry
+ * @param {number} statusCode status code of retrival and decryption of the KVDB entry
+ * @param {number} schemaVersion Version of the KVDB entry data structure and how it is encoded/encrypted
+ */
+export interface KvdbEntry {
+    info: ServerKvdbEntryInfo;
+    publicMeta: Uint8Array;
+    privateMeta: Uint8Array;
+    data: Uint8Array;
+    authorPubKey: string;
+    version: number;
+    statusCode: number;
+    schemaVersion: number;
+}
+/**
+ * Holds message's information created by server
+ *
+ * @type {ServerKvdbEntryInfo}
+ *
+ * @param {string} kvdbId ID of the kvdb
+ * @param {string} key KVDB entry's key
+ * @param {number} createDate entry creation timestamp
+ * @param {string} author ID of the user who created the entry
+ *
+ */
+export interface ServerKvdbEntryInfo {
+    kvdbId: string;
+    key: string;
+    createDate: number;
+    author: string;
+}
+/**
+ * Holds information about the entries deletion result.
+ *
+ * @type {DeleteEntriesResult}
+ */
+export type DeleteEntriesResult = Map<string, boolean>;
 /**
  * Holds Container policies settings
  *
@@ -461,3 +550,15 @@ export interface BridgeIdentity {
     pubKey?: string;
     instanceId?: string;
 }
+/**
+ * PKI Verification options
+ *
+ * @type {PKIVerificationOptions}
+ *
+ * @param {string} [bridgePubKey] Bridge public key
+ * @param {string} [bridgeInstanceId] Bridge instance Id given by PKI
+ */
+export interface PKIVerificationOptions {
+    bridgePubKey?: string;
+    bridgeInstanceId?: string;
+}

package/Types.js

@@ -28,3 +28,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 ;
 ;
 ;
+;
+;
+;
+;

package/api/ConnectionNative.d.ts

@@ -9,7 +9,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 import { UserVerifierInterface } from "../service/UserVerifierInterface";
-import { PagingQuery, PagingList, Context, UserInfo } from "../Types";
+import { PagingQuery, PagingList, Context, UserInfo, PKIVerificationOptions } from "../Types";
 import { BaseNative } from "./BaseNative";
 export declare class ConnectionNative extends BaseNative {
     protected lastConnectionId: number;
@@ -18,8 +18,8 @@ export declare class ConnectionNative extends BaseNative {
     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>;
+    connect(ptr: number, args: [string, string, string, PKIVerificationOptions]): Promise<void>;
+    connectPublic(ptr: number, args: [string, string, PKIVerificationOptions]): Promise<void>;
     getConnectionId(ptr: number, args: []): Promise<number>;
     listContexts(ptr: number, args: [PagingQuery]): Promise<PagingList<Context>>;
     getContextUsers(ptr: number, args: [string]): Promise<UserInfo[]>;

package/api/KvdbApiNative.d.ts

@@ -0,0 +1,33 @@
+/*!
+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, UserWithPubKey, Kvdb, KvdbEntry, ContainerPolicy, DeleteEntriesResult } from "../Types";
+import { BaseNative } from "./BaseNative";
+export declare class KvdbApiNative extends BaseNative {
+    newApi(connectionPtr: number): Promise<number>;
+    deleteApi(ptr: number): Promise<void>;
+    create(ptr: number, args: []): Promise<void>;
+    createKvdb(ptr: number, args: [string, UserWithPubKey[], UserWithPubKey[], Uint8Array, Uint8Array, ContainerPolicy | undefined]): Promise<string>;
+    updateKvdb(ptr: number, args: [string, UserWithPubKey[], UserWithPubKey[], Uint8Array, Uint8Array, number, boolean, boolean, ContainerPolicy | undefined]): Promise<void>;
+    deleteKvdb(ptr: number, args: [string]): Promise<void>;
+    getKvdb(ptr: number, args: [string]): Promise<Kvdb>;
+    listKvdbs(ptr: number, args: [string, PagingQuery]): Promise<PagingList<Kvdb>>;
+    hasEntry(ptr: number, args: [string, string]): Promise<boolean>;
+    getEntry(ptr: number, args: [string, string]): Promise<KvdbEntry>;
+    listEntriesKeys(ptr: number, args: [string, PagingQuery]): Promise<PagingList<string>>;
+    listEntries(ptr: number, args: [string, PagingQuery]): Promise<PagingList<KvdbEntry>>;
+    setEntry(ptr: number, args: [string, string, Uint8Array, Uint8Array, Uint8Array, number]): Promise<void>;
+    deleteEntry(ptr: number, args: [string, string]): Promise<void>;
+    deleteEntries(ptr: number, args: [string, string[]]): Promise<DeleteEntriesResult>;
+    subscribeForKvdbEvents(ptr: number, args: []): Promise<void>;
+    unsubscribeFromKvdbEvents(ptr: number, args: []): Promise<void>;
+    subscribeForEntryEvents(ptr: number, args: [string]): Promise<void>;
+    unsubscribeFromEntryEvents(ptr: number, args: [string]): Promise<void>;
+}

package/api/KvdbApiNative.js

@@ -0,0 +1,75 @@
+"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.KvdbApiNative = void 0;
+const BaseNative_1 = require("./BaseNative");
+class KvdbApiNative extends BaseNative_1.BaseNative {
+    async newApi(connectionPtr) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_newKvdbApi(taskId, connectionPtr));
+    }
+    async deleteApi(ptr) {
+        await this.runAsync((taskId) => this.api.lib.KvdbApi_deleteKvdbApi(taskId, ptr));
+        this.deleteApiRef();
+    }
+    async create(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_create(taskId, ptr, args));
+    }
+    async createKvdb(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_createKvdb(taskId, ptr, args));
+    }
+    async updateKvdb(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_updateKvdb(taskId, ptr, args));
+    }
+    async deleteKvdb(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_deleteKvdb(taskId, ptr, args));
+    }
+    async getKvdb(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_getKvdb(taskId, ptr, args));
+    }
+    async listKvdbs(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_listKvdbs(taskId, ptr, args));
+    }
+    async hasEntry(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_hasEntry(taskId, ptr, args));
+    }
+    async getEntry(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_getEntry(taskId, ptr, args));
+    }
+    async listEntriesKeys(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_listEntriesKeys(taskId, ptr, args));
+    }
+    async listEntries(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_listEntries(taskId, ptr, args));
+    }
+    async setEntry(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_setEntry(taskId, ptr, args));
+    }
+    async deleteEntry(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_deleteEntry(taskId, ptr, args));
+    }
+    async deleteEntries(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_deleteEntries(taskId, ptr, args));
+    }
+    async subscribeForKvdbEvents(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_subscribeForKvdbEvents(taskId, ptr, args));
+    }
+    async unsubscribeFromKvdbEvents(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_unsubscribeFromKvdbEvents(taskId, ptr, args));
+    }
+    async subscribeForEntryEvents(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_subscribeForEntryEvents(taskId, ptr, args));
+    }
+    async unsubscribeFromEntryEvents(ptr, args) {
+        return this.runAsync((taskId) => this.api.lib.KvdbApi_unsubscribeFromEntryEvents(taskId, ptr, args));
+    }
+}
+exports.KvdbApiNative = KvdbApiNative;