plandev-actions

Javascript package for use with PlanDev/SeqDev actions.

PlanDev/SeqDev Rebrand

This product was formerly known as Aerie Actions and is now named PlanDev/SeqDev Actions. What to know:

• The planning product, including modeling, simulation, scheduling and constraint-checking, is now named PlanDev
• The sequencing product, including the sequence editor, workspaces, and actions, is now named PlanDev/SeqDev
• All features and functionality remain the same

For the latest documentation, visit: PlanDev Documentation

See PlanDev/SeqDev Actions docs for more information - full API reference coming soon.

Action results: data vs report

An action returns an ActionResult:

type ActionResult = {
  status: 'FAILED' | 'SUCCESS';
  data: any; // machine-readable output (rendered as raw JSON in the "Results" block)
  report?: string; // optional human-facing Markdown summary (rendered in the "Report" block)
};

• data is the structured, machine-readable output. The UI shows it as pretty-printed JSON in the Results block.
• report is an optional Markdown string for the things a person needs to read and click. The UI renders it in a Report block shown above Results — so you no longer need to stuff human-readable output into logs.

Example

export async function main(parameters, settings, actionsAPI) {
  // ... do work ...
  return {
    status: 'SUCCESS',
    data: { violations: 2, checked: 148 },
    report: [
      '## Constraint check complete',
      '',
      'Checked **148** constraints — <span style="color: #c00">2 violations</span> found.',
      '',
      '| Constraint | Result |',
      '| --- | --- |',
      '| Power margin | <span style="color: green">OK</span> |',
      '| Thermal window | <span style="color: #c00">**Violated** at 04:12Z</span> |',
      '',
      'See the [full report](https://example.com/runs/123) for details.',
    ].join('\n'),
  };
}

Supported Markdown

The Report block accepts a curated, GitHub-flavored Markdown subset:

• Headings, paragraphs, line breaks, horizontal rules
• Bold, italic, ~~strikethrough~~, inline code and fenced code blocks
• Ordered/unordered lists, blockquotes
• Tables
• Hyperlinks (open in a new tab)
• Inline text color via <span style="color: ..."> — color and background-color only, with validated color values (named, #hex, rgb()/hsl()). Works in text and inside table cells.

Not supported (stripped for safety)

The UI sanitizes report content because it is rendered in other users' browsers. The following are removed: <script> and event handlers, javascript:/data: links, images and video (<img>/<video>), <iframe>/embeds, other raw HTML, and any CSS other than color/background-color (so a style can't carry url(...), position, etc.). Treat report as untrusted display content — only the supported subset above is rendered.