@loopstack/workflow-state-example-workflow

A module for the Loopstack AI automation framework.

This module provides an example workflow demonstrating how to manage state across transitions using instance properties.

Overview

The Workflow State Example Workflow shows how to store data as instance properties and access it across transitions. It demonstrates the core patterns for managing data flow in a workflow.

By using this workflow as a reference, you'll learn how to:

• Store tool results as workflow instance properties
• Access instance properties in subsequent transitions
• Create private helper methods to transform stored data
• Use @InjectTool() to declare and call tools

This example is useful for developers building workflows that need to store and manipulate data across transitions.

Installation

See SETUP.md for installation and setup instructions.

How It Works

Key Concepts

1. Defining Workflow State

State is stored as instance properties on the workflow class. No special decorator is needed -- just declare properties on your class:

@Workflow({
  uiConfig: __dirname + '/workflow-state.ui.yaml',
})
export class WorkflowStateWorkflow extends BaseWorkflow {
  @InjectTool() private createValue: CreateValue;
  @InjectTool() private createChatMessage: CreateChatMessage;

  message?: string;
}

The message property is a plain instance property that persists across transitions automatically.

2. Storing Tool Results in State

Call a tool and assign the result to an instance property inside a transition method:

@Initial({ to: 'data_created' })
async createSomeData() {
  const result = await this.createValue.call({ input: 'Hello :)' });
  this.message = result.data as string;
}

The createValue tool returns a ToolResult with a data property. The value is stored in this.message for use in later transitions.

3. Accessing State in Later Transitions

Instance properties are available in any subsequent transition method:

@Final({ from: 'data_created' })
async showResults() {
  await this.createChatMessage.call({
    role: 'assistant',
    content: `Data from state: ${this.message}`,
  });

  await this.createChatMessage.call({
    role: 'assistant',
    content: `Use workflow helper method: ${this.messageInUpperCase(this.message!)}`,
  });
}

4. Private Helper Methods

Define private methods to transform or process state data:

private messageInUpperCase(message: string): string {
  return message?.toUpperCase();
}

These are standard TypeScript methods with no decorator required. Call them from any transition using this.messageInUpperCase(...).

Complete Workflow

import { BaseWorkflow, Final, Initial, InjectTool, Workflow } from '@loopstack/common';
import { CreateChatMessage } from '@loopstack/create-chat-message-tool';
import { CreateValue } from '@loopstack/create-value-tool';

@Workflow({
  uiConfig: __dirname + '/workflow-state.ui.yaml',
})
export class WorkflowStateWorkflow extends BaseWorkflow {
  @InjectTool() private createValue: CreateValue;
  @InjectTool() private createChatMessage: CreateChatMessage;

  message?: string;

  @Initial({ to: 'data_created' })
  async createSomeData() {
    const result = await this.createValue.call({ input: 'Hello :)' });
    this.message = result.data as string;
  }

  @Final({ from: 'data_created' })
  async showResults() {
    await this.createChatMessage.call({
      role: 'assistant',
      content: `Data from state: ${this.message}`,
    });

    await this.createChatMessage.call({
      role: 'assistant',
      content: `Use workflow helper method: ${this.messageInUpperCase(this.message!)}`,
    });
  }

  private messageInUpperCase(message: string): string {
    return message?.toUpperCase();
  }
}

Dependencies

This workflow uses the following Loopstack modules:

• @loopstack/common - Base classes, decorators, and tool injection
• @loopstack/create-chat-message-tool - Provides CreateChatMessage tool
• @loopstack/create-value-tool - Provides CreateValue tool

About

Author: Jakob Klippel

License: Apache-2.0

Additional Resources

• Loopstack Documentation
• Getting Started with Loopstack
• Find more Loopstack examples in the Loopstack Registry