mdmodels-core 0.2.1 → 0.2.2

package/mdmodels-core.d.ts

@@ -81,48 +81,99 @@ export enum Templates {
   Julia = 19,
 }
 /**
- * Represents different types of model imports.
+ * A raw key-value representation of an attribute option.
  *
- * Can be either a remote URL or a local file path.
+ * This struct provides a simple string-based representation of options,
+ * which is useful for serialization/deserialization and when working
+ * with untyped data.
  */
-export type ImportType = { Remote: string } | { Local: string };
+export interface RawOption {
+    /**
+     * The key/name of the option
+     */
+    key: string;
+    /**
+     * The string value of the option
+     */
+    value: string;
+}
 
 /**
- * Represents the front matter data of a markdown file.
+ * 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 interface FrontMatter {
+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 {
     /**
-     * Identifier field of the model.
+     * Name of the enumeration.
      */
-    id: string | undefined;
+    name: string;
     /**
-     * A boolean field with a default value, renamed from `id-field`.
+     * Mappings associated with the enumeration.
      */
-    "id-field"?: boolean;
+    mappings: Map<string, string>;
     /**
-     * Optional hashmap of prefixes.
+     * Documentation string for the enumeration.
      */
-    prefixes: Map<string, string> | undefined;
+    docstring: string;
     /**
-     * Optional namespace map.
+     * The line number of the enumeration
      */
-    nsmap: Map<string, string> | undefined;
+    position: Position | undefined;
+}
+
+/**
+ * Represents an object with a name, attributes, docstring, and an optional term.
+ */
+export interface Object {
     /**
-     * A string field with a default value representing the repository URL.
+     * Name of the object.
      */
-    repo?: string;
+    name: string;
     /**
-     * A string field with a default value representing the prefix.
+     * List of attributes associated with the object.
      */
-    prefix?: string;
+    attributes: Attribute[];
     /**
-     * Import remote or local models.
+     * Documentation string for the object.
      */
-    imports?: Map<string, ImportType>;
+    docstring: string;
     /**
-     * Allow empty models.
+     * Optional term associated with the object.
      */
-    "allow-empty"?: boolean;
+    term?: string;
+    /**
+     * Parent object of the object.
+     */
+    parent?: string;
+    /**
+     * The line number of the object
+     */
+    position?: Position;
+}
+
+export interface PositionRange {
+    start: number;
+    end: number;
+}
+
+export interface Position {
+    line: number;
+    column: PositionRange;
+    offset: PositionRange;
 }
 
 export interface DataModel {
@@ -197,100 +248,49 @@ export interface Attribute {
  */
 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
+ * Represents different types of model imports.
  *
+ * Can be either a remote URL or a local file path.
  */
-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 ImportType = { Remote: string } | { Local: string };
 
 /**
- * Represents an enumeration with a name and mappings.
+ * Represents the front matter data of a markdown file.
  */
-export interface Enumeration {
-    /**
-     * Name of the enumeration.
-     */
-    name: string;
-    /**
-     * Mappings associated with the enumeration.
-     */
-    mappings: Map<string, string>;
+export interface FrontMatter {
     /**
-     * Documentation string for the enumeration.
+     * Identifier field of the model.
      */
-    docstring: string;
+    id: string | undefined;
     /**
-     * The line number of the enumeration
+     * A boolean field with a default value, renamed from `id-field`.
      */
-    position: Position | undefined;
-}
-
-/**
- * Represents an object with a name, attributes, docstring, and an optional term.
- */
-export interface Object {
+    "id-field"?: boolean;
     /**
-     * Name of the object.
+     * Optional hashmap of prefixes.
      */
-    name: string;
+    prefixes: Map<string, string> | undefined;
     /**
-     * List of attributes associated with the object.
+     * Optional namespace map.
      */
-    attributes: Attribute[];
+    nsmap: Map<string, string> | undefined;
     /**
-     * Documentation string for the object.
+     * A string field with a default value representing the repository URL.
      */
-    docstring: string;
+    repo?: string;
     /**
-     * Optional term associated with the object.
+     * A string field with a default value representing the prefix.
      */
-    term?: string;
+    prefix?: string;
     /**
-     * Parent object of the object.
+     * Import remote or local models.
      */
-    parent?: string;
+    imports?: Map<string, ImportType>;
     /**
-     * The line number of the object
+     * Allow empty models.
      */
-    position?: Position;
+    "allow-empty"?: boolean;
 }
 
 /**

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