mdmodels-core 0.1.8 → 0.2.1

package/README.md

@@ -1,15 +1,25 @@
-
 # MD-Models
 
 ![Crates.io Version](https://img.shields.io/crates/v/mdmodels) ![NPM Version](https://img.shields.io/npm/v/mdmodels-core)
 ![PyPI - Version](https://img.shields.io/pypi/v/mdmodels-core)
  ![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.
+Welcome to Markdown Models (MD-Models), a powerful framework for research data management that prioritizes narrative and readability for data models.
 
 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.
+## Core Philosophy
+
+The primary motivation behind MD-Models is to reduce cognitive overhead and maintenance burden by unifying documentation and structural definition into a single source of truth. Traditional approaches often require maintaining separate artifacts:
+
+1. Technical schemas (JSON Schema, XSD, ShEx, SHACL)
+2. Programming language implementations
+3. Documentation for domain experts
+4. API documentation
+
+This separation frequently leads to documentation drift and increases the cognitive load on both developers and domain experts.
+
+Check out the [documentation and graph editor](https://mdmodels.vercel.app/?about) for more information.
 
 ### Example
 
@@ -73,10 +83,21 @@ 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
+- `typescript`: TypeScript interface definitions with JSON-LD support
+- `typescript-zod`: TypeScript Zod schema definitions
+- `rust`: Rust struct definitions with serde support
+- `golang`: Go struct definitions
+- `julia`: Julia struct definitions
+- `protobuf`: Protocol Buffer schema definition
+- `graphql`: GraphQL schema definition
 - `xml-schema`: XML schema definition
 - `json-schema`: JSON schema definition
+- `json-schema-all`: Multiple JSON schema definitions (one per object)
 - `shacl`: SHACL shapes definition
 - `shex`: ShEx shapes definition
+- `compact-markdown`: Compact markdown representation
+- `mkdocs`: MkDocs documentation format
+- `linkml`: LinkML schema definition
 
 ## Installation options
 
@@ -88,7 +109,7 @@ The main Rust crate is compiled to Python and WebAssembly, allowing the usage be
   pip install mdmodels-core
   ```
 
-- **[Python Package](https://pypi.org/project/mdmodels/)**: Install via pip:
+- **[Python Package](https://github.com/FAIRChemistry/py-mdmodels/tree/master)**: Install via pip:
   ```bash
   # Provides in-memory data models, database support, LLM support, etc.
   pip install mdmodels

package/mdmodels-core.d.ts

@@ -72,86 +72,29 @@ export enum Templates {
   MkDocs = 10,
   Internal = 11,
   Typescript = 12,
+  TypescriptZod = 13,
+  Rust = 14,
+  Protobuf = 15,
+  Graphql = 16,
+  Golang = 17,
+  Linkml = 18,
+  Julia = 19,
 }
 /**
- * Represents an XML type, either an attribute or an element.
+ * Represents different types of model imports.
+ *
+ * Can be either a remote URL or a local file path.
  */
-export type XMLType = { Attribute: { is_attr: boolean; name: string } } | { Element: { is_attr: boolean; name: string } };
-
-/**
- * Represents an enumeration with a name and mappings.
- */
-export interface Enumeration {
-    /**
-     * Name of the enumeration.
-     */
-    name: string;
-    /**
-     * Mappings associated with the enumeration.
-     */
-    mappings: Map<string, string>;
-    /**
-     * Documentation string for the enumeration.
-     */
-    docstring: string;
-    /**
-     * The line number of the enumeration
-     */
-    position: Position | undefined;
-}
-
-/**
- * Represents an object with a name, attributes, docstring, and an optional term.
- */
-export interface Object {
-    /**
-     * Name of the object.
-     */
-    name: string;
-    /**
-     * List of attributes associated with the object.
-     */
-    attributes: Attribute[];
-    /**
-     * Documentation string for the object.
-     */
-    docstring: string;
-    /**
-     * Optional term associated with the object.
-     */
-    term?: string;
-    /**
-     * Parent object of the object.
-     */
-    parent?: string;
-    /**
-     * The line number of the object
-     */
-    position?: 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;
-}
+export type ImportType = { Remote: string } | { Local: string };
 
 /**
  * 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`.
      */
@@ -172,24 +115,25 @@ export interface FrontMatter {
      * A string field with a default value representing the prefix.
      */
     prefix?: string;
-}
-
-export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
-
-/**
- * Represents an option for an attribute.
- */
-export interface AttrOption {
     /**
-     * The key of the option.
+     * Import remote or local models.
      */
-    key: string;
+    imports?: Map<string, ImportType>;
     /**
-     * The value of the option.
+     * Allow empty models.
      */
-    value: string;
+    "allow-empty"?: boolean;
+}
+
+export interface DataModel {
+    name?: string;
+    objects: Object[];
+    enums: Enumeration[];
+    config?: FrontMatter;
 }
 
+export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
+
 /**
  * Represents an attribute with various properties and options.
  */
@@ -242,6 +186,111 @@ export interface Attribute {
      * The line number of the attribute
      */
     position: Position | undefined;
+    /**
+     * The prefix of the attribute, if it is an import
+     */
+    import_prefix?: 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 } };
+
+export interface PositionRange {
+    start: number;
+    end: number;
+}
+
+export interface Position {
+    line: number;
+    column: PositionRange;
+    offset: PositionRange;
+}
+
+/**
+ * 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 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 } };
+
+/**
+ * Represents an enumeration with a name and mappings.
+ */
+export interface Enumeration {
+    /**
+     * Name of the enumeration.
+     */
+    name: string;
+    /**
+     * Mappings associated with the enumeration.
+     */
+    mappings: Map<string, string>;
+    /**
+     * Documentation string for the enumeration.
+     */
+    docstring: string;
+    /**
+     * The line number of the enumeration
+     */
+    position: Position | undefined;
+}
+
+/**
+ * Represents an object with a name, attributes, docstring, and an optional term.
+ */
+export interface Object {
+    /**
+     * Name of the object.
+     */
+    name: string;
+    /**
+     * List of attributes associated with the object.
+     */
+    attributes: Attribute[];
+    /**
+     * Documentation string for the object.
+     */
+    docstring: string;
+    /**
+     * Optional term associated with the object.
+     */
+    term?: string;
+    /**
+     * Parent object of the object.
+     */
+    parent?: string;
+    /**
+     * The line number of the object
+     */
+    position?: Position;
 }
 
 /**
@@ -255,7 +304,7 @@ export interface Validator {
 /**
  * Enum representing the type of validation error.
  */
-export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError";
+export type ErrorType = "NameError" | "TypeError" | "DuplicateError" | "GlobalError" | "XMLError" | "ObjectError";
 
 /**
  * Represents a validation error in the data model.
@@ -265,6 +314,7 @@ export interface ValidationError {
     object: string | undefined;
     attribute: string | undefined;
     location: string;
+    solution: string | undefined;
     error_type: ErrorType;
     positions: Position[];
 }

package/mdmodels-core_bg.js

@@ -224,7 +224,7 @@ export function validate(markdown_content) {
 
 /**
  * Enumeration of available templates.
- * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12}
+ * @enum {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19}
  */
 export const Templates = Object.freeze({
     XmlSchema: 0, "0": "XmlSchema",
@@ -240,6 +240,13 @@ export const Templates = Object.freeze({
     MkDocs: 10, "10": "MkDocs",
     Internal: 11, "11": "Internal",
     Typescript: 12, "12": "Typescript",
+    TypescriptZod: 13, "13": "TypescriptZod",
+    Rust: 14, "14": "Rust",
+    Protobuf: 15, "15": "Protobuf",
+    Graphql: 16, "16": "Graphql",
+    Golang: 17, "17": "Golang",
+    Linkml: 18, "18": "Linkml",
+    Julia: 19, "19": "Julia",
 });
 
 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.1.8",
+  "version": "0.2.1",
   "license": "MIT",
   "repository": {
     "type": "git",