From 2178b7db2ff818af633d3ec758acd49da9536d10 Mon Sep 17 00:00:00 2001
From: Philipp Burckhardt <pburckhardt@outlook.com>
Date: Fri, 30 Jun 2023 16:31:35 -0400
Subject: [PATCH] docs: add comments

---
 legacy/packages/core/src/events/emitters.ts |  3 ++
 legacy/packages/core/src/events/event.ts    | 31 +++++++++++++++++++--
 2 files changed, 31 insertions(+), 3 deletions(-)

diff --git a/legacy/packages/core/src/events/emitters.ts b/legacy/packages/core/src/events/emitters.ts
index a05746a2..2b54ad6d 100644
--- a/legacy/packages/core/src/events/emitters.ts
+++ b/legacy/packages/core/src/events/emitters.ts
@@ -6,6 +6,9 @@ import { BaseTask } from '@/task'
 
 import { TaskEvent, TaskStatus } from './event'
 
+/**
+ * Event emitter for task events.
+ */
 export class TaskEventEmitter<
   TInput extends types.TaskInput = void,
   TOutput extends types.TaskOutput = string
diff --git a/legacy/packages/core/src/events/event.ts b/legacy/packages/core/src/events/event.ts
index 85d85365..b02bd568 100644
--- a/legacy/packages/core/src/events/event.ts
+++ b/legacy/packages/core/src/events/event.ts
@@ -11,10 +11,29 @@ export interface EventPayload {
  * Data required to create a new Event object.
  */
 export interface EventData<T extends EventPayload> {
+  /**
+   * Event identifier
+   */
   id?: string
+
+  /**
+   * Event timestamp
+   */
   timestamp?: Date
+
+  /**
+   * Key-value pairs holding event data.
+   */
   payload?: T
+
+  /**
+   * Version of the event.
+   */
   version?: number
+
+  /**
+   * Event type.
+   */
   type?: string
 }
 
@@ -57,6 +76,9 @@ export class Event<T extends EventPayload> {
     return new Type(data)
   }
 
+  /**
+   * Serializes an event into a JSON string.
+   */
   toJSON(): string {
     return JSON.stringify({
       id: this.id,
@@ -67,6 +89,9 @@ export class Event<T extends EventPayload> {
     })
   }
 
+  /**
+   * Returns a human-readable string representation of an event.
+   */
   toString(): string {
     return `Event { id: ${
       this.id
@@ -85,7 +110,7 @@ export interface TaskEventPayload<TInput, TOutput> extends EventPayload {
   taskStatus: TaskStatus
   taskInputs?: TInput
   taskOutput?: TOutput
-  taskParent?: string
+  parentTaskId?: string
 }
 
 /**
@@ -126,7 +151,7 @@ export class TaskEvent<TInput, TOutput> extends Event<
     return this.payload?.taskOutput ?? ''
   }
 
-  get parent(): string {
-    return this.payload?.taskParent ?? 'root'
+  get parentTaskId(): string {
+    return this.payload?.parentTaskId ?? 'root'
   }
 }