mdmodels-core 0.2.5 → 0.2.6

package/mdmodels-core.d.ts

@@ -156,6 +156,22 @@ export enum Templates {
    */
   Mermaid = 20,
 }
+export interface PositionRange {
+    start: number;
+    end: number;
+}
+
+export interface Position {
+    line: number;
+    column: PositionRange;
+    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 } };
+
 /**
  * A raw key-value representation of an attribute option.
  *
@@ -189,108 +205,58 @@ 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 type DataType = { Boolean: boolean } | { Integer: number } | { Float: number } | { String: string };
-
 /**
- * Represents an attribute with various properties and options.
+ * Represents an enumeration with a name and mappings.
  */
-export interface Attribute {
+export interface Enumeration {
     /**
-     * The name of the attribute.
+     * Name of the enumeration.
      */
     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.
+     * Mappings associated with the enumeration.
      */
-    dtypes: string[];
+    mappings: Map<string, string>;
     /**
-     * Documentation string for the attribute.
+     * Documentation string for the enumeration.
      */
     docstring: string;
     /**
-     * List of additional options for the attribute.
-     */
-    options: AttrOption[];
-    /**
-     * Term associated with the attribute, if any.
+     * The line number of the enumeration
      */
-    term: string | undefined;
+    position: Position | undefined;
+}
+
+/**
+ * Represents an object with a name, attributes, docstring, and an optional term.
+ */
+export interface Object {
     /**
-     * Indicates if the attribute is required.
+     * Name of the object.
      */
-    required: boolean;
+    name: string;
     /**
-     * Default value for the attribute.
+     * List of attributes associated with the object.
      */
-    default?: DataType;
+    attributes: Attribute[];
     /**
-     * XML type information for the attribute.
+     * Documentation string for the object.
      */
-    xml?: XMLType;
+    docstring: string;
     /**
-     * Is an enumeration or not
+     * Optional term associated with the object.
      */
-    is_enum: boolean;
+    term?: string;
     /**
-     * The line number of the attribute
+     * Other objects that this object gets mixed in with.
      */
-    position: Position | undefined;
+    mixins?: string[];
     /**
-     * The prefix of the attribute, if it is an import
+     * The line number of the object
      */
-    import_prefix?: string;
-}
-
-/**
- * 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 PositionRange {
-    start: number;
-    end: number;
-}
-
-export interface Position {
-    line: number;
-    column: PositionRange;
-    offset: PositionRange;
+    position?: Position;
 }
 
-/**
- * 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,62 +302,96 @@ export interface FrontMatter {
     "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 enumeration with a name and mappings.
+ * Represents an attribute with various properties and options.
  */
-export interface Enumeration {
+export interface Attribute {
     /**
-     * Name of the enumeration.
+     * The name of the attribute.
      */
     name: string;
     /**
-     * Mappings associated with the enumeration.
+     * Indicates if the attribute is an array.
      */
-    mappings: Map<string, string>;
+    multiple: boolean;
     /**
-     * Documentation string for the enumeration.
+     * Is an identifier or not
+     */
+    is_id: boolean;
+    /**
+     * Data types associated with the attribute.
+     */
+    dtypes: string[];
+    /**
+     * Documentation string for the attribute.
      */
     docstring: string;
     /**
-     * The line number of the enumeration
+     * List of additional options for the attribute.
      */
-    position: Position | undefined;
-}
-
-/**
- * Represents an object with a name, attributes, docstring, and an optional term.
- */
-export interface Object {
+    options: AttrOption[];
     /**
-     * Name of the object.
+     * Term associated with the attribute, if any.
      */
-    name: string;
+    term: string | undefined;
     /**
-     * List of attributes associated with the object.
+     * Indicates if the attribute is required.
      */
-    attributes: Attribute[];
+    required: boolean;
     /**
-     * Documentation string for the object.
+     * Default value for the attribute.
      */
-    docstring: string;
+    default?: DataType;
     /**
-     * Optional term associated with the object.
+     * XML type information for the attribute.
      */
-    term?: string;
+    xml?: XMLType;
     /**
-     * Other objects that this object gets mixed in with.
+     * Is an enumeration or not
      */
-    mixins?: string[];
+    is_enum: boolean;
     /**
-     * The line number of the object
+     * The line number of the attribute
      */
-    position?: Position;
+    position: Position | undefined;
+    /**
+     * The prefix of the attribute, if it is an import
+     */
+    import_prefix?: string;
 }
 
-export interface DataModel {
-    name?: string;
-    objects: Object[];
-    enums: Enumeration[];
-    config?: FrontMatter;
+/**
+ * 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[];
 }
 

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.6",
   "license": "MIT",
   "repository": {
     "type": "git",