46 |
47 |
48 |
49 |
50 |
51 | `;
52 |
--------------------------------------------------------------------------------
/dist-js/index.mjs.map:
--------------------------------------------------------------------------------
1 | {"version":3,"file":"index.mjs","sources":["../guest-js/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAsDc,MAAO,SAAS,CAAA;IAI5B,WAAA,CAAY,EAAU,EAAE,SAAwC,EAAA;AAC9D,QAAA,IAAI,CAAC,EAAE,GAAG,EAAE;AACZ,QAAA,IAAI,CAAC,SAAS,GAAG,SAAS;IAC5B;AAEA,IAAA,aAAa,OAAO,CAClB,GAAW,EACX,MAAyB,EAAA;QAEzB,MAAM,SAAS,GAAkC,EAAE;AACnD,QAAA,MAAM,OAAO,GAAG,CAAC,OAAgB,KAAU;AACzC,YAAA,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;AACtC,QAAA,CAAC;QAED,IAAI,MAAM,aAAN,MAAM,KAAA,MAAA,GAAA,MAAA,GAAN,MAAM,CAAE,OAAO,EAAE;AACnB,YAAA,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;QACpE;AAEA,QAAA,OAAO,MAAM,MAAM,CAAS,0BAA0B,EAAE;YACtD,GAAG;AACH,YAAA,gBAAgB,EAAE,iBAAiB,CAAC,OAAO,CAAC;YAC5C,MAAM;AACP,SAAA,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,IAAI,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;IAC/C;AAEA,IAAA,WAAW,CAAC,EAA0B,EAAA;AACpC,QAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IACzB;IAEA,MAAM,IAAI,CAAC,OAAoC,EAAA;AAC7C,QAAA,IAAI,CAAU;AACd,QAAA,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC/B,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE;QACrC;aAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,MAAM,IAAI,OAAO,EAAE;YAC3D,CAAC,GAAG,OAAO;QACb;AAAO,aAAA,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACjC,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE;QACvC;aAAO;AACL,YAAA,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG;QACH;AACA,QAAA,OAAO,MAAM,MAAM,CAAC,uBAAuB,EAAE;YAC3C,EAAE,EAAE,IAAI,CAAC,EAAE;AACX,YAAA,OAAO,EAAE,CAAC;AACX,SAAA,CAAC;IACJ;AAEA,IAAA,MAAM,UAAU,GAAA;AACd,QAAA,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC;AACrB,YAAA,IAAI,EAAE,OAAO;AACb,YAAA,IAAI,EAAE;AACJ,gBAAA,IAAI,EAAE,IAAI;AACV,gBAAA,MAAM,EAAE,wBAAwB;AACjC,aAAA;AACF,SAAA,CAAC;IACJ;AACD;;;;"}
--------------------------------------------------------------------------------
/dist-js/index.mjs:
--------------------------------------------------------------------------------
1 | import { invoke, transformCallback } from '@tauri-apps/api/tauri';
2 |
3 | class WebSocket {
4 | constructor(id, listeners) {
5 | this.id = id;
6 | this.listeners = listeners;
7 | }
8 | static async connect(url, config) {
9 | const listeners = [];
10 | const handler = (message) => {
11 | listeners.forEach((l) => l(message));
12 | };
13 | if (config === null || config === void 0 ? void 0 : config.headers) {
14 | config.headers = Array.from(new Headers(config.headers).entries());
15 | }
16 | return await invoke("plugin:websocket|connect", {
17 | url,
18 | callbackFunction: transformCallback(handler),
19 | config,
20 | }).then((id) => new WebSocket(id, listeners));
21 | }
22 | addListener(cb) {
23 | this.listeners.push(cb);
24 | }
25 | async send(message) {
26 | let m;
27 | if (typeof message === "string") {
28 | m = { type: "Text", data: message };
29 | }
30 | else if (typeof message === "object" && "type" in message) {
31 | m = message;
32 | }
33 | else if (Array.isArray(message)) {
34 | m = { type: "Binary", data: message };
35 | }
36 | else {
37 | throw new Error("invalid `message` type, expected a `{ type: string, data: any }` object, a string or a numeric array");
38 | }
39 | return await invoke("plugin:websocket|send", {
40 | id: this.id,
41 | message: m,
42 | });
43 | }
44 | async disconnect() {
45 | return await this.send({
46 | type: "Close",
47 | data: {
48 | code: 1000,
49 | reason: "Disconnected by client",
50 | },
51 | });
52 | }
53 | }
54 |
55 | export { WebSocket as default };
56 | //# sourceMappingURL=index.mjs.map
57 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 |
4 |
5 | ## Install
6 |
7 | _This plugin requires a Rust version of at least **1.67**_
8 |
9 | There are three general methods of installation that we can recommend.
10 |
11 | 1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
12 | 2. Pull sources directly from Github using git tags / revision hashes (most secure)
13 | 3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
14 |
15 | Install the Core plugin by adding the following to your `Cargo.toml` file:
16 |
17 | `src-tauri/Cargo.toml`
18 |
19 | ```toml
20 | [dependencies]
21 | tauri-plugin-websocket = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v1" }
22 | ```
23 |
24 | You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
25 |
26 | > Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
27 |
28 | ```sh
29 | pnpm add https://github.com/tauri-apps/tauri-plugin-websocket#v1
30 | # or
31 | npm add https://github.com/tauri-apps/tauri-plugin-websocket#v1
32 | # or
33 | yarn add https://github.com/tauri-apps/tauri-plugin-websocket#v1
34 | ```
35 |
36 | ## Usage
37 |
38 | First you need to register the core plugin with Tauri:
39 |
40 | `src-tauri/src/main.rs`
41 |
42 | ```rust
43 | fn main() {
44 | tauri::Builder::default()
45 | .plugin(tauri_plugin_websocket::init())
46 | .run(tauri::generate_context!())
47 | .expect("error while running tauri application");
48 | }
49 | ```
50 |
51 | Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
52 |
53 | ```javascript
54 | import WebSocket from "tauri-plugin-websocket-api";
55 |
56 | const ws = await WebSocket.connect("wss://example.com");
57 |
58 | await ws.send("Hello World");
59 |
60 | await ws.disconnect();
61 | ```
62 |
63 | ## Contributing
64 |
65 | PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
66 |
67 | ## Partners
68 |
69 |
73 |
74 | 
75 |
76 | |
77 |