htmltoadf 0.1.2 → 0.1.6

package/README.md

@@ -16,43 +16,48 @@ The library can be used in several different ways:
 
 ----
 
-```toml
-[dependencies]
-htmltoadf = "0.1.2"
-```
+<img src="./screenshot-light.png" width=350/><img src="./screenshot-dark.png" width=350/>
+
+----
+## Demo
+
+See demo of the tool running as a WASM library entirely in the client here:
+https://wouterken.github.io/htmltoadf/
+
+----
 
 ## CLI
 ### Binaries
 ### Install Binary from Crates.io with `cargo install`
 ```
 $ cargo install htmltoadf
-    installing htmltoadf v0.1.2 (/usr/src/html2adf)
+    installing htmltoadf v0.1.6 (/usr/src/html2adf)
     Updating crates.io index
  Downloading crates ...
   Downloaded lock_api v0.4.6
 --snip--
-      Compiling htmltoadf v0.1.2
+      Compiling htmltoadf v0.1.6
     Finished release [optimized] target(s) in 1m 42s
   Installing ~/.cargo/bin/htmltoadf
-   Installed package `htmltoadf v0.1.2` (executable `htmltoadf`)
+   Installed package `htmltoadf v0.1.6` (executable `html2adf`)
 ```
 
 ### Download Binary file from Github
 Pre-built binaries can be downloaded from here:
-https://github.com/wouterken/htmltoadf/releases/tag/0.1.2
+https://github.com/wouterken/htmltoadf/releases/tag/0.1.6
 
 ### Docker Image
 **Docker Repo:**
 
-https://hub.docker.com/repository/docker/wouterken/html2adf
+https://hub.docker.com/r/wouterken/html2adf
 
 **Usage**
 
 ```bash
-$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.2
+$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.6
 {"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"type":"text","text":"Hello world"},{"type":"text","text":"Test"}]}]}
 
-$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.2 | jq
+$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.6 | jq
 {
   "version": 1,
   "type": "doc",
@@ -79,7 +84,17 @@ $ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf
 
 ## Lib
 
-### Example Code
+### Example Rust Code
+
+**Cargo.toml**
+
+```toml
+[dependencies]
+htmltoadf = "0.1.6"
+```
+
+**Code**
+
 ```rust
 use htmltoadf::convert_html_str_to_adf_str;
 use serde_json::json;
@@ -108,20 +123,87 @@ assert_eq!(expected, converted);
 ```
 
 ### WASM
-*TODO*
+
+Install package from [npm](https://www.npmjs.com/package/htmltoadf)
+
+```javascript
+import init, {convert} from "htmltoadf";
+init()
+  .then(() => {
+    alert(convert("<h1>Hello from WebAssembly</h1>"))
+  });
+```
+
 ### FFI
-*TODO*
+First compile the code as a library, e.g.:
+
+```bash
+cargo build --lib --release
+```
+
+Then you can link to the library dynamic from any environment that supports a FFI.
+**It is important to copy the dynamic library from the release directory, and provide a relative link to the library file from the FFI**
+E.g.
+
+#### Ruby
+```ruby
+require 'ffi'
+
+module HTMLToADF
+  extend FFI::Library
+  ffi_lib 'libhtmltoadf'
+  attach_function :convert, [ :string ], :string
+end
+
+puts HTMLToADF.convert("<h1>Hello from Ruby</h1>")
+```
+
+#### Node/JavaScript
+```javascript
+var ffi = require('ffi-napi');
+
+var htmltoadf = ffi.Library('libhtmltoadf', {
+  'convert': [ 'string', [ 'string' ] ]
+});
+console.log(htmltoadf.convert("<h1>Hello from Node!</h1>"));
+
+```
+
+#### Python
+```python
+from cffi import FFI
+ffi = FFI()
+lib = ffi.dlopen("libhtmltoadf")
+ffi.cdef("char * convert(char *);")
+print(ffi.string(lib.convert(b"<h1>Hello from Python!</h1>")))
+
+```
 
 ## Implemented features
 This converter only implements a subset of possible mappings between HTML and ADF.
-The following conversions are implemented:
-* Headings
-* Images
-* Lists (ordered and unordered)
-* Tables
-* Text and Paragraphs
-* Code
-
+The following features are implemented:
+- [x] Headings
+- [x] Images
+- [x] Lists (ordered and unordered)
+- [x] Tables
+- [x] Text and Paragraphs
+- [x] Code
+- [ ] Fuzz Tests
+- [ ] Support for named CSS colors
+- [ ] Smart image sizing
+- [ ] Inline Cards
+- [ ] Panels
+- [ ] Emoji
+- [ ] In built JSON Schema Validation
+
+## Release Process
+* Increment version number in .toml and README
+* Compile binaries and create release
+* Build and push Docker image
+* Build and push WASM NPM package
+* Push crate
+* Update dependency in demo page
+* Push to VCS
 
 ## Testing
 Run `cargo test` from the repository root.

package/htmltoadf.js

@@ -1,2 +1,159 @@
-import * as wasm from "./htmltoadf_bg.wasm";
-export * from "./htmltoadf_bg.js";
+
+let wasm;
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+let cachegetUint8Memory0 = null;
+function getUint8Memory0() {
+    if (cachegetUint8Memory0 === null || cachegetUint8Memory0.buffer !== wasm.memory.buffer) {
+        cachegetUint8Memory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachegetUint8Memory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    return cachedTextDecoder.decode(getUint8Memory0().subarray(ptr, ptr + len));
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let cachedTextEncoder = new TextEncoder('utf-8');
+
+const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
+    ? function (arg, view) {
+    return cachedTextEncoder.encodeInto(arg, view);
+}
+    : function (arg, view) {
+    const buf = cachedTextEncoder.encode(arg);
+    view.set(buf);
+    return {
+        read: arg.length,
+        written: buf.length
+    };
+});
+
+function passStringToWasm0(arg, malloc, realloc) {
+
+    if (typeof(arg) !== 'string') throw new Error('expected a string argument');
+
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length);
+        getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len);
+
+    const mem = getUint8Memory0();
+
+    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);
+        const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
+        const ret = encodeString(arg, view);
+        if (ret.read !== arg.length) throw new Error('failed to pass whole string');
+        offset += ret.written;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+let cachegetInt32Memory0 = null;
+function getInt32Memory0() {
+    if (cachegetInt32Memory0 === null || cachegetInt32Memory0.buffer !== wasm.memory.buffer) {
+        cachegetInt32Memory0 = new Int32Array(wasm.memory.buffer);
+    }
+    return cachegetInt32Memory0;
+}
+/**
+* @param {string} html
+* @returns {string}
+*/
+export function convert(html) {
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        var ptr0 = passStringToWasm0(html, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len0 = WASM_VECTOR_LEN;
+        wasm.convert(retptr, ptr0, len0);
+        var r0 = getInt32Memory0()[retptr / 4 + 0];
+        var r1 = getInt32Memory0()[retptr / 4 + 1];
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_free(r0, r1);
+    }
+}
+
+async function load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+
+            } catch (e) {
+                if (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;
+        }
+    }
+}
+
+async function init(input) {
+    if (typeof input === 'undefined') {
+        input = new URL('htmltoadf_bg.wasm', import.meta.url);
+    }
+    const imports = {};
+    imports.wbg = {};
+    imports.wbg.__wbindgen_throw = function(arg0, arg1) {
+        throw new Error(getStringFromWasm0(arg0, arg1));
+    };
+
+    if (typeof input === 'string' || (typeof Request === 'function' && input instanceof Request) || (typeof URL === 'function' && input instanceof URL)) {
+        input = fetch(input);
+    }
+
+
+
+    const { instance, module } = await load(await input, imports);
+
+    wasm = instance.exports;
+    init.__wbindgen_wasm_module = module;
+
+    return wasm;
+}
+
+export default init;
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "htmltoadf",
   "description": "An HTML to Atlassian Document Format (ADF) converter",
-  "version": "0.1.2",
+  "version": "0.1.6",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -9,8 +9,7 @@
   },
   "files": [
     "htmltoadf_bg.wasm",
-    "htmltoadf.js",
-    "htmltoadf_bg.js"
+    "htmltoadf.js"
   ],
   "module": "htmltoadf.js",
   "homepage": "https://github.com/wouterken/htmltoadf",
@@ -22,4 +21,4 @@
     "converter",
     "cli"
   ]
-}
+}

package/htmltoadf_bg.js

@@ -1,109 +0,0 @@
-import * as wasm from './htmltoadf_bg.wasm';
-
-const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
-
-let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-
-cachedTextDecoder.decode();
-
-let cachegetUint8Memory0 = null;
-function getUint8Memory0() {
-    if (cachegetUint8Memory0 === null || cachegetUint8Memory0.buffer !== wasm.memory.buffer) {
-        cachegetUint8Memory0 = new Uint8Array(wasm.memory.buffer);
-    }
-    return cachegetUint8Memory0;
-}
-
-function getStringFromWasm0(ptr, len) {
-    return cachedTextDecoder.decode(getUint8Memory0().subarray(ptr, ptr + len));
-}
-
-let WASM_VECTOR_LEN = 0;
-
-const lTextEncoder = typeof TextEncoder === 'undefined' ? (0, module.require)('util').TextEncoder : TextEncoder;
-
-let cachedTextEncoder = new lTextEncoder('utf-8');
-
-const encodeString = (typeof cachedTextEncoder.encodeInto === 'function'
-    ? function (arg, view) {
-    return cachedTextEncoder.encodeInto(arg, view);
-}
-    : function (arg, view) {
-    const buf = cachedTextEncoder.encode(arg);
-    view.set(buf);
-    return {
-        read: arg.length,
-        written: buf.length
-    };
-});
-
-function passStringToWasm0(arg, malloc, realloc) {
-
-    if (typeof(arg) !== 'string') throw new Error('expected a string argument');
-
-    if (realloc === undefined) {
-        const buf = cachedTextEncoder.encode(arg);
-        const ptr = malloc(buf.length);
-        getUint8Memory0().subarray(ptr, ptr + buf.length).set(buf);
-        WASM_VECTOR_LEN = buf.length;
-        return ptr;
-    }
-
-    let len = arg.length;
-    let ptr = malloc(len);
-
-    const mem = getUint8Memory0();
-
-    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);
-        const view = getUint8Memory0().subarray(ptr + offset, ptr + len);
-        const ret = encodeString(arg, view);
-        if (ret.read !== arg.length) throw new Error('failed to pass whole string');
-        offset += ret.written;
-    }
-
-    WASM_VECTOR_LEN = offset;
-    return ptr;
-}
-
-let cachegetInt32Memory0 = null;
-function getInt32Memory0() {
-    if (cachegetInt32Memory0 === null || cachegetInt32Memory0.buffer !== wasm.memory.buffer) {
-        cachegetInt32Memory0 = new Int32Array(wasm.memory.buffer);
-    }
-    return cachegetInt32Memory0;
-}
-/**
-* @param {string} html
-* @returns {string}
-*/
-export function convert(html) {
-    try {
-        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
-        var ptr0 = passStringToWasm0(html, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-        var len0 = WASM_VECTOR_LEN;
-        wasm.convert(retptr, ptr0, len0);
-        var r0 = getInt32Memory0()[retptr / 4 + 0];
-        var r1 = getInt32Memory0()[retptr / 4 + 1];
-        return getStringFromWasm0(r0, r1);
-    } finally {
-        wasm.__wbindgen_add_to_stack_pointer(16);
-        wasm.__wbindgen_free(r0, r1);
-    }
-}
-
-export function __wbindgen_throw(arg0, arg1) {
-    throw new Error(getStringFromWasm0(arg0, arg1));
-};
-