mdmodels-core 0.2.5 → 0.2.7

package/mdmodels-core.d.ts

@@ -157,97 +157,9 @@ export enum Templates {
   Mermaid = 20,
 }
 /**
- * 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 } };
-
-export type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
-
-/**
- * Represents an attribute with various properties and options.
+ * Represents an XML type, either an attribute or an element.
  */
-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 XMLType = { Attribute: { is_attr: boolean; name: string } } | { Element: { is_attr: boolean; name: string } } | { Wrapped: { is_attr: boolean; name: string; wrapped: string[] | undefined } };
 
 /**
  * Validator for checking the integrity of a data model.
@@ -275,6 +187,13 @@ export interface ValidationError {
     positions: Position[];
 }
 
+export interface DataModel {
+    name?: string;
+    objects: Object[];
+    enums: Enumeration[];
+    config?: FrontMatter;
+}
+
 export interface PositionRange {
     start: number;
     end: number;
@@ -286,11 +205,6 @@ export interface Position {
     offset: PositionRange;
 }
 
-/**
- * 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 different types of model imports.
  *
@@ -336,6 +250,39 @@ export interface FrontMatter {
     "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 {
+    /**
+     * 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.
  */
@@ -388,10 +335,63 @@ export interface Object {
     position?: Position;
 }
 
-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.
+ */
+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/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.5",
+  "version": "0.2.7",
   "license": "MIT",
   "repository": {
     "type": "git",