mdmodels-core 0.1.5 → 0.1.7

package/README.md

@@ -84,3 +84,14 @@ This project uses GitHub Actions for continuous integration. The tests can be ru
 cargo test
 cargo clippy
 ```
+
+### Using pre-commit hooks
+
+This project uses [pre-commit](https://pre-commit.com/) to run the `rustfmt` and `clippy` commands on every commit. To install the pre-commit hooks, you can use the following command:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+Once the pre-commit hooks are installed, they will run on every commit. This will ensure that the code is formatted and linted correctly. And the clippy CI will not complain about warnings.

package/mdmodels-core.d.ts

@@ -12,8 +12,6 @@
  * A `Result` which is:
  * - `Ok(JsValue)` if the parsing and serialization are successful.
  * - `Err(JsValue)` if there is an error during parsing or serialization.
- * @param {string} markdown_content
- * @returns {any}
  */
 export function parse_model(markdown_content: string): any;
 /**
@@ -29,11 +27,24 @@ export function parse_model(markdown_content: string): any;
  * A `Result` which is:
  * - `Ok(String)` if the conversion is successful.
  * - `Err(JsValue)` if there is an error during parsing or conversion.
- * @param {string} markdown_content
- * @param {Templates} template
- * @returns {string}
  */
 export function convert_to(markdown_content: string, template: Templates): string;
+/**
+ * Returns the JSON schema for the given markdown content.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be converted.
+ * * `root` - The root object to use for the schema.
+ * * `openai` - Whether to remove options from the schema properties. OpenAI does not support options.
+ *
+ * # Returns
+ *
+ * A `Result` which is:
+ * - `Ok(JsValue)` if the conversion is successful.
+ * - `Err(JsValue)` if there is an error during parsing or conversion.
+ */
+export function json_schema(markdown_content: string, root: string | undefined, openai: boolean): string;
 /**
  * Validates the given markdown content and returns the validation result as a `JsValue`.
  *
@@ -46,8 +57,6 @@ export function convert_to(markdown_content: string, template: Templates): strin
  * A `Result` which is:
  * - `Ok(JsValue)` if the validation is successful.
  * - `Err(JsValue)` if there is an error during parsing or validation.
- * @param {string} markdown_content
- * @returns {any}
  */
 export function validate(markdown_content: string): any;
 /**

package/mdmodels-core_bg.js

@@ -4,11 +4,7 @@ export function __wbg_set_wasm(val) {
 }
 
 
-const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
-
-let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
-
-cachedTextDecoder.decode();
+let WASM_VECTOR_LEN = 0;
 
 let cachedUint8ArrayMemory0 = null;
 
@@ -19,13 +15,6 @@ function getUint8ArrayMemory0() {
     return cachedUint8ArrayMemory0;
 }
 
-function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return cachedTextDecoder.decode(getUint8ArrayMemory0().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');
@@ -82,8 +71,28 @@ function passStringToWasm0(arg, malloc, realloc) {
     return ptr;
 }
 
+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;
+}
+
+const lTextDecoder = typeof TextDecoder === 'undefined' ? (0, module.require)('util').TextDecoder : TextDecoder;
+
+let cachedTextDecoder = new lTextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+
+cachedTextDecoder.decode();
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
 function takeFromExternrefTable0(idx) {
-    const value = wasm.__wbindgen_export_0.get(idx);
+    const value = wasm.__wbindgen_export_2.get(idx);
     wasm.__externref_table_dealloc(idx);
     return value;
 }
@@ -150,6 +159,51 @@ export function convert_to(markdown_content, template) {
     }
 }
 
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+/**
+ * Returns the JSON schema for the given markdown content.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be converted.
+ * * `root` - The root object to use for the schema.
+ * * `openai` - Whether to remove options from the schema properties. OpenAI does not support options.
+ *
+ * # Returns
+ *
+ * A `Result` which is:
+ * - `Ok(JsValue)` if the conversion is successful.
+ * - `Err(JsValue)` if there is an error during parsing or conversion.
+ * @param {string} markdown_content
+ * @param {string | undefined} root
+ * @param {boolean} openai
+ * @returns {string}
+ */
+export function json_schema(markdown_content, root, openai) {
+    let deferred4_0;
+    let deferred4_1;
+    try {
+        const ptr0 = passStringToWasm0(markdown_content, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        var ptr1 = isLikeNone(root) ? 0 : passStringToWasm0(root, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        var len1 = WASM_VECTOR_LEN;
+        const ret = wasm.json_schema(ptr0, len0, ptr1, len1, openai);
+        var ptr3 = ret[0];
+        var len3 = ret[1];
+        if (ret[3]) {
+            ptr3 = 0; len3 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred4_0 = ptr3;
+        deferred4_1 = len3;
+        return getStringFromWasm0(ptr3, len3);
+    } finally {
+        wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+    }
+}
+
 /**
  * Validates the given markdown content and returns the validation result as a `JsValue`.
  *
@@ -175,48 +229,27 @@ export function validate(markdown_content) {
     return takeFromExternrefTable0(ret[0]);
 }
 
-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;
-}
 /**
  * Enumeration of available templates.
+ * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12}
  */
-export const Templates = Object.freeze({ XmlSchema:0,"0":"XmlSchema",Markdown:1,"1":"Markdown",CompactMarkdown:2,"2":"CompactMarkdown",Shacl:3,"3":"Shacl",JsonSchema:4,"4":"JsonSchema",JsonSchemaAll:5,"5":"JsonSchemaAll",Shex:6,"6":"Shex",PythonDataclass:7,"7":"PythonDataclass",PythonPydanticXML:8,"8":"PythonPydanticXML",PythonPydantic:9,"9":"PythonPydantic",MkDocs:10,"10":"MkDocs",Internal:11,"11":"Internal",Typescript:12,"12":"Typescript", });
-
-const __wbindgen_enum_RequestCredentials = ["omit", "same-origin", "include"];
-
-const __wbindgen_enum_RequestMode = ["same-origin", "no-cors", "cors", "navigate"];
-
-export function __wbindgen_string_new(arg0, arg1) {
-    const ret = getStringFromWasm0(arg0, arg1);
-    return ret;
-};
-
-export function __wbg_log_fc0eddb5caa343af(arg0, arg1) {
-    console.log(getStringFromWasm0(arg0, arg1));
-};
-
-export function __wbindgen_number_new(arg0) {
-    const ret = arg0;
-    return ret;
-};
-
-export function __wbindgen_error_new(arg0, arg1) {
-    const ret = new Error(getStringFromWasm0(arg0, arg1));
-    return ret;
-};
-
-export function __wbindgen_is_string(arg0) {
-    const ret = typeof(arg0) === 'string';
-    return ret;
-};
+export const Templates = Object.freeze({
+    XmlSchema: 0, "0": "XmlSchema",
+    Markdown: 1, "1": "Markdown",
+    CompactMarkdown: 2, "2": "CompactMarkdown",
+    Shacl: 3, "3": "Shacl",
+    JsonSchema: 4, "4": "JsonSchema",
+    JsonSchemaAll: 5, "5": "JsonSchemaAll",
+    Shex: 6, "6": "Shex",
+    PythonDataclass: 7, "7": "PythonDataclass",
+    PythonPydanticXML: 8, "8": "PythonPydanticXML",
+    PythonPydantic: 9, "9": "PythonPydantic",
+    MkDocs: 10, "10": "MkDocs",
+    Internal: 11, "11": "Internal",
+    Typescript: 12, "12": "Typescript",
+});
 
-export function __wbg_String_b9412f8799faab3e(arg0, arg1) {
+export function __wbg_String_8f0eb39a4a4c2f66(arg0, arg1) {
     const ret = String(arg1);
     const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len1 = WASM_VECTOR_LEN;
@@ -224,45 +257,50 @@ export function __wbg_String_b9412f8799faab3e(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 };
 
-export function __wbindgen_bigint_from_i64(arg0) {
-    const ret = arg0;
-    return ret;
-};
-
-export function __wbg_set_f975102236d3c502(arg0, arg1, arg2) {
-    arg0[arg1] = arg2;
+export function __wbg_log_bdcc137b879aea04(arg0, arg1) {
+    console.log(getStringFromWasm0(arg0, arg1));
 };
 
-export function __wbg_new_16b304a2cfa7ff4a() {
+export function __wbg_new_254fa9eac11932ae() {
     const ret = new Array();
     return ret;
 };
 
-export function __wbg_new_d9bc3a0147634640() {
-    const ret = new Map();
+export function __wbg_new_688846f374351c92() {
+    const ret = new Object();
     return ret;
 };
 
-export function __wbg_new_72fb9a18b5ae2624() {
-    const ret = new Object();
+export function __wbg_new_bc96c6a1c0786643() {
+    const ret = new Map();
     return ret;
 };
 
-export function __wbg_set_d4638f722068f043(arg0, arg1, arg2) {
+export function __wbg_set_1d80752d0d5f0b21(arg0, arg1, arg2) {
     arg0[arg1 >>> 0] = arg2;
 };
 
-export function __wbg_set_8417257aaedc936b(arg0, arg1, arg2) {
+export function __wbg_set_3f1d0b984ed272ed(arg0, arg1, arg2) {
+    arg0[arg1] = arg2;
+};
+
+export function __wbg_set_76818dc3c59a63d5(arg0, arg1, arg2) {
     const ret = arg0.set(arg1, arg2);
     return ret;
 };
 
-export function __wbindgen_throw(arg0, arg1) {
-    throw new Error(getStringFromWasm0(arg0, arg1));
+export function __wbindgen_bigint_from_i64(arg0) {
+    const ret = arg0;
+    return ret;
+};
+
+export function __wbindgen_error_new(arg0, arg1) {
+    const ret = new Error(getStringFromWasm0(arg0, arg1));
+    return ret;
 };
 
 export function __wbindgen_init_externref_table() {
-    const table = wasm.__wbindgen_export_0;
+    const table = wasm.__wbindgen_export_2;
     const offset = table.grow(4);
     table.set(0, undefined);
     table.set(offset + 0, undefined);
@@ -272,3 +310,22 @@ export function __wbindgen_init_externref_table() {
     ;
 };
 
+export function __wbindgen_is_string(arg0) {
+    const ret = typeof(arg0) === 'string';
+    return ret;
+};
+
+export function __wbindgen_number_new(arg0) {
+    const ret = arg0;
+    return ret;
+};
+
+export function __wbindgen_string_new(arg0, arg1) {
+    const ret = getStringFromWasm0(arg0, arg1);
+    return ret;
+};
+
+export function __wbindgen_throw(arg0, arg1) {
+    throw new Error(getStringFromWasm0(arg0, arg1));
+};
+

package/package.json

@@ -5,7 +5,7 @@
     "Jan Range <jan.range@simtech.uni-stuttgart.de>"
   ],
   "description": "A tool to generate models, code and schemas from markdown files",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "license": "MIT",
   "repository": {
     "type": "git",