Merge pull request #62 from tabkram/feature/doc

feat: update and complete ts-doc for models

Author: tabkram

src/common/models/engineTrace.model.ts

@@ -1,16 +1,31 @@
 import { EngineEdgeData } from './engineEdgeData.model';
 import { EngineNodeData } from './engineNodeData.model';
 
+/**
+ * Represents a node in the engine, which is an individual component or entity.
+ */
 export interface EngineNode {
   data: EngineNodeData;
   group: 'nodes';
 }
 
+/**
+ * Represents an edge in the engine, which defines a relationship or connection between nodes.
+ */
 export interface EngineEdge {
   data: EngineEdgeData;
   group: 'edges';
 }
 
+/**
+ * Represents a **graph structure** as an array of **nodes** and **edges** in the engine.
+ *
+ * This structure includes:
+ * - `EngineNode`: Represents the nodes in the graph, which are individual components or entities with their own properties and characteristics.
+ * - `EngineEdge`: Represents the edges in the graph, which define the relationships or dependencies between nodes, showing how entities are connected.
+ *
+ * The array allows for a complete representation of the system as a graph, where nodes are linked by edges, enabling the modeling of workflows, processes, or complex relationships.
+ */
 export type EngineTrace = Array<EngineNode | EngineEdge>;
 
 

src/common/models/executionTrace.model.ts

@@ -1,3 +1,6 @@
+/**
+ * Represents an execution trace with information about inputs, outputs, errors, and timing.
+ */
 export interface ExecutionTrace<I, O> {
   id: string;
   inputs?: I;
@@ -11,6 +14,14 @@ export interface ExecutionTrace<I, O> {
   elapsedTime?: string;
 }
 
+/**
+ * Defines how to extract specific data from an `ExecutionTrace`.
+ *
+ * Each property can either be a:
+ * - `boolean`: If `true`, include all data for the property.
+ * - `Array<string>`: A list of specific keys to extract from the property.
+ * - `Function`: A function that processes the data of the property and returns a value.
+ */
 export interface ExecutionTraceExtractor<I, O> {
   inputs?: boolean | Array<string> | ((i: I) => unknown);
   outputs?: boolean | Array<string> | ((o: O) => unknown);

src/common/models/timer.model.ts

@@ -1,8 +1,19 @@
-
-export interface TimerDetailsModel{
+/**
+ * Represents details of a timed execution.
+ */
+export interface TimerDetailsModel {
+  /** Unique identifier for the execution. */
   executionId: string;
+
+  /** The timestamp when execution started. */
   startTime: Date | undefined;
+
+  /** The timestamp when execution ended. */
   endTime: Date | undefined;
+
+  /** Total execution time in milliseconds. */
   duration: number | undefined;
+
+  /** Human-readable duration of the execution. */
   elapsedTime: string | undefined;
 }