asciidoc-editor 0.1.0 → 0.1.2

package/README.md

@@ -8,6 +8,17 @@ edited underneath.
 Parsing and rendering are [`asciidoc-parser`] and [`asciidoc-html5`]; the
 interface is [Leptos].
 
+<!--
+  Absolute, not relative: this README is copied into the npm package, and
+  npmjs.com cannot resolve a path into the repository. And media., not raw.,
+  because the screenshot is held in git-lfs — raw.githubusercontent.com hands
+  back the pointer file rather than the image.
+-->
+![The editor showing a rendered AsciiDoc document — a title, a table of
+contents, headings, a list, a code block and a table — with the formatting
+toolbar above
+it.](https://media.githubusercontent.com/media/AlexanderThaller/asciidoc-editor/main/docs/screenshot.png)
+
 ## Using it in a page
 
 ```sh
@@ -85,13 +96,37 @@ python3 -m http.server 8000
 
 ### Publishing
 
+Releases go out from CI, which needs no token and no second factor: npm trusts
+`.github/workflows/release.yml` by name and the runner proves it is that
+workflow with an OIDC token.
+
 ```sh
-./build-package.sh
-npm publish ./pkg
+git tag v0.1.1 && git push origin v0.1.1
 ```
 
-The leading `./` matters: `npm publish pkg` reads `pkg` as the name of a
-package on the registry and tries to publish that one.
+The workflow refuses to publish if the tag and the version in `Cargo.toml`
+disagree.
+
+Setting that trust up is a one-off, and it has an awkward first step: npm will
+only configure a trusted publisher for a package that already exists, so the
+very first release has to be published by hand.
+
+1. `./build-package.sh && npm publish ./pkg` — the leading `./` matters, since
+   `npm publish pkg` reads `pkg` as the name of a package on the registry and
+   tries to publish that one. Publishing by hand needs 2FA on the account: npm
+   now accepts only a security key, added at
+   `npmjs.com/settings/<user>/tfa`.
+2. On the package's settings page at npmjs.com, add a trusted publisher: this
+   repository, workflow `release.yml`.
+3. Every release after that is the tag above.
+
+The trusted publisher is a record against the package, not against the
+repository, and `npm publish` fails with "package not found" when it is
+missing — whatever the package's own state. `npm trust list asciidoc-editor`
+shows it; `npm trust github asciidoc-editor --file release.yml --repo
+AlexanderThaller/asciidoc-editor --allow-publish` creates it. The publish
+grant is not implied, and the environment must be left unset, because the
+workflow declares none.
 
 ## Licence
 
@@ -99,11 +134,24 @@ MIT. See `LICENSE`.
 
 ## Developing
 
+Every tool this needs is in the flake, pinned by `flake.lock` — the same
+compiler, generator and optimiser here as in CI:
+
 ```sh
+nix develop
 trunk serve      # the editor on its own at http://localhost:8080
 cargo test       # the source-editing and parsing logic
 ```
 
+With direnv, `direnv allow` enters it for you. Without Nix it still builds from
+whatever is on PATH, so long as `wasm-bindgen` matches the version in
+`Cargo.lock` — `build-package.sh` refuses to run when it does not, because a
+mismatch yields a module the browser rejects at load.
+
+That pin runs the other way too: `wasm-bindgen` is held at an exact version in
+`Cargo.toml` because it has to match the CLI nixpkgs provides. Moving one means
+moving both.
+
 `trunk serve` runs `src/main.rs`, which is the same library mounted onto a bare
 page.
 

package/asciidoc_editor.d.ts

@@ -97,13 +97,14 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
     readonly __wbg_editor_free: (a: number, b: number) => void;
-    readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
-    readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;
-    readonly __wbg_intounderlyingsource_free: (a: number, b: number) => void;
     readonly editor_destroy: (a: number) => void;
     readonly editor_onChange: (a: number, b: any) => void;
     readonly editor_setValue: (a: number, b: number, c: number) => void;
     readonly editor_value: (a: number) => [number, number];
+    readonly mount: (a: any, b: number) => [number, number, number];
+    readonly __wbg_intounderlyingbytesource_free: (a: number, b: number) => void;
+    readonly __wbg_intounderlyingsink_free: (a: number, b: number) => void;
+    readonly __wbg_intounderlyingsource_free: (a: number, b: number) => void;
     readonly intounderlyingbytesource_autoAllocateChunkSize: (a: number) => number;
     readonly intounderlyingbytesource_cancel: (a: number) => void;
     readonly intounderlyingbytesource_pull: (a: number, b: any) => any;
@@ -114,18 +115,17 @@ export interface InitOutput {
     readonly intounderlyingsink_write: (a: number, b: any) => any;
     readonly intounderlyingsource_cancel: (a: number) => void;
     readonly intounderlyingsource_pull: (a: number, b: any) => any;
-    readonly mount: (a: any, b: number) => [number, number, number];
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___js_sys_b5492ab1ec297925___Function_fn_wasm_bindgen_56bfa123189e575a___JsValue_____wasm_bindgen_56bfa123189e575a___sys__Undefined___js_sys_b5492ab1ec297925___Function_fn_wasm_bindgen_56bfa123189e575a___JsValue_____wasm_bindgen_56bfa123189e575a___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___wasm_bindgen_56bfa123189e575a___JsValue__core_dcdb5b26ee14507c___result__Result_____wasm_bindgen_56bfa123189e575a___JsError___true_: (a: number, b: number, c: any) => [number, number];
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___wasm_bindgen_56bfa123189e575a___JsValue______true_: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___wasm_bindgen_56bfa123189e575a___JsValue______true__20: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___web_sys_7d5907b0b8adcf95___features__gen_CloseEvent__CloseEvent______true_: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___web_sys_7d5907b0b8adcf95___features__gen_DragEvent__DragEvent______true_: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___web_sys_7d5907b0b8adcf95___features__gen_DragEvent__DragEvent______true__19: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___web_sys_7d5907b0b8adcf95___features__gen_DragEvent__DragEvent______true__22: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke___web_sys_7d5907b0b8adcf95___features__gen_DragEvent__DragEvent______true__23: (a: number, b: number, c: any) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke_______true_: (a: number, b: number) => void;
-    readonly wasm_bindgen_56bfa123189e575a___convert__closures_____invoke_______true__1_: (a: number, b: number) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___wasm_bindgen_c467f9011b18c78b___JsValue__core_83f2c1a17d31e451___result__Result_____wasm_bindgen_c467f9011b18c78b___JsError___true_: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___js_sys_8529a515a58b8dfc___Function_fn_wasm_bindgen_c467f9011b18c78b___JsValue_____wasm_bindgen_c467f9011b18c78b___sys__Undefined___js_sys_8529a515a58b8dfc___Function_fn_wasm_bindgen_c467f9011b18c78b___JsValue_____wasm_bindgen_c467f9011b18c78b___sys__Undefined_______true_: (a: number, b: number, c: any, d: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___wasm_bindgen_c467f9011b18c78b___JsValue______true_: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___web_sys_32935426f250c96f___features__gen_DragEvent__DragEvent______true_: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___web_sys_32935426f250c96f___features__gen_DragEvent__DragEvent______true__3: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___wasm_bindgen_c467f9011b18c78b___JsValue______true__4: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___web_sys_32935426f250c96f___features__gen_CloseEvent__CloseEvent______true_: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___web_sys_32935426f250c96f___features__gen_DragEvent__DragEvent______true__6: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke___web_sys_32935426f250c96f___features__gen_DragEvent__DragEvent______true__7: (a: number, b: number, c: any) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke_______true__1_: (a: number, b: number) => void;
+    readonly wasm_bindgen_c467f9011b18c78b___convert__closures_____invoke_______true_: (a: number, b: number) => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __externref_table_alloc: () => number;