mdmodels-core 0.2.7 → 0.2.8

package/mdmodels-core.d.ts

@@ -1,72 +1,72 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Parses the given markdown content into a `DataModel` and returns it as a `JsValue`.
+ * Parses the given JSON schema string into a `DataModel`.
  *
  * # Arguments
  *
- * * `markdown_content` - A string slice that holds the markdown content to be parsed.
+ * * `json_schema` - A string slice that holds the JSON schema to be parsed.
  *
  * # Returns
  *
- * A `DataModel` or an error `JsError`.
+ * A `String` or an error `JsError`.
  */
-export function parse_model(markdown_content: string): DataModel;
+export function from_json_schema(json_schema: any): string;
 /**
- * Converts the given markdown content into a specified template format.
+ * Returns the JSON schema for the given markdown content.
  *
  * # Arguments
  *
  * * `markdown_content` - A string slice that holds the markdown content to be converted.
- * * `template` - The template format to convert the markdown content into.
+ * * `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(String)` if the conversion is successful.
+ * - `Ok(JsValue)` if the conversion is successful.
  * - `Err(JsValue)` if there is an error during parsing or conversion.
  */
-export function convert_to(markdown_content: string, template: Templates): string;
+export function json_schema(markdown_content: string, root: string | undefined, openai: boolean): string;
 /**
- * Parses the given JSON schema string into a `DataModel`.
+ * Validates the given markdown content and returns the validation result as a `Validator`.
  *
  * # Arguments
  *
- * * `json_schema` - A string slice that holds the JSON schema to be parsed.
+ * * `markdown_content` - A string slice that holds the markdown content to be validated.
  *
  * # Returns
  *
- * A `String` or an error `JsError`.
+ * Either an empty `Validator` or an error `Validator`.
  */
-export function from_json_schema(json_schema: any): string;
+export function validate(markdown_content: string): Validator;
 /**
- * Returns the JSON schema for the given markdown content.
+ * Converts the given markdown content into a specified template format.
  *
  * # 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.
+ * * `template` - The template format to convert the markdown content into.
  *
  * # Returns
  *
  * A `Result` which is:
- * - `Ok(JsValue)` if the conversion is successful.
+ * - `Ok(String)` 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;
+export function convert_to(markdown_content: string, template: Templates): string;
 /**
- * Validates the given markdown content and returns the validation result as a `Validator`.
+ * 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 validated.
+ * * `markdown_content` - A string slice that holds the markdown content to be parsed.
  *
  * # Returns
  *
- * Either an empty `Validator` or an error `Validator`.
+ * A `DataModel` or an error `JsError`.
  */
-export function validate(markdown_content: string): Validator;
+export function parse_model(markdown_content: string): DataModel;
 /**
  * Enumeration of available templates.
  */
@@ -83,84 +83,103 @@ export enum Templates {
    * Compact Markdown
    */
   CompactMarkdown = 2,
-  /**
-   * SHACL
-   */
-  Shacl = 3,
   /**
    * JSON Schema
    */
-  JsonSchema = 4,
+  JsonSchema = 3,
   /**
    * JSON Schema All
    */
-  JsonSchemaAll = 5,
+  JsonSchemaAll = 4,
+  /**
+   * JSON-LD
+   */
+  JsonLd = 5,
   /**
    * SHACL
    */
-  Shex = 6,
+  Shacl = 6,
+  /**
+   * OWL
+   */
+  Owl = 7,
+  /**
+   * ShEx
+   */
+  Shex = 8,
   /**
    * Python Dataclass
    */
-  PythonDataclass = 7,
+  PythonDataclass = 9,
   /**
    * Python Pydantic XML
    */
-  PythonPydanticXML = 8,
+  PythonPydanticXML = 10,
   /**
    * Python Pydantic
    */
-  PythonPydantic = 9,
+  PythonPydantic = 11,
   /**
    * MkDocs
    */
-  MkDocs = 10,
+  MkDocs = 12,
   /**
    * Internal
    */
-  Internal = 11,
+  Internal = 13,
   /**
    * Typescript (io-ts)
    */
-  Typescript = 12,
+  Typescript = 14,
   /**
    * Typescript (Zod)
    */
-  TypescriptZod = 13,
+  TypescriptZod = 15,
   /**
    * Rust
    */
-  Rust = 14,
+  Rust = 16,
   /**
    * Protobuf
    */
-  Protobuf = 15,
+  Protobuf = 17,
   /**
    * Graphql
    */
-  Graphql = 16,
+  Graphql = 18,
   /**
    * Golang
    */
-  Golang = 17,
+  Golang = 19,
   /**
    * Linkml
    */
-  Linkml = 18,
+  Linkml = 20,
   /**
    * Julia
    */
-  Julia = 19,
+  Julia = 21,
   /**
    * Mermaid class diagram
    */
-  Mermaid = 20,
+  Mermaid = 22,
 }
 /**
  * Represents an XML type, either an attribute or an element.
  */
 export type XMLType = { Attribute: { is_attr: boolean; name: string } } | { Element: { is_attr: boolean; name: string } } | { Wrapped: { is_attr: boolean; name: string; wrapped: string[] | undefined } };
 
+export interface PositionRange {
+    start: number;
+    end: number;
+}
+
+export interface Position {
+    line: number;
+    column: PositionRange;
+    offset: PositionRange;
+}
+
 /**
  * Validator for checking the integrity of a data model.
  */
@@ -169,11 +188,6 @@ export interface Validator {
     errors: ValidationError[];
 }
 
-/**
- * Enum representing the type of validation error.
- */
-export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
-
 /**
  * Represents a validation error in the data model.
  */
@@ -187,30 +201,10 @@ export interface ValidationError {
     positions: Position[];
 }
 
-export interface DataModel {
-    name?: string;
-    objects: Object[];
-    enums: Enumeration[];
-    config?: FrontMatter;
-}
-
-export interface PositionRange {
-    start: number;
-    end: number;
-}
-
-export interface Position {
-    line: number;
-    column: PositionRange;
-    offset: PositionRange;
-}
-
 /**
- * Represents different types of model imports.
- *
- * Can be either a remote URL or a local file path.
+ * Enum representing the type of validation error.
  */
-export type ImportType = { Remote: string } | { Local: string };
+export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
 
 /**
  * Represents the front matter data of a markdown file.
@@ -250,6 +244,73 @@ export interface FrontMatter {
     "allow-empty"?: boolean;
 }
 
+/**
+ * Represents different types of model imports.
+ *
+ * Can be either a remote URL or a local file path.
+ */
+export type ImportType = { Remote: string } | { Local: string };
+
+/**
+ * Represents an attribute with various properties and options.
+ */
+export interface Attribute {
+    /**
+     * The name of the attribute.
+     */
+    name: string;
+    /**
+     * Indicates if the attribute is an array.
+     */
+    multiple: boolean;
+    /**
+     * Is an identifier or not
+     */
+    is_id: boolean;
+    /**
+     * Data types associated with the attribute.
+     */
+    dtypes: string[];
+    /**
+     * Documentation string for the attribute.
+     */
+    docstring: string;
+    /**
+     * List of additional options for the attribute.
+     */
+    options: AttrOption[];
+    /**
+     * Term associated with the attribute, if any.
+     */
+    term: string | undefined;
+    /**
+     * Indicates if the attribute is required.
+     */
+    required: boolean;
+    /**
+     * Default value for the attribute.
+     */
+    default?: DataType;
+    /**
+     * XML type information for the attribute.
+     */
+    xml?: XMLType;
+    /**
+     * Is an enumeration or not
+     */
+    is_enum: boolean;
+    /**
+     * The line number of the attribute
+     */
+    position: Position | undefined;
+    /**
+     * The prefix of the attribute, if it is an import
+     */
+    import_prefix?: string;
+}
+
+export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
+
 /**
  * A raw key-value representation of an attribute option.
  *
@@ -283,6 +344,13 @@ export interface RawOption {
  */
 export type AttrOption = { Example: string } | { MinimumValue: number } | { MaximumValue: number } | { MinItems: number } | { MaxItems: number } | { MinLength: number } | { MaxLength: number } | { Pattern: string } | { Unique: boolean } | { MultipleOf: number } | { ExclusiveMinimum: number } | { ExclusiveMaximum: number } | { PrimaryKey: boolean } | { ReadOnly: boolean } | { Recommended: boolean } | { Other: { key: string; value: string } };
 
+export interface DataModel {
+    name?: string;
+    objects: Object[];
+    enums: Enumeration[];
+    config?: FrontMatter;
+}
+
 /**
  * Represents an enumeration with a name and mappings.
  */
@@ -335,63 +403,3 @@ export interface Object {
     position?: Position;
 }
 
-export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
-
-/**
- * Represents an attribute with various properties and options.
- */
-export interface Attribute {
-    /**
-     * The name of the attribute.
-     */
-    name: string;
-    /**
-     * Indicates if the attribute is an array.
-     */
-    multiple: boolean;
-    /**
-     * Is an identifier or not
-     */
-    is_id: boolean;
-    /**
-     * Data types associated with the attribute.
-     */
-    dtypes: string[];
-    /**
-     * Documentation string for the attribute.
-     */
-    docstring: string;
-    /**
-     * List of additional options for the attribute.
-     */
-    options: AttrOption[];
-    /**
-     * Term associated with the attribute, if any.
-     */
-    term: string | undefined;
-    /**
-     * Indicates if the attribute is required.
-     */
-    required: boolean;
-    /**
-     * Default value for the attribute.
-     */
-    default?: DataType;
-    /**
-     * XML type information for the attribute.
-     */
-    xml?: XMLType;
-    /**
-     * Is an enumeration or not
-     */
-    is_enum: boolean;
-    /**
-     * The line number of the attribute
-     */
-    position: Position | undefined;
-    /**
-     * The prefix of the attribute, if it is an import
-     */
-    import_prefix?: string;
-}
-

package/mdmodels-core_bg.js

@@ -180,67 +180,6 @@ function takeFromExternrefTable0(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 `DataModel` or an error `JsError`.
- * @param {string} markdown_content
- * @returns {DataModel}
- */
-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);
-    }
-}
-
 /**
  * Parses the given JSON schema string into a `DataModel`.
  *
@@ -335,9 +274,70 @@ export function validate(markdown_content) {
     return ret;
 }
 
+/**
+ * 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);
+    }
+}
+
+/**
+ * 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 `DataModel` or an error `JsError`.
+ * @param {string} markdown_content
+ * @returns {DataModel}
+ */
+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]);
+}
+
 /**
  * Enumeration of available templates.
- * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20}
+ * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22}
  */
 export const Templates = Object.freeze({
     /**
@@ -352,78 +352,86 @@ export const Templates = Object.freeze({
      * Compact Markdown
      */
     CompactMarkdown: 2, "2": "CompactMarkdown",
-    /**
-     * SHACL
-     */
-    Shacl: 3, "3": "Shacl",
     /**
      * JSON Schema
      */
-    JsonSchema: 4, "4": "JsonSchema",
+    JsonSchema: 3, "3": "JsonSchema",
     /**
      * JSON Schema All
      */
-    JsonSchemaAll: 5, "5": "JsonSchemaAll",
+    JsonSchemaAll: 4, "4": "JsonSchemaAll",
+    /**
+     * JSON-LD
+     */
+    JsonLd: 5, "5": "JsonLd",
     /**
      * SHACL
      */
-    Shex: 6, "6": "Shex",
+    Shacl: 6, "6": "Shacl",
+    /**
+     * OWL
+     */
+    Owl: 7, "7": "Owl",
+    /**
+     * ShEx
+     */
+    Shex: 8, "8": "Shex",
     /**
      * Python Dataclass
      */
-    PythonDataclass: 7, "7": "PythonDataclass",
+    PythonDataclass: 9, "9": "PythonDataclass",
     /**
      * Python Pydantic XML
      */
-    PythonPydanticXML: 8, "8": "PythonPydanticXML",
+    PythonPydanticXML: 10, "10": "PythonPydanticXML",
     /**
      * Python Pydantic
      */
-    PythonPydantic: 9, "9": "PythonPydantic",
+    PythonPydantic: 11, "11": "PythonPydantic",
     /**
      * MkDocs
      */
-    MkDocs: 10, "10": "MkDocs",
+    MkDocs: 12, "12": "MkDocs",
     /**
      * Internal
      */
-    Internal: 11, "11": "Internal",
+    Internal: 13, "13": "Internal",
     /**
      * Typescript (io-ts)
      */
-    Typescript: 12, "12": "Typescript",
+    Typescript: 14, "14": "Typescript",
     /**
      * Typescript (Zod)
      */
-    TypescriptZod: 13, "13": "TypescriptZod",
+    TypescriptZod: 15, "15": "TypescriptZod",
     /**
      * Rust
      */
-    Rust: 14, "14": "Rust",
+    Rust: 16, "16": "Rust",
     /**
      * Protobuf
      */
-    Protobuf: 15, "15": "Protobuf",
+    Protobuf: 17, "17": "Protobuf",
     /**
      * Graphql
      */
-    Graphql: 16, "16": "Graphql",
+    Graphql: 18, "18": "Graphql",
     /**
      * Golang
      */
-    Golang: 17, "17": "Golang",
+    Golang: 19, "19": "Golang",
     /**
      * Linkml
      */
-    Linkml: 18, "18": "Linkml",
+    Linkml: 20, "20": "Linkml",
     /**
      * Julia
      */
-    Julia: 19, "19": "Julia",
+    Julia: 21, "21": "Julia",
     /**
      * Mermaid class diagram
      */
-    Mermaid: 20, "20": "Mermaid",
+    Mermaid: 22, "22": "Mermaid",
 });
 
 export function __wbg_String_8f0eb39a4a4c2f66(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.2.7",
+  "version": "0.2.8",
   "license": "MIT",
   "repository": {
     "type": "git",