mdmodels-core 0.2.3 → 0.2.4

package/mdmodels-core.d.ts

@@ -59,124 +59,173 @@ export function validate(markdown_content: string): Validator;
  * Enumeration of available templates.
  */
 export enum Templates {
+  /**
+   * XML Schema
+   */
   XmlSchema = 0,
+  /**
+   * Markdown
+   */
   Markdown = 1,
+  /**
+   * Compact Markdown
+   */
   CompactMarkdown = 2,
+  /**
+   * SHACL
+   */
   Shacl = 3,
+  /**
+   * JSON Schema
+   */
   JsonSchema = 4,
+  /**
+   * JSON Schema All
+   */
   JsonSchemaAll = 5,
+  /**
+   * SHACL
+   */
   Shex = 6,
+  /**
+   * Python Dataclass
+   */
   PythonDataclass = 7,
+  /**
+   * Python Pydantic XML
+   */
   PythonPydanticXML = 8,
+  /**
+   * Python Pydantic
+   */
   PythonPydantic = 9,
+  /**
+   * MkDocs
+   */
   MkDocs = 10,
+  /**
+   * Internal
+   */
   Internal = 11,
+  /**
+   * Typescript (io-ts)
+   */
   Typescript = 12,
+  /**
+   * Typescript (Zod)
+   */
   TypescriptZod = 13,
+  /**
+   * Rust
+   */
   Rust = 14,
+  /**
+   * Protobuf
+   */
   Protobuf = 15,
+  /**
+   * Graphql
+   */
   Graphql = 16,
+  /**
+   * Golang
+   */
   Golang = 17,
+  /**
+   * Linkml
+   */
   Linkml = 18,
+  /**
+   * Julia
+   */
   Julia = 19,
+  /**
+   * Mermaid class diagram
+   */
+  Mermaid = 20,
 }
-export interface DataModel {
-    name?: string;
-    objects: Object[];
-    enums: Enumeration[];
-    config?: FrontMatter;
-}
-
-export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
+/**
+ * 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.
+ * Represents the front matter data of a markdown file.
  */
-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;
+export interface FrontMatter {
     /**
-     * List of additional options for the attribute.
+     * Identifier field of the model.
      */
-    options: AttrOption[];
+    id: string | undefined;
     /**
-     * Term associated with the attribute, if any.
+     * A boolean field with a default value, renamed from `id-field`.
      */
-    term: string | undefined;
+    "id-field"?: boolean;
     /**
-     * Indicates if the attribute is required.
+     * Optional hashmap of prefixes.
      */
-    required: boolean;
+    prefixes: Map<string, string> | undefined;
     /**
-     * Default value for the attribute.
+     * Optional namespace map.
      */
-    default?: DataType;
+    nsmap: Map<string, string> | undefined;
     /**
-     * XML type information for the attribute.
+     * A string field with a default value representing the repository URL.
      */
-    xml?: XMLType;
+    repo?: string;
     /**
-     * Is an enumeration or not
+     * A string field with a default value representing the prefix.
      */
-    is_enum: boolean;
+    prefix?: string;
     /**
-     * The line number of the attribute
+     * Import remote or local models.
      */
-    position: Position | undefined;
+    imports?: Map<string, ImportType>;
     /**
-     * The prefix of the attribute, if it is an import
+     * Allow empty models.
      */
-    import_prefix?: string;
-}
-
-/**
- * Validator for checking the integrity of a data model.
- */
-export interface Validator {
-    is_valid: boolean;
-    errors: ValidationError[];
+    "allow-empty"?: boolean;
 }
 
 /**
- * Enum representing the type of validation error.
+ * Represents an XML type, either an attribute or an element.
  */
-export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
+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 a validation error in the data model.
+ * 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 ValidationError {
-    message: string;
-    object: string | undefined;
-    attribute: string | undefined;
-    location: string;
-    solution: string | undefined;
-    error_type: ErrorType;
-    positions: Position[];
+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.
+ * 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 XMLType = { Attribute: { is_attr: boolean; name: string } } | { Element: { is_attr: boolean; name: string } } | { Wrapped: { is_attr: boolean; name: string; wrapped: string[] | undefined } };
+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 } };
 
 /**
  * Represents an enumeration with a name and mappings.
@@ -230,84 +279,66 @@ export interface Object {
     position?: Position;
 }
 
-/**
- * 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 type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
 
 /**
- * Represents the front matter data of a markdown file.
+ * Represents an attribute with various properties and options.
  */
-export interface FrontMatter {
+export interface Attribute {
     /**
-     * Identifier field of the model.
+     * The name of the attribute.
      */
-    id: string | undefined;
+    name: string;
     /**
-     * A boolean field with a default value, renamed from `id-field`.
+     * Indicates if the attribute is an array.
      */
-    "id-field"?: boolean;
+    multiple: boolean;
     /**
-     * Optional hashmap of prefixes.
+     * Is an identifier or not
      */
-    prefixes: Map<string, string> | undefined;
+    is_id: boolean;
     /**
-     * Optional namespace map.
+     * Data types associated with the attribute.
      */
-    nsmap: Map<string, string> | undefined;
+    dtypes: string[];
     /**
-     * A string field with a default value representing the repository URL.
+     * Documentation string for the attribute.
      */
-    repo?: string;
+    docstring: string;
     /**
-     * A string field with a default value representing the prefix.
+     * List of additional options for the attribute.
      */
-    prefix?: string;
+    options: AttrOption[];
     /**
-     * Import remote or local models.
+     * Term associated with the attribute, if any.
      */
-    imports?: Map<string, ImportType>;
+    term: string | undefined;
     /**
-     * Allow empty models.
+     * Indicates if the attribute is required.
      */
-    "allow-empty"?: boolean;
-}
-
-/**
- * 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 {
+    required: boolean;
     /**
-     * The key/name of the option
+     * Default value for the attribute.
      */
-    key: string;
+    default?: DataType;
     /**
-     * The string value of the option
+     * XML type information for the attribute.
      */
-    value: string;
+    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;
 }
 
-/**
- * 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 } };
-
 export interface PositionRange {
     start: number;
     end: number;
@@ -319,3 +350,36 @@ export interface Position {
     offset: PositionRange;
 }
 
+/**
+ * Validator for checking the integrity of a data model.
+ */
+export interface Validator {
+    is_valid: boolean;
+    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.
+ */
+export interface ValidationError {
+    message: string;
+    object: string | undefined;
+    attribute: string | undefined;
+    location: string;
+    solution: string | undefined;
+    error_type: ErrorType;
+    positions: Position[];
+}
+
+export interface DataModel {
+    name?: string;
+    objects: Object[];
+    enums: Enumeration[];
+    config?: FrontMatter;
+}
+

package/mdmodels-core_bg.js

@@ -224,29 +224,93 @@ export function validate(markdown_content) {
 
 /**
  * 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}
+ * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20}
  */
 export const Templates = Object.freeze({
+    /**
+     * XML Schema
+     */
     XmlSchema: 0, "0": "XmlSchema",
+    /**
+     * Markdown
+     */
     Markdown: 1, "1": "Markdown",
+    /**
+     * Compact Markdown
+     */
     CompactMarkdown: 2, "2": "CompactMarkdown",
+    /**
+     * SHACL
+     */
     Shacl: 3, "3": "Shacl",
+    /**
+     * JSON Schema
+     */
     JsonSchema: 4, "4": "JsonSchema",
+    /**
+     * JSON Schema All
+     */
     JsonSchemaAll: 5, "5": "JsonSchemaAll",
+    /**
+     * SHACL
+     */
     Shex: 6, "6": "Shex",
+    /**
+     * Python Dataclass
+     */
     PythonDataclass: 7, "7": "PythonDataclass",
+    /**
+     * Python Pydantic XML
+     */
     PythonPydanticXML: 8, "8": "PythonPydanticXML",
+    /**
+     * Python Pydantic
+     */
     PythonPydantic: 9, "9": "PythonPydantic",
+    /**
+     * MkDocs
+     */
     MkDocs: 10, "10": "MkDocs",
+    /**
+     * Internal
+     */
     Internal: 11, "11": "Internal",
+    /**
+     * Typescript (io-ts)
+     */
     Typescript: 12, "12": "Typescript",
+    /**
+     * Typescript (Zod)
+     */
     TypescriptZod: 13, "13": "TypescriptZod",
+    /**
+     * Rust
+     */
     Rust: 14, "14": "Rust",
+    /**
+     * Protobuf
+     */
     Protobuf: 15, "15": "Protobuf",
+    /**
+     * Graphql
+     */
     Graphql: 16, "16": "Graphql",
+    /**
+     * Golang
+     */
     Golang: 17, "17": "Golang",
+    /**
+     * Linkml
+     */
     Linkml: 18, "18": "Linkml",
+    /**
+     * Julia
+     */
     Julia: 19, "19": "Julia",
+    /**
+     * Mermaid class diagram
+     */
+    Mermaid: 20, "20": "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.3",
+  "version": "0.2.4",
   "license": "MIT",
   "repository": {
     "type": "git",