@statelyai/sdk 0.29.1 → 0.31.1

package/dist/protocol-2cvzJtGN.d.mts

@@ -0,0 +1,846 @@
+import { i as ProfileManifest } from "./index-DlOZxzrW.mjs";
+import { i as StatelyGraph } from "./graph-CR_g-mOq.mjs";
+import { c as EditorSyncSourceLocation, f as MachineSourceLocations$1, l as EditorSyncSourceRange, t as EditorCapabilities$1, u as EditorSyncStateSourceLocation } from "./editor-sync-types-CPpzTSnT.mjs";
+
+//#region src/embedPanel.d.ts
+type EmbedPanelPosition = 'left' | 'right' | 'bottom';
+interface EmbedPanelConfig {
+  id: string;
+  /** Restrict the panel to one side. Omit to allow any side. */
+  position?: EmbedPanelPosition;
+  /** Keep a one-click tab visible on its positioned or preferred side. */
+  tab?: boolean;
+  /** Open the panel when the embed is initialized. */
+  initiallyOpen?: boolean;
+}
+//#endregion
+//#region src/protocol.d.ts
+/** Query parameter carrying the unguessable inspection room capability. */
+declare const INSPECTION_ROOM_QUERY_PARAM = "r";
+/**
+ * Create the room-global identity for one producer-local actor session.
+ * Runtime and producer-resolved session ids may use different uniqueness
+ * domains; the producer id supplies a stable room namespace.
+ */
+declare function createInspectionActorId(producerId: string, sessionId: string): string;
+interface InspectionRoomUrls {
+  roomId: string;
+  relayUrl: string;
+  inspectorUrl: string;
+}
+/** Resolve the transport and browser URLs required by the inspection protocol. */
+declare function createInspectionRoomUrls(options: {
+  url: string;
+  roomId: string;
+  inspectorBaseUrl?: string;
+}): InspectionRoomUrls;
+/** Read a room capability from a conforming relay or inspector URL. */
+declare function getInspectionRoomId(value: string | URL): string | null;
+type EmbedMode = 'editing' | 'viewing' | 'simulating' | 'inspecting';
+interface CommentsConfig {
+  roomId: string;
+  userId?: string | null;
+  publicApiKey?: string;
+  authEndpoint?: string;
+  baseUrl?: string;
+}
+interface ProjectEmbedMachine {
+  id: string;
+  name?: string;
+  /** Source identifier used when another machine invokes this machine. */
+  sourceReference?: string;
+  /** Source document used to scope references that do not carry imports. */
+  sourceUri?: string;
+  /** Optional host project scope for machine-to-machine references. */
+  projectId?: string;
+  createdAt?: number;
+  updatedAt?: number;
+  origin?: ProjectWorkspaceMachineOrigin;
+  machine: unknown;
+  /** Source format used by source-backed project hosts. */
+  format?: string;
+  /** Per-machine writeback locations used by source-backed project hosts. */
+  sourceLocations?: MachineSourceLocations;
+}
+type ProjectWorkspaceActionIcon = 'arrow-left' | 'copy' | 'fork' | 'history';
+interface ProjectWorkspaceAction {
+  id: string;
+  label: string;
+  icon?: ProjectWorkspaceActionIcon;
+  disabled?: boolean;
+}
+interface ProjectWorkspaceMachineOrigin {
+  parentMachineId: string;
+  type: 'version' | 'fork';
+  createdBy?: {
+    type: string;
+    id?: string;
+    name?: string;
+  };
+  captureType?: string;
+}
+/** Opt-in host-facing automatic version capture policy. */
+interface MachineVersionAutoSaveOptions {
+  /** Minimum time between automatic versions, in milliseconds. */
+  intervalMs: number;
+  createdBy?: {
+    type: string;
+    id?: string;
+    name?: string;
+  };
+  captureType?: string;
+}
+interface ProjectWorkspaceMachine {
+  id: string;
+  name?: string;
+  createdAt?: number;
+  updatedAt?: number;
+  origin?: ProjectWorkspaceMachineOrigin;
+  /** Optional editor target supplied by a hosted workspace. */
+  editor?: 'legacy' | 'beta';
+  /** Action emitted instead of selecting the machine when it is clicked. */
+  openAction?: ProjectWorkspaceAction;
+}
+interface ProjectWorkspaceProject {
+  id: string;
+  name: string;
+  machines: ProjectWorkspaceMachine[];
+  rootMachineId?: string;
+}
+/** Host-backed operations for the built-in workspace controls. */
+interface ProjectWorkspaceCapabilities {
+  renameProject?: ProjectWorkspaceAction;
+  createMachine?: ProjectWorkspaceAction;
+  createMachineVersion?: ProjectWorkspaceAction;
+  restoreMachineVersion?: ProjectWorkspaceAction;
+  renameMachine?: ProjectWorkspaceAction;
+  copyMachine?: ProjectWorkspaceAction;
+  deleteMachine?: ProjectWorkspaceAction;
+  setRootMachine?: ProjectWorkspaceAction;
+}
+interface ProjectWorkspaceConfigBase {
+  defaultProjectId?: string;
+  /** Optional navigation action shown above the workspace. Set to null to hide it. */
+  backAction?: ProjectWorkspaceAction | null;
+  userAvatarUrl?: string;
+  machineSelectionDisabled?: boolean;
+  /** Optional host-backed operations for the built-in workspace controls. */
+  workspaceCapabilities?: ProjectWorkspaceCapabilities;
+  /** Actions rendered from the workspace options menu. */
+  workspaceActions?: ProjectWorkspaceAction[];
+  /** Optional actions keyed by project or machine id. */
+  projectActions?: Record<string, ProjectWorkspaceAction[]>;
+  machineActions?: Record<string, ProjectWorkspaceAction[]>;
+}
+/** Serializable workspace tree rendered by project-mode embeds. */
+type ProjectWorkspaceConfig = (ProjectWorkspaceConfigBase & {
+  /** Single-project mode: hides project CRUD for this project. */project: ProjectWorkspaceProject;
+  projects?: never;
+}) | (ProjectWorkspaceConfigBase & {
+  /** Multi-project mode: renders a collapsible project tree. */projects: ProjectWorkspaceProject[];
+  project?: never;
+});
+declare const EMBED_DOCUMENT_LANGUAGES: readonly ["markdown", "typescript", "javascript", "json", "xml", "mermaid", "text"];
+type EmbedDocumentLanguage = (typeof EMBED_DOCUMENT_LANGUAGES)[number];
+declare const EMBED_DOCUMENT_LIMITS: {
+  readonly maxDocuments: 100;
+  readonly maxDocumentLength: number;
+  readonly maxTotalLength: number;
+};
+/** Read-only text supplied by an embed host for display beside a machine. */
+interface EmbedDocument {
+  /** Relative POSIX path used as the document's stable identity. */
+  path: string;
+  content: string;
+  /** Overrides renderer detection from the path's file extension. */
+  language?: EmbedDocumentLanguage;
+}
+interface ValidationIssue {
+  nodeIds: string[];
+  edgeIds: string[];
+  level: 'info' | 'warning' | 'error';
+  message: string;
+}
+type EditorCapabilities = EditorCapabilities$1;
+type ReadOnlyReason = 'free-plan' | 'access-unverified';
+type CapabilityDeniedCapability = 'edit' | 'export' | 'ai' | 'simulate' | 'inspect' | 'panel' | 'mode';
+interface CapabilityDeniedEvent {
+  capability: CapabilityDeniedCapability;
+  action: 'openPanel' | 'openDialog' | 'editSource' | 'setMode' | 'simulationStart' | 'inspectStart' | 'retrieve';
+  requested?: string;
+  message: string;
+  dedupeKey: string;
+}
+type SourceRange = EditorSyncSourceRange;
+type SourceLocation = EditorSyncSourceLocation;
+type StateSourceLocation = EditorSyncStateSourceLocation;
+type MachineSourceLocations = MachineSourceLocations$1;
+interface ExportFormatMap {
+  xstate: {
+    options: {
+      version?: 4 | 5;
+      addTSTypes?: boolean;
+      showIds?: boolean;
+      showDescriptions?: boolean;
+    };
+    result: string;
+  };
+  async: {
+    options: object;
+    result: string;
+  };
+  'xstate-json': {
+    options: {
+      version?: 4 | 5;
+    };
+    result: Record<string, unknown>;
+  };
+  xgraph: {
+    options: object;
+    result: Record<string, unknown>;
+  };
+  digraph: {
+    options: object;
+    result: Record<string, unknown>;
+  };
+  d2: {
+    options: {
+      includeLayout?: boolean;
+    };
+    result: string;
+  };
+  mermaid: {
+    options: object;
+    result: string;
+  };
+  redux: {
+    options: object;
+    result: string;
+  };
+  zustand: {
+    options: object;
+    result: string;
+  };
+  'asl-json': {
+    options: object;
+    result: string;
+  };
+  'asl-yaml': {
+    options: object;
+    result: string;
+  };
+  scxml: {
+    options: object;
+    result: string;
+  };
+}
+type ExportFormat = keyof ExportFormatMap;
+type ExportCallOptions<F extends ExportFormat> = ExportFormatMap[F]['options'] & {
+  timeout?: number;
+};
+interface EmbedEventMap {
+  ready: {
+    version: string;
+  };
+  loaded: {
+    graph: StatelyGraph;
+    machineId?: string;
+    sourceLocations?: MachineSourceLocations;
+  };
+  change: {
+    graph: StatelyGraph;
+    machineConfig: unknown;
+    machineId?: string;
+    patches?: unknown[];
+    sourceLocations?: MachineSourceLocations;
+  };
+  save: {
+    requestId?: string;
+    graph: StatelyGraph;
+    machineConfig: unknown;
+    machineId?: string;
+    patches?: unknown[];
+    validations?: ValidationIssue[];
+    sourceLocations?: MachineSourceLocations;
+    sourceUpdateStrategy?: 'preserve' | 'rewrite';
+  };
+  versionSaveRequested: {
+    graph: StatelyGraph;
+    machineConfig: unknown;
+    machineId?: string;
+    patches?: unknown[];
+    createdBy: NonNullable<MachineVersionAutoSaveOptions['createdBy']>;
+    captureType: string;
+    sourceLocations?: MachineSourceLocations;
+  };
+  error: {
+    code: ErrorCode;
+    message: string;
+    machineId?: string;
+    details?: string[];
+  };
+  capabilityDenied: CapabilityDeniedEvent;
+  snapshot: {
+    snapshot: unknown;
+    event: unknown | null;
+  };
+  machineSelected: {
+    machineId: string;
+  };
+  projectWorkspaceAction: {
+    actionId: string;
+    projectId?: string;
+    machineId?: string;
+    data?: unknown;
+  };
+  projectWorkspaceOpenChanged: {
+    open: boolean;
+  };
+  viewModeChanged: {
+    viewMode: 'graph' | 'list';
+    machineId?: string;
+  };
+  panelChanged: {
+    side: 'left' | 'right' | 'bottom';
+    id: string | null;
+    activePanels: string[];
+    machineId?: string;
+  };
+  modeChanged: {
+    mode: EmbedMode;
+    machineId?: string;
+  };
+}
+type EmbedEventName = keyof EmbedEventMap;
+type EmbedEventHandler<K extends EmbedEventName> = (data: EmbedEventMap[K]) => void;
+interface EmbedFormatManifest {
+  id: string;
+  name: string;
+  file?: {
+    extension?: string;
+    mediaType?: string;
+  };
+  editorLanguage?: string;
+  detect?: boolean;
+  import?: boolean;
+  export?: boolean;
+}
+interface EmbedExtensionsManifest {
+  profiles: ProfileManifest[];
+  formats: EmbedFormatManifest[];
+  defaultProfile?: string;
+  defaultFormat?: string;
+}
+/** Host-provided examples shown in the editor's Get started launchpad. */
+interface EmbedExample {
+  id: string;
+  title: string;
+  description: string;
+  category: string;
+  machine: unknown;
+}
+/** Check whether an example machine has a shape supported by the editor. */
+declare function isEmbedExampleMachine(value: unknown): value is Record<string, unknown>;
+/** Check whether an unknown value is a valid serialized embed example. */
+declare function isEmbedExample(value: unknown): value is EmbedExample;
+/** Reject malformed host-provided examples before creating an init message. */
+declare function assertEmbedExamples(examples: readonly EmbedExample[] | undefined): void;
+interface MachineInitOptions {
+  machine: unknown;
+  /** Ephemeral, read-only reference documents owned by the embed host. */
+  documents?: EmbedDocument[];
+  format?: string;
+  extensions?: EmbedExtensionsManifest;
+  mode?: EmbedMode;
+  theme?: 'light' | 'dark';
+  readOnly?: boolean;
+  readOnlyReason?: ReadOnlyReason;
+  depth?: number;
+  capabilities?: EditorCapabilities;
+  examples?: readonly EmbedExample[];
+  panels?: EmbedPanelConfig[];
+  comments?: CommentsConfig;
+  sourceLocations?: MachineSourceLocations;
+  settings?: Record<string, unknown>;
+  /**
+   * Show a persistent "Save to apply" pill in the embed whenever Viz has
+   * local edits that have not yet been saved. Intended for contexts like
+   * editor extensions where Viz edits don't reach the source until the user
+   * saves.
+   *
+   * - `enabled` — whether to show the pill at all. Defaults to `false`.
+   * - `mode` — `'structural'` (default) only triggers on graph-structural
+   *   changes (state/transition/action/invoke/schema edits). Pure visual
+   *   changes like drag-to-position, color, and layout are ignored.
+   *   `'all'` triggers on any graph change.
+   */
+  unsavedIndicator?: {
+    enabled?: boolean;
+    mode?: 'structural' | 'all';
+  };
+  /** Omit to disable automatic version requests. */
+  versionAutoSave?: MachineVersionAutoSaveOptions;
+}
+interface ProjectInitOptions {
+  machines: ProjectEmbedMachine[];
+  /** Ephemeral, read-only reference documents shared across the project. */
+  documents?: EmbedDocument[];
+  currentMachineId?: string;
+  mode?: EmbedMode;
+  theme?: 'light' | 'dark';
+  readOnly?: boolean;
+  readOnlyReason?: ReadOnlyReason;
+  depth?: number;
+  capabilities?: EditorCapabilities;
+  examples?: readonly EmbedExample[];
+  panels?: EmbedPanelConfig[];
+  commentsByMachineId?: Record<string, CommentsConfig>;
+  projectWorkspace?: ProjectWorkspaceConfig;
+  projectWorkspaceOpen?: boolean;
+  settings?: Record<string, unknown>;
+  unsavedIndicator?: {
+    enabled?: boolean;
+    mode?: 'structural' | 'all';
+  };
+  /** Omit to disable automatic version requests. */
+  versionAutoSave?: MachineVersionAutoSaveOptions;
+}
+type InitOptions = MachineInitOptions | ProjectInitOptions;
+interface InitMessage {
+  type: '@statelyai.init';
+  machine: unknown;
+  documents?: EmbedDocument[];
+  format?: string;
+  extensions?: EmbedExtensionsManifest;
+  mode?: EmbedMode;
+  theme?: 'light' | 'dark';
+  readOnly?: boolean;
+  readOnlyReason?: ReadOnlyReason;
+  depth?: number;
+  capabilities?: EditorCapabilities;
+  examples?: readonly EmbedExample[];
+  panels?: EmbedPanelConfig[];
+  /** @deprecated Use `panels`. */
+  leftPanels?: string[];
+  /** @deprecated Use `panels`. */
+  rightPanels?: string[];
+  /** @deprecated Use `panels[].initiallyOpen`. */
+  activePanels?: string[];
+  comments?: CommentsConfig;
+  sourceLocations?: MachineSourceLocations;
+  settings?: Record<string, unknown>;
+  /** Mirror of `InitOptions.unsavedIndicator`. */
+  unsavedIndicator?: {
+    enabled?: boolean;
+    mode?: 'structural' | 'all';
+  };
+  versionAutoSave?: MachineVersionAutoSaveOptions;
+}
+interface SetApiKeyMessage {
+  type: '@statelyai.setApiKey';
+  apiKey: string;
+}
+interface SavedMessage {
+  type: '@statelyai.saved';
+  requestId?: string;
+  graph: unknown;
+}
+interface ClipboardReadResponseMessage {
+  type: '@statelyai.clipboardReadResponse';
+  requestId: string;
+  text: string;
+}
+interface ClipboardWriteResponseMessage {
+  type: '@statelyai.clipboardWriteResponse';
+  requestId: string;
+  ok: boolean;
+}
+interface ClipboardReadMessage {
+  type: '@statelyai.clipboardRead';
+  requestId: string;
+}
+interface ClipboardWriteMessage {
+  type: '@statelyai.clipboardWrite';
+  requestId: string;
+  text: string;
+}
+interface ProjectInitMessage {
+  type: '@statelyai.project.init';
+  machines: ProjectEmbedMachine[];
+  documents?: EmbedDocument[];
+  currentMachineId?: string;
+  mode?: EmbedMode;
+  theme?: 'light' | 'dark';
+  readOnly?: boolean;
+  readOnlyReason?: ReadOnlyReason;
+  depth?: number;
+  capabilities?: EditorCapabilities;
+  examples?: readonly EmbedExample[];
+  panels?: EmbedPanelConfig[];
+  /** @deprecated Use `panels`. */
+  leftPanels?: string[];
+  /** @deprecated Use `panels`. */
+  rightPanels?: string[];
+  /** @deprecated Use `panels[].initiallyOpen`. */
+  activePanels?: string[];
+  commentsByMachineId?: Record<string, CommentsConfig>;
+  projectWorkspace?: ProjectWorkspaceConfig;
+  projectWorkspaceOpen?: boolean;
+  settings?: Record<string, unknown>;
+  unsavedIndicator?: {
+    enabled?: boolean;
+    mode?: 'structural' | 'all';
+  };
+  versionAutoSave?: MachineVersionAutoSaveOptions;
+  sessionId?: string;
+}
+interface ProjectUpdateMessage {
+  type: '@statelyai.project.update';
+  machines: ProjectEmbedMachine[];
+  currentMachineId?: string;
+  commentsByMachineId?: Record<string, CommentsConfig>;
+  projectWorkspace?: ProjectWorkspaceConfig;
+  projectWorkspaceOpen?: boolean;
+}
+interface ProjectSelectMachineMessage {
+  type: '@statelyai.project.selectMachine';
+  machineId: string;
+}
+interface ProjectSetWorkspaceOpenMessage {
+  type: '@statelyai.project.setWorkspaceOpen';
+  open: boolean;
+}
+interface UpdateMessage {
+  type: '@statelyai.update';
+  machine: unknown;
+  format?: string;
+  sourceLocations?: MachineSourceLocations;
+}
+interface SetModeMessage {
+  type: '@statelyai.setMode';
+  mode: EmbedMode;
+}
+interface SetThemeMessage {
+  type: '@statelyai.setTheme';
+  theme: 'light' | 'dark';
+}
+interface SetSettingsMessage {
+  type: '@statelyai.setSettings';
+  settings: Record<string, unknown>;
+}
+interface RetrieveMessage {
+  type: '@statelyai.retrieve';
+  requestId: string;
+  format: ExportFormat;
+  options?: Record<string, unknown>;
+}
+interface ToastMessage {
+  type: '@statelyai.toast';
+  message: string;
+  toastType?: 'success' | 'error' | 'info' | 'warning';
+}
+interface InspectSnapshotMessage {
+  type: '@statelyai.inspectSnapshot';
+  snapshot: unknown;
+  event: unknown | null;
+  /** Producer-local actor session id, when this snapshot belongs to an actor. */
+  sessionId?: string;
+}
+interface ActorSystemEntry {
+  /** XState process-local `actor.sessionId`; pair with relay `producerId`. */
+  sessionId: string;
+  /** System-local xstate `actor.id`. */
+  actorId: string;
+  /** Optional readable label; never replaces the runtime actor ID. */
+  displayName?: string;
+  /** Parent actor's sessionId, or `null` for the root. */
+  parentSessionId: string | null;
+  /** Machine configuration used to render the state chart. */
+  machine: unknown;
+  /** Optional current snapshot (`{value, status, ...}`). */
+  snapshot?: unknown;
+  /** Whether this actor stopped before this checkpoint was sent. */
+  stopped?: boolean;
+}
+/** JSON-safe record of an action executed during an inspected transition. */
+interface InspectionAction {
+  type: string;
+  params?: unknown;
+}
+/** JSON-safe identity of a state transition taken during a macrostep. */
+interface InspectionTakenTransition {
+  sourceStateId: string | null;
+  targetStateIds: string[];
+  eventType?: string;
+  reenter?: boolean;
+}
+/** JSON-safe record of an event sent or scheduled during a transition. */
+interface InspectionSentEvent {
+  targetSessionId?: string;
+  targetId: string;
+  event: unknown;
+  delay?: number;
+  id?: string;
+}
+interface SystemInitMessage {
+  type: '@statelyai.system.init';
+  protocolVersion: number;
+  /** All known actors at the moment the system is first streamed. */
+  actors: ActorSystemEntry[];
+  /** Actor session id the viz should focus first. Defaults to the root. */
+  selectedSessionId?: string;
+  documents?: EmbedDocument[];
+  mode?: EmbedMode;
+  theme?: 'light' | 'dark';
+  readOnly?: boolean;
+  depth?: number;
+  capabilities?: EditorCapabilities;
+  panels?: EmbedPanelConfig[];
+  /** @deprecated Use `panels`. */
+  leftPanels?: string[];
+  /** @deprecated Use `panels`. */
+  rightPanels?: string[];
+  /** @deprecated Use `panels[].initiallyOpen`. */
+  activePanels?: string[];
+  comments?: CommentsConfig;
+}
+/** Change the focused actor without re-initializing the system. */
+interface SystemSelectActorMessage {
+  type: '@statelyai.system.selectActor';
+  sessionId: string;
+}
+/** A new actor joined the system after init. */
+interface SystemActorRegisteredMessage {
+  type: '@statelyai.system.actorRegistered';
+  sessionId: string;
+  actorId: string;
+  /** Optional readable label; never replaces the runtime actor ID. */
+  displayName?: string;
+  parentSessionId: string | null;
+  machine: unknown;
+  snapshot?: unknown;
+}
+/** An event was observed targeting an actor, before processing completed. */
+interface SystemActorEventMessage {
+  type: '@statelyai.system.actorEvent';
+  sessionId: string;
+  event: unknown;
+  /** Global session id of the actor that sent the event, if known. */
+  sourceSessionId?: string | null;
+}
+/** An actor's snapshot updated. */
+interface SystemActorSnapshotMessage {
+  type: '@statelyai.system.actorSnapshot';
+  sessionId: string;
+  /** Snapshot before the event was processed. */
+  previousSnapshot?: unknown | null;
+  snapshot: unknown;
+  event?: unknown | null;
+  /** Global session id of the actor that sent the triggering event, if known. */
+  sourceSessionId?: string | null;
+  /** Actions executed while processing the event. */
+  actions?: InspectionAction[];
+  /** State transitions taken across every microstep. */
+  transitions?: InspectionTakenTransition[];
+  /** Events sent or scheduled while processing the event. */
+  sent?: InspectionSentEvent[];
+}
+/** An actor reached a final state / was stopped. */
+interface SystemActorStoppedMessage {
+  type: '@statelyai.system.actorStopped';
+  sessionId: string;
+}
+interface ReadyMessage {
+  type: '@statelyai.ready';
+  version: string;
+  protocolVersion?: number;
+}
+interface EditorHandshakeMessage {
+  type: '@statelyai.handshake';
+  protocolVersion: number;
+  client?: {
+    name: string;
+    version: string;
+  };
+}
+interface LoadedMessage {
+  type: '@statelyai.loaded';
+  graph: StatelyGraph;
+  machineId?: string;
+  sourceLocations?: MachineSourceLocations;
+}
+interface ChangeMessage {
+  type: '@statelyai.change';
+  graph: StatelyGraph;
+  machineConfig: unknown;
+  machineId?: string;
+  patches?: unknown[];
+  sourceLocations?: MachineSourceLocations;
+}
+interface SaveMessage {
+  type: '@statelyai.save';
+  requestId?: string;
+  graph: StatelyGraph;
+  machineConfig: unknown;
+  machineId?: string;
+  patches?: unknown[];
+  validations?: ValidationIssue[];
+  sourceLocations?: MachineSourceLocations;
+  sourceUpdateStrategy?: 'preserve' | 'rewrite';
+}
+interface VersionSaveRequestedMessage {
+  type: '@statelyai.versionSaveRequested';
+  graph: StatelyGraph;
+  machineConfig: unknown;
+  machineId?: string;
+  patches?: unknown[];
+  createdBy: NonNullable<MachineVersionAutoSaveOptions['createdBy']>;
+  captureType: string;
+  sourceLocations?: MachineSourceLocations;
+}
+interface ProjectMachineSelectedMessage {
+  type: '@statelyai.project.machineSelected';
+  machineId: string;
+}
+interface ProjectWorkspaceActionMessage {
+  type: '@statelyai.project.workspaceAction';
+  actionId: string;
+  projectId?: string;
+  machineId?: string;
+  data?: unknown;
+}
+interface ProjectWorkspaceOpenChangedMessage {
+  type: '@statelyai.project.workspaceOpenChanged';
+  open: boolean;
+}
+interface ViewModeChangedMessage {
+  type: '@statelyai.viewModeChanged';
+  viewMode: 'graph' | 'list';
+  machineId?: string;
+}
+interface PanelChangedMessage {
+  type: '@statelyai.panelChanged';
+  side: 'left' | 'right' | 'bottom';
+  id: string | null;
+  activePanels: string[];
+  machineId?: string;
+}
+interface ModeChangedMessage {
+  type: '@statelyai.modeChanged';
+  mode: EmbedMode;
+  machineId?: string;
+}
+interface RetrievedMessage {
+  type: '@statelyai.retrieved';
+  requestId: string;
+  data: unknown;
+}
+/**
+ * Error codes the editor emits. Open-ended (`string`) so an older SDK keeps
+ * forwarding codes a newer editor adds.
+ *
+ * - `unsupported_protocol` — editor/SDK protocol versions disagree.
+ * - `conversion_failed` — a machine source could not be converted to a graph.
+ * - `invalid_graph` — a host-supplied graph is structurally invalid; see `details`.
+ * - `render_failed` — the editor threw while rendering a machine.
+ */
+type ErrorCode = 'unsupported_protocol' | 'conversion_failed' | 'invalid_graph' | 'render_failed' | (string & {});
+interface ErrorMessage {
+  type: '@statelyai.error';
+  code: ErrorCode;
+  message: string;
+  /** Machine the error belongs to, when the editor knows which one failed. */
+  machineId?: string;
+  /** Per-problem explanations, e.g. one line per structural graph error. */
+  details?: string[];
+  requestId?: string;
+}
+interface CapabilityDeniedMessage extends CapabilityDeniedEvent {
+  type: '@statelyai.capabilityDenied';
+}
+/** File metadata sent from viz to SDK when a file needs uploading. */
+interface UploadFileInfo {
+  /** Original filename (e.g. "screenshot.png") */
+  name: string;
+  /** MIME type (e.g. "image/png") */
+  mimeType: string;
+  /** File size in bytes */
+  size: number;
+  /** File content as base64-encoded string */
+  data: string;
+}
+/** The result the consumer returns after uploading. */
+interface UploadResult {
+  /** The publicly accessible URL of the uploaded file */
+  url: string;
+  /** Optional display name (defaults to original filename) */
+  name?: string;
+  /** Optional metadata stored on the asset */
+  metadata?: Record<string, unknown>;
+}
+/** Viz requests the parent to upload a file. */
+interface UploadRequestMessage {
+  type: '@statelyai.uploadRequest';
+  requestId: string;
+  file: UploadFileInfo;
+  stateNodeId: string;
+}
+/** Parent tells the viz the upload capabilities on init. */
+interface UploadCapabilitiesMessage {
+  type: '@statelyai.uploadCapabilities';
+  enabled: boolean;
+  accept?: string[];
+  maxFileSize?: number;
+}
+/** Parent sends the upload result back to the viz. */
+interface UploadResponseMessage {
+  type: '@statelyai.uploadResponse';
+  requestId: string;
+  result: UploadResult;
+}
+interface ExtensionCallMessage {
+  type: '@statelyai.extension.call';
+  requestId: string;
+  extensionId: string;
+  method: 'detect' | 'import' | 'export' | 'validate';
+  payload: unknown;
+}
+interface ExtensionResultMessage {
+  type: '@statelyai.extension.result';
+  requestId: string;
+  result?: unknown;
+  error?: string;
+}
+/** All messages a client (embed/inspector) can send to the viz. */
+type ClientMessage = InitMessage | SetApiKeyMessage | EditorHandshakeMessage | SavedMessage | ClipboardReadResponseMessage | ClipboardWriteResponseMessage | ProjectInitMessage | ProjectUpdateMessage | ProjectSelectMachineMessage | ProjectSetWorkspaceOpenMessage | UpdateMessage | SetModeMessage | SetThemeMessage | SetSettingsMessage | RetrieveMessage | ToastMessage | InspectSnapshotMessage | SystemInitMessage | SystemSelectActorMessage | SystemActorRegisteredMessage | SystemActorEventMessage | SystemActorSnapshotMessage | SystemActorStoppedMessage | UploadCapabilitiesMessage | UploadResponseMessage | ExtensionResultMessage | ErrorMessage;
+/** All messages the viz can send back to a client. */
+type VizMessage = ReadyMessage | LoadedMessage | ChangeMessage | SaveMessage | VersionSaveRequestedMessage | ProjectMachineSelectedMessage | ProjectWorkspaceActionMessage | ProjectWorkspaceOpenChangedMessage | ViewModeChangedMessage | PanelChangedMessage | ModeChangedMessage | RetrievedMessage | ErrorMessage | CapabilityDeniedMessage | ClipboardReadMessage | ClipboardWriteMessage | UploadRequestMessage | ExtensionCallMessage;
+interface InspectionClientMetadata {
+  name?: string;
+  machineId?: string;
+  sdkVersion?: string;
+  runtime?: 'browser' | 'node' | 'unknown';
+}
+interface RegisterMessage {
+  type: '@statelyai.register';
+  protocolVersion: number;
+  role: 'producer' | 'viewer';
+  producerId?: string;
+  metadata?: InspectionClientMetadata;
+}
+interface RegisteredMessage {
+  type: '@statelyai.registered';
+  protocolVersion: number;
+  producerId?: string;
+}
+/** All registration messages for the WebSocket relay. */
+type SessionMessage = RegisterMessage | RegisteredMessage;
+/** Any valid protocol message. Relays add/consume `producerId` as an envelope. */
+type ProtocolMessage = (ClientMessage | VizMessage | SessionMessage) & {
+  producerId?: string;
+};
+declare const PREFIX = "@statelyai.";
+/** Current WebSocket inspection protocol version. */
+declare const INSPECTION_PROTOCOL_VERSION = 2;
+//#endregion
+export { ProjectSelectMachineMessage as $, ExtensionCallMessage as A, SystemActorSnapshotMessage as At, InspectionSentEvent as B, UploadResult as Bt, EmbedFormatManifest as C, SetSettingsMessage as Ct, ExportCallOptions as D, StateSourceLocation as Dt, ErrorMessage as E, SourceRange as Et, InitOptions as F, UpdateMessage as Ft, MachineVersionAutoSaveOptions as G, assertEmbedExamples as Gt, LoadedMessage as H, VersionSaveRequestedMessage as Ht, InspectSnapshotMessage as I, UploadCapabilitiesMessage as It, PanelChangedMessage as J, getInspectionRoomId as Jt, ModeChangedMessage as K, createInspectionActorId as Kt, InspectionAction as L, UploadFileInfo as Lt, INSPECTION_PROTOCOL_VERSION as M, SystemInitMessage as Mt, INSPECTION_ROOM_QUERY_PARAM as N, SystemSelectActorMessage as Nt, ExportFormat as O, SystemActorEventMessage as Ot, InitMessage as P, ToastMessage as Pt, ProjectMachineSelectedMessage as Q, EmbedPanelPosition as Qt, InspectionClientMetadata as R, UploadRequestMessage as Rt, EmbedExtensionsManifest as S, SetModeMessage as St, ErrorCode as T, SourceLocation as Tt, MachineInitOptions as U, ViewModeChangedMessage as Ut, InspectionTakenTransition as V, ValidationIssue as Vt, MachineSourceLocations as W, VizMessage as Wt, ProjectInitMessage as X, isEmbedExampleMachine as Xt, ProjectEmbedMachine as Y, isEmbedExample as Yt, ProjectInitOptions as Z, EmbedPanelConfig as Zt, EmbedDocumentLanguage as _, RetrievedMessage as _t, ChangeMessage as a, ProjectWorkspaceCapabilities as at, EmbedEventName as b, SessionMessage as bt, ClipboardReadResponseMessage as c, ProjectWorkspaceMachineOrigin as ct, CommentsConfig as d, ProtocolMessage as dt, ProjectSetWorkspaceOpenMessage as et, EMBED_DOCUMENT_LANGUAGES as f, ReadOnlyReason as ft, EmbedDocument as g, RetrieveMessage as gt, EditorHandshakeMessage as h, RegisteredMessage as ht, CapabilityDeniedMessage as i, ProjectWorkspaceActionMessage as it, ExtensionResultMessage as j, SystemActorStoppedMessage as jt, ExportFormatMap as k, SystemActorRegisteredMessage as kt, ClipboardWriteMessage as l, ProjectWorkspaceOpenChangedMessage as lt, EditorCapabilities as m, RegisterMessage as mt, CapabilityDeniedCapability as n, ProjectWorkspaceAction as nt, ClientMessage as o, ProjectWorkspaceConfig as ot, EMBED_DOCUMENT_LIMITS as p, ReadyMessage as pt, PREFIX as q, createInspectionRoomUrls as qt, CapabilityDeniedEvent as r, ProjectWorkspaceActionIcon as rt, ClipboardReadMessage as s, ProjectWorkspaceMachine as st, ActorSystemEntry as t, ProjectUpdateMessage as tt, ClipboardWriteResponseMessage as u, ProjectWorkspaceProject as ut, EmbedEventHandler as v, SaveMessage as vt, EmbedMode as w, SetThemeMessage as wt, EmbedExample as x, SetApiKeyMessage as xt, EmbedEventMap as y, SavedMessage as yt, InspectionRoomUrls as z, UploadResponseMessage as zt };