Plans

`createPlan(definition)`

Creates and validates a new execution plan.

import { createPlan } from '@dee/engine';

const plan = createPlan(definition: PlanDefinition): ExecutionPlan;

interface PlanDefinition {
  id: string;
  name: string;
  steps: Step[];
  transitions: TransitionSet;
  exitConditions?: ExitCondition[];
  metadata?: Record<string, unknown>;
}

Throws PlanValidationError if the plan is invalid (unreachable steps, missing defaults, circular references).

Step Builders

`steps.sendEmail(config)`

steps.sendEmail({
  id: string;
  templateId: string;
  subject: string;
  replyTo?: string;
  tracking?: {
    opens?: boolean;
    clicks?: boolean;
  };
}): EmailStep;

`steps.sendVoice(config)`

steps.sendVoice({
  id: string;
  scriptId: string;
  callerId?: string;
  maxDuration?: Duration;
  voicemail?: {
    detect: boolean;
    messageId?: string;
    fallbackTTS?: string;
  };
}): VoiceStep;

`steps.wait(config)`

steps.wait({
  id: string;
  duration: Duration;
}): WaitStep;

type Duration = {
  days?: number;
  hours?: number;
  minutes?: number;
};

`steps.branch(config)`

steps.branch({
  id: string;
  conditions: Array<{
    when: string;  // condition expression
    goto: string;  // target step ID
  }>;
}): BranchStep;

The last condition should use when: 'default' as a fallback.

`steps.end(config)`

steps.end({
  id: string;
  outcome: string;
}): EndStep;

Transition Builders

`transitions.linear()`

Creates transitions that connect steps in the order they're defined.

transitions.linear(): TransitionSet;

`transitions.explicit(edges)`

Creates transitions from explicit edge definitions.

transitions.explicit(edges: Array<{
  from: string;
  to: string;
  condition?: string;
}>): TransitionSet;

Condition Expressions

Branch conditions use a simple expression language:

Expression	Description
`events.hasReply("step-id")`	Contact replied to email from step
`events.hasOpen("step-id")`	Contact opened email from step
`events.hasClick("step-id")`	Contact clicked a link in email
`events.hasBounce("step-id")`	Email from step bounced
`events.hasReply(any)`	Contact replied to any email
`contact.unsubscribed`	Contact is on suppression list
`contact.bounced`	Contact email is invalid
`call.outcome("step-id") == "answered"`	Call was answered
`default`	Always true (fallback)

Plans

On this page