asciidoc-editor 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alexander Thaller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALING IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,134 @@
+# AsciiDoc editor
+
+A WYSIWYG AsciiDoc editor for the web, written in Rust and compiled to
+WebAssembly. You edit the rendered document — click a heading and type in it,
+press Tab in a list to indent — and the AsciiDoc source stays the thing being
+edited underneath.
+
+Parsing and rendering are [`asciidoc-parser`] and [`asciidoc-html5`]; the
+interface is [Leptos].
+
+## Using it in a page
+
+```sh
+npm install asciidoc-editor
+```
+
+Or build it yourself, which is what `npm publish ./pkg` publishes:
+
+```sh
+./build-package.sh
+```
+
+Either way you get an ES module, its wasm, and TypeScript types — and nothing
+else to serve, because the stylesheets are inside the wasm.
+
+```html
+<div id="editor" style="height: 34rem"></div>
+
+<script type="module">
+  import init, { mount } from "./pkg/asciidoc_editor.js";
+
+  await init();
+  const editor = mount("#editor", { value: "= Title\n\nWords.\n" });
+
+  editor.onChange((document) => save(document));
+</script>
+```
+
+The editor fills the element it is given, so give that element a height.
+
+Loading the module from a bundler works the same way. The wasm is fetched
+relative to the module (`new URL(..., import.meta.url)`), which Vite, webpack 5
+and esbuild all understand without configuration.
+
+### TypeScript
+
+The types ship with the package. wasm-bindgen writes a `[Symbol.dispose]()` on
+its classes, so a project compiling the package's own declarations needs either
+`"skipLibCheck": true` — which most templates set already — or `"lib"` at
+`ESNext`.
+
+### `mount(target, options?)`
+
+`target` is a CSS selector or an element (`MountTarget`). The element keeps
+whatever classes the page put on it.
+
+| Option | Default | |
+|---|---|---|
+| `value` | the sample document | the document to open with |
+| `autosave` | none | a `localStorage` key to keep the document under |
+| `richText` | `true` | start in rich text rather than source |
+
+With `autosave` set and no `value`, the editor opens whatever was last saved
+under that key.
+
+### The handle
+
+| | |
+|---|---|
+| `editor.value()` | the document, as AsciiDoc |
+| `editor.setValue(source)` | replace the document |
+| `editor.onChange(callback)` | called with the document whenever it changes |
+| `editor.destroy()` | take the editor off the page |
+
+Hold on to the handle. Dropping it unmounts the editor, which is what
+`destroy()` does deliberately; after it the element is as it was found, and can
+be mounted into again.
+
+`demo/index.html` is a page doing all of this. Serve the repository root and
+open `/demo/`:
+
+```sh
+python3 -m http.server 8000
+```
+
+### Publishing
+
+```sh
+./build-package.sh
+npm publish ./pkg
+```
+
+The leading `./` matters: `npm publish pkg` reads `pkg` as the name of a
+package on the registry and tries to publish that one.
+
+## Licence
+
+MIT. See `LICENSE`.
+
+## Developing
+
+```sh
+trunk serve      # the editor on its own at http://localhost:8080
+cargo test       # the source-editing and parsing logic
+```
+
+`trunk serve` runs `src/main.rs`, which is the same library mounted onto a bare
+page.
+
+### How it works
+
+The AsciiDoc source is the only state. It is rendered to HTML with source
+locations turned on, which puts a `data-source-line` on every block, and that
+HTML goes into an iframe. Blocks in the iframe are made `contenteditable`; when
+one changes, its DOM is written back out as AsciiDoc and spliced over the lines
+it came from.
+
+A block is only made editable if writing its DOM back reproduces its source
+exactly. Anything that fails that check is left alone and can still be edited
+in source mode — better a block that refuses to be edited in place than one
+that quietly rewrites itself.
+
+The block being edited is never re-rendered, or the caret would be lost; the
+line numbers of the blocks below it are shifted instead.
+
+### What stays source-only
+
+Cell specifiers (`2+|`, `a|`, `^|`), explicitly numbered ordered lists, image
+sizing attributes, and anything else that would not survive the round trip.
+Strikethrough is not implemented.
+
+[`asciidoc-parser`]: https://crates.io/crates/asciidoc-parser
+[`asciidoc-html5`]: https://crates.io/crates/asciidoc-html5
+[Leptos]: https://leptos.dev

package/asciidoc_editor.d.ts

@@ -0,0 +1,160 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * The `ReadableStreamType` enum.
+ *
+ * *This API requires the following crate features to be activated: `ReadableStreamType`*
+ */
+
+export type ReadableStreamType = "bytes";
+
+/** What the editor may be told when it is mounted. */
+export interface MountOptions {
+    /** The document to open with. Defaults to a sample document. */
+    value?: string;
+    /** A `localStorage` key to keep the document under. */
+    autosave?: string;
+    /** Start in rich text rather than source. Defaults to `true`. */
+    richText?: boolean;
+}
+
+/** The element to mount into, or a selector naming it. */
+export type MountTarget = Element | string;
+
+/** Called with the document, as AsciiDoc, whenever it changes. */
+export type ChangeCallback = (document: string) => void;
+
+
+
+/**
+ * A mounted editor.
+ *
+ * Hold on to it: letting it go takes the editor off the page, which is what
+ * [`Editor::destroy`] does deliberately.
+ */
+export class Editor {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Takes the editor off the page, leaving the element as it was found.
+     */
+    destroy(): void;
+    /**
+     * Calls `callback` with the document whenever it changes.
+     */
+    onChange(callback: ChangeCallback): void;
+    /**
+     * Replaces the document.
+     */
+    setValue(source: string): void;
+    /**
+     * The document, as AsciiDoc.
+     */
+    value(): string;
+}
+
+export class IntoUnderlyingByteSource {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    cancel(): void;
+    pull(controller: ReadableByteStreamController): Promise<any>;
+    start(controller: ReadableByteStreamController): void;
+    readonly autoAllocateChunkSize: number;
+    readonly type: ReadableStreamType;
+}
+
+export class IntoUnderlyingSink {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    abort(reason: any): Promise<any>;
+    close(): Promise<any>;
+    write(chunk: any): Promise<any>;
+}
+
+export class IntoUnderlyingSource {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    cancel(): void;
+    pull(controller: ReadableStreamDefaultController): Promise<any>;
+}
+
+/**
+ * Puts an editor inside the element named by `target`, a CSS selector or the
+ * element itself.
+ *
+ * Options, all of them optional: `value` to open with, `autosave` naming a
+ * `localStorage` key to keep the document under, and `richText` to start in
+ * rich text rather than source (the default).
+ */
+export function mount(target: MountTarget, options?: MountOptions | null): Editor;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+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 intounderlyingbytesource_autoAllocateChunkSize: (a: number) => number;
+    readonly intounderlyingbytesource_cancel: (a: number) => void;
+    readonly intounderlyingbytesource_pull: (a: number, b: any) => any;
+    readonly intounderlyingbytesource_start: (a: number, b: any) => void;
+    readonly intounderlyingbytesource_type: (a: number) => number;
+    readonly intounderlyingsink_abort: (a: number, b: any) => any;
+    readonly intounderlyingsink_close: (a: number) => any;
+    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 __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_destroy_closure: (a: number, b: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;