@simplito/privmx-webendpoint 2.3.0 → 2.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Types.d.ts +101 -0
- package/Types.js +4 -0
- package/api/ConnectionNative.d.ts +3 -3
- package/api/KvdbApiNative.d.ts +33 -0
- package/api/KvdbApiNative.js +75 -0
- package/assets/driver-web-context.js +1 -1
- package/assets/endpoint-wasm-module.js +1 -1
- package/assets/endpoint-wasm-module.wasm +0 -0
- package/bundle/privmx-endpoint-web.js +1 -1
- package/extra/PrivmxClient.d.ts +7 -1
- package/extra/PrivmxClient.js +14 -0
- package/index.d.ts +2 -2
- package/index.js +2 -1
- package/package.json +1 -1
- package/service/Connection.d.ts +2 -2
- package/service/Connection.js +2 -2
- package/service/EndpointFactory.d.ts +15 -3
- package/service/EndpointFactory.js +32 -5
- package/service/InboxApi.d.ts +9 -9
- package/service/InboxApi.js +9 -9
- package/service/KvdbApi.d.ts +142 -0
- package/service/KvdbApi.js +208 -0
- package/service/StoreApi.d.ts +6 -6
- package/service/StoreApi.js +6 -6
- package/service/ThreadApi.d.ts +6 -6
- package/service/ThreadApi.js +6 -6
- package/service/index.d.ts +2 -1
- package/service/index.js +3 -1
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
PrivMX Web Endpoint.
|
|
3
|
+
Copyright © 2024 Simplito sp. z o.o.
|
|
4
|
+
|
|
5
|
+
This file is part of the PrivMX Platform (https://privmx.dev).
|
|
6
|
+
This software is Licensed under the PrivMX Free License.
|
|
7
|
+
|
|
8
|
+
See the License for the specific language governing permissions and
|
|
9
|
+
limitations under the License.
|
|
10
|
+
*/
|
|
11
|
+
import { BaseApi } from "./BaseApi";
|
|
12
|
+
import { KvdbApiNative } from "../api/KvdbApiNative";
|
|
13
|
+
import { PagingQuery, PagingList, UserWithPubKey, Kvdb, ContainerPolicy, KvdbEntry, DeleteEntriesResult } from "../Types";
|
|
14
|
+
export declare class KvdbApi extends BaseApi {
|
|
15
|
+
protected native: KvdbApiNative;
|
|
16
|
+
constructor(native: KvdbApiNative, ptr: number);
|
|
17
|
+
/**
|
|
18
|
+
* Creates a new KVDB in given Context.
|
|
19
|
+
*
|
|
20
|
+
* @param {string} contextId ID of the Context to create the KVDB in
|
|
21
|
+
* @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
|
|
22
|
+
* @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
|
|
23
|
+
* the created KVDB
|
|
24
|
+
* @param {Uint8Array} publicMeta public (unencrypted) metadata
|
|
25
|
+
* @param {Uint8Array} privateMeta private (encrypted) metadata
|
|
26
|
+
* @param {ContainerPolicy} policies KVDB's policies
|
|
27
|
+
* @returns {string} ID of the created KVDB
|
|
28
|
+
*/
|
|
29
|
+
createKvdb(contextId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, policies?: ContainerPolicy): Promise<string>;
|
|
30
|
+
/**
|
|
31
|
+
* Updates an existing KVDB.
|
|
32
|
+
*
|
|
33
|
+
* @param {string} kvdbId ID of the KVDB to update
|
|
34
|
+
* @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
|
|
35
|
+
* @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
|
|
36
|
+
* the created KVDB
|
|
37
|
+
* @param {Uint8Array} publicMeta public (unencrypted) metadata
|
|
38
|
+
* @param {Uint8Array} privateMeta private (encrypted) metadata
|
|
39
|
+
* @param {number} version current version of the updated KVDB
|
|
40
|
+
* @param {boolean} force force update (without checking version)
|
|
41
|
+
* @param {boolean} forceGenerateNewKey force to regenerate a key for the KVDB
|
|
42
|
+
* @param {ContainerPolicy} policies KVDB's policies
|
|
43
|
+
*/
|
|
44
|
+
updateKvdb(kvdbId: string, users: UserWithPubKey[], managers: UserWithPubKey[], publicMeta: Uint8Array, privateMeta: Uint8Array, version: number, force: boolean, forceGenerateNewKey: boolean, policies?: ContainerPolicy): Promise<void>;
|
|
45
|
+
/**
|
|
46
|
+
* Deletes a KVDB by given KVDB ID.
|
|
47
|
+
*
|
|
48
|
+
* @param {string} kvdbId ID of the KVDB to delete
|
|
49
|
+
*/
|
|
50
|
+
deleteKvdb(kvdbId: string): Promise<void>;
|
|
51
|
+
/**
|
|
52
|
+
* Gets a KVDB by given KVDB ID.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} kvdbId ID of KVDB to get
|
|
55
|
+
* @returns {Kvdb} containing info about the KVDB
|
|
56
|
+
*/
|
|
57
|
+
getKvdb(kvdbId: string): Promise<Kvdb>;
|
|
58
|
+
/**
|
|
59
|
+
* Gets a list of Kvdbs in given Context.
|
|
60
|
+
*
|
|
61
|
+
* @param {string} contextId ID of the Context to get the Kvdbs from
|
|
62
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
63
|
+
* @returns {PagingList<Kvdb>} containing a list of Kvdbs
|
|
64
|
+
*/
|
|
65
|
+
listKvdbs(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Kvdb>>;
|
|
66
|
+
/**
|
|
67
|
+
* Gets a KVDB entry by given KVDB entry key and KVDB ID.
|
|
68
|
+
*
|
|
69
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to get
|
|
70
|
+
* @param {string} key key of the KVDB entry to get
|
|
71
|
+
* @returns {KvdbEntry} containing the KVDB entry
|
|
72
|
+
*/
|
|
73
|
+
getEntry(kvdbId: string, key: string): Promise<KvdbEntry>;
|
|
74
|
+
/**
|
|
75
|
+
* Check whether the KVDB entry exists.
|
|
76
|
+
*
|
|
77
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to check
|
|
78
|
+
* @param {string} key key of the KVDB entry to check
|
|
79
|
+
* @returns {boolean} 'true' if the KVDB has an entry with given key, 'false' otherwise
|
|
80
|
+
*/
|
|
81
|
+
hasEntry(kvdbId: string, key: string): Promise<boolean>;
|
|
82
|
+
/**
|
|
83
|
+
* Gets a list of KVDB entries keys from a KVDB.
|
|
84
|
+
*
|
|
85
|
+
* @param {string} kvdbId ID of the KVDB to list KVDB entries from
|
|
86
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
87
|
+
* @returns {PagingList<string>} containing a list of KVDB entries
|
|
88
|
+
*/
|
|
89
|
+
listEntriesKeys(kvdbId: string, pagingQuery: PagingQuery): Promise<PagingList<string>>;
|
|
90
|
+
/**
|
|
91
|
+
* Gets a list of KVDB entries from a KVDB.
|
|
92
|
+
*
|
|
93
|
+
* @param {string} kvdbId ID of the KVDB to list KVDB entries from
|
|
94
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
95
|
+
* @returns {PagingList<KvdbEntry>} containing a list of KVDB entries
|
|
96
|
+
*/
|
|
97
|
+
listEntries(kvdbId: string, pagingQuery: PagingQuery): Promise<PagingList<KvdbEntry>>;
|
|
98
|
+
/**
|
|
99
|
+
* Sets a KVDB entry in the given KVDB.
|
|
100
|
+
* @param {string} kvdbId ID of the KVDB to set the entry to
|
|
101
|
+
* @param {string} key KVDB entry key
|
|
102
|
+
* @param {Uint8Array} publicMeta public KVDB entry metadata
|
|
103
|
+
* @param {Uint8Array} privateMeta private KVDB entry metadata
|
|
104
|
+
* @param {Uint8Array} data content of the KVDB entry
|
|
105
|
+
* @param {number} [version] KVDB entry version (when updating the entry)
|
|
106
|
+
* @returns {string} ID of the KVDB entry
|
|
107
|
+
*/
|
|
108
|
+
setEntry(kvdbId: string, key: string, publicMeta: Uint8Array, privateMeta: Uint8Array, data: Uint8Array, version?: number): Promise<void>;
|
|
109
|
+
/**
|
|
110
|
+
* Deletes a KVDB entry by given KVDB entry ID.
|
|
111
|
+
*
|
|
112
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to delete
|
|
113
|
+
* @param {string} key key of the KVDB entry to delete
|
|
114
|
+
*/
|
|
115
|
+
deleteEntry(kvdbId: string, key: string): Promise<void>;
|
|
116
|
+
/**
|
|
117
|
+
* Deletes KVDB entries by given KVDB IDs and the list of entry keys.
|
|
118
|
+
*
|
|
119
|
+
* @param {string} kvdbId ID of the KVDB database to delete from
|
|
120
|
+
* @param {string[]} keys keys of the KVDB entries to delete
|
|
121
|
+
* @returns {Map<string, boolean>} map with the statuses of deletion for every key
|
|
122
|
+
*/
|
|
123
|
+
deleteEntries(kvdbId: string, keys: string[]): Promise<DeleteEntriesResult>;
|
|
124
|
+
/**
|
|
125
|
+
* Subscribes for the KVDB module main events.
|
|
126
|
+
*/
|
|
127
|
+
subscribeForKvdbEvents(): Promise<void>;
|
|
128
|
+
/**
|
|
129
|
+
* Unsubscribes from the KVDB module main events.
|
|
130
|
+
*/
|
|
131
|
+
unsubscribeFromKvdbEvents(): Promise<void>;
|
|
132
|
+
/**
|
|
133
|
+
* Subscribes for events in given KVDB.
|
|
134
|
+
* @param {string} kvdbId ID of the KVDB to subscribe
|
|
135
|
+
*/
|
|
136
|
+
subscribeForEntryEvents(kvdbId: string): Promise<void>;
|
|
137
|
+
/**
|
|
138
|
+
* Unsubscribes from events in given KVDB.
|
|
139
|
+
* @param {string} kvdbId ID of the KVDB to unsubscribe
|
|
140
|
+
*/
|
|
141
|
+
unsubscribeFromEntryEvents(kvdbId: string): Promise<void>;
|
|
142
|
+
}
|
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/*!
|
|
3
|
+
PrivMX Web Endpoint.
|
|
4
|
+
Copyright © 2024 Simplito sp. z o.o.
|
|
5
|
+
|
|
6
|
+
This file is part of the PrivMX Platform (https://privmx.dev).
|
|
7
|
+
This software is Licensed under the PrivMX Free License.
|
|
8
|
+
|
|
9
|
+
See the License for the specific language governing permissions and
|
|
10
|
+
limitations under the License.
|
|
11
|
+
*/
|
|
12
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
exports.KvdbApi = void 0;
|
|
14
|
+
const BaseApi_1 = require("./BaseApi");
|
|
15
|
+
class KvdbApi extends BaseApi_1.BaseApi {
|
|
16
|
+
native;
|
|
17
|
+
constructor(native, ptr) {
|
|
18
|
+
super(ptr);
|
|
19
|
+
this.native = native;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Creates a new KVDB in given Context.
|
|
23
|
+
*
|
|
24
|
+
* @param {string} contextId ID of the Context to create the KVDB in
|
|
25
|
+
* @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
|
|
26
|
+
* @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
|
|
27
|
+
* the created KVDB
|
|
28
|
+
* @param {Uint8Array} publicMeta public (unencrypted) metadata
|
|
29
|
+
* @param {Uint8Array} privateMeta private (encrypted) metadata
|
|
30
|
+
* @param {ContainerPolicy} policies KVDB's policies
|
|
31
|
+
* @returns {string} ID of the created KVDB
|
|
32
|
+
*/
|
|
33
|
+
async createKvdb(contextId, users, managers, publicMeta, privateMeta, policies) {
|
|
34
|
+
return this.native.createKvdb(this.servicePtr, [
|
|
35
|
+
contextId,
|
|
36
|
+
users,
|
|
37
|
+
managers,
|
|
38
|
+
publicMeta,
|
|
39
|
+
privateMeta,
|
|
40
|
+
policies,
|
|
41
|
+
]);
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Updates an existing KVDB.
|
|
45
|
+
*
|
|
46
|
+
* @param {string} kvdbId ID of the KVDB to update
|
|
47
|
+
* @param {UserWithPubKey[]} users array of UserWithPubKey structs which indicates who will have access to the created KVDB
|
|
48
|
+
* @param {UserWithPubKey[]} managers array of UserWithPubKey structs which indicates who will have access (and management rights) to
|
|
49
|
+
* the created KVDB
|
|
50
|
+
* @param {Uint8Array} publicMeta public (unencrypted) metadata
|
|
51
|
+
* @param {Uint8Array} privateMeta private (encrypted) metadata
|
|
52
|
+
* @param {number} version current version of the updated KVDB
|
|
53
|
+
* @param {boolean} force force update (without checking version)
|
|
54
|
+
* @param {boolean} forceGenerateNewKey force to regenerate a key for the KVDB
|
|
55
|
+
* @param {ContainerPolicy} policies KVDB's policies
|
|
56
|
+
*/
|
|
57
|
+
async updateKvdb(kvdbId, users, managers, publicMeta, privateMeta, version, force, forceGenerateNewKey, policies) {
|
|
58
|
+
return this.native.updateKvdb(this.servicePtr, [
|
|
59
|
+
kvdbId,
|
|
60
|
+
users,
|
|
61
|
+
managers,
|
|
62
|
+
publicMeta,
|
|
63
|
+
privateMeta,
|
|
64
|
+
version,
|
|
65
|
+
force,
|
|
66
|
+
forceGenerateNewKey,
|
|
67
|
+
policies,
|
|
68
|
+
]);
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Deletes a KVDB by given KVDB ID.
|
|
72
|
+
*
|
|
73
|
+
* @param {string} kvdbId ID of the KVDB to delete
|
|
74
|
+
*/
|
|
75
|
+
async deleteKvdb(kvdbId) {
|
|
76
|
+
return this.native.deleteKvdb(this.servicePtr, [kvdbId]);
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Gets a KVDB by given KVDB ID.
|
|
80
|
+
*
|
|
81
|
+
* @param {string} kvdbId ID of KVDB to get
|
|
82
|
+
* @returns {Kvdb} containing info about the KVDB
|
|
83
|
+
*/
|
|
84
|
+
async getKvdb(kvdbId) {
|
|
85
|
+
return this.native.getKvdb(this.servicePtr, [kvdbId]);
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Gets a list of Kvdbs in given Context.
|
|
89
|
+
*
|
|
90
|
+
* @param {string} contextId ID of the Context to get the Kvdbs from
|
|
91
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
92
|
+
* @returns {PagingList<Kvdb>} containing a list of Kvdbs
|
|
93
|
+
*/
|
|
94
|
+
async listKvdbs(contextId, pagingQuery) {
|
|
95
|
+
return this.native.listKvdbs(this.servicePtr, [contextId, pagingQuery]);
|
|
96
|
+
}
|
|
97
|
+
/**
|
|
98
|
+
* Gets a KVDB entry by given KVDB entry key and KVDB ID.
|
|
99
|
+
*
|
|
100
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to get
|
|
101
|
+
* @param {string} key key of the KVDB entry to get
|
|
102
|
+
* @returns {KvdbEntry} containing the KVDB entry
|
|
103
|
+
*/
|
|
104
|
+
async getEntry(kvdbId, key) {
|
|
105
|
+
return this.native.getEntry(this.servicePtr, [kvdbId, key]);
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Check whether the KVDB entry exists.
|
|
109
|
+
*
|
|
110
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to check
|
|
111
|
+
* @param {string} key key of the KVDB entry to check
|
|
112
|
+
* @returns {boolean} 'true' if the KVDB has an entry with given key, 'false' otherwise
|
|
113
|
+
*/
|
|
114
|
+
async hasEntry(kvdbId, key) {
|
|
115
|
+
return this.native.hasEntry(this.servicePtr, [kvdbId, key]);
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Gets a list of KVDB entries keys from a KVDB.
|
|
119
|
+
*
|
|
120
|
+
* @param {string} kvdbId ID of the KVDB to list KVDB entries from
|
|
121
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
122
|
+
* @returns {PagingList<string>} containing a list of KVDB entries
|
|
123
|
+
*/
|
|
124
|
+
async listEntriesKeys(kvdbId, pagingQuery) {
|
|
125
|
+
return this.native.listEntriesKeys(this.servicePtr, [kvdbId, pagingQuery]);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Gets a list of KVDB entries from a KVDB.
|
|
129
|
+
*
|
|
130
|
+
* @param {string} kvdbId ID of the KVDB to list KVDB entries from
|
|
131
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
132
|
+
* @returns {PagingList<KvdbEntry>} containing a list of KVDB entries
|
|
133
|
+
*/
|
|
134
|
+
async listEntries(kvdbId, pagingQuery) {
|
|
135
|
+
return this.native.listEntries(this.servicePtr, [kvdbId, pagingQuery]);
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* Sets a KVDB entry in the given KVDB.
|
|
139
|
+
* @param {string} kvdbId ID of the KVDB to set the entry to
|
|
140
|
+
* @param {string} key KVDB entry key
|
|
141
|
+
* @param {Uint8Array} publicMeta public KVDB entry metadata
|
|
142
|
+
* @param {Uint8Array} privateMeta private KVDB entry metadata
|
|
143
|
+
* @param {Uint8Array} data content of the KVDB entry
|
|
144
|
+
* @param {number} [version] KVDB entry version (when updating the entry)
|
|
145
|
+
* @returns {string} ID of the KVDB entry
|
|
146
|
+
*/
|
|
147
|
+
async setEntry(kvdbId, key, publicMeta, privateMeta, data, version) {
|
|
148
|
+
return this.native.setEntry(this.servicePtr, [
|
|
149
|
+
kvdbId,
|
|
150
|
+
key,
|
|
151
|
+
publicMeta,
|
|
152
|
+
privateMeta,
|
|
153
|
+
data,
|
|
154
|
+
version || 0
|
|
155
|
+
]);
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Deletes a KVDB entry by given KVDB entry ID.
|
|
159
|
+
*
|
|
160
|
+
* @param {string} kvdbId KVDB ID of the KVDB entry to delete
|
|
161
|
+
* @param {string} key key of the KVDB entry to delete
|
|
162
|
+
*/
|
|
163
|
+
async deleteEntry(kvdbId, key) {
|
|
164
|
+
return this.native.deleteEntry(this.servicePtr, [kvdbId, key]);
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Deletes KVDB entries by given KVDB IDs and the list of entry keys.
|
|
168
|
+
*
|
|
169
|
+
* @param {string} kvdbId ID of the KVDB database to delete from
|
|
170
|
+
* @param {string[]} keys keys of the KVDB entries to delete
|
|
171
|
+
* @returns {Map<string, boolean>} map with the statuses of deletion for every key
|
|
172
|
+
*/
|
|
173
|
+
async deleteEntries(kvdbId, keys) {
|
|
174
|
+
return this.native.deleteEntries(this.servicePtr, [
|
|
175
|
+
kvdbId,
|
|
176
|
+
keys,
|
|
177
|
+
]);
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* Subscribes for the KVDB module main events.
|
|
181
|
+
*/
|
|
182
|
+
async subscribeForKvdbEvents() {
|
|
183
|
+
return this.native.subscribeForKvdbEvents(this.servicePtr, []);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* Unsubscribes from the KVDB module main events.
|
|
187
|
+
*/
|
|
188
|
+
async unsubscribeFromKvdbEvents() {
|
|
189
|
+
return this.native.unsubscribeFromKvdbEvents(this.servicePtr, []);
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* Subscribes for events in given KVDB.
|
|
193
|
+
* @param {string} kvdbId ID of the KVDB to subscribe
|
|
194
|
+
*/
|
|
195
|
+
async subscribeForEntryEvents(kvdbId) {
|
|
196
|
+
return this.native.subscribeForEntryEvents(this.servicePtr, [kvdbId]);
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Unsubscribes from events in given KVDB.
|
|
200
|
+
* @param {string} kvdbId ID of the KVDB to unsubscribe
|
|
201
|
+
*/
|
|
202
|
+
async unsubscribeFromEntryEvents(kvdbId) {
|
|
203
|
+
return this.native.unsubscribeFromEntryEvents(this.servicePtr, [
|
|
204
|
+
kvdbId,
|
|
205
|
+
]);
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
exports.KvdbApi = KvdbApi;
|
package/service/StoreApi.d.ts
CHANGED
|
@@ -52,15 +52,15 @@ export declare class StoreApi extends BaseApi {
|
|
|
52
52
|
* Gets a single Store by given Store ID.
|
|
53
53
|
*
|
|
54
54
|
* @param {string} storeId ID of the Store to get
|
|
55
|
-
* @returns {Store}
|
|
55
|
+
* @returns {Store} containing information about the Store
|
|
56
56
|
*/
|
|
57
57
|
getStore(storeId: string): Promise<Store>;
|
|
58
58
|
/**
|
|
59
59
|
* Gets a list of Stores in given Context.
|
|
60
60
|
*
|
|
61
61
|
* @param {string} contextId ID of the Context to get the Stores from
|
|
62
|
-
* @param {PagingQuery} pagingQuery
|
|
63
|
-
* @returns {PagingList<Store>}
|
|
62
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
63
|
+
* @returns {PagingList<Store>} containing list of Stores
|
|
64
64
|
*/
|
|
65
65
|
listStores(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Store>>;
|
|
66
66
|
/**
|
|
@@ -108,15 +108,15 @@ export declare class StoreApi extends BaseApi {
|
|
|
108
108
|
* Gets a single file by the given file ID.
|
|
109
109
|
*
|
|
110
110
|
* @param {string} fileId ID of the file to get
|
|
111
|
-
* @returns {File}
|
|
111
|
+
* @returns {File} containing information about the file
|
|
112
112
|
*/
|
|
113
113
|
getFile(fileId: string): Promise<File>;
|
|
114
114
|
/**
|
|
115
115
|
* Gets a list of files in given Store.
|
|
116
116
|
*
|
|
117
117
|
* @param {string} storeId ID of the Store to get files from
|
|
118
|
-
* @param {PagingQuery} pagingQuery
|
|
119
|
-
* @returns {PagingList<File>}
|
|
118
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
119
|
+
* @returns {PagingList<File>} containing list of files
|
|
120
120
|
*/
|
|
121
121
|
listFiles(storeId: string, pagingQuery: PagingQuery): Promise<PagingList<File>>;
|
|
122
122
|
/**
|
package/service/StoreApi.js
CHANGED
|
@@ -79,7 +79,7 @@ class StoreApi extends BaseApi_1.BaseApi {
|
|
|
79
79
|
* Gets a single Store by given Store ID.
|
|
80
80
|
*
|
|
81
81
|
* @param {string} storeId ID of the Store to get
|
|
82
|
-
* @returns {Store}
|
|
82
|
+
* @returns {Store} containing information about the Store
|
|
83
83
|
*/
|
|
84
84
|
async getStore(storeId) {
|
|
85
85
|
return this.native.getStore(this.servicePtr, [storeId]);
|
|
@@ -88,8 +88,8 @@ class StoreApi extends BaseApi_1.BaseApi {
|
|
|
88
88
|
* Gets a list of Stores in given Context.
|
|
89
89
|
*
|
|
90
90
|
* @param {string} contextId ID of the Context to get the Stores from
|
|
91
|
-
* @param {PagingQuery} pagingQuery
|
|
92
|
-
* @returns {PagingList<Store>}
|
|
91
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
92
|
+
* @returns {PagingList<Store>} containing list of Stores
|
|
93
93
|
*/
|
|
94
94
|
async listStores(contextId, pagingQuery) {
|
|
95
95
|
return this.native.listStores(this.servicePtr, [contextId, pagingQuery]);
|
|
@@ -163,7 +163,7 @@ class StoreApi extends BaseApi_1.BaseApi {
|
|
|
163
163
|
* Gets a single file by the given file ID.
|
|
164
164
|
*
|
|
165
165
|
* @param {string} fileId ID of the file to get
|
|
166
|
-
* @returns {File}
|
|
166
|
+
* @returns {File} containing information about the file
|
|
167
167
|
*/
|
|
168
168
|
async getFile(fileId) {
|
|
169
169
|
return this.native.getFile(this.servicePtr, [fileId]);
|
|
@@ -172,8 +172,8 @@ class StoreApi extends BaseApi_1.BaseApi {
|
|
|
172
172
|
* Gets a list of files in given Store.
|
|
173
173
|
*
|
|
174
174
|
* @param {string} storeId ID of the Store to get files from
|
|
175
|
-
* @param {PagingQuery} pagingQuery
|
|
176
|
-
* @returns {PagingList<File>}
|
|
175
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
176
|
+
* @returns {PagingList<File>} containing list of files
|
|
177
177
|
*/
|
|
178
178
|
async listFiles(storeId, pagingQuery) {
|
|
179
179
|
return this.native.listFiles(this.servicePtr, [storeId, pagingQuery]);
|
package/service/ThreadApi.d.ts
CHANGED
|
@@ -52,30 +52,30 @@ export declare class ThreadApi extends BaseApi {
|
|
|
52
52
|
* Gets a Thread by given Thread ID.
|
|
53
53
|
*
|
|
54
54
|
* @param {string} threadId ID of Thread to get
|
|
55
|
-
* @returns {Thread}
|
|
55
|
+
* @returns {Thread} containing info about the Thread
|
|
56
56
|
*/
|
|
57
57
|
getThread(threadId: string): Promise<Thread>;
|
|
58
58
|
/**
|
|
59
59
|
* Gets a list of Threads in given Context.
|
|
60
60
|
*
|
|
61
61
|
* @param {string} contextId ID of the Context to get the Threads from
|
|
62
|
-
* @param {PagingQuery} pagingQuery
|
|
63
|
-
* @returns {PagingList<Thread>}
|
|
62
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
63
|
+
* @returns {PagingList<Thread>} containing a list of Threads
|
|
64
64
|
*/
|
|
65
65
|
listThreads(contextId: string, pagingQuery: PagingQuery): Promise<PagingList<Thread>>;
|
|
66
66
|
/**
|
|
67
67
|
* Gets a message by given message ID.
|
|
68
68
|
*
|
|
69
69
|
* @param {string} messageId ID of the message to get
|
|
70
|
-
* @returns {Message}
|
|
70
|
+
* @returns {Message} containing the message
|
|
71
71
|
*/
|
|
72
72
|
getMessage(messageId: string): Promise<Message>;
|
|
73
73
|
/**
|
|
74
74
|
* Gets a list of messages from a Thread.
|
|
75
75
|
*
|
|
76
76
|
* @param {string} threadId ID of the Thread to list messages from
|
|
77
|
-
* @param {PagingQuery} pagingQuery
|
|
78
|
-
* @returns {PagingList<Message>}
|
|
77
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
78
|
+
* @returns {PagingList<Message>} containing a list of messages
|
|
79
79
|
*/
|
|
80
80
|
listMessages(threadId: string, pagingQuery: PagingQuery): Promise<PagingList<Message>>;
|
|
81
81
|
/**
|
package/service/ThreadApi.js
CHANGED
|
@@ -79,7 +79,7 @@ class ThreadApi extends BaseApi_1.BaseApi {
|
|
|
79
79
|
* Gets a Thread by given Thread ID.
|
|
80
80
|
*
|
|
81
81
|
* @param {string} threadId ID of Thread to get
|
|
82
|
-
* @returns {Thread}
|
|
82
|
+
* @returns {Thread} containing info about the Thread
|
|
83
83
|
*/
|
|
84
84
|
async getThread(threadId) {
|
|
85
85
|
return this.native.getThread(this.servicePtr, [threadId]);
|
|
@@ -88,8 +88,8 @@ class ThreadApi extends BaseApi_1.BaseApi {
|
|
|
88
88
|
* Gets a list of Threads in given Context.
|
|
89
89
|
*
|
|
90
90
|
* @param {string} contextId ID of the Context to get the Threads from
|
|
91
|
-
* @param {PagingQuery} pagingQuery
|
|
92
|
-
* @returns {PagingList<Thread>}
|
|
91
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
92
|
+
* @returns {PagingList<Thread>} containing a list of Threads
|
|
93
93
|
*/
|
|
94
94
|
async listThreads(contextId, pagingQuery) {
|
|
95
95
|
return this.native.listThreads(this.servicePtr, [contextId, pagingQuery]);
|
|
@@ -98,7 +98,7 @@ class ThreadApi extends BaseApi_1.BaseApi {
|
|
|
98
98
|
* Gets a message by given message ID.
|
|
99
99
|
*
|
|
100
100
|
* @param {string} messageId ID of the message to get
|
|
101
|
-
* @returns {Message}
|
|
101
|
+
* @returns {Message} containing the message
|
|
102
102
|
*/
|
|
103
103
|
async getMessage(messageId) {
|
|
104
104
|
return this.native.getMessage(this.servicePtr, [messageId]);
|
|
@@ -107,8 +107,8 @@ class ThreadApi extends BaseApi_1.BaseApi {
|
|
|
107
107
|
* Gets a list of messages from a Thread.
|
|
108
108
|
*
|
|
109
109
|
* @param {string} threadId ID of the Thread to list messages from
|
|
110
|
-
* @param {PagingQuery} pagingQuery
|
|
111
|
-
* @returns {PagingList<Message>}
|
|
110
|
+
* @param {PagingQuery} pagingQuery with list query parameters
|
|
111
|
+
* @returns {PagingList<Message>} containing a list of messages
|
|
112
112
|
*/
|
|
113
113
|
async listMessages(threadId, pagingQuery) {
|
|
114
114
|
return this.native.listMessages(this.servicePtr, [threadId, pagingQuery]);
|
package/service/index.d.ts
CHANGED
|
@@ -2,9 +2,10 @@ import { EndpointFactory } from "./EndpointFactory";
|
|
|
2
2
|
import { ThreadApi } from "./ThreadApi";
|
|
3
3
|
import { StoreApi } from "./StoreApi";
|
|
4
4
|
import { InboxApi } from "./InboxApi";
|
|
5
|
+
import { KvdbApi } from "./KvdbApi";
|
|
5
6
|
import { CryptoApi } from "./CryptoApi";
|
|
6
7
|
import { Connection } from "./Connection";
|
|
7
8
|
import { EventQueue } from "./EventQueue";
|
|
8
9
|
import { BaseApi } from "./BaseApi";
|
|
9
10
|
import { ExtKey } from "./ExtKey";
|
|
10
|
-
export { EndpointFactory, ThreadApi, StoreApi, InboxApi, CryptoApi, Connection, EventQueue, BaseApi, ExtKey };
|
|
11
|
+
export { EndpointFactory, ThreadApi, StoreApi, InboxApi, KvdbApi, CryptoApi, Connection, EventQueue, BaseApi, ExtKey };
|
package/service/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ExtKey = exports.BaseApi = exports.EventQueue = exports.Connection = exports.CryptoApi = exports.InboxApi = exports.StoreApi = exports.ThreadApi = exports.EndpointFactory = void 0;
|
|
3
|
+
exports.ExtKey = exports.BaseApi = exports.EventQueue = exports.Connection = exports.CryptoApi = exports.KvdbApi = exports.InboxApi = exports.StoreApi = exports.ThreadApi = exports.EndpointFactory = void 0;
|
|
4
4
|
const EndpointFactory_1 = require("./EndpointFactory");
|
|
5
5
|
Object.defineProperty(exports, "EndpointFactory", { enumerable: true, get: function () { return EndpointFactory_1.EndpointFactory; } });
|
|
6
6
|
const ThreadApi_1 = require("./ThreadApi");
|
|
@@ -9,6 +9,8 @@ const StoreApi_1 = require("./StoreApi");
|
|
|
9
9
|
Object.defineProperty(exports, "StoreApi", { enumerable: true, get: function () { return StoreApi_1.StoreApi; } });
|
|
10
10
|
const InboxApi_1 = require("./InboxApi");
|
|
11
11
|
Object.defineProperty(exports, "InboxApi", { enumerable: true, get: function () { return InboxApi_1.InboxApi; } });
|
|
12
|
+
const KvdbApi_1 = require("./KvdbApi");
|
|
13
|
+
Object.defineProperty(exports, "KvdbApi", { enumerable: true, get: function () { return KvdbApi_1.KvdbApi; } });
|
|
12
14
|
const CryptoApi_1 = require("./CryptoApi");
|
|
13
15
|
Object.defineProperty(exports, "CryptoApi", { enumerable: true, get: function () { return CryptoApi_1.CryptoApi; } });
|
|
14
16
|
const Connection_1 = require("./Connection");
|