Skip to main content
The Workflow interface defines the structure and components of a workflow, including its execution environment, available tools and guards, event handlers, context, and state machine definition.

​
Structure

export interface Workflow {
    server: ServerConfig;
    guards: Record<string, string>;
    tools: Record<string, string | null>;
    events: Record<string, string | null>;
    context: Record<string, "string" | "number" | "boolean" | "object" | "array" | "null">;
    machine: {
        initial: string;
        states: Record<string, State>;
    };
}

​
Server Configuration

​
server
ServerConfig
Specifies the server configuration for executing the workflow. This defines how and where tools will be invoked during the workflow execution.
interface ServerConfig {
  domain: string;
  toolWebhookUrl: string;
  headers: Record<string, string>;
}
  • domain: The domain that Solmyr’s Deno environment will permit you to make requests to.
  • toolWebhookUrl: The base URL that Solmyr will use as the prefix for invoking tools by URL.
  • headers: HTTP headers to be included with every tool call.

​
Guards

​
guards
Record<string, string>
Defines conditional checks that can be used within the workflow’s state machine. Each guard is a TypeScript expression that evaluates to a boolean.

​
Tools

​
tools
Record<string, string | null>
Defines the tools available for use within the workflow. Tools can be either remote functions (invoked via HTTP) or local functions executed in the Deno environment.
  • If the value is null, Solmyr will call toolWebhookUrl/toolName with the entire state as the body.
  • If the value is a string containing a TypeScript function, Solmyr will execute it locally.

​
Events

​
events
Record<string, string | null>
Defines the events that the workflow can handle, along with their expected parameters.
  • If an event requires parameters, the value is a JSON Schema string describing the expected structure.
  • Use zodToJsonSchema to generate JSON Schema from Zod schemas for type safety.

​
Context

​
context
Record<string, string>
Defines the structure of the workflow’s context (state). This represents the data that persists throughout the workflow execution and can be modified by tools and events.

​
State Machine

The machine property in our Workflow interface corresponds to XState’s machine configuration. While our structure is a subset of XState’s full capabilities, it’s compatible with XState’s core concepts.
​
machine
object
Defines the state machine that governs the workflow’s behavior.
  • initial: The name of the initial state when the workflow starts.
  • states: A record of all possible states in the workflow.

​
Usage Example

const myWorkflow: Workflow = {
    server: {
        domain: "api.example.com",
        toolWebhookUrl: "https://api.example.com/tools",
        headers: {
            "Authorization": "Bearer TOKEN"
        }
    },
    guards: {
        "isAuthenticated": "context.user !== null"
    },
    tools: {
        "fetchUserData": null,
        "processPayment": "async (amount) => { /* ... */ }"
    },
    events: {
        "userInput": zodToJsonSchema(z.object({ text: z.string() }))
    },
    context: {
        user: "object",
        cart: "array"
    },
    machine: {
        initial: "greeting",
        states: {
            // ... (state definitions)
        }
    }
};
This structure provides a comprehensive definition of a workflow, including all the components necessary for its execution within the Solmyr system.