@ox-content/wasm 2.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ubugeeei
+
+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 DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# @ox-content/wasm
+
+WebAssembly bindings for Ox Content's Rust Markdown engine.
+
+Use this package when you want to run Ox Content in the browser, a Web Worker, or another JavaScript environment that can load `.wasm` from ESM.
+
+If you are building for Node.js, prefer [`@ox-content/napi`](https://www.npmjs.com/package/@ox-content/napi).
+
+## Installation
+
+```bash
+pnpm add @ox-content/wasm
+```
+
+## Usage
+
+```ts
+import init, { parseAndRender, WasmParserOptions } from "@ox-content/wasm";
+
+await init();
+
+const options = new WasmParserOptions();
+options.gfm = true;
+options.tables = true;
+options.taskLists = true;
+
+const result = parseAndRender("# Hello from WASM", options);
+console.log(result.html);
+```
+
+## API
+
+The current WebAssembly surface exposes:
+
+- `parseAndRender(source, options?)`
+- `transform(source, options?)`
+- `version()`
+- `WasmParserOptions`
+
+## Notes
+
+- The generated module is ESM-only.
+- The default `init()` call loads `ox_content_wasm_bg.wasm` relative to the package entry.
+- For server-side Node.js usage, use `@ox-content/napi` instead.
+
+## Local Build
+
+From the repository root:
+
+```bash
+vp run build:wasm
+pnpm --filter @ox-content/wasm pack --dry-run
+```
+
+This generates a publish-ready package in `crates/ox_content_wasm/pkg/`.
+
+## First Local Publish
+
+Use `pnpm --filter` from the workspace root so you do not accidentally target the wrong package:
+
+```bash
+pnpm whoami || pnpm login
+pnpm --filter @ox-content/wasm publish --access public --no-git-checks
+```
+
+Avoid `pnpm -r publish` here, because that would try to publish every publishable package in the workspace.

package/ox_content_wasm.d.ts

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export class WasmParserOptions {
+  free(): void;
+  [Symbol.dispose](): void;
+  constructor();
+  set tables(value: boolean);
+  set autolinks(value: boolean);
+  set footnotes(value: boolean);
+  set taskLists(value: boolean);
+  set strikethrough(value: boolean);
+  set tocMaxDepth(value: number);
+  set gfm(value: boolean);
+}
+
+/**
+ * Parses Markdown and renders to HTML.
+ */
+export function parseAndRender(source: string, options?: WasmParserOptions | null): any;
+
+/**
+ * Transforms Markdown source into HTML, frontmatter, and TOC.
+ */
+export function transform(source: string, options?: WasmParserOptions | null): any;
+
+/**
+ * Returns the version of ox_content_wasm.
+ */
+export function version(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly __wbg_wasmparseroptions_free: (a: number, b: number) => void;
+  readonly parseAndRender: (a: number, b: number, c: number) => number;
+  readonly transform: (a: number, b: number, c: number) => number;
+  readonly version: (a: number) => void;
+  readonly wasmparseroptions_new: () => number;
+  readonly wasmparseroptions_set_autolinks: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_footnotes: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_gfm: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_strikethrough: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_tables: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_task_lists: (a: number, b: number) => void;
+  readonly wasmparseroptions_set_toc_max_depth: (a: number, b: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_export: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_export2: (a: number, b: number) => number;
+  readonly __wbindgen_export3: (a: number, b: number, c: number, d: number) => number;
+}
+
+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>;

package/ox_content_wasm.js

@@ -0,0 +1,411 @@
+let wasm;
+
+function addHeapObject(obj) {
+    if (heap_next === heap.length) heap.push(heap.length + 1);
+    const idx = heap_next;
+    heap_next = heap[idx];
+
+    heap[idx] = obj;
+    return idx;
+}
+
+function _assertClass(instance, klass) {
+    if (!(instance instanceof klass)) {
+        throw new Error(`expected instance of ${klass.name}`);
+    }
+}
+
+function dropObject(idx) {
+    if (idx < 132) return;
+    heap[idx] = heap_next;
+    heap_next = idx;
+}
+
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function getObject(idx) { return heap[idx]; }
+
+let heap = new Array(128).fill(undefined);
+heap.push(undefined, null, true, false);
+
+let heap_next = heap.length;
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeObject(idx) {
+    const ret = getObject(idx);
+    dropObject(idx);
+    return ret;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    }
+}
+
+let WASM_VECTOR_LEN = 0;
+
+const WasmParserOptionsFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_wasmparseroptions_free(ptr >>> 0, 1));
+
+/**
+ * Parser options.
+ */
+export class WasmParserOptions {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        WasmParserOptionsFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_wasmparseroptions_free(ptr, 0);
+    }
+    /**
+     * @param {boolean} value
+     */
+    set tables(value) {
+        wasm.wasmparseroptions_set_tables(this.__wbg_ptr, value);
+    }
+    /**
+     * @param {boolean} value
+     */
+    set autolinks(value) {
+        wasm.wasmparseroptions_set_autolinks(this.__wbg_ptr, value);
+    }
+    /**
+     * @param {boolean} value
+     */
+    set footnotes(value) {
+        wasm.wasmparseroptions_set_footnotes(this.__wbg_ptr, value);
+    }
+    /**
+     * @param {boolean} value
+     */
+    set taskLists(value) {
+        wasm.wasmparseroptions_set_task_lists(this.__wbg_ptr, value);
+    }
+    /**
+     * @param {boolean} value
+     */
+    set strikethrough(value) {
+        wasm.wasmparseroptions_set_strikethrough(this.__wbg_ptr, value);
+    }
+    /**
+     * @param {number} value
+     */
+    set tocMaxDepth(value) {
+        wasm.wasmparseroptions_set_toc_max_depth(this.__wbg_ptr, value);
+    }
+    constructor() {
+        const ret = wasm.wasmparseroptions_new();
+        this.__wbg_ptr = ret >>> 0;
+        WasmParserOptionsFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * @param {boolean} value
+     */
+    set gfm(value) {
+        wasm.wasmparseroptions_set_gfm(this.__wbg_ptr, value);
+    }
+}
+if (Symbol.dispose) WasmParserOptions.prototype[Symbol.dispose] = WasmParserOptions.prototype.free;
+
+/**
+ * Parses Markdown and renders to HTML.
+ * @param {string} source
+ * @param {WasmParserOptions | null} [options]
+ * @returns {any}
+ */
+export function parseAndRender(source, options) {
+    const ptr0 = passStringToWasm0(source, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+    const len0 = WASM_VECTOR_LEN;
+    let ptr1 = 0;
+    if (!isLikeNone(options)) {
+        _assertClass(options, WasmParserOptions);
+        ptr1 = options.__destroy_into_raw();
+    }
+    const ret = wasm.parseAndRender(ptr0, len0, ptr1);
+    return takeObject(ret);
+}
+
+/**
+ * Transforms Markdown source into HTML, frontmatter, and TOC.
+ * @param {string} source
+ * @param {WasmParserOptions | null} [options]
+ * @returns {any}
+ */
+export function transform(source, options) {
+    const ptr0 = passStringToWasm0(source, wasm.__wbindgen_export2, wasm.__wbindgen_export3);
+    const len0 = WASM_VECTOR_LEN;
+    let ptr1 = 0;
+    if (!isLikeNone(options)) {
+        _assertClass(options, WasmParserOptions);
+        ptr1 = options.__destroy_into_raw();
+    }
+    const ret = wasm.transform(ptr0, len0, ptr1);
+    return takeObject(ret);
+}
+
+/**
+ * Returns the version of ox_content_wasm.
+ * @returns {string}
+ */
+export function version() {
+    let deferred1_0;
+    let deferred1_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        wasm.version(retptr);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred1_0 = r0;
+        deferred1_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export(deferred1_0, deferred1_1, 1);
+    }
+}
+
+const EXPECTED_RESPONSE_TYPES = new Set(['basic', 'cors', 'default']);
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && EXPECTED_RESPONSE_TYPES.has(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else {
+                    throw e;
+                }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+}
+
+function __wbg_get_imports() {
+    const imports = {};
+    imports.wbg = {};
+    imports.wbg.__wbg_Error_52673b7de5a0ca89 = function(arg0, arg1) {
+        const ret = Error(getStringFromWasm0(arg0, arg1));
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg___wbindgen_is_string_704ef9c8fc131030 = function(arg0) {
+        const ret = typeof(getObject(arg0)) === 'string';
+        return ret;
+    };
+    imports.wbg.__wbg___wbindgen_throw_dd24417ed36fc46e = function(arg0, arg1) {
+        throw new Error(getStringFromWasm0(arg0, arg1));
+    };
+    imports.wbg.__wbg_new_1ba21ce319a06297 = function() {
+        const ret = new Object();
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_new_25f239778d6112b9 = function() {
+        const ret = new Array();
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_new_b546ae120718850e = function() {
+        const ret = new Map();
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbg_set_3f1d0b984ed272ed = function(arg0, arg1, arg2) {
+        getObject(arg0)[takeObject(arg1)] = takeObject(arg2);
+    };
+    imports.wbg.__wbg_set_7df433eea03a5c14 = function(arg0, arg1, arg2) {
+        getObject(arg0)[arg1 >>> 0] = takeObject(arg2);
+    };
+    imports.wbg.__wbg_set_efaaf145b9377369 = function(arg0, arg1, arg2) {
+        const ret = getObject(arg0).set(getObject(arg1), getObject(arg2));
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_cast_2241b6af4c4b2941 = function(arg0, arg1) {
+        // Cast intrinsic for `Ref(String) -> Externref`.
+        const ret = getStringFromWasm0(arg0, arg1);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_cast_4625c577ab2ec9ee = function(arg0) {
+        // Cast intrinsic for `U64 -> Externref`.
+        const ret = BigInt.asUintN(64, arg0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_cast_9ae0607507abb057 = function(arg0) {
+        // Cast intrinsic for `I64 -> Externref`.
+        const ret = arg0;
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_cast_d6cd19b81560fd6e = function(arg0) {
+        // Cast intrinsic for `F64 -> Externref`.
+        const ret = arg0;
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_object_clone_ref = function(arg0) {
+        const ret = getObject(arg0);
+        return addHeapObject(ret);
+    };
+    imports.wbg.__wbindgen_object_drop_ref = function(arg0) {
+        takeObject(arg0);
+    };
+
+    return imports;
+}
+
+function __wbg_finalize_init(instance, module) {
+    wasm = instance.exports;
+    __wbg_init.__wbindgen_wasm_module = module;
+    cachedDataViewMemory0 = null;
+    cachedUint8ArrayMemory0 = null;
+
+
+
+    return wasm;
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (typeof module !== 'undefined') {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (typeof module_or_path !== 'undefined') {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (typeof module_or_path === 'undefined') {
+        module_or_path = new URL('ox_content_wasm_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync };
+export default __wbg_init;

package/ox_content_wasm_bg.wasm.d.ts

@@ -0,0 +1,19 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_wasmparseroptions_free: (a: number, b: number) => void;
+export const parseAndRender: (a: number, b: number, c: number) => number;
+export const transform: (a: number, b: number, c: number) => number;
+export const version: (a: number) => void;
+export const wasmparseroptions_new: () => number;
+export const wasmparseroptions_set_autolinks: (a: number, b: number) => void;
+export const wasmparseroptions_set_footnotes: (a: number, b: number) => void;
+export const wasmparseroptions_set_gfm: (a: number, b: number) => void;
+export const wasmparseroptions_set_strikethrough: (a: number, b: number) => void;
+export const wasmparseroptions_set_tables: (a: number, b: number) => void;
+export const wasmparseroptions_set_task_lists: (a: number, b: number) => void;
+export const wasmparseroptions_set_toc_max_depth: (a: number, b: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_export: (a: number, b: number, c: number) => void;
+export const __wbindgen_export2: (a: number, b: number) => number;
+export const __wbindgen_export3: (a: number, b: number, c: number, d: number) => number;

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ox-content/wasm",
+  "type": "module",
+  "description": "WebAssembly bindings for Ox Content - Browser-ready Markdown parser",
+  "version": "2.2.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ubugeeei/ox-content.git",
+    "directory": "crates/ox_content_wasm"
+  },
+  "files": [
+    "ox_content_wasm.js",
+    "ox_content_wasm.d.ts",
+    "ox_content_wasm_bg.wasm",
+    "ox_content_wasm_bg.wasm.d.ts"
+  ],
+  "main": "ox_content_wasm.js",
+  "homepage": "https://ubugeeei.github.io/ox-content/packages/wasm",
+  "types": "ox_content_wasm.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "markdown",
+    "documentation",
+    "parser",
+    "vite",
+    "browser",
+    "wasm",
+    "webassembly"
+  ],
+  "author": "ubugeeei",
+  "bugs": {
+    "url": "https://github.com/ubugeeei/ox-content/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}