Class Plan

Plan class for managing task plans

This class represents a task plan in the Mosaia platform.

Hierarchy (View Summary)

Constructors

constructor

Methods

isActive toJSON toAPIPayload update save delete subscribe approve execute

Constructors

constructor

Methods

isActive

  • isActive(): boolean

    Check if the entity is active

    This method checks the active status of the entity. Most entities in the system can be active or inactive, which affects their availability and usability in the platform.

    Returns boolean

    True if the entity is active, false otherwise

    Example

    const user = new User(userData);
    if (user.isActive()) {
      // Perform operations with active user
    } else {
      console.log('User is inactive');
    }

toJSON

  • toJSON(): PlanInterface

    Convert model instance to interface data

    This method serializes the model instance to a plain object that matches the interface type. This is useful for:

    • Sending data to the API
    • Storing data in a database
    • Passing data between components
    • Debugging model state

    Returns PlanInterface

    The model data as a plain object matching the interface type

    Example

    const user = new User({
      email: 'user@example.com',
      firstName: 'John'
    });

    const data = user.toJSON();
    console.log(data); // { email: '...', firstName: '...' }

    // Use with JSON.stringify
    const json = JSON.stringify(user);

toAPIPayload

  • toAPIPayload(): Partial<PlanInterface>

    Convert model instance to API payload

    This method creates a payload suitable for API requests by:

    • Converting the model to a plain object
    • Removing read-only fields (like 'id')
    • Ensuring proper data format for the API

    Returns Partial<PlanInterface>

    A clean object suitable for API requests

    Example

    const user = new User({
      id: '123',           // Will be removed from payload
      email: 'new@example.com',
      firstName: 'John'
    });

    const payload = user.toAPIPayload();
    // payload = { email: '...', firstName: '...' }
    // Note: 'id' is removed as it's read-only

    await apiClient.POST('/users', payload);

update

  • update(updates: Partial<PlanInterface>): void

    Update model data with new values

    This method updates the model's data and instance properties with new values. It performs a shallow merge of the updates with existing data, allowing for partial updates of the model's properties.

    Parameters

    • updates: Partial<PlanInterface>

      Object containing properties to update

    Returns void

    Example

    const user = new User({
      email: 'old@example.com',
      firstName: 'John'
    });

    // Update multiple properties
    user.update({
      email: 'new@example.com',
      lastName: 'Doe'
    });

    // Save changes to API
    await user.save();

    Remarks

    This method only updates the local model instance. To persist changes to the API, call save after updating.

save

  • save(): Promise<PlanInterface>

    Save the model instance to the API

    This method persists the current state of the model to the API using a PUT request. It requires the model to have an ID (existing instance). For new instances, use the collection's create method instead.

    The method:

    1. Validates the model has an ID
    2. Sends current data to the API
    3. Updates local instance with API response

    Returns Promise<PlanInterface>

    Promise resolving to the updated model data

    Throws

    When model has no ID

    Throws

    When API request fails

    Example

    const user = new User({
      id: '123',
      email: 'user@example.com'
    });

    // Update and save
    user.update({ firstName: 'John' });
    await user.save();

    Example

    Error handling:

    try {
      await user.save();
    } catch (error) {
      if (error.message.includes('ID is required')) {
        // Handle missing ID error
      } else {
        // Handle API errors
      }
    }

delete

  • delete(params?: object): Promise<void>

    Delete the model instance from the API

    This method permanently deletes the model instance from the API and clears the local data. This operation cannot be undone.

    The method:

    1. Validates the model has an ID
    2. Sends DELETE request to the API
    3. Clears local instance data on success

    Parameters

    • Optionalparams: object

      Optional query parameters for deletion (e.g., { delete: true, deleteS3: true })

    Returns Promise<void>

    Promise that resolves when deletion is successful

    Throws

    When model has no ID

    Throws

    When API request fails

    Example

    Basic deletion:

    const user = await users.get({}, 'user-id');
    if (user) {
      await user.delete();
      // User is now deleted and instance is cleared
    }

    Example

    Error handling:

    try {
      await user.delete();
      console.log('User deleted successfully');
    } catch (error) {
      if (error.message.includes('ID is required')) {
        console.error('Cannot delete - no ID');
      } else {
        console.error('Deletion failed:', error.message);
      }
    }

    Example

    Delete with query parameters:

    // Hard delete
    await item.delete({ delete: true });

    // Delete with S3 cleanup
    await item.delete({ deleteS3: true, delete: true });

subscribe

  • subscribe<TStart = any>(
        handlers: SSESubscribeHandlers<Partial<PlanInterface>, TStart>,
    ): SSESubscription

    Subscribe to live updates for this entity via the SSE relay.

    Opens a Server-Sent Events connection to the Mosaia relay server (mosaia-sse-relay-server) scoped to this specific document. The relay watches the underlying MongoDB change stream and forwards every update to handlers.onUpdate.

    Requires the entity to have an id (must be saved first).

    Type Parameters

    • TStart = any

    Parameters

    Returns SSESubscription

    A subscription handle. Call close() to disconnect.

    Example

    const drive = await client.drives.get({}, driveId);
    const sub = drive.subscribe({
      onUpdate: (doc) => console.log('drive changed', doc),
      onError: (err) => console.error(err),
    });

    // later
    sub.close();

approve

  • approve(
        options?: { mode?: "auto_execute" | "review" },
    ): Promise<{ message: string; plan: string; mode: string }>

    Approve the plan

    This method approves a plan that is in DRAFT status. The approval process creates tasks from the plan content. The mode parameter determines whether the plan is auto-executed after approval or requires manual review.

    Parameters

    • options: { mode?: "auto_execute" | "review" } = {}

      Approval options

      • Optionalmode?: "auto_execute" | "review"

        Approval mode: 'auto_execute' or 'review' (default: 'review')

    Returns Promise<{ message: string; plan: string; mode: string }>

    Promise resolving to approval response data

    Throws

    When plan has no ID

    Throws

    When plan is not in DRAFT status

    Throws

    When API request fails

    Example

    // Approve for review (default)
    await plan.approve();

    // Approve with auto-execution
    await plan.approve({ mode: 'auto_execute' });

execute

  • execute(options?: { message?: { content: string; role: string } }): Promise<any>

    Execute the plan

    This method triggers plan execution for plans that are in APPROVED status. It sends the plan to the execution queue where tasks will be run. Optionally accepts a message that will be passed to the first eligible task.

    Parameters

    • options: { message?: { content: string; role: string } } = {}

      Execution options

      • Optionalmessage?: { content: string; role: string }

        Optional message to pass to the first task

    Returns Promise<any>

    Promise resolving to the updated plan data

    Throws

    When plan has no ID

    Throws

    When plan is not in APPROVED status

    Throws

    When API request fails

    Example

    // Execute plan
    await plan.execute();

    // Execute with message for first task
    await plan.execute({
        message: { content: 'Use production settings', role: 'user' }
    });

Settings

Member Visibility

On This Page

Constructors
Methods