mdmodels-core 0.1.3

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2024 Jan Range
+
+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,86 @@
+
+# MD-Models
+
+![Build Status](https://github.com/JR-1991/sdrdm.rs/actions/workflows/test.yml/badge.svg)
+
+Welcome to Markdown Models (MD-Models), a powerful framework for research data management that prioritizes flexibility and efficiency.
+
+With an adaptable markdown-based schema language, MD-Models automatically generates schemas and programming language representations. This markdown schema forms the foundation for object-oriented models, enabling seamless cross-format compatibility and simplifying modifications to data structures.
+
+Check out the [documentation](https://fairchemistry.github.io/md-models/) for more information.
+
+### Example
+
+The schema syntax uses Markdown to define data models in a clear and structured way. Each object is introduced with a header, followed by its attributes. Attributes are described with their type, a brief explanation, and optional metadata like terms. Nested or related objects are represented using array types or references to other objects.
+
+```markdown
+---
+prefixes:
+  schema: http://schema.org/
+---
+
+### Person
+
+- **name**
+  - Type: string
+  - Description: The name of the person
+  - Term: schema:name
+- age
+  - Type: integer
+  - Description: The age of the person
+  - Term: schema:age
+- addresses
+  - Type: Address[]
+  - Description: The address of the person
+
+### Address
+
+- street
+  - Type: string
+  - Description: The street of the address
+```
+
+## Installation
+
+In order to install the command line tool, you can use the following command:
+
+```bash
+git clone https://github.com/JR-1991/md-models
+cd md-models
+cargo install --path .
+```
+
+## Command line usage
+
+The command line tool can be used to convert markdown files to various formats. The following command will convert a markdown file to Python code:
+
+```bash
+md-models convert -i model.md -o lib.py -l python-dataclass
+```
+
+This will read the input file `model.md` and write the output to `lib.py` using the Python dataclass template. Alternatively, you can also pass a URL as input to fetch the model remotely. For an overview of all available templates, you can use the following command:
+
+```bash
+md-models --help
+```
+
+## Available templates
+
+The following templates are available:
+
+- `python-dataclass`: Python dataclass implementation with JSON-LD support
+- `python-pydantic`: PyDantic implementation with JSON-LD support
+- `python-pydantic-xml`: PyDantic implementation with XML support
+- `xml-schema`: XML schema definition
+- `json-schema`: JSON schema definition
+- `shacl`: SHACL shapes definition
+- `shex`: ShEx shapes definition
+
+## Development
+
+This project uses GitHub Actions for continuous integration. The tests can be run using the following command:
+
+```bash
+cargo test
+cargo clippy
+```

package/mdmodels-core.d.ts

@@ -0,0 +1,70 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Parses the given markdown content into a `DataModel` and returns it as a `JsValue`.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be parsed.
+ *
+ * # Returns
+ *
+ * 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;
+/**
+ * Converts the given markdown content into a specified template format.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be converted.
+ * * `template` - The template format to convert the markdown content into.
+ *
+ * # Returns
+ *
+ * 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;
+/**
+ * Validates the given markdown content and returns the validation result as a `JsValue`.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be validated.
+ *
+ * # Returns
+ *
+ * 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;
+/**
+ * Enumeration of available templates.
+ */
+export enum Templates {
+  XmlSchema = 0,
+  Markdown = 1,
+  CompactMarkdown = 2,
+  Shacl = 3,
+  JsonSchema = 4,
+  JsonSchemaAll = 5,
+  Shex = 6,
+  PythonDataclass = 7,
+  PythonPydanticXML = 8,
+  PythonPydantic = 9,
+  MkDocs = 10,
+  Internal = 11,
+  Typescript = 12,
+}

package/mdmodels-core.js

@@ -0,0 +1,5 @@
+import * as wasm from "./mdmodels-core_bg.wasm";
+export * from "./mdmodels-core_bg.js";
+import { __wbg_set_wasm } from "./mdmodels-core_bg.js";
+__wbg_set_wasm(wasm);
+wasm.__wbindgen_start();

package/mdmodels-core_bg.js

@@ -0,0 +1,274 @@
+let wasm;
+export function __wbg_set_wasm(val) {
+    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 cachedUint8ArrayMemory0 = null;
+
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    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');
+
+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 (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 = encodeString(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_export_0.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+/**
+ * Parses the given markdown content into a `DataModel` and returns it as a `JsValue`.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be parsed.
+ *
+ * # Returns
+ *
+ * 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) {
+    const ptr0 = passStringToWasm0(markdown_content, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.parse_model(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Converts the given markdown content into a specified template format.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be converted.
+ * * `template` - The template format to convert the markdown content into.
+ *
+ * # Returns
+ *
+ * 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, template) {
+    let deferred3_0;
+    let deferred3_1;
+    try {
+        const ptr0 = passStringToWasm0(markdown_content, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.convert_to(ptr0, len0, template);
+        var ptr2 = ret[0];
+        var len2 = ret[1];
+        if (ret[3]) {
+            ptr2 = 0; len2 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred3_0 = ptr2;
+        deferred3_1 = len2;
+        return getStringFromWasm0(ptr2, len2);
+    } finally {
+        wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
+    }
+}
+
+/**
+ * Validates the given markdown content and returns the validation result as a `JsValue`.
+ *
+ * # Arguments
+ *
+ * * `markdown_content` - A string slice that holds the markdown content to be validated.
+ *
+ * # Returns
+ *
+ * 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) {
+    const ptr0 = passStringToWasm0(markdown_content, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.validate(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    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.
+ */
+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_error_new(arg0, arg1) {
+    const ret = new Error(getStringFromWasm0(arg0, arg1));
+    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 __wbg_log_babdc861f1e14f89(arg0, arg1) {
+    console.log(getStringFromWasm0(arg0, arg1));
+};
+
+export function __wbindgen_is_string(arg0) {
+    const ret = typeof(arg0) === 'string';
+    return ret;
+};
+
+export function __wbg_String_b9412f8799faab3e(arg0, arg1) {
+    const ret = String(arg1);
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
+    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_new_16b304a2cfa7ff4a() {
+    const ret = new Array();
+    return ret;
+};
+
+export function __wbg_new_d9bc3a0147634640() {
+    const ret = new Map();
+    return ret;
+};
+
+export function __wbg_new_72fb9a18b5ae2624() {
+    const ret = new Object();
+    return ret;
+};
+
+export function __wbg_set_d4638f722068f043(arg0, arg1, arg2) {
+    arg0[arg1 >>> 0] = arg2;
+};
+
+export function __wbg_set_8417257aaedc936b(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_init_externref_table() {
+    const table = wasm.__wbindgen_export_0;
+    const offset = table.grow(4);
+    table.set(0, undefined);
+    table.set(offset + 0, undefined);
+    table.set(offset + 1, null);
+    table.set(offset + 2, true);
+    table.set(offset + 3, false);
+    ;
+};
+

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "mdmodels-core",
+  "type": "module",
+  "collaborators": [
+    "Jan Range <jan.range@simtech.uni-stuttgart.de>"
+  ],
+  "description": "A tool to generate models, code and schemas from markdown files",
+  "version": "0.1.3",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FAIRChemistry/md-models"
+  },
+  "files": [
+    "mdmodels-core_bg.wasm",
+    "mdmodels-core.js",
+    "mdmodels-core_bg.js",
+    "mdmodels-core.d.ts"
+  ],
+  "main": "mdmodels-core.js",
+  "types": "mdmodels-core.d.ts",
+  "sideEffects": [
+    "./mdmodels-core.js",
+    "./snippets/*"
+  ]
+}