htmltoadf 0.1.2

package/README.md

@@ -0,0 +1,131 @@
+# htmltoadf [![Latest Version]][crates.io] [![Rustc Version 1.58+]][rustc] ![htmltoadf]
+
+[Latest Version]: https://img.shields.io/crates/v/htmltoadf.svg
+[crates.io]: https://crates.io/crates/htmltoadf
+[Rustc Version 1.58+]: https://img.shields.io/badge/rustc-1.58+-lightgray.svg
+[rustc]: https://blog.rust-lang.org/2022/01/13/Rust-1.58.0.html
+[htmltoadf]: https://img.shields.io/badge/htmltoadf--green.svg
+
+**htmltoadf is an HTML to Atlassian Document Format (ADF) converter written in Rust.**
+
+The library can be used in several different ways:
+* As a command line binary (either directly on a compatible host or using Docker)
+* Included as a library within a Rust project
+* Called from a different language or environment (e.g. C, JavaScript, Ruby, PHP, .NET etc.) using [FFI](https://doc.rust-lang.org/nomicon/ffi.html)
+* Called as a Web Assembly (wasm) module
+
+----
+
+```toml
+[dependencies]
+htmltoadf = "0.1.2"
+```
+
+## CLI
+### Binaries
+### Install Binary from Crates.io with `cargo install`
+```
+$ cargo install htmltoadf
+    installing htmltoadf v0.1.2 (/usr/src/html2adf)
+    Updating crates.io index
+ Downloading crates ...
+  Downloaded lock_api v0.4.6
+--snip--
+      Compiling htmltoadf v0.1.2
+    Finished release [optimized] target(s) in 1m 42s
+  Installing ~/.cargo/bin/htmltoadf
+   Installed package `htmltoadf v0.1.2` (executable `htmltoadf`)
+```
+
+### Download Binary file from Github
+Pre-built binaries can be downloaded from here:
+https://github.com/wouterken/htmltoadf/releases/tag/0.1.2
+
+### Docker Image
+**Docker Repo:**
+
+https://hub.docker.com/repository/docker/wouterken/html2adf
+
+**Usage**
+
+```bash
+$ echo "<h1>Hello world<p>Test</p></h1>" | docker run --rm -i wouterken/html2adf:0.1.2
+{"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
+{
+  "version": 1,
+  "type": "doc",
+  "content": [
+    {
+      "type": "heading",
+      "attrs": {
+        "level": 1
+      },
+      "content": [
+        {
+          "type": "text",
+          "text": "Hello world"
+        },
+        {
+          "type": "text",
+          "text": "Test"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Lib
+
+### Example Code
+```rust
+use htmltoadf::convert_html_str_to_adf_str;
+use serde_json::json;
+
+let converted = convert_html_str_to_adf_str("<h1>Hello World</h1>".to_string());
+let expected = json!({
+    "version": 1,
+    "type": "doc",
+    "content": [
+        {
+            "type": "heading",
+            "attrs": {
+                "level": 1
+            },
+            "content": [
+                {
+                    "type": "text",
+                    "text": "Hello World"
+                }
+            ]
+        }
+    ]
+}).to_string();
+
+assert_eq!(expected, converted);
+```
+
+### WASM
+*TODO*
+### FFI
+*TODO*
+
+## 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
+
+
+## Testing
+Run `cargo test` from the repository root.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wouterken/htmltoadf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

package/htmltoadf.js

@@ -0,0 +1,2 @@
+import * as wasm from "./htmltoadf_bg.wasm";
+export * from "./htmltoadf_bg.js";

package/htmltoadf_bg.js

@@ -0,0 +1,109 @@
+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));
+};
+

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "htmltoadf",
+  "description": "An HTML to Atlassian Document Format (ADF) converter",
+  "version": "0.1.2",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wouterken/htmltoadf"
+  },
+  "files": [
+    "htmltoadf_bg.wasm",
+    "htmltoadf.js",
+    "htmltoadf_bg.js"
+  ],
+  "module": "htmltoadf.js",
+  "homepage": "https://github.com/wouterken/htmltoadf",
+  "sideEffects": false,
+  "keywords": [
+    "html",
+    "adf",
+    "atlassian",
+    "converter",
+    "cli"
+  ]
+}