@haex-space/vault-sdk 4.8.1 → 4.10.0
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/README.md +61 -0
- package/dist/{client-CNbwFQjB.d.ts → client-DTxLSJrk.d.mts} +194 -4
- package/dist/{client-DOAj36ga.d.mts → client-s0eCQoWA.d.ts} +194 -4
- package/dist/index.d.mts +54 -7
- package/dist/index.d.ts +54 -7
- package/dist/index.js +215 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +211 -2
- package/dist/index.mjs.map +1 -1
- package/dist/node.d.mts +1 -1
- package/dist/node.d.ts +1 -1
- package/dist/react.d.mts +1 -1
- package/dist/react.d.ts +1 -1
- package/dist/react.js +209 -1
- package/dist/react.js.map +1 -1
- package/dist/react.mjs +209 -1
- package/dist/react.mjs.map +1 -1
- package/dist/runtime/nuxt.plugin.client.js +206 -1
- package/dist/runtime/nuxt.plugin.client.js.map +1 -1
- package/dist/runtime/nuxt.plugin.client.mjs +206 -1
- package/dist/runtime/nuxt.plugin.client.mjs.map +1 -1
- package/dist/svelte.d.mts +1 -1
- package/dist/svelte.d.ts +1 -1
- package/dist/svelte.js +209 -1
- package/dist/svelte.js.map +1 -1
- package/dist/svelte.mjs +209 -1
- package/dist/svelte.mjs.map +1 -1
- package/dist/{types-3iifP-Q1.d.mts → types-BZVkX0Wf.d.mts} +24 -2
- package/dist/{types-3iifP-Q1.d.ts → types-BZVkX0Wf.d.ts} +24 -2
- package/dist/vue.d.mts +1 -1
- package/dist/vue.d.ts +1 -1
- package/dist/vue.js +209 -1
- package/dist/vue.js.map +1 -1
- package/dist/vue.mjs +209 -1
- package/dist/vue.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.mjs
CHANGED
|
@@ -765,6 +765,18 @@ var MODEL_JOB_EVENTS = {
|
|
|
765
765
|
/** A job of this frame ended: completed, failed or cancelled. */
|
|
766
766
|
COMPLETED: "haextension:model-job:completed"
|
|
767
767
|
};
|
|
768
|
+
var PEERS_EVENTS = {
|
|
769
|
+
/** The outcome of an invitation, once per invitation (inviting side). */
|
|
770
|
+
INVITE_STATUS: "peers:invite-status",
|
|
771
|
+
/** A channel opened after the user accepted an invitation in holzi's prompt (invited side). */
|
|
772
|
+
CHANNEL_OPENED: "peers:channel-opened",
|
|
773
|
+
/** A device joined one of this device's lobbies by code (host). */
|
|
774
|
+
JOINED: "peers:joined",
|
|
775
|
+
/** A message on a channel; `data` is Base64 on the bridge. */
|
|
776
|
+
MESSAGE: "peers:message",
|
|
777
|
+
/** A channel ended: closed, lost or timed out. */
|
|
778
|
+
CHANNEL_CLOSED: "peers:channel-closed"
|
|
779
|
+
};
|
|
768
780
|
var EXTERNAL_EVENTS = {
|
|
769
781
|
/** External request from authorized client */
|
|
770
782
|
REQUEST: "haextension:external:request",
|
|
@@ -1203,7 +1215,32 @@ var MODEL_COMMANDS = {
|
|
|
1203
1215
|
/** Starts a job; the result follows as an event */
|
|
1204
1216
|
start: "extension_model_job_start",
|
|
1205
1217
|
/** Cancels a running job of this frame */
|
|
1206
|
-
cancel: "extension_model_job_cancel"
|
|
1218
|
+
cancel: "extension_model_job_cancel",
|
|
1219
|
+
/** Asks for a grant before the first job; nothing goes to a model */
|
|
1220
|
+
requestAccess: "extension_model_access_request",
|
|
1221
|
+
/** Opens the host's page of this extension's models */
|
|
1222
|
+
openSettings: "extension_model_settings_open"
|
|
1223
|
+
};
|
|
1224
|
+
|
|
1225
|
+
// src/commands/peers.ts
|
|
1226
|
+
init_esm_shims();
|
|
1227
|
+
var PEER_COMMANDS = {
|
|
1228
|
+
/** Invites a contact; the outcome follows as `peers:invite-status` */
|
|
1229
|
+
invite: "extension_peers_invite",
|
|
1230
|
+
/** Withdraws an open invitation on all devices of the contact */
|
|
1231
|
+
inviteCancel: "extension_peers_invite_cancel",
|
|
1232
|
+
/** Opens a lobby and returns its join code */
|
|
1233
|
+
lobbyOpen: "extension_peers_lobby_open",
|
|
1234
|
+
/** Closes a lobby; its code stops working, its channels stay open */
|
|
1235
|
+
lobbyClose: "extension_peers_lobby_close",
|
|
1236
|
+
/** Joins a lobby by its code; waits at most 15 s for the host */
|
|
1237
|
+
join: "extension_peers_join",
|
|
1238
|
+
/** Closes a channel of an own lobby and keeps the device out of that lobby */
|
|
1239
|
+
remove: "extension_peers_remove",
|
|
1240
|
+
/** Sends a fast or a reliable message over a channel */
|
|
1241
|
+
send: "extension_peers_send",
|
|
1242
|
+
/** Closes a channel on both sides */
|
|
1243
|
+
close: "extension_peers_close"
|
|
1207
1244
|
};
|
|
1208
1245
|
|
|
1209
1246
|
// src/commands/mail.ts
|
|
@@ -1265,6 +1302,7 @@ var TAURI_COMMANDS = {
|
|
|
1265
1302
|
passwords: PASSWORD_COMMANDS,
|
|
1266
1303
|
contacts: CONTACT_COMMANDS,
|
|
1267
1304
|
models: MODEL_COMMANDS,
|
|
1305
|
+
peers: PEER_COMMANDS,
|
|
1268
1306
|
mail: MAIL_COMMANDS,
|
|
1269
1307
|
notifications: NOTIFICATION_COMMANDS
|
|
1270
1308
|
};
|
|
@@ -2459,6 +2497,24 @@ var ModelsAPI = class {
|
|
|
2459
2497
|
);
|
|
2460
2498
|
return answer.models;
|
|
2461
2499
|
}
|
|
2500
|
+
/**
|
|
2501
|
+
* Asks for a grant before the first job (holzi spec 055 US9) and resolves with the allowed
|
|
2502
|
+
* models that fit `needs`. Without one, the host asks the user as it would for a job, and the
|
|
2503
|
+
* SDK waits for the answer. Rejects with `no_capable_model` (8001) when no model of the host
|
|
2504
|
+
* fits and with a denial (1002) when the user refused. Nothing is sent to a model, and consent
|
|
2505
|
+
* for a destination outside this device is asked with the first job that sends data.
|
|
2506
|
+
*/
|
|
2507
|
+
async requestAccessAsync(request) {
|
|
2508
|
+
const answer = await this.client.request(
|
|
2509
|
+
MODEL_COMMANDS.requestAccess,
|
|
2510
|
+
{ ...request }
|
|
2511
|
+
);
|
|
2512
|
+
return answer.models;
|
|
2513
|
+
}
|
|
2514
|
+
/** Opens the host's page of this extension's models, where the user chooses models and effort. */
|
|
2515
|
+
async openSettingsAsync() {
|
|
2516
|
+
await this.client.request(MODEL_COMMANDS.openSettings, {});
|
|
2517
|
+
}
|
|
2462
2518
|
/** Starts a job; its end comes as {@link onCompleted}. Use {@link runAsync} to await it. */
|
|
2463
2519
|
async startAsync(job) {
|
|
2464
2520
|
const answer = await this.client.request(MODEL_COMMANDS.start, {
|
|
@@ -2531,6 +2587,158 @@ var ModelsAPI = class {
|
|
|
2531
2587
|
}
|
|
2532
2588
|
};
|
|
2533
2589
|
|
|
2590
|
+
// src/api/peers.ts
|
|
2591
|
+
init_esm_shims();
|
|
2592
|
+
init_vaultKey();
|
|
2593
|
+
var PEER_ERROR_KINDS = {
|
|
2594
|
+
contact_unknown: "PEER_CONTACT_UNKNOWN",
|
|
2595
|
+
invite_not_open: "PEER_INVITE_UNKNOWN",
|
|
2596
|
+
channel_unknown: "PEER_CHANNEL_CLOSED",
|
|
2597
|
+
channel_closed: "PEER_CHANNEL_CLOSED",
|
|
2598
|
+
too_large: "PEER_PAYLOAD_TOO_LARGE",
|
|
2599
|
+
lobby_closed: "PEER_LOBBY_CLOSED",
|
|
2600
|
+
not_admitted: "PEER_NOT_ALLOWED",
|
|
2601
|
+
limit: "PEER_LIMIT",
|
|
2602
|
+
network_unavailable: "PEER_NETWORK_UNAVAILABLE",
|
|
2603
|
+
invalid_input: "PEER_INVALID_INPUT"
|
|
2604
|
+
};
|
|
2605
|
+
var PeerError = class extends Error {
|
|
2606
|
+
constructor(code, reason, message, details = {}, options) {
|
|
2607
|
+
super(message, options);
|
|
2608
|
+
this.code = code;
|
|
2609
|
+
this.reason = reason;
|
|
2610
|
+
this.details = details;
|
|
2611
|
+
this.name = "PeerError";
|
|
2612
|
+
this.kind = PEER_ERROR_KINDS[reason];
|
|
2613
|
+
if (typeof details.limit === "number") this.limit = details.limit;
|
|
2614
|
+
}
|
|
2615
|
+
};
|
|
2616
|
+
function isPeerErrorReason(value) {
|
|
2617
|
+
return typeof value === "string" && Object.hasOwn(PEER_ERROR_KINDS, value);
|
|
2618
|
+
}
|
|
2619
|
+
function toPeerError(error) {
|
|
2620
|
+
if (typeof error !== "object" || error === null) return error;
|
|
2621
|
+
const { code, message, details } = error;
|
|
2622
|
+
if (typeof code !== "number" || typeof details !== "object" || details === null) return error;
|
|
2623
|
+
const reason = details.reason;
|
|
2624
|
+
if (!isPeerErrorReason(reason)) return error;
|
|
2625
|
+
return new PeerError(
|
|
2626
|
+
code,
|
|
2627
|
+
reason,
|
|
2628
|
+
typeof message === "string" ? message : reason,
|
|
2629
|
+
details,
|
|
2630
|
+
{ cause: error }
|
|
2631
|
+
);
|
|
2632
|
+
}
|
|
2633
|
+
var EVENT_NAMES = {
|
|
2634
|
+
"invite-status": PEERS_EVENTS.INVITE_STATUS,
|
|
2635
|
+
"channel-opened": PEERS_EVENTS.CHANNEL_OPENED,
|
|
2636
|
+
joined: PEERS_EVENTS.JOINED,
|
|
2637
|
+
message: PEERS_EVENTS.MESSAGE,
|
|
2638
|
+
"channel-closed": PEERS_EVENTS.CHANNEL_CLOSED
|
|
2639
|
+
};
|
|
2640
|
+
function decodeEvent(type, data) {
|
|
2641
|
+
if (typeof data !== "object" || data === null) return void 0;
|
|
2642
|
+
if (type !== "message") return data;
|
|
2643
|
+
const message = data;
|
|
2644
|
+
if (typeof message.channelId !== "string" || typeof message.data !== "string") return void 0;
|
|
2645
|
+
let decoded;
|
|
2646
|
+
try {
|
|
2647
|
+
decoded = base64ToArrayBuffer(message.data);
|
|
2648
|
+
} catch {
|
|
2649
|
+
return void 0;
|
|
2650
|
+
}
|
|
2651
|
+
if (arrayBufferToBase64(decoded) !== message.data) return void 0;
|
|
2652
|
+
return {
|
|
2653
|
+
channelId: message.channelId,
|
|
2654
|
+
data: decoded,
|
|
2655
|
+
reliable: message.reliable === true
|
|
2656
|
+
};
|
|
2657
|
+
}
|
|
2658
|
+
var PeersAPI = class {
|
|
2659
|
+
constructor(client) {
|
|
2660
|
+
this.client = client;
|
|
2661
|
+
/** Largest fast message (`reliable: false`) in bytes. */
|
|
2662
|
+
this.MAX_FAST_BYTES = 1024;
|
|
2663
|
+
/** Largest reliable message in bytes. */
|
|
2664
|
+
this.MAX_RELIABLE_BYTES = 65536;
|
|
2665
|
+
/** Largest `payload` of an invitation or a join, as JSON, in bytes. */
|
|
2666
|
+
this.MAX_PAYLOAD_BYTES = 4096;
|
|
2667
|
+
}
|
|
2668
|
+
async call(method, params) {
|
|
2669
|
+
try {
|
|
2670
|
+
return await this.client.request(method, params);
|
|
2671
|
+
} catch (error) {
|
|
2672
|
+
throw toPeerError(error);
|
|
2673
|
+
}
|
|
2674
|
+
}
|
|
2675
|
+
/** Invites a contact; the outcome follows as `invite-status` with this `inviteId`. */
|
|
2676
|
+
async inviteAsync(contactId, payload) {
|
|
2677
|
+
const answer = await this.call(PEER_COMMANDS.invite, { contactId, payload });
|
|
2678
|
+
return { inviteId: answer.inviteId };
|
|
2679
|
+
}
|
|
2680
|
+
/** Withdraws an open invitation on all devices of the contact; no `invite-status` follows. */
|
|
2681
|
+
async cancelInviteAsync(inviteId) {
|
|
2682
|
+
await this.call(PEER_COMMANDS.inviteCancel, { inviteId });
|
|
2683
|
+
}
|
|
2684
|
+
/**
|
|
2685
|
+
* Opens a lobby; `lobbyId` is 1–64 characters of `[A-Za-z0-9._-]`. The join code is opaque:
|
|
2686
|
+
* hand it on as it is.
|
|
2687
|
+
*/
|
|
2688
|
+
async openLobbyAsync(lobbyId, visibility) {
|
|
2689
|
+
const answer = await this.call(PEER_COMMANDS.lobbyOpen, { lobbyId, visibility });
|
|
2690
|
+
return { joinCode: answer.joinCode };
|
|
2691
|
+
}
|
|
2692
|
+
/** Closes a lobby: its code stops working, its channels stay open. An unknown lobby is fine. */
|
|
2693
|
+
async closeLobbyAsync(lobbyId) {
|
|
2694
|
+
await this.call(PEER_COMMANDS.lobbyClose, { lobbyId });
|
|
2695
|
+
}
|
|
2696
|
+
/**
|
|
2697
|
+
* Joins a lobby by its code with a self-chosen `displayName` (1–64 characters). The host
|
|
2698
|
+
* answers within 15 s; a lobby that cannot be joined for any reason rejects as `lobby_closed`.
|
|
2699
|
+
*/
|
|
2700
|
+
async joinAsync(joinCode, displayName, payload) {
|
|
2701
|
+
const answer = await this.call(PEER_COMMANDS.join, {
|
|
2702
|
+
joinCode,
|
|
2703
|
+
displayName,
|
|
2704
|
+
payload
|
|
2705
|
+
});
|
|
2706
|
+
return { channelId: answer.channelId, lobbyId: answer.lobbyId };
|
|
2707
|
+
}
|
|
2708
|
+
/** Closes a channel of an own lobby and keeps that device (and vault) out of the lobby. */
|
|
2709
|
+
async removeAsync(channelId) {
|
|
2710
|
+
await this.call(PEER_COMMANDS.remove, { channelId });
|
|
2711
|
+
}
|
|
2712
|
+
/**
|
|
2713
|
+
* Sends bytes over a channel: fast (default, at most {@link MAX_FAST_BYTES}, may be lost) or
|
|
2714
|
+
* `reliable` (at most {@link MAX_RELIABLE_BYTES}, in order; 16 may wait per channel).
|
|
2715
|
+
*/
|
|
2716
|
+
async sendAsync(channelId, data, options = {}) {
|
|
2717
|
+
await this.call(PEER_COMMANDS.send, {
|
|
2718
|
+
channelId,
|
|
2719
|
+
data: { $bytes: arrayBufferToBase64(data) },
|
|
2720
|
+
reliable: options.reliable ?? false
|
|
2721
|
+
});
|
|
2722
|
+
}
|
|
2723
|
+
/** Closes a channel; both sides get `channel-closed` with `reason: "closed"`. */
|
|
2724
|
+
async closeAsync(channelId) {
|
|
2725
|
+
await this.call(PEER_COMMANDS.close, { channelId });
|
|
2726
|
+
}
|
|
2727
|
+
/**
|
|
2728
|
+
* Listens for one of the peers events (`invite-status`, `channel-opened`, `joined`, `message`,
|
|
2729
|
+
* `channel-closed`); `message.data` arrives as bytes. Returns an unsubscribe function.
|
|
2730
|
+
*/
|
|
2731
|
+
on(type, handler) {
|
|
2732
|
+
const name = EVENT_NAMES[type];
|
|
2733
|
+
const wrapped = (event) => {
|
|
2734
|
+
const decoded = decodeEvent(type, event.data);
|
|
2735
|
+
if (decoded) handler(decoded);
|
|
2736
|
+
};
|
|
2737
|
+
this.client.on(name, wrapped);
|
|
2738
|
+
return () => this.client.off(name, wrapped);
|
|
2739
|
+
}
|
|
2740
|
+
};
|
|
2741
|
+
|
|
2534
2742
|
// src/api/mail.ts
|
|
2535
2743
|
init_esm_shims();
|
|
2536
2744
|
var MailAPI = class {
|
|
@@ -3648,6 +3856,7 @@ var HaexVaultSdk = class {
|
|
|
3648
3856
|
this.passwords = new PasswordsAPI(this);
|
|
3649
3857
|
this.contacts = new ContactsAPI(this);
|
|
3650
3858
|
this.models = new ModelsAPI(this);
|
|
3859
|
+
this.peers = new PeersAPI(this);
|
|
3651
3860
|
this.mail = new MailAPI(this);
|
|
3652
3861
|
this.notifications = new NotificationsAPI(this);
|
|
3653
3862
|
this.tab = new TabAPI(this);
|
|
@@ -4517,6 +4726,6 @@ function createHaexVaultSdk(config = {}) {
|
|
|
4517
4726
|
return new HaexVaultSdk(config);
|
|
4518
4727
|
}
|
|
4519
4728
|
|
|
4520
|
-
export { CONTACT_COMMANDS, COSE_ALGORITHM, ContactsAPI, DEFAULT_TIMEOUT, DatabaseAPI, DialogAPI, ENCRYPTED_FOLDER_COMMANDS, EXTERNAL_EVENTS, EncryptedFoldersAPI, ErrorCode, ExternalConnectionErrorCode, ExternalConnectionState, FilesystemAPI, HAEXSPACE_MESSAGE_TYPES, HAEXTENSION_EVENTS, HaexVaultSdk, HaexVaultSdkError, HostErrorCode, KEY_AGREEMENT_ALGO, KnownPath, LOCALSEND_EVENTS, LocalSendAPI, MAIL_COMMANDS, MAIL_EVENTS, MODEL_COMMANDS, MODEL_JOB_EVENTS, MailAPI, ModelsAPI, NOTIFICATION_COMMANDS, NOTIFICATION_EVENTS, NotificationsAPI, PASSWORD_COMMANDS, PasswordsAPI, PermissionErrorCode, PermissionStatus, PermissionsAPI, RemoteStorageAPI, SHELL_EVENTS, SIGNING_ALGO, SPACE_COMMANDS, ShellAPI, SpacesAPI, TABLE_SEPARATOR, TAURI_COMMANDS, TabAPI, ToolsAPI, WebAPI, arrayBufferToBase64, base58btcDecode, base58btcEncode, base64ToArrayBuffer, canExternalClientSendRequests, createHaexVaultSdk, decryptCrdtData, decryptPrivateKeyAsync, decryptSpaceNameAsync, decryptString, decryptVaultKey, decryptVaultName, decryptWithPrivateKeyAsync, deriveKeyFromPassword, didKeyToPublicKeyAsync, encryptCrdtData, encryptPrivateKeyAsync, encryptSpaceNameAsync, encryptString, encryptVaultKey, encryptWithPublicKeyAsync, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, exportUserKeypairAsync, generateCredentialId, generateIdentityAsync, generatePasskeyPairAsync, generateSpaceKey, generateUserKeypairAsync, generateVaultKey, getTableName, importPrivateKeyAsync, importPrivateKeyForKeyAgreementAsync, importPublicKeyAsync, importPublicKeyForKeyAgreementAsync, importUserPrivateKeyAsync, importUserPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, isExternalClientConnected, isPermissionDeniedError, isPermissionError, isPermissionPromptError, publicKeyToDidKeyAsync, signClaimPresentationAsync, signRecordAsync, signSpaceChallengeAsync, signWithPasskeyAsync, unwrapKey, verifyClaimPresentationAsync, verifyRecordSignatureAsync, verifySpaceChallengeAsync, verifyWithPasskeyAsync, wrapKey };
|
|
4729
|
+
export { CONTACT_COMMANDS, COSE_ALGORITHM, ContactsAPI, DEFAULT_TIMEOUT, DatabaseAPI, DialogAPI, ENCRYPTED_FOLDER_COMMANDS, EXTERNAL_EVENTS, EncryptedFoldersAPI, ErrorCode, ExternalConnectionErrorCode, ExternalConnectionState, FilesystemAPI, HAEXSPACE_MESSAGE_TYPES, HAEXTENSION_EVENTS, HaexVaultSdk, HaexVaultSdkError, HostErrorCode, KEY_AGREEMENT_ALGO, KnownPath, LOCALSEND_EVENTS, LocalSendAPI, MAIL_COMMANDS, MAIL_EVENTS, MODEL_COMMANDS, MODEL_JOB_EVENTS, MailAPI, ModelsAPI, NOTIFICATION_COMMANDS, NOTIFICATION_EVENTS, NotificationsAPI, PASSWORD_COMMANDS, PEERS_EVENTS, PEER_COMMANDS, PEER_ERROR_KINDS, PasswordsAPI, PeerError, PeersAPI, PermissionErrorCode, PermissionStatus, PermissionsAPI, RemoteStorageAPI, SHELL_EVENTS, SIGNING_ALGO, SPACE_COMMANDS, ShellAPI, SpacesAPI, TABLE_SEPARATOR, TAURI_COMMANDS, TabAPI, ToolsAPI, WebAPI, arrayBufferToBase64, base58btcDecode, base58btcEncode, base64ToArrayBuffer, canExternalClientSendRequests, createHaexVaultSdk, decryptCrdtData, decryptPrivateKeyAsync, decryptSpaceNameAsync, decryptString, decryptVaultKey, decryptVaultName, decryptWithPrivateKeyAsync, deriveKeyFromPassword, didKeyToPublicKeyAsync, encryptCrdtData, encryptPrivateKeyAsync, encryptSpaceNameAsync, encryptString, encryptVaultKey, encryptWithPublicKeyAsync, exportKeyPairAsync, exportPrivateKeyAsync, exportPublicKeyAsync, exportPublicKeyCoseAsync, exportUserKeypairAsync, generateCredentialId, generateIdentityAsync, generatePasskeyPairAsync, generateSpaceKey, generateUserKeypairAsync, generateVaultKey, getTableName, importPrivateKeyAsync, importPrivateKeyForKeyAgreementAsync, importPublicKeyAsync, importPublicKeyForKeyAgreementAsync, importUserPrivateKeyAsync, importUserPublicKeyAsync, installBaseTag, installCookiePolyfill, installHistoryPolyfill, installLocalStoragePolyfill, installPolyfills, installSessionStoragePolyfill, isExternalClientConnected, isPermissionDeniedError, isPermissionError, isPermissionPromptError, publicKeyToDidKeyAsync, signClaimPresentationAsync, signRecordAsync, signSpaceChallengeAsync, signWithPasskeyAsync, unwrapKey, verifyClaimPresentationAsync, verifyRecordSignatureAsync, verifySpaceChallengeAsync, verifyWithPasskeyAsync, wrapKey };
|
|
4521
4730
|
//# sourceMappingURL=index.mjs.map
|
|
4522
4731
|
//# sourceMappingURL=index.mjs.map
|