javy-plugin-api 5.0.0

APIs for Javy plugins
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

<div align="center">
  <h1><code>javy-plugin-api</code></h1>
  <p>
    <strong>A crate for creating Javy plugins</strong>
  </p>
  <p>
    <a href="https://docs.rs/javy-plugin-api"><img src="https://docs.rs/javy-plugin-api/badge.svg" alt="Documentation Status" /></a>
    <a href="https://crates.io/crates/javy-plugin-api"><img src="https://img.shields.io/crates/v/javy-plugin-api.svg" alt="crates.io status" /></a>
  </p>
</div>

Refer to the [crate level documentation](https://docs.rs/javy-plugin-api) to learn more.

Example usage for WASI preview 2 plugins:

```rust
use javy_plugin_api::{
    javy::{quickjs::prelude::Func, Runtime},
    javy_plugin, Config,
};

wit_bindgen::generate!({ world: "my-javy-plugin-v1", generate_all });

fn config() -> Config {
    let mut config = Config::default();
    config
        .text_encoding(true)
        .javy_stream_io(true);
    config
}

fn modify_runtime(runtime: Runtime) -> Runtime {
    runtime.context().with(|ctx| {
        ctx.globals().set("plugin", true).unwrap();
    });
    runtime
}

struct Component;

// Dynamically linked modules will use `my_javy_plugin_v1` as the import
// namespace.
javy_plugin!("my-javy-plugin-v1", Component, config, modify_runtime);

export!(Component);
```

See the crate documentation for WASI preview 1 plugins.

## Migration for v2.0.0

Please read the extending Javy documentation for the new plugin API details.

To update your plugin:
1. Create a directory named `wit` adjacent to the `Cargo.toml` file
2. Inside that `wit` directory, create a WIT file matching the details in the
   extending Javy documentation
3. Create a `config() -> Config` function that will return a Javy config
4. Create a `modify_runtime(runtime: Runtime) -> Runtime` function that will
   perform whatever modifications to `runtime` that are necessary
5. Add a dependency on `wit-bindgen` to your crate
6. Use `wit_bindgen::generate!` to create the required traits from the WIT file
7. Create a struct type
8. Remove `import_namespace!` and use `javy_plugin!` instead. Ensure you use a
   different value for the `import_namespace` parameter since the API has
   changed. Pass your struct type, your `config` function, and your
   `modify_runtime` function.
9. Call `export!` on your struct type.

## Publishing to crates.io

To publish this crate to crates.io, run `./publish.sh`.