mdmodels-core 0.2.8 → 0.2.10

package/mdmodels-core.d.ts

@@ -1,72 +1,72 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Parses the given JSON schema string into a `DataModel`.
+ * Converts the given markdown content into a specified template format.
  *
  * # 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 converted.
+ * * `template` - The template format to convert the markdown content into.
  *
  * # Returns
  *
- * A `String` or an error `JsError`.
+ * A `Result` which is:
+ * - `Ok(String)` if the conversion is successful.
+ * - `Err(JsValue)` if there is an error during parsing or conversion.
  */
-export function from_json_schema(json_schema: any): string;
+export function convert_to(markdown_content: string, template: Templates): string;
 /**
- * Returns the JSON schema for the given markdown content.
+ * Validates the given markdown content and returns the validation result as a `Validator`.
  *
  * # 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.
+ * * `markdown_content` - A string slice that holds the markdown content to be validated.
  *
  * # Returns
  *
- * A `Result` which is:
- * - `Ok(JsValue)` if the conversion is successful.
- * - `Err(JsValue)` if there is an error during parsing or conversion.
+ * Either an empty `Validator` or an error `Validator`.
  */
-export function json_schema(markdown_content: string, root: string | undefined, openai: boolean): string;
+export function validate(markdown_content: string): Validator;
 /**
- * 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;
 /**
- * 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 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;
 /**
  * Enumeration of available templates.
  */
@@ -164,93 +164,6 @@ export enum Templates {
    */
   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.
- */
-export interface Validator {
-    is_valid: boolean;
-    errors: ValidationError[];
-}
-
-/**
- * Represents a validation error in the data model.
- */
-export interface ValidationError {
-    message: string;
-    object: string | undefined;
-    attribute: string | undefined;
-    location: string;
-    solution: string | undefined;
-    error_type: ErrorType;
-    positions: Position[];
-}
-
-/**
- * Enum representing the type of validation error.
- */
-export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
-
-/**
- * Represents the front matter data of a markdown file.
- */
-export interface FrontMatter {
-    /**
-     * Identifier field of the model.
-     */
-    id: string | undefined;
-    /**
-     * A boolean field with a default value, renamed from `id-field`.
-     */
-    "id-field"?: boolean;
-    /**
-     * Optional hashmap of prefixes.
-     */
-    prefixes: Map<string, string> | undefined;
-    /**
-     * Optional namespace map.
-     */
-    nsmap: Map<string, string> | undefined;
-    /**
-     * A string field with a default value representing the repository URL.
-     */
-    repo?: string;
-    /**
-     * A string field with a default value representing the prefix.
-     */
-    prefix?: string;
-    /**
-     * Import remote or local models.
-     */
-    imports?: Map<string, ImportType>;
-    /**
-     * Allow empty models.
-     */
-    "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.
  */
@@ -312,45 +225,31 @@ export interface Attribute {
 export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
 
 /**
- * A raw key-value representation of an attribute option.
- *
- * This struct provides a simple string-based representation of options,
- * which is useful for serialization/deserialization and when working
- * with untyped data.
+ * Validator for checking the integrity of a data model.
  */
-export interface RawOption {
-    /**
-     * The key/name of the option
-     */
-    key: string;
-    /**
-     * The string value of the option
-     */
-    value: string;
+export interface Validator {
+    is_valid: boolean;
+    errors: ValidationError[];
 }
 
 /**
- * Represents an option for an attribute in a data model.
- *
- * This enum provides a strongly-typed representation of various attribute options
- * that can be used to configure and constrain attributes in a data model.
- *
- * The options are grouped into several categories:
- * - JSON Schema validation options (e.g., minimum/maximum values, length constraints)
- * - SQL database options (e.g., primary key)
- * - LinkML specific options (e.g., readonly, recommended)
- * - Custom options via the `Other` variant
- *
+ * Represents a validation error in the data model.
  */
-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;
+export interface ValidationError {
+    message: string;
+    object: string | undefined;
+    attribute: string | undefined;
+    location: string;
+    solution: string | undefined;
+    error_type: ErrorType;
+    positions: Position[];
 }
 
+/**
+ * Enum representing the type of validation error.
+ */
+export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
+
 /**
  * Represents an enumeration with a name and mappings.
  */
@@ -403,3 +302,104 @@ export interface Object {
     position?: Position;
 }
 
+/**
+ * Represents an option for an attribute in a data model.
+ *
+ * This enum provides a strongly-typed representation of various attribute options
+ * that can be used to configure and constrain attributes in a data model.
+ *
+ * The options are grouped into several categories:
+ * - JSON Schema validation options (e.g., minimum/maximum values, length constraints)
+ * - SQL database options (e.g., primary key)
+ * - LinkML specific options (e.g., readonly, recommended)
+ * - Custom options via the `Other` variant
+ *
+ */
+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 } };
+
+/**
+ * A raw key-value representation of an attribute option.
+ *
+ * This struct provides a simple string-based representation of options,
+ * which is useful for serialization/deserialization and when working
+ * with untyped data.
+ */
+export interface RawOption {
+    /**
+     * The key/name of the option
+     */
+    key: string;
+    /**
+     * The string value of the option
+     */
+    value: string;
+}
+
+/**
+ * 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 } };
+
+/**
+ * Represents the front matter data of a markdown file.
+ */
+export interface FrontMatter {
+    /**
+     * Identifier field of the model.
+     */
+    id: string | undefined;
+    /**
+     * A boolean field with a default value, renamed from `id-field`.
+     */
+    "id-field"?: boolean;
+    /**
+     * Optional hashmap of prefixes.
+     */
+    prefixes: Map<string, string> | undefined;
+    /**
+     * Optional namespace map.
+     */
+    nsmap: Map<string, string> | undefined;
+    /**
+     * A string field with a default value representing the repository URL.
+     */
+    repo?: string;
+    /**
+     * A string field with a default value representing the prefix.
+     */
+    prefix?: string;
+    /**
+     * Import remote or local models.
+     */
+    imports?: Map<string, ImportType>;
+    /**
+     * Allow empty models.
+     */
+    "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 };
+
+export interface Position {
+    line: number;
+    column: PositionRange;
+    offset: PositionRange;
+}
+
+export interface PositionRange {
+    start: number;
+    end: number;
+}
+
+export interface DataModel {
+    name?: string;
+    objects: Object[];
+    enums: Enumeration[];
+    config?: FrontMatter;
+}
+

package/mdmodels-core_bg.js

@@ -181,76 +181,40 @@ function takeFromExternrefTable0(idx) {
     return value;
 }
 /**
- * Parses the given JSON schema string into a `DataModel`.
- *
- * # Arguments
- *
- * * `json_schema` - A string slice that holds the JSON schema to be parsed.
- *
- * # Returns
- *
- * A `String` or an error `JsError`.
- * @param {any} json_schema
- * @returns {string}
- */
-export function from_json_schema(json_schema) {
-    let deferred2_0;
-    let deferred2_1;
-    try {
-        const ret = wasm.from_json_schema(json_schema);
-        var ptr1 = ret[0];
-        var len1 = ret[1];
-        if (ret[3]) {
-            ptr1 = 0; len1 = 0;
-            throw takeFromExternrefTable0(ret[2]);
-        }
-        deferred2_0 = ptr1;
-        deferred2_1 = len1;
-        return getStringFromWasm0(ptr1, len1);
-    } finally {
-        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
-    }
-}
-
-/**
- * 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.
  * @param {string} markdown_content
- * @param {string | undefined} root
- * @param {boolean} openai
+ * @param {Templates} template
  * @returns {string}
  */
-export function json_schema(markdown_content, root, openai) {
-    let deferred4_0;
-    let deferred4_1;
+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;
-        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];
+        const ret = wasm.convert_to(ptr0, len0, template);
+        var ptr2 = ret[0];
+        var len2 = ret[1];
         if (ret[3]) {
-            ptr3 = 0; len3 = 0;
+            ptr2 = 0; len2 = 0;
             throw takeFromExternrefTable0(ret[2]);
         }
-        deferred4_0 = ptr3;
-        deferred4_1 = len3;
-        return getStringFromWasm0(ptr3, len3);
+        deferred3_0 = ptr2;
+        deferred3_1 = len2;
+        return getStringFromWasm0(ptr2, len2);
     } finally {
-        wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+        wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
     }
 }
 
@@ -275,64 +239,100 @@ export function validate(markdown_content) {
 }
 
 /**
- * Converts the given markdown content into a specified template format.
+ * 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]);
+}
+
+/**
+ * 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.
  * @param {string} markdown_content
- * @param {Templates} template
+ * @param {string | undefined} root
+ * @param {boolean} openai
  * @returns {string}
  */
-export function convert_to(markdown_content, template) {
-    let deferred3_0;
-    let deferred3_1;
+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;
-        const ret = wasm.convert_to(ptr0, len0, template);
-        var ptr2 = ret[0];
-        var len2 = ret[1];
+        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]) {
-            ptr2 = 0; len2 = 0;
+            ptr3 = 0; len3 = 0;
             throw takeFromExternrefTable0(ret[2]);
         }
-        deferred3_0 = ptr2;
-        deferred3_1 = len2;
-        return getStringFromWasm0(ptr2, len2);
+        deferred4_0 = ptr3;
+        deferred4_1 = len3;
+        return getStringFromWasm0(ptr3, len3);
     } finally {
-        wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
+        wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
     }
 }
 
 /**
- * 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`.
- * @param {string} markdown_content
- * @returns {DataModel}
+ * A `String` or an error `JsError`.
+ * @param {any} json_schema
+ * @returns {string}
  */
-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]);
+export function from_json_schema(json_schema) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ret = wasm.from_json_schema(json_schema);
+        var ptr1 = ret[0];
+        var len1 = ret[1];
+        if (ret[3]) {
+            ptr1 = 0; len1 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred2_0 = ptr1;
+        deferred2_1 = len1;
+        return getStringFromWasm0(ptr1, len1);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
     }
-    return takeFromExternrefTable0(ret[0]);
 }
 
 /**

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.8",
+  "version": "0.2.10",
   "license": "MIT",
   "repository": {
     "type": "git",