A reactive notebook for Python — run reproducible experiments, query with SQL, execute as a script, deploy as an app, and version with git. Stored as pure Python. All in a modern, AI-native editor.
Python artificial-intelligencedagdata-sciencedata-visualizationdataflowdeveloper-toolsmachine-learningnotebookspipelinepythonreactivesqlweb-app
feat: better branded type codegen with format + transform hook (#8952)
Kiran Gadhave7632d8416b70
diff --git a/frontend/src/__tests__/branded.ts b/frontend/src/__tests__/branded.tsindex 566447aefb..c5e4c49d7c 100644--- a/frontend/src/__tests__/branded.ts+++ b/frontend/src/__tests__/branded.ts@@ -10,11 +10,17 @@* everywhere.*/+import type { components } from "@marimo-team/marimo-api";import type { CellId, UIElementId } from "@/core/cells/ids";import type { RequestId } from "@/core/network/DeferredRequestRegistry";import type { VariableName } from "@/core/variables/types";+type WidgetModelId = components["schemas"]["WidgetModelId"];+type Base64String = components["schemas"]["Base64String"];+export const cellId = (s: string) => s as CellId;export const variableName = (s: string) => s as VariableName;export const requestId = (s: string) => s as RequestId;export const uiElementId = (s: string) => s as UIElementId;+export const widgetModelId = (s: string) => s as WidgetModelId;+export const base64String = (s: string) => s as Base64String;diff --git a/frontend/src/core/cells/__tests__/apply-transaction.test.ts b/frontend/src/core/cells/__tests__/apply-transaction.test.tsindex ad9689c90f..34772d6f38 100644--- a/frontend/src/core/cells/__tests__/apply-transaction.test.ts+++ b/frontend/src/core/cells/__tests__/apply-transaction.test.ts@@ -18,6 +18,7 @@ import { python } from "@codemirror/lang-python";import { EditorState } from "@codemirror/state";import { EditorView } from "@codemirror/view";import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";+import { cellId } from "@/__tests__/branded";import type { CellHandle } from "@/components/editor/notebook-cell";import { adaptiveLanguageConfiguration } from "@/core/codemirror/language/extension";import { OverridingHotkeyProvider } from "@/core/hotkeys/hotkeys";@@ -121,7 +122,7 @@ describe("applyTransactionChanges edge cases", () => {apply([{type: "create-cell",- cellId: "new-cell",+ cellId: cellId("new-cell"),code: "configured",name: "",config: { hide_code: true, disabled: true, column: 1 },@@ -141,12 +142,12 @@ describe("applyTransactionChanges edge cases", () => {apply([{type: "create-cell",- cellId: "new-cell",+ cellId: cellId("new-cell"),code: "new",name: "",config: {},},- { type: "move-cell", cellId: "new-cell", before: a },+ { type: "move-cell", cellId: cellId("new-cell"), before: a },]);expect(pretty(state)).toMatchInlineSnapshot(`"@@ -162,12 +163,12 @@ describe("applyTransactionChanges edge cases", () => {apply([{type: "create-cell",- cellId: "new-cell",+ cellId: cellId("new-cell"),code: "initial",name: "",config: {},},- { type: "set-code", cellId: "new-cell", code: "updated" },+ { type: "set-code", cellId: cellId("new-cell"), code: "updated" },]);expect(pretty(state)).toMatchInlineSnapshot(`"@@ -182,12 +183,12 @@ describe("applyTransactionChanges edge cases", () => {apply([{type: "create-cell",- cellId: "ephemeral",+ cellId: cellId("ephemeral"),code: "tmp",name: "",config: {},},- { type: "delete-cell", cellId: "ephemeral" },+ { type: "delete-cell", cellId: cellId("ephemeral") },]);expect(pretty(state)).toMatchInlineSnapshot(`"@@ -228,7 +229,7 @@ describe("applyTransactionChanges edge cases", () => {it("move-cell with missing after anchor falls back to end", () => {setup("a", "b");const [a] = state.cellIds.inOrderIds;- apply([{ type: "move-cell", cellId: a, after: "nonexistent" as CellId }]);+ apply([{ type: "move-cell", cellId: a, after: cellId("nonexistent") }]);expect(pretty(state)).toMatchInlineSnapshot(`"1: 'b'@@ -240,7 +241,7 @@ describe("applyTransactionChanges edge cases", () => {it("move-cell with missing before anchor falls back to start", () => {setup("a", "b");const [, b] = state.cellIds.inOrderIds;- apply([{ type: "move-cell", cellId: b, before: "nonexistent" as CellId }]);+ apply([{ type: "move-cell", cellId: b, before: cellId("nonexistent") }]);expect(pretty(state)).toMatchInlineSnapshot(`"1: 'b'@@ -254,8 +255,8 @@ describe("applyTransactionChanges edge cases", () => {apply([{type: "move-cell",- cellId: "nonexistent" as CellId,- after: "0" as CellId,+ cellId: cellId("nonexistent"),+ after: cellId("0"),},]);expect(pretty(state)).toMatchInlineSnapshot(`diff --git a/frontend/src/core/cells/document-changes.ts b/frontend/src/core/cells/document-changes.tsindex 9a717ad7c6..1c623dbba9 100644--- a/frontend/src/core/cells/document-changes.ts+++ b/frontend/src/core/cells/document-changes.ts@@ -425,7 +425,7 @@ export function fromDocumentChanges(cellId,before,code: change.code,- newCellId: change.cellId as CellId,+ newCellId: change.cellId,autoFocus: false,hideCode: change.config?.hide_code ?? false,},@@ -433,14 +433,14 @@ export function fromDocumentChanges(if (change.name) {actions.push({type: "updateCellName",- payload: { cellId: change.cellId as CellId, name: change.name },+ payload: { cellId: change.cellId, name: change.name },});}if (change.config?.disabled != null || change.config?.column != null) {actions.push({type: "updateCellConfig",payload: {- cellId: change.cellId as CellId,+ cellId: change.cellId,config: {...(change.config.disabled != null && {disabled: change.config.disabled,@@ -460,7 +460,7 @@ export function fromDocumentChanges(case "delete-cell":actions.push({type: "deleteCell",- payload: { cellId: change.cellId as CellId },+ payload: { cellId: change.cellId },});break;@@ -471,7 +471,7 @@ export function fromDocumentChanges(// missing. No-ops if the cell itself doesn't exist.case "move-cell": {const ids = [...getCurrentCellIds()];- const cellId = change.cellId as CellId;+ const cellId = change.cellId;const idx = ids.indexOf(cellId);if (idx < 0) {break;@@ -507,7 +507,7 @@ export function fromDocumentChanges(case "reorder-cells":actions.push({type: "setCellIds",- payload: { cellIds: change.cellIds as CellId[] },+ payload: { cellIds: change.cellIds },});break;@@ -518,7 +518,7 @@ export function fromDocumentChanges(actions.push({type: "setCellCodes",payload: {- ids: [change.cellId as CellId],+ ids: [change.cellId],codes: [change.code],codeIsStale: true,},@@ -530,7 +530,7 @@ export function fromDocumentChanges(case "set-name":actions.push({type: "updateCellName",- payload: { cellId: change.cellId as CellId, name: change.name },+ payload: { cellId: change.cellId, name: change.name },});break;@@ -542,7 +542,7 @@ export function fromDocumentChanges(actions.push({type: "updateCellConfig",payload: {- cellId: change.cellId as CellId,+ cellId: change.cellId,config: {...(change.hideCode != null && { hide_code: change.hideCode }),...(change.disabled != null && { disabled: change.disabled }),diff --git a/frontend/src/core/islands/__tests__/bridge.test.ts b/frontend/src/core/islands/__tests__/bridge.test.tsindex 3be122bad8..76b880affe 100644--- a/frontend/src/core/islands/__tests__/bridge.test.ts+++ b/frontend/src/core/islands/__tests__/bridge.test.ts@@ -1,5 +1,15 @@/* Copyright 2026 Marimo. All rights reserved. */++import type { components } from "@marimo-team/marimo-api";import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";+import {+ cellId,+ requestId,+ uiElementId,+ widgetModelId,+} from "@/__tests__/branded";++type Base64String = components["schemas"]["Base64String"];// Mock browser APIs before any importsvi.stubGlobal(@@ -89,7 +99,7 @@ describe("IslandsPyodideBridge", () => {describe("sendComponentValues", () => {it("should include type field and token in control request", async () => {const request = {- objectIds: ["Hbol-0"],+ objectIds: [uiElementId("Hbol-0")],values: [58],};@@ -108,7 +118,7 @@ describe("IslandsPyodideBridge", () => {it("should preserve all request properties", async () => {const request = {- objectIds: ["slider-1", "slider-2"],+ objectIds: [uiElementId("slider-1"), uiElementId("slider-2")],values: [10, 20],};@@ -128,7 +138,7 @@ describe("IslandsPyodideBridge", () => {describe("sendFunctionRequest", () => {it("should include type field in control request", async () => {const request = {- functionCallId: "call-123",+ functionCallId: requestId("call-123"),namespace: "test_namespace",functionName: "my_function",args: { x: 1, y: 2 },@@ -152,7 +162,7 @@ describe("IslandsPyodideBridge", () => {describe("sendRun", () => {it("should include type field in control request", async () => {const request = {- cellIds: ["cell-1", "cell-2"],+ cellIds: [cellId("cell-1"), cellId("cell-2")],codes: ["print('hello')", "print('world')"],};@@ -170,7 +180,7 @@ describe("IslandsPyodideBridge", () => {it("should call loadPackages before putControlRequest", async () => {const request = {- cellIds: ["cell-1"],+ cellIds: [cellId("cell-1")],codes: ["import pandas"],};@@ -190,13 +200,13 @@ describe("IslandsPyodideBridge", () => {describe("sendModelValue", () => {it("should include type field in control request", async () => {const request = {- modelId: "widget-1",+ modelId: widgetModelId("widget-1"),message: {method: "update" as const,state: { value: 42 },bufferPaths: [],},- buffers: [],+ buffers: [] as Base64String[],};await bridge.sendModelValue(request);@@ -222,16 +232,16 @@ describe("IslandsPyodideBridge", () => {// Test all methods to ensure they include the type fieldawait bridge.sendComponentValues({ objectIds: [], values: [] });await bridge.sendFunctionRequest({- functionCallId: "",+ functionCallId: requestId(""),namespace: "",functionName: "",args: {},});await bridge.sendRun({ cellIds: [], codes: [] });await bridge.sendModelValue({- modelId: "",+ modelId: widgetModelId(""),message: { method: "update", state: {}, bufferPaths: [] },- buffers: [],+ buffers: [] as Base64String[],});// All calls should have the type fielddiff --git a/frontend/src/core/network/__tests__/requests-lazy.test.ts b/frontend/src/core/network/__tests__/requests-lazy.test.tsindex d4d55f6367..6ea29b2726 100644--- a/frontend/src/core/network/__tests__/requests-lazy.test.ts+++ b/frontend/src/core/network/__tests__/requests-lazy.test.ts@@ -1,6 +1,7 @@/* Copyright 2026 Marimo. All rights reserved. */import { beforeEach, describe, expect, it, vi } from "vitest";+import { cellId, requestId, uiElementId } from "@/__tests__/branded";import type { RuntimeManager } from "../../runtime/runtime";import { createLazyRequests } from "../requests-lazy";import type { EditRequests, RunRequests } from "../types";@@ -59,7 +60,7 @@ describe("createLazyRequests", () => {mockGetRuntimeManager,);- await lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] });+ await lazyRequests.sendRun({ cellIds: [cellId("cell1")], codes: ["code"] });expect(mockInit).toHaveBeenCalledTimes(1);});@@ -70,10 +71,13 @@ describe("createLazyRequests", () => {mockGetRuntimeManager,);- await lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] });- await lazyRequests.sendInstantiate({ objectIds: ["obj1"], values: [] });+ await lazyRequests.sendRun({ cellIds: [cellId("cell1")], codes: ["code"] });+ await lazyRequests.sendInstantiate({+ objectIds: [uiElementId("obj1")],+ values: [],+ });await lazyRequests.sendFunctionRequest({- functionCallId: "func1",+ functionCallId: requestId("func1"),functionName: "testFunc",args: {},namespace: "test",@@ -89,7 +93,7 @@ describe("createLazyRequests", () => {mockGetRuntimeManager,);- await lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] });+ await lazyRequests.sendRun({ cellIds: [cellId("cell1")], codes: ["code"] });expect(waitForConnectionOpen).toHaveBeenCalled();});@@ -100,7 +104,7 @@ describe("createLazyRequests", () => {mockGetRuntimeManager,);- const args = { cellIds: ["cell1"], codes: ["code"] };+ const args = { cellIds: [cellId("cell1")], codes: ["code"] };await lazyRequests.sendRun(args);expect(mockDelegate.sendRun).toHaveBeenCalledWith(args);@@ -113,7 +117,7 @@ describe("createLazyRequests", () => {);const result = await lazyRequests.sendFunctionRequest({- functionCallId: "func1",+ functionCallId: requestId("func1"),functionName: "testFunc",args: {},namespace: "test",@@ -143,7 +147,7 @@ describe("createLazyRequests", () => {);await expect(- lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] }),+ lazyRequests.sendRun({ cellIds: [cellId("cell1")], codes: ["code"] }),).rejects.toThrow("Init failed");});@@ -157,7 +161,7 @@ describe("createLazyRequests", () => {);await expect(- lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] }),+ lazyRequests.sendRun({ cellIds: [cellId("cell1")], codes: ["code"] }),).rejects.toThrow("Request failed");});@@ -169,7 +173,10 @@ describe("createLazyRequests", () => {);// First request with first runtime manager- await lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] });+ await lazyRequests.sendRun({+ cellIds: [cellId("cell1")],+ codes: ["code"],+ });expect(mockInit).toHaveBeenCalledTimes(1);// Create a new runtime manager@@ -187,7 +194,10 @@ describe("createLazyRequests", () => {);// Second request with second runtime manager- await lazyRequests2.sendRun({ cellIds: ["cell2"], codes: ["code2"] });+ await lazyRequests2.sendRun({+ cellIds: [cellId("cell2")],+ codes: ["code2"],+ });// Both inits should have been calledexpect(mockInit).toHaveBeenCalledTimes(1);@@ -201,9 +211,15 @@ describe("createLazyRequests", () => {);// Multiple requests- await lazyRequests.sendRun({ cellIds: ["cell1"], codes: ["code"] });- await lazyRequests.sendDeleteCell({ cellId: "cell2" });- await lazyRequests.sendInstantiate({ objectIds: ["obj1"], values: [] });+ await lazyRequests.sendRun({+ cellIds: [cellId("cell1")],+ codes: ["code"],+ });+ await lazyRequests.sendDeleteCell({ cellId: cellId("cell2") });+ await lazyRequests.sendInstantiate({+ objectIds: [uiElementId("obj1")],+ values: [],+ });// Init should only be called onceexpect(mockInit).toHaveBeenCalledTimes(1);diff --git a/frontend/src/core/websocket/useMarimoKernelConnection.tsx b/frontend/src/core/websocket/useMarimoKernelConnection.tsxindex 6c6151ae46..89c261a705 100644--- a/frontend/src/core/websocket/useMarimoKernelConnection.tsx+++ b/frontend/src/core/websocket/useMarimoKernelConnection.tsx@@ -186,7 +186,7 @@ export function useMarimoKernelConnection(opts: {return;case "completion-result":- AUTOCOMPLETER.resolve(msg.data.completion_id as RequestId, msg.data);+ AUTOCOMPLETER.resolve(msg.data.completion_id, msg.data);return;case "function-call-result":FUNCTIONS_REGISTRY.resolve(msg.data.function_call_id, msg.data);@@ -207,20 +207,14 @@ export function useMarimoKernelConnection(opts: {case "variables":setVariables(msg.data.variables.map((v) => ({- name: v.name as VariableName,+ name: v.name,declaredBy: v.declared_by,usedBy: v.used_by,})),);- filterDatasetsFromVariables(- msg.data.variables.map((v) => v.name as VariableName),- );- filterDataSourcesFromVariables(- msg.data.variables.map((v) => v.name as VariableName),- );- filterStorageFromVariables(- msg.data.variables.map((v) => v.name as VariableName),- );+ filterDatasetsFromVariables(msg.data.variables.map((v) => v.name));+ filterDataSourcesFromVariables(msg.data.variables.map((v) => v.name));+ filterStorageFromVariables(msg.data.variables.map((v) => v.name));return;case "variable-values":setMetadata(diff --git a/frontend/src/utils/time.ts b/frontend/src/utils/time.tsindex 2f23c23765..589e91d551 100644--- a/frontend/src/utils/time.ts+++ b/frontend/src/utils/time.ts@@ -1,8 +1,10 @@/* Copyright 2026 Marimo. All rights reserved. */-export type Milliseconds = number & { __type__: "milliseconds" };+import type { TypedNumber } from "./typed";-export type Seconds = number & { __type__: "seconds" };+export type Milliseconds = TypedNumber<"milliseconds">;++export type Seconds = TypedNumber<"seconds">;export class Time {private readonly ms: Milliseconds;diff --git a/frontend/src/utils/typed.ts b/frontend/src/utils/typed.tsindex fbacaa1b38..32f1892105 100644--- a/frontend/src/utils/typed.ts+++ b/frontend/src/utils/typed.ts@@ -5,13 +5,13 @@* This is a compile-time type only and does not exist at runtime.* It is used to distinguish between different types of numbers.*/-export type TypedNumber<T> = number & { __type__: T };+export type TypedNumber<T> = number & { __brand: T };/*** A typed string.* This is a compile-time type only and does not exist at runtime.* It is used to distinguish between different types of strings.*/-export type TypedString<T> = string & { __type__: T };+export type TypedString<T> = string & { __brand: T };export type Identified<T> = { id: string } & T;diff --git a/marimo/_cli/development/commands.py b/marimo/_cli/development/commands.pyindex 1d221e3b92..8e82de5100 100644--- a/marimo/_cli/development/commands.py+++ b/marimo/_cli/development/commands.py@@ -54,18 +54,21 @@ def _enrich_branded_types(WidgetModelId,)- branded: dict[Any, str] = {- CellId_t: "CellId",- UIElementId: "UIElementId",- SessionId: "SessionId",- VariableName: "VariableName",- RequestId: "RequestId",- WidgetModelId: "WidgetModelId",+ branded: dict[Any, tuple[str, str]] = {+ CellId_t: ("CellId", "cell-id"),+ UIElementId: ("UIElementId", "ui-element-id"),+ SessionId: ("SessionId", "session-id"),+ VariableName: ("VariableName", "variable-name"),+ RequestId: ("RequestId", "request-id"),+ WidgetModelId: ("WidgetModelId", "widget-model-id"),}# Step 1 — add named schemas for each branded type- for schema_name in branded.values():- component_schemas[schema_name] = {"type": "string"}+ for schema_name, format_value in branded.values():+ component_schemas[schema_name] = {+ "type": "string",+ "format": format_value,+ }def make_ref(name: str) -> dict[str, str]:return {"$ref": f"#/components/schemas/{name}"}@@ -76,7 +79,7 @@ def _enrich_branded_types(def resolve(ty: Any) -> dict[str, Any] | None:"""Produce a branded schema for *ty*, or ``None``."""if ty in branded:- return make_ref(branded[ty])+ return make_ref(branded[ty][0])origin = typing.get_origin(ty)args = typing.get_args(ty)@@ -143,7 +146,9 @@ def _enrich_branded_types(for model in models:_visit_type(model)- # Step 3 — walk collected structs and replace inline schemas with $refs+ # Step 3 — walk collected structs and replace inline schemas with $refs.+ # Use msgspec.structs.fields() to map Python names → schema keys,+ # which accounts for rename="camel" and other rename strategies.for schema_name, struct_cls in all_structs.items():schema = component_schemas.get(schema_name)if schema is None:@@ -156,17 +161,25 @@ def _enrich_branded_types(except Exception:continue+ field_to_schema_key: dict[str, str] = {}+ try:+ for fi in msgspec.structs.fields(struct_cls):+ field_to_schema_key[fi.name] = fi.encode_name+ except Exception:+ field_to_schema_key = {name: name for name in hints}+for field_name, field_type in hints.items():- if field_name not in properties:+ schema_key = field_to_schema_key.get(field_name, field_name)+ if schema_key not in properties:continuereplacement = resolve(field_type)if replacement is not None:# Preserve default value from the original schema- existing = properties[field_name]+ existing = properties[schema_key]if isinstance(existing, dict) and "default" in existing:replacement["default"] = existing["default"]- properties[field_name] = replacement+ properties[schema_key] = replacement# Step 4 — replace inline {type: string, contentEncoding: base64}# with a named $ref. msgspec already emits contentEncoding for@@ -174,6 +187,7 @@ def _enrich_branded_types(# can brand it.component_schemas["Base64String"] = {"type": "string",+ "format": "base64","contentEncoding": "base64",}diff --git a/marimo/_messaging/notification.py b/marimo/_messaging/notification.pyindex ee15f1e572..f12bb881ec 100644--- a/marimo/_messaging/notification.py+++ b/marimo/_messaging/notification.py@@ -37,7 +37,13 @@ from marimo._plugins.core.web_component import JSONTypefrom marimo._runtime.layout.layout import LayoutConfigfrom marimo._secrets.models import SecretKeysWithProviderfrom marimo._sql.parse import SqlCatalogCheckResult, SqlParseResult-from marimo._types.ids import CellId_t, RequestId, UIElementId, WidgetModelId+from marimo._types.ids import (+ CellId_t,+ RequestId,+ UIElementId,+ VariableName,+ WidgetModelId,+)from marimo._utils.msgspec_basestruct import BaseStructfrom marimo._utils.platform import is_pyodide, is_windows@@ -311,7 +317,7 @@ class CompletionResultNotification(Notification, tag="completion-result"):"""name: ClassVar[str] = "completion-result"- completion_id: str+ completion_id: RequestIdprefix_length: intoptions: list[CompletionOption]@@ -435,7 +441,7 @@ class VariableDeclarationNotification(msgspec.Struct):used_by: Cell IDs that use this variable."""- name: str+ name: VariableNamedeclared_by: list[CellId_t]used_by: list[CellId_t]diff --git a/marimo/_runtime/complete.py b/marimo/_runtime/complete.pyindex 50b1090e1f..a5d87182eb 100644--- a/marimo/_runtime/complete.py+++ b/marimo/_runtime/complete.py@@ -24,6 +24,7 @@ from marimo._output.md import _mdfrom marimo._runtime import dataflowfrom marimo._runtime.commands import CodeCompletionCommandfrom marimo._session.queue import QueueType+from marimo._types.ids import RequestIdfrom marimo._utils.docs import MarimoConverterfrom marimo._utils.format_signature import format_signaturefrom marimo._utils.rst_to_html import convert_rst_to_html@@ -334,7 +335,7 @@ def _get_completion_options(def _write_completion_result(stream: Stream,- completion_id: str,+ completion_id: RequestId,prefix_length: int,options: list[CompletionOption],) -> None:@@ -348,7 +349,7 @@ def _write_completion_result()-def _write_no_completions(stream: Stream, completion_id: str) -> None:+def _write_no_completions(stream: Stream, completion_id: RequestId) -> None:_write_completion_result(stream, completion_id, 0, [])diff --git a/marimo/_runtime/runtime.py b/marimo/_runtime/runtime.pyindex c330942a42..27b92a7d0f 100644--- a/marimo/_runtime/runtime.py+++ b/marimo/_runtime/runtime.py@@ -1349,7 +1349,7 @@ class Kernel:VariablesNotification(variables=[VariableDeclarationNotification(- name=variable,+ name=VariableName(variable),declared_by=list(declared_by),used_by=list(self.graph.get_referring_cells(diff --git a/packages/openapi/api.yaml b/packages/openapi/api.yamlindex d93d404b21..50f9f24f2a 100644--- a/packages/openapi/api.yaml+++ b/packages/openapi/api.yaml@@ -94,19 +94,43 @@ components:title: AiCompletionRequesttype: objectAiConfig:- description: "Configuration options for AI.\n\n **Keys.**\n\n - `rules`:\- \ custom rules to include in all AI completion prompts\n - `max_tokens`:\- \ the maximum number of tokens to use in AI completions\n - `mode`: the\- \ mode to use for AI completions. Can be one of: `\"ask\"` or `\"manual\"\- `\n - `inline_tooltip`: if `True`, enable inline AI tooltip suggestions\n\- \ - `models`: the models to use for AI completions\n - `open_ai`: the\- \ OpenAI config\n - `anthropic`: the Anthropic config\n - `google`:\- \ the Google AI config\n - `bedrock`: the Bedrock config\n - `azure`:\- \ the Azure config\n - `ollama`: the Ollama config\n - `github`: the\- \ GitHub config\n - `openrouter`: the OpenRouter config\n - `wandb`:\- \ the Weights & Biases config\n - `custom_providers`: a dict of custom\- \ OpenAI-compatible providers\n - `open_ai_compatible`: the OpenAI-compatible\- \ config (deprecated, use custom_providers)"+ description: 'Configuration options for AI.+++ **Keys.**+++ - `rules`: custom rules to include in all AI completion prompts++ - `max_tokens`: the maximum number of tokens to use in AI completions++ - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`++ - `inline_tooltip`: if `True`, enable inline AI tooltip suggestions++ - `models`: the models to use for AI completions++ - `open_ai`: the OpenAI config++ - `anthropic`: the Anthropic config++ - `google`: the Google AI config++ - `bedrock`: the Bedrock config++ - `azure`: the Azure config++ - `ollama`: the Ollama config++ - `github`: the GitHub config++ - `openrouter`: the OpenRouter config++ - `wandb`: the Weights & Biases config++ - `custom_providers`: a dict of custom OpenAI-compatible providers++ - `open_ai_compatible`: the OpenAI-compatible config (deprecated, use custom_providers)'properties:anthropic:$ref: '#/components/schemas/AnthropicConfig'@@ -166,12 +190,22 @@ components:title: AiInlineCompletionRequesttype: objectAiModelConfig:- description: "Configuration options for an AI model.\n\n **Keys.**\n\n \- \ - `chat_model`: the model to use for chat completions\n - `edit_model`:\- \ the model to use for edit completions\n - `autocomplete_model`: the model\- \ to use for code completion/autocomplete\n - `displayed_models`: a list\- \ of models to display in the UI\n - `custom_models`: a list of custom\- \ models to use that are not from the default list"+ description: 'Configuration options for an AI model.+++ **Keys.**+++ - `chat_model`: the model to use for chat completions++ - `edit_model`: the model to use for edit completions++ - `autocomplete_model`: the model to use for code completion/autocomplete++ - `displayed_models`: a list of models to display in the UI++ - `custom_models`: a list of custom models to use that are not from the default+ list'properties:autocomplete_model:type: string@@ -193,9 +227,9 @@ components:title: AiModelConfigtype: objectAlertNotification:- description: "User-facing alert message.\n\n Attributes:\n title:\- \ Alert title.\n description: Alert body (may contain HTML).\n \- \ variant: Visual variant (e.g., \"danger\")."+ description: "User-facing alert message.\n\nAttributes:\n title: Alert title.\n\+ \ description: Alert body (may contain HTML).\n variant: Visual variant\+ \ (e.g., \"danger\")."properties:description:type: string@@ -217,8 +251,13 @@ components:title: AlertNotificationtype: objectAnthropicConfig:- description: "Configuration options for Anthropic.\n\n **Keys.**\n\n -\- \ `api_key`: the Anthropic API key"+ description: 'Configuration options for Anthropic.+++ **Keys.**+++ - `api_key`: the Anthropic API key'properties:api_key:type: string@@ -226,10 +265,10 @@ components:title: AnthropicConfigtype: objectBannerNotification:- description: "Persistent banner message at top of notebook.\n\n Attributes:\n\- \ title: Banner title.\n description: Banner body (may contain\- \ HTML).\n variant: Visual variant (e.g., \"danger\").\n action:\- \ Optional user action (e.g., \"restart\")."+ description: "Persistent banner message at top of notebook.\n\nAttributes:\n\+ \ title: Banner title.\n description: Banner body (may contain HTML).\n\+ \ variant: Visual variant (e.g., \"danger\").\n action: Optional user\+ \ action (e.g., \"restart\")."properties:action:anyOf:@@ -258,6 +297,7 @@ components:type: objectBase64String:contentEncoding: base64+ format: base64type: stringBaseResponse:properties:@@ -281,10 +321,19 @@ components:title: BasedpyrightServerConfigtype: objectBedrockConfig:- description: "Configuration options for Bedrock.\n\n **Keys.**\n\n - `profile_name`:\- \ the AWS profile to use\n - `region_name`: the AWS region to use\n \- \ - `aws_access_key_id`: the AWS access key ID\n - `aws_secret_access_key`:\- \ the AWS secret access key"+ description: 'Configuration options for Bedrock.+++ **Keys.**+++ - `profile_name`: the AWS profile to use++ - `region_name`: the AWS region to use++ - `aws_access_key_id`: the AWS access key ID++ - `aws_secret_access_key`: the AWS secret access key'properties:aws_access_key_id:type: string@@ -298,7 +347,7 @@ components:title: BedrockConfigtype: objectCacheClearedNotification:- description: "Execution cache cleared result.\n\n Attributes:\n bytes_freed:\+ description: "Execution cache cleared result.\n\nAttributes:\n bytes_freed:\\ Bytes freed by clearing cache."properties:bytes_freed:@@ -312,10 +361,10 @@ components:title: CacheClearedNotificationtype: objectCacheInfoNotification:- description: "Execution cache statistics.\n\n Attributes:\n hits:\- \ Cache hits.\n misses: Cache misses.\n time: Time spent on\- \ cache operations (seconds).\n disk_to_free: Disk space that could\- \ be freed (bytes).\n disk_total: Total disk space used (bytes)."+ description: "Execution cache statistics.\n\nAttributes:\n hits: Cache hits.\n\+ \ misses: Cache misses.\n time: Time spent on cache operations (seconds).\n\+ \ disk_to_free: Disk space that could be freed (bytes).\n disk_total:\+ \ Total disk space used (bytes)."properties:disk_to_free:type: integer@@ -370,18 +419,19 @@ components:title: CellConfigtype: objectCellId:+ format: cell-idtype: stringCellNotification:- description: "Updates a cell's state in the frontend.\n\n Only fields that\- \ are set (not None) will update the cell state.\n Omitting a field leaves\- \ that aspect unchanged.\n\n Attributes:\n cell_id: Unique identifier\- \ of the cell being updated.\n output: Cell's output. Use CellOutput.empty()\- \ to clear.\n console: Console messages. Single/list appends, [] clears,\- \ None unchanged.\n status: Execution status (idle/running/stale/queued/disabled-transitively).\n\- \ stale_inputs: Whether cell has stale inputs from changed dependencies.\n\- \ run_id: Execution run ID for tracing. Auto-set from context.\n \- \ serialization: Serialization status (TopLevelHints).\n timestamp:\- \ Creation timestamp, auto-set."+ description: "Updates a cell's state in the frontend.\n\nOnly fields that are\+ \ set (not None) will update the cell state.\nOmitting a field leaves that\+ \ aspect unchanged.\n\nAttributes:\n cell_id: Unique identifier of the\+ \ cell being updated.\n output: Cell's output. Use CellOutput.empty() to\+ \ clear.\n console: Console messages. Single/list appends, [] clears, None\+ \ unchanged.\n status: Execution status (idle/running/stale/queued/disabled-transitively).\n\+ \ stale_inputs: Whether cell has stale inputs from changed dependencies.\n\+ \ run_id: Execution run ID for tracing. Auto-set from context.\n serialization:\+ \ Serialization status (TopLevelHints).\n timestamp: Creation timestamp,\+ \ auto-set."properties:cell_id:$ref: '#/components/schemas/CellId'@@ -597,8 +647,12 @@ components:title: ChatRequesttype: objectClearCacheCommand:- description: "Clear all cached data.\n\n Clears all cache contexts, freeing\- \ memory and disk space.\n Affects all cells using the @cache decorator."+ description: 'Clear all cached data.+++ Clears all cache contexts, freeing memory and disk space.++ Affects all cells using the @cache decorator.'properties:type:enum:@@ -613,14 +667,14 @@ components:title: ClearCacheRequesttype: objectCodeCompletionCommand:- description: "Request code completion suggestions.\n\n Sent when the user\- \ requests autocomplete. Provides code context up to\n the cursor position\- \ for the language server.\n\n Attributes:\n id: Unique identifier\- \ for this request.\n document: Source code up to the cursor position.\n\- \ cell_id: Cell where completion is requested."+ description: "Request code completion suggestions.\n\nSent when the user requests\+ \ autocomplete. Provides code context up to\nthe cursor position for the language\+ \ server.\n\nAttributes:\n id: Unique identifier for this request.\n \+ \ document: Source code up to the cursor position.\n cell_id: Cell where\+ \ completion is requested."properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'document:type: stringid:@@ -638,7 +692,7 @@ components:CodeCompletionRequest:properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'document:type: stringid:@@ -736,13 +790,27 @@ components:title: CompletedRunNotificationtype: objectCompletionConfig:- description: "Configuration for code completion.\n\n A dict with key/value\- \ pairs configuring code completion in the marimo\n editor.\n\n **Keys.**\n\- \n - `activate_on_typing`: if `False`, completion won't activate\n until\- \ the completion hotkey is entered\n - `signature_hint_on_typing`: if `False`,\- \ signature hint won't be shown when typing\n - `copilot`: one of `\"github\"\- `, `\"codeium\"`, or `\"custom\"`\n - `codeium_api_key`: the Codeium API\- \ key"+ description: 'Configuration for code completion.+++ A dict with key/value pairs configuring code completion in the marimo++ editor.+++ **Keys.**+++ - `activate_on_typing`: if `False`, completion won''t activate++ until the completion hotkey is entered++ - `signature_hint_on_typing`: if `False`, signature hint won''t be shown when+ typing++ - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`++ - `codeium_api_key`: the Codeium API key'properties:activate_on_typing:type: boolean@@ -794,12 +862,12 @@ components:title: CompletionOptiontype: objectCompletionResultNotification:- description: "Code completion result from language server.\n\n Attributes:\n\- \ completion_id: Request ID this responds to.\n prefix_length:\- \ Length of prefix to replace.\n options: Completion options to display."+ description: "Code completion result from language server.\n\nAttributes:\n\+ \ completion_id: Request ID this responds to.\n prefix_length: Length\+ \ of prefix to replace.\n options: Completion options to display."properties:completion_id:- type: string+ $ref: '#/components/schemas/RequestId'op:enum:- completion-result@@ -841,7 +909,7 @@ components:- type: 'null'default: nullcellId:- type: string+ $ref: '#/components/schemas/CellId'code:type: stringconfig:@@ -860,12 +928,12 @@ components:title: CreateCelltype: objectCreateNotebookCommand:- description: "Instantiate and initialize a notebook.\n\n Sent when a notebook\- \ is first loaded. Contains all cells and initial UI element values.\n\n \- \ Attributes:\n execution_requests: ExecuteCellCommand for each notebook\- \ cell.\n cell_ids: Initial cell IDs in the notebook.\n set_ui_element_value_request:\- \ Initial UI element values.\n auto_run: Whether to automatically execute\- \ cells on instantiation.\n request: HTTP request context if available."+ description: "Instantiate and initialize a notebook.\n\nSent when a notebook\+ \ is first loaded. Contains all cells and initial UI element values.\n\nAttributes:\n\+ \ execution_requests: ExecuteCellCommand for each notebook cell.\n cell_ids:\+ \ Initial cell IDs in the notebook.\n set_ui_element_value_request: Initial\+ \ UI element values.\n auto_run: Whether to automatically execute cells\+ \ on instantiation.\n request: HTTP request context if available."properties:autoRun:type: boolean@@ -938,9 +1006,9 @@ components:title: CycleErrortype: objectDataColumnPreviewNotification:- description: "Data column preview with stats and visualization.\n\n Inherits\- \ all ColumnPreview attributes.\n\n Attributes:\n table_name: Table\- \ containing the column.\n column_name: Column being previewed."+ description: "Data column preview with stats and visualization.\n\nInherits\+ \ all ColumnPreview attributes.\n\nAttributes:\n table_name: Table containing\+ \ the column.\n column_name: Column being previewed."properties:chart_code:anyOf:@@ -1024,8 +1092,8 @@ components:title: DataSourceConnectiontype: objectDataSourceConnectionsNotification:- description: "Available data source connections for SQL cells.\n\n Attributes:\n\- \ connections: Available data source connections."+ description: "Available data source connections for SQL cells.\n\nAttributes:\n\+ \ connections: Available data source connections."properties:connections:items:@@ -1168,9 +1236,9 @@ components:title: Databasetype: objectDatasetsNotification:- description: "Available datasets for data explorer.\n\n Attributes:\n \- \ tables: Available data tables/datasets.\n clear_channel: If set,\- \ clears tables from this channel first."+ description: "Available datasets for data explorer.\n\nAttributes:\n tables:\+ \ Available data tables/datasets.\n clear_channel: If set, clears tables\+ \ from this channel first."properties:clear_channel:anyOf:@@ -1194,11 +1262,18 @@ components:title: DatasetsNotificationtype: objectDatasourcesConfig:- description: "Configuration for datasources panel.\n\n **Keys.**\n\n -\- \ `auto_discover_schemas`: if `True`, include schemas in the datasource\n\- \ - `auto_discover_tables`: if `True`, include tables in the datasource\n\- \ - `auto_discover_columns`: if `True`, include columns & table metadata\- \ in the datasource"+ description: 'Configuration for datasources panel.+++ **Keys.**+++ - `auto_discover_schemas`: if `True`, include schemas in the datasource++ - `auto_discover_tables`: if `True`, include tables in the datasource++ - `auto_discover_columns`: if `True`, include columns & table metadata in+ the datasource'properties:auto_discover_columns:anyOf:@@ -1219,12 +1294,12 @@ components:title: DatasourcesConfigtype: objectDebugCellCommand:- description: "Enter debugger mode for a cell.\n\n Starts the Python debugger\- \ (pdb) for the specified cell.\n\n Attributes:\n cell_id: Cell\- \ to debug.\n request: HTTP request context if available."+ description: "Enter debugger mode for a cell.\n\nStarts the Python debugger\+ \ (pdb) for the specified cell.\n\nAttributes:\n cell_id: Cell to debug.\n\+ \ request: HTTP request context if available."properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'request:anyOf:- $ref: '#/components/schemas/HTTPRequest'@@ -1241,7 +1316,7 @@ components:DebugCellRequest:properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'request:anyOf:- $ref: '#/components/schemas/HTTPRequest'@@ -1255,7 +1330,7 @@ components:description: Remove a cell from the notebook.properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'type:enum:- delete-cell@@ -1265,12 +1340,12 @@ components:title: DeleteCelltype: objectDeleteCellCommand:- description: "Delete a cell from the notebook.\n\n Removes cell from the\- \ dependency graph and cleans up its variables.\n Dependent cells may become\- \ stale.\n\n Attributes:\n cell_id: Cell to delete."+ description: "Delete a cell from the notebook.\n\nRemoves cell from the dependency\+ \ graph and cleans up its variables.\nDependent cells may become stale.\n\n\+ Attributes:\n cell_id: Cell to delete."properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'type:enum:- delete-cell@@ -1282,7 +1357,7 @@ components:DeleteCellRequest:properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'required:- cellIdtitle: DeleteCellRequest@@ -1340,9 +1415,15 @@ components:title: DependencyTreeResponsetype: objectDiagnosticsConfig:- description: "Configuration options for diagnostics.\n\n **Keys.**\n\n \- \ - `enabled`: if `True`, diagnostics will be shown in the editor\n -\- \ `sql_linter`: if `True`, SQL cells will have linting enabled"+ description: 'Configuration options for diagnostics.+++ **Keys.**+++ - `enabled`: if `True`, diagnostics will be shown in the editor++ - `sql_linter`: if `True`, SQL cells will have linting enabled'properties:enabled:type: boolean@@ -1352,16 +1433,31 @@ components:title: DiagnosticsConfigtype: objectDisplayConfig:- description: "Configuration for display.\n\n **Keys.**\n\n - `theme`:\- \ `\"light\"`, `\"dark\"`, or `\"system\"`\n - `code_editor_font_size`:\- \ font size for the code editor\n - `cell_output`: `\"above\"` or `\"below\"\- `\n - `dataframes`: `\"rich\"` or `\"plain\"`\n - `custom_css`: list\- \ of paths to custom CSS files\n - `default_table_page_size`: default number\- \ of rows to display in tables\n - `default_table_max_columns`: default\- \ maximum number of columns to display in tables\n - `reference_highlighting`:\- \ if `True`, highlight reactive variable references\n - `locale`: locale\- \ for date formatting and internationalization (e.g., \"en-US\", \"en-GB\"\- , \"de-DE\")"+ description: 'Configuration for display.+++ **Keys.**+++ - `theme`: `"light"`, `"dark"`, or `"system"`++ - `code_editor_font_size`: font size for the code editor++ - `cell_output`: `"above"` or `"below"`++ - `dataframes`: `"rich"` or `"plain"`++ - `custom_css`: list of paths to custom CSS files++ - `default_table_page_size`: default number of rows to display in tables++ - `default_table_max_columns`: default maximum number of columns to display+ in tables++ - `reference_highlighting`: if `True`, highlight reactive variable references++ - `locale`: locale for date formatting and internationalization (e.g., "en-US",+ "en-GB", "de-DE")'properties:cell_output:enum:@@ -1410,14 +1506,14 @@ components:title: DisplayConfigtype: objectExecuteCellCommand:- description: "Execute a single cell.\n\n Executes a cell with the provided\- \ code. Dependent cells may be\n re-executed based on the reactive execution\- \ mode.\n\n Attributes:\n cell_id: Cell to execute.\n code:\- \ Python code to execute.\n request: HTTP request context if available.\n\- \ timestamp: Unix timestamp when command was created."+ description: "Execute a single cell.\n\nExecutes a cell with the provided code.\+ \ Dependent cells may be\nre-executed based on the reactive execution mode.\n\+ \nAttributes:\n cell_id: Cell to execute.\n code: Python code to execute.\n\+ \ request: HTTP request context if available.\n timestamp: Unix timestamp\+ \ when command was created."properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'code:type: stringrequest:@@ -1437,16 +1533,16 @@ components:title: ExecuteCellCommandtype: objectExecuteCellsCommand:- description: "Execute multiple cells in a batch.\n\n Executes multiple cells\- \ with their corresponding code. The kernel manages\n dependency tracking\- \ and reactive execution.\n\n Attributes:\n cell_ids: Cells to execute.\n\- \ codes: Python code for each cell. Must match length of cell_ids.\n\- \ request: HTTP request context if available.\n timestamp: Unix\- \ timestamp when command was created."+ description: "Execute multiple cells in a batch.\n\nExecutes multiple cells\+ \ with their corresponding code. The kernel manages\ndependency tracking and\+ \ reactive execution.\n\nAttributes:\n cell_ids: Cells to execute.\n \+ \ codes: Python code for each cell. Must match length of cell_ids.\n request:\+ \ HTTP request context if available.\n timestamp: Unix timestamp when command\+ \ was created."properties:cellIds:items:- type: string+ $ref: '#/components/schemas/CellId'type: arraycodes:items:@@ -1472,7 +1568,7 @@ components:properties:cellIds:items:- type: string+ $ref: '#/components/schemas/CellId'type: arraycodes:items:@@ -1489,14 +1585,14 @@ components:title: ExecuteCellsRequesttype: objectExecuteScratchpadCommand:- description: "Execute code in the scratchpad.\n\n The scratchpad is a temporary\- \ execution environment that doesn't affect\n the notebook's cells or dependencies.\- \ Runs in an isolated cell with a copy\n of the global namespace, useful\- \ for experimentation.\n\n Attributes:\n code: Python code to execute.\n\- \ request: HTTP request context if available.\n notebook_cells:\- \ Snapshot of notebook cells from the session document.\n Used\- \ to populate the document ContextVar so code_mode can read\n cell\- \ ordering, code, names, and configs."+ description: "Execute code in the scratchpad.\n\nThe scratchpad is a temporary\+ \ execution environment that doesn't affect\nthe notebook's cells or dependencies.\+ \ Runs in an isolated cell with a copy\nof the global namespace, useful for\+ \ experimentation.\n\nAttributes:\n code: Python code to execute.\n \+ \ request: HTTP request context if available.\n notebook_cells: Snapshot\+ \ of notebook cells from the session document.\n Used to populate the\+ \ document ContextVar so code_mode can read\n cell ordering, code,\+ \ names, and configs."properties:code:type: string@@ -1541,10 +1637,9 @@ components:title: ExecuteScratchpadRequesttype: objectExecuteStaleCellsCommand:- description: "Execute all stale cells.\n\n Cells become stale when their\- \ dependencies change but haven't been\n re-executed yet. Brings the notebook\- \ to a consistent state.\n\n Attributes:\n request: HTTP request\- \ context if available."+ description: "Execute all stale cells.\n\nCells become stale when their dependencies\+ \ change but haven't been\nre-executed yet. Brings the notebook to a consistent\+ \ state.\n\nAttributes:\n request: HTTP request context if available."properties:request:anyOf:@@ -1891,8 +1986,8 @@ components:title: FileUpdateResponsetype: objectFocusCellNotification:- description: "Focuses a cell (kiosk mode).\n\n Attributes:\n cell_id:\- \ Cell to focus."+ description: "Focuses a cell (kiosk mode).\n\nAttributes:\n cell_id: Cell\+ \ to focus."properties:cell_id:$ref: '#/components/schemas/CellId'@@ -1907,7 +2002,7 @@ components:FocusCellRequest:properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'required:- cellIdtitle: FocusCellRequest@@ -1936,8 +2031,13 @@ components:title: FormatResponsetype: objectFormattingConfig:- description: "Configuration for code formatting.\n\n **Keys.**\n\n - `line_length`:\- \ max line length"+ description: 'Configuration for code formatting.+++ **Keys.**+++ - `line_length`: max line length'properties:line_length:type: integer@@ -1946,9 +2046,9 @@ components:title: FormattingConfigtype: objectFunctionCallResultNotification:- description: "Result of a frontend-initiated function call.\n\n Attributes:\n\- \ function_call_id: ID matching the original request.\n return_value:\- \ Function return value as JSON.\n status: Human-readable success/failure\+ description: "Result of a frontend-initiated function call.\n\nAttributes:\n\+ \ function_call_id: ID matching the original request.\n return_value:\+ \ Function return value as JSON.\n status: Human-readable success/failure\\ status."properties:function_call_id:@@ -1967,8 +2067,11 @@ components:title: FunctionCallResultNotificationtype: objectGetCacheInfoCommand:- description: "Retrieve cache statistics.\n\n Collects cache usage info across\- \ all contexts (hit/miss rates, time saved, disk usage)."+ description: 'Retrieve cache statistics.+++ Collects cache usage info across all contexts (hit/miss rates, time saved,+ disk usage).'properties:type:enum:@@ -1983,11 +2086,11 @@ components:title: GetCacheInfoRequesttype: objectGitHubConfig:- description: "Configuration options for GitHub.\n\n **Keys.**\n\n - `api_key`:\- \ the GitHub API token\n - `base_url`: the base URL for the API\n -\- \ `copilot_settings`: configuration settings for GitHub Copilot LSP.\n \- \ Supports settings like `http` (proxy configuration), `telemetry`,\n\- \ and `github-enterprise` (enterprise URI)."+ description: "Configuration options for GitHub.\n\n**Keys.**\n\n- `api_key`:\+ \ the GitHub API token\n- `base_url`: the base URL for the API\n- `copilot_settings`:\+ \ configuration settings for GitHub Copilot LSP.\n Supports settings like\+ \ `http` (proxy configuration), `telemetry`,\n and `github-enterprise`\+ \ (enterprise URI)."properties:api_key:type: string@@ -1999,8 +2102,13 @@ components:title: GitHubConfigtype: objectGoogleAiConfig:- description: "Configuration options for Google AI.\n\n **Keys.**\n\n -\- \ `api_key`: the Google AI API key"+ description: 'Configuration options for Google AI.+++ **Keys.**+++ - `api_key`: the Google AI API key'properties:api_key:type: string@@ -2008,16 +2116,15 @@ components:title: GoogleAiConfigtype: objectHTTPRequest:- description: "Serializable HTTP request representation.\n\n Mimics Starlette/FastAPI\- \ Request but is pickle-able and contains only a safe\n subset of data.\- \ Excludes session and auth to prevent exposing sensitive data.\n\n Attributes:\n\- \ url: Serialized URL with path, port, scheme, netloc, query, hostname.\n\- \ base_url: Serialized base URL.\n headers: Request headers\- \ (marimo-specific headers excluded).\n query_params: Query parameters\- \ mapped to lists of values.\n path_params: Path parameters from the\- \ URL route.\n cookies: Request cookies.\n meta: User-defined\- \ storage for custom data.\n user: User info from authentication middleware\- \ (e.g., is_authenticated, username)."+ description: "Serializable HTTP request representation.\n\nMimics Starlette/FastAPI\+ \ Request but is pickle-able and contains only a safe\nsubset of data. Excludes\+ \ session and auth to prevent exposing sensitive data.\n\nAttributes:\n \+ \ url: Serialized URL with path, port, scheme, netloc, query, hostname.\n\+ \ base_url: Serialized base URL.\n headers: Request headers (marimo-specific\+ \ headers excluded).\n query_params: Query parameters mapped to lists of\+ \ values.\n path_params: Path parameters from the URL route.\n cookies:\+ \ Request cookies.\n meta: User-defined storage for custom data.\n user:\+ \ User info from authentication middleware (e.g., is_authenticated, username)."properties:base_url:type: object@@ -2054,9 +2161,9 @@ components:title: HTTPRequesttype: objectHumanReadableStatus:- description: "Human-readable status for operation results.\n\n Attributes:\n\- \ code: Status code (\"ok\" or \"error\").\n title: Optional\- \ short title.\n message: Optional detailed description."+ description: "Human-readable status for operation results.\n\nAttributes:\n\+ \ code: Status code (\"ok\" or \"error\").\n title: Optional short title.\n\+ \ message: Optional detailed description."properties:code:enum:@@ -2094,16 +2201,15 @@ components:title: ImportStarErrortype: objectInstallPackagesCommand:- description: "Install Python packages.\n\n Installs missing packages using\- \ the specified package manager. Triggered\n automatically on import errors\- \ or manually by the user.\n\n Attributes:\n manager: Package manager\- \ to use ('pip', 'conda', 'uv', etc.).\n versions: Package names mapped\- \ to version specifiers. Empty version\n means install latest.\n\- \ source: Where to install. \"kernel\" (default) dispatches to the\- \ kernel\n subprocess; \"server\" installs directly into the\- \ server's Python\n environment (sys.executable), used when\- \ the server itself needs\n a package (e.g. nbformat for IPYNB\- \ auto-export in sandbox mode)."+ description: "Install Python packages.\n\nInstalls missing packages using the\+ \ specified package manager. Triggered\nautomatically on import errors or\+ \ manually by the user.\n\nAttributes:\n manager: Package manager to use\+ \ ('pip', 'conda', 'uv', etc.).\n versions: Package names mapped to version\+ \ specifiers. Empty version\n means install latest.\n source:\+ \ Where to install. \"kernel\" (default) dispatches to the kernel\n \+ \ subprocess; \"server\" installs directly into the server's Python\n\+ \ environment (sys.executable), used when the server itself needs\n\+ \ a package (e.g. nbformat for IPYNB auto-export in sandbox mode)."properties:manager:type: string@@ -2144,10 +2250,10 @@ components:title: InstallPackagesRequesttype: objectInstallingPackageAlertNotification:- description: "Package installation progress with streaming logs.\n\n Attributes:\n\- \ packages: Package name to status (queued/installing/installed/failed).\n\- \ logs: Optional streaming logs per package.\n log_status: Log\- \ stream status (append/start/done)."+ description: "Package installation progress with streaming logs.\n\nAttributes:\n\+ \ packages: Package name to status (queued/installing/installed/failed).\n\+ \ logs: Optional streaming logs per package.\n log_status: Log stream\+ \ status (append/start/done)."properties:log_status:anyOf:@@ -2194,7 +2300,7 @@ components:default: nullobjectIds:items:- type: string+ $ref: '#/components/schemas/UIElementId'type: arrayvalues:type: array@@ -2243,16 +2349,16 @@ components:title: InvokeAiToolResponsetype: objectInvokeFunctionCommand:- description: "Invoke a function from a UI element.\n\n Called when a UI element\- \ needs to invoke a Python function.\n\n Attributes:\n function_call_id:\- \ Unique identifier for this call.\n namespace: Namespace where the\- \ function is registered.\n function_name: Function to invoke.\n \- \ args: Keyword arguments for the function."+ description: "Invoke a function from a UI element.\n\nCalled when a UI element\+ \ needs to invoke a Python function.\n\nAttributes:\n function_call_id:\+ \ Unique identifier for this call.\n namespace: Namespace where the function\+ \ is registered.\n function_name: Function to invoke.\n args: Keyword\+ \ arguments for the function."properties:args:type: objectfunctionCallId:- type: string+ $ref: '#/components/schemas/RequestId'functionName:type: stringnamespace:@@ -2273,7 +2379,7 @@ components:args:type: objectfunctionCallId:- type: string+ $ref: '#/components/schemas/RequestId'functionName:type: stringnamespace:@@ -2286,11 +2392,11 @@ components:title: InvokeFunctionRequesttype: objectKernelCapabilitiesNotification:- description: "Kernel capabilities detected at startup.\n\n All fields auto-detected\- \ in __post_init__.\n\n Attributes:\n terminal: Terminal access\- \ (unavailable on Windows/Pyodide).\n pylsp: Python Language Server\- \ Protocol installed.\n ty: ty type checker installed.\n basedpyright:\- \ basedpyright type checker installed."+ description: "Kernel capabilities detected at startup.\n\nAll fields auto-detected\+ \ in __post_init__.\n\nAttributes:\n terminal: Terminal access (unavailable\+ \ on Windows/Pyodide).\n pylsp: Python Language Server Protocol installed.\n\+ \ ty: ty type checker installed.\n basedpyright: basedpyright type checker\+ \ installed."properties:basedpyright:default: false@@ -2312,16 +2418,15 @@ components:type: objectKernelReadyNotification:description: "Kernel ready for execution. First notification sent at startup.\n\- \n Attributes:\n cell_ids: Cell IDs in order.\n codes: Source\- \ code for each cell.\n names: Cell names/titles.\n layout:\- \ Notebook layout config.\n configs: Per-cell configuration.\n \- \ resumed: Whether resumed from previous session.\n ui_values: Previous\- \ UI element values if resumed.\n last_executed_code: Last executed\- \ code per cell if resumed.\n last_execution_time: Last execution time\- \ per cell if resumed.\n app_config: Application configuration.\n \- \ kiosk: Whether running in kiosk mode.\n capabilities: Available\- \ kernel capabilities.\n auto_instantiated: Whether cells already executed\- \ (run mode)."+ \nAttributes:\n cell_ids: Cell IDs in order.\n codes: Source code for\+ \ each cell.\n names: Cell names/titles.\n layout: Notebook layout config.\n\+ \ configs: Per-cell configuration.\n resumed: Whether resumed from previous\+ \ session.\n ui_values: Previous UI element values if resumed.\n last_executed_code:\+ \ Last executed code per cell if resumed.\n last_execution_time: Last execution\+ \ time per cell if resumed.\n app_config: Application configuration.\n\+ \ kiosk: Whether running in kiosk mode.\n capabilities: Available kernel\+ \ capabilities.\n auto_instantiated: Whether cells already executed (run\+ \ mode)."properties:app_config:$ref: '#/components/schemas/_AppConfig'@@ -2390,8 +2495,8 @@ components:title: KernelReadyNotificationtype: objectKernelStartupErrorNotification:- description: "Kernel failed to start.\n\n Attributes:\n error: Error\- \ message describing failure."+ description: "Kernel failed to start.\n\nAttributes:\n error: Error message\+ \ describing failure."properties:error:type: string@@ -2404,11 +2509,19 @@ components:title: KernelStartupErrorNotificationtype: objectKeymapConfig:- description: "Configuration for keymaps.\n\n **Keys.**\n\n - `preset`:\- \ one of `\"default\"` or `\"vim\"`\n - `overrides`: a dict of keymap actions\- \ to their keymap override\n - `vimrc`: path to a vimrc file to load keymaps\- \ from\n - `destructive_delete`: if `True`, allows deleting cells with\- \ content."+ description: 'Configuration for keymaps.+++ **Keys.**+++ - `preset`: one of `"default"` or `"vim"`++ - `overrides`: a dict of keymap actions to their keymap override++ - `vimrc`: path to a vimrc file to load keymaps from++ - `destructive_delete`: if `True`, allows deleting cells with content.'properties:destructive_delete:type: boolean@@ -2621,9 +2734,19 @@ components:title: KnownUnionstype: objectLanguageServersConfig:- description: "Configuration options for language servers.\n\n **Keys.**\n\- \n - `pylsp`: the pylsp config\n - `basedpyright`: the basedpyright\- \ config\n - `ty`: the ty config\n - `pyrefly`: the pyrefly config"+ description: 'Configuration options for language servers.+++ **Keys.**+++ - `pylsp`: the pylsp config++ - `basedpyright`: the basedpyright config++ - `ty`: the ty config++ - `pyrefly`: the pyrefly config'properties:basedpyright:$ref: '#/components/schemas/BasedpyrightServerConfig'@@ -2648,12 +2771,12 @@ components:title: LayoutConfigtype: objectLintConfig:- description: "Configuration for lint rule selection.\n\n Follows ruff-inspired\- \ semantics for selecting which rules to run\n during ``marimo check``.\n\- \n **Keys.**\n\n - ``select``: list of rule code prefixes that replaces\- \ the default\n enabled set. Use ``\"ALL\"`` to select all rules.\n \- \ Example: ``[\"MB\", \"MR001\"]``\n - ``ignore``: list of rule code\- \ prefixes to remove from the\n enabled set."+ description: "Configuration for lint rule selection.\n\nFollows ruff-inspired\+ \ semantics for selecting which rules to run\nduring ``marimo check``.\n\n\+ **Keys.**\n\n- ``select``: list of rule code prefixes that replaces the default\n\+ \ enabled set. Use ``\"ALL\"`` to select all rules.\n Example: ``[\"MB\"\+ , \"MR001\"]``\n- ``ignore``: list of rule code prefixes to remove from the\n\+ \ enabled set."properties:ignore:items:@@ -2667,9 +2790,8 @@ components:title: LintConfigtype: objectListDataSourceConnectionCommand:- description: "List data source schemas.\n\n Retrieves available schemas for\- \ a data source engine.\n\n Attributes:\n engine: Data source engine\- \ identifier."+ description: "List data source schemas.\n\nRetrieves available schemas for a\+ \ data source engine.\n\nAttributes:\n engine: Data source engine identifier."properties:engine:type: string@@ -2700,18 +2822,17 @@ components:title: ListPackagesResponsetype: objectListSQLSchemasCommand:- description: "List schemas in an SQL database.\n\n Retrieves names of all\- \ schemas in a database. Used by the SQL editor for\n schema selection.\n\- \n Attributes:\n request_id: Unique identifier for this request.\n\- \ engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).\n \- \ database: Database to query."+ description: "List schemas in an SQL database.\n\nRetrieves names of all schemas\+ \ in a database. Used by the SQL editor for\nschema selection.\n\nAttributes:\n\+ \ request_id: Unique identifier for this request.\n engine: SQL engine\+ \ ('postgresql', 'mysql', 'duckdb', etc.).\n database: Database to query."properties:database:type: stringengine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'type:enum:- list-sql-schemas@@ -2729,7 +2850,7 @@ components:engine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'required:- requestId- engine@@ -2737,19 +2858,18 @@ components:title: ListSQLSchemasRequesttype: objectListSQLTablesCommand:- description: "List tables in an SQL schema.\n\n Retrieves names of all tables\- \ and views in a schema. Used by the SQL\n editor for table selection.\n\- \n Attributes:\n request_id: Unique identifier for this request.\n\- \ engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).\n \- \ database: Database to query.\n schema: Schema to list tables\- \ from."+ description: "List tables in an SQL schema.\n\nRetrieves names of all tables\+ \ and views in a schema. Used by the SQL\neditor for table selection.\n\n\+ Attributes:\n request_id: Unique identifier for this request.\n engine:\+ \ SQL engine ('postgresql', 'mysql', 'duckdb', etc.).\n database: Database\+ \ to query.\n schema: Schema to list tables from."properties:database:type: stringengine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'schema:type: stringtype:@@ -2770,7 +2890,7 @@ components:engine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'schema:type: stringrequired:@@ -2781,12 +2901,12 @@ components:title: ListSQLTablesRequesttype: objectListSecretKeysCommand:- description: "List available secret keys.\n\n Retrieves secret names without\- \ exposing values.\n\n Attributes:\n request_id: Unique identifier\- \ for this request."+ description: "List available secret keys.\n\nRetrieves secret names without\+ \ exposing values.\n\nAttributes:\n request_id: Unique identifier for this\+ \ request."properties:requestId:- type: string+ $ref: '#/components/schemas/RequestId'type:enum:- list-secret-keys@@ -2798,7 +2918,7 @@ components:ListSecretKeysRequest:properties:requestId:- type: string+ $ref: '#/components/schemas/RequestId'required:- requestIdtitle: ListSecretKeysRequest@@ -2863,11 +2983,20 @@ components:title: LspRestartResponsetype: objectLspServerHealth:- description: "Health status for a single LSP server.\n\n Status meanings:\n\- \ - starting: process launched, initializing\n - running: healthy and\- \ responsive to pings\n - stopped: not running (never started or cleanly\- \ stopped)\n - crashed: exited with non-zero code\n - unresponsive:\- \ process alive but not responding to pings"+ description: 'Health status for a single LSP server.+++ Status meanings:++ - starting: process launched, initializing++ - running: healthy and responsive to pings++ - stopped: not running (never started or cleanly stopped)++ - crashed: exited with non-zero code++ - unresponsive: process alive but not responding to pings'properties:error:anyOf:@@ -3090,7 +3219,7 @@ components:type: stringsessionId:anyOf:- - type: string+ - $ref: '#/components/schemas/SessionId'- type: 'null'default: nullrequired:@@ -3205,12 +3334,12 @@ components:title: MarimoSyntaxErrortype: objectMissingPackageAlertNotification:- description: "Alert for missing packages with install option.\n\n Attributes:\n\- \ packages: Missing package names.\n isolated: Whether auto-install\- \ is possible in this environment.\n source: Which Python environment\- \ to install into. \"kernel\" (default)\n installs in the kernel's\- \ venv; \"server\" installs in the\n server's own Python env\- \ (e.g. for formatter tools like ruff)."+ description: "Alert for missing packages with install option.\n\nAttributes:\n\+ \ packages: Missing package names.\n isolated: Whether auto-install\+ \ is possible in this environment.\n source: Which Python environment to\+ \ install into. \"kernel\" (default)\n installs in the kernel's\+ \ venv; \"server\" installs in the\n server's own Python env (e.g.\+ \ for formatter tools like ruff)."properties:isolated:type: boolean@@ -3243,11 +3372,11 @@ components:title: ModelClosetype: objectModelCommand:- description: "Widget model message command.\n\n Handles widget model communication\- \ between frontend and backend.\n\n Attributes:\n model_id: Widget\- \ model identifier.\n message: Model message (update or custom).\n\- \ buffers: Base64-encoded binary buffers.\n token: Unique identifier\- \ for deduplication across dual queues."+ description: "Widget model message command.\n\nHandles widget model communication\+ \ between frontend and backend.\n\nAttributes:\n model_id: Widget model\+ \ identifier.\n message: Model message (update or custom).\n buffers:\+ \ Base64-encoded binary buffers.\n token: Unique identifier for deduplication\+ \ across dual queues."properties:buffers:items:@@ -3263,7 +3392,7 @@ components:update: '#/components/schemas/ModelUpdateMessage'propertyName: methodmodelId:- type: string+ $ref: '#/components/schemas/WidgetModelId'token:type: stringtype:@@ -3294,7 +3423,7 @@ components:title: ModelCustomtype: objectModelCustomMessage:- description: "Custom widget message.\n\n Attributes:\n content: Arbitrary\+ description: "Custom widget message.\n\nAttributes:\n content: Arbitrary\\ content for the custom message."properties:content: {}@@ -3307,10 +3436,9 @@ components:title: ModelCustomMessagetype: objectModelLifecycleNotification:- description: "Widget model lifecycle message.\n\n Mirrors the Jupyter widget\- \ comm protocol with open/update/custom/close.\n\n Attributes:\n \- \ model_id: Widget model identifier.\n message: The lifecycle message\- \ (open/update/custom/close)."+ description: "Widget model lifecycle message.\n\nMirrors the Jupyter widget\+ \ comm protocol with open/update/custom/close.\n\nAttributes:\n model_id:\+ \ Widget model identifier.\n message: The lifecycle message (open/update/custom/close)."properties:message:anyOf:@@ -3379,7 +3507,7 @@ components:update: '#/components/schemas/ModelUpdateMessage'propertyName: methodmodelId:- type: string+ $ref: '#/components/schemas/WidgetModelId'token:type: stringrequired:@@ -3416,9 +3544,9 @@ components:title: ModelUpdatetype: objectModelUpdateMessage:- description: "Widget model state update message.\n\n Attributes:\n \- \ state: Model state updates.\n buffer_paths: Paths within state dict\- \ pointing to binary buffers."+ description: "Widget model state update message.\n\nAttributes:\n state:\+ \ Model state updates.\n buffer_paths: Paths within state dict pointing\+ \ to binary buffers."properties:bufferPaths:items:@@ -3453,7 +3581,7 @@ components:- type: 'null'default: nullcellId:- type: string+ $ref: '#/components/schemas/CellId'type:enum:- move-cell@@ -3498,9 +3626,12 @@ components:title: NotebookCelltype: objectNotebookDocumentTransactionNotification:- description: "Broadcasts an applied transaction to the frontend.\n\n Sent\- \ by the session when the document changes (from any source).\n The frontend\- \ applies the ops to update its local state."+ description: 'Broadcasts an applied transaction to the frontend.+++ Sent by the session when the document changes (from any source).++ The frontend applies the ops to update its local state.'properties:op:enum:@@ -3540,16 +3671,29 @@ components:title: NotebookDocumentTransactionRequesttype: objectOpenAiConfig:- description: "Configuration options for OpenAI or OpenAI-compatible services.\n\- \n **Keys.**\n\n - `api_key`: the OpenAI API key\n - `base_url`:\- \ the base URL for the API\n - `project`: the project ID for the OpenAI\- \ API\n - `ssl_verify` : Boolean argument for httpx passed to open ai client.\- \ httpx defaults to true, but some use cases to let users override to False\- \ in some testing scenarios\n - `ca_bundle_path`: custom ca bundle to be\- \ used for verifying SSL certificates. Used to create custom SSL context for\- \ httpx client\n - `client_pem` : custom path of a client .pem cert used\- \ for verifying identity of client server\n - `extra_headers`: extra headers\- \ to be passed to the OpenAI client"+ description: 'Configuration options for OpenAI or OpenAI-compatible services.+++ **Keys.**+++ - `api_key`: the OpenAI API key++ - `base_url`: the base URL for the API++ - `project`: the project ID for the OpenAI API++ - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx+ defaults to true, but some use cases to let users override to False in some+ testing scenarios++ - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates.+ Used to create custom SSL context for httpx client++ - `client_pem` : custom path of a client .pem cert used for verifying identity+ of client server++ - `extra_headers`: extra headers to be passed to the OpenAI client'properties:api_key:type: string@@ -3573,9 +3717,14 @@ components:title: OpenAiConfigtype: objectOpenGraphMetadata:- description: "OpenGraph-style metadata for a notebook.\n\n The `image` field\- \ may be either:\n - a relative path (typically under `__marimo__/`), or\n\- \ - an absolute HTTPS URL."+ description: 'OpenGraph-style metadata for a notebook.+++ The `image` field may be either:++ - a relative path (typically under `__marimo__/`), or++ - an absolute HTTPS URL.'properties:description:anyOf:@@ -3627,8 +3776,13 @@ components:title: PackageDescriptiontype: objectPackageManagementConfig:- description: "Configuration options for package management.\n\n **Keys.**\n\- \n - `manager`: the package manager to use"+ description: 'Configuration options for package management.+++ **Keys.**+++ - `manager`: the package manager to use'properties:manager:enum:@@ -3655,13 +3809,13 @@ components:title: PackageOperationResponsetype: objectPreviewDatasetColumnCommand:- description: "Preview a dataset column.\n\n Retrieves and displays data from\- \ a single column (dataframe or SQL table).\n Used by the data explorer\- \ UI.\n\n Attributes:\n source_type: Data source type ('dataframe',\- \ 'sql', etc.).\n source: Source identifier (connection string or variable\- \ name).\n table_name: Table or dataframe variable name.\n column_name:\- \ Column to preview.\n fully_qualified_table_name: Full database.schema.table\- \ name for SQL."+ description: "Preview a dataset column.\n\nRetrieves and displays data from\+ \ a single column (dataframe or SQL table).\nUsed by the data explorer UI.\n\+ \nAttributes:\n source_type: Data source type ('dataframe', 'sql', etc.).\n\+ \ source: Source identifier (connection string or variable name).\n \+ \ table_name: Table or dataframe variable name.\n column_name: Column to\+ \ preview.\n fully_qualified_table_name: Full database.schema.table name\+ \ for SQL."properties:columnName:type: string@@ -3718,19 +3872,19 @@ components:title: PreviewDatasetColumnRequesttype: objectPreviewSQLTableCommand:- description: "Preview SQL table details.\n\n Retrieves metadata and sample\- \ data for a table. Used by the SQL editor\n and data explorer.\n\n \- \ Attributes:\n request_id: Unique identifier for this request.\n \- \ engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).\n \- \ database: Database containing the table.\n schema: Schema containing\- \ the table.\n table_name: Table to preview."+ description: "Preview SQL table details.\n\nRetrieves metadata and sample data\+ \ for a table. Used by the SQL editor\nand data explorer.\n\nAttributes:\n\+ \ request_id: Unique identifier for this request.\n engine: SQL engine\+ \ ('postgresql', 'mysql', 'duckdb', etc.).\n database: Database containing\+ \ the table.\n schema: Schema containing the table.\n table_name: Table\+ \ to preview."properties:database:type: stringengine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'schema:type: stringtableName:@@ -3754,7 +3908,7 @@ components:engine:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'schema:type: stringtableName:@@ -3802,8 +3956,8 @@ components:title: PythonLanguageServerConfigtype: objectQueryParamsAppendNotification:- description: "Appends value to URL query parameter.\n\n Attributes:\n \- \ key: Query parameter key.\n value: Value to append."+ description: "Appends value to URL query parameter.\n\nAttributes:\n key:\+ \ Query parameter key.\n value: Value to append."properties:key:type: string@@ -3829,9 +3983,9 @@ components:title: QueryParamsClearNotificationtype: objectQueryParamsDeleteNotification:- description: "Deletes URL query parameter values.\n\n Attributes:\n \- \ key: Query parameter key.\n value: Specific value to delete. If\- \ None, deletes all values for key."+ description: "Deletes URL query parameter values.\n\nAttributes:\n key: Query\+ \ parameter key.\n value: Specific value to delete. If None, deletes all\+ \ values for key."properties:key:type: string@@ -3849,8 +4003,8 @@ components:title: QueryParamsDeleteNotificationtype: objectQueryParamsSetNotification:- description: "Sets URL query parameter, replacing existing values.\n\n Attributes:\n\- \ key: Query parameter key.\n value: Value(s) to set."+ description: "Sets URL query parameter, replacing existing values.\n\nAttributes:\n\+ \ key: Query parameter key.\n value: Value(s) to set."properties:key:type: string@@ -3898,8 +4052,10 @@ components:title: ReconnectedNotificationtype: objectRefreshSecretsCommand:- description: "Refresh secrets from the secrets store.\n\n Reloads secrets\- \ from the provider without restarting the kernel."+ description: 'Refresh secrets from the secrets store.+++ Reloads secrets from the provider without restarting the kernel.'properties:type:enum:@@ -3932,9 +4088,9 @@ components:title: RemovePackageRequesttype: objectRemoveUIElementsNotification:- description: "Removes UI elements associated with a cell.\n\n Sent when cell\- \ is re-executed or deleted.\n\n Attributes:\n cell_id: Cell whose\- \ UI elements should be removed."+ description: "Removes UI elements associated with a cell.\n\nSent when cell\+ \ is re-executed or deleted.\n\nAttributes:\n cell_id: Cell whose UI elements\+ \ should be removed."properties:cell_id:$ref: '#/components/schemas/CellId'@@ -3947,9 +4103,9 @@ components:title: RemoveUIElementsNotificationtype: objectRenameNotebookCommand:- description: "Rename or move the notebook file.\n\n Updates the notebook's\- \ filename in the kernel metadata.\n\n Attributes:\n filename: New\- \ filename or path for the notebook."+ description: "Rename or move the notebook file.\n\nUpdates the notebook's filename\+ \ in the kernel metadata.\n\nAttributes:\n filename: New filename or path\+ \ for the notebook."properties:filename:type: string@@ -3970,13 +4126,16 @@ components:title: RenameNotebookRequesttype: objectReorderCells:- description: "Replace the full cell ordering.\n\n Cell IDs present in the\- \ document but missing from ``cell_ids``\n are appended at the end. IDs\- \ not in the document are ignored."+ description: 'Replace the full cell ordering.+++ Cell IDs present in the document but missing from ``cell_ids``++ are appended at the end. IDs not in the document are ignored.'properties:cellIds:items:- type: string+ $ref: '#/components/schemas/CellId'type: arraytype:enum:@@ -3987,6 +4146,7 @@ components:title: ReorderCellstype: objectRequestId:+ format: request-idtype: stringRunningNotebooksResponse:properties:@@ -3999,40 +4159,38 @@ components:title: RunningNotebooksResponsetype: objectRuntimeConfig:- description: "Configuration for runtime.\n\n **Keys.**\n\n - `auto_instantiate`:\- \ if `False`, cells won't automatically\n run on startup. This only\- \ applies when editing a notebook,\n and not when running as an application.\n\- \ The default is `True`.\n - `auto_reload`: if `lazy`, cells importing\- \ modified modules will marked\n as stale; if `autorun`, affected cells\- \ will be automatically run. similar\n to IPython's %autoreload extension\- \ but with more code intelligence.\n - `reactive_tests`: if `True`, marimo\- \ will automatically run pytest on cells containing only test functions and\- \ test classes.\n execution.\n - `on_cell_change`: if `lazy`, cells\- \ will be marked stale when their\n ancestors run but won't autorun;\- \ if `autorun`, cells will automatically\n run when their ancestors run.\n\- \ - `execution_type`: if `relaxed`, marimo will not clone cell declarations;\n\- \ if `strict` marimo will clone cell declarations by default, avoiding\n\- \ hidden potential state build up.\n - `watcher_on_save`: how to handle\- \ file changes when saving. `\"lazy\"` marks\n affected cells as stale,\- \ `\"autorun\"` automatically runs affected cells.\n - `output_max_bytes`:\- \ the maximum size in bytes of cell outputs; larger\n values may affect\- \ frontend performance\n - `serve_cached_sessions_in_apps`: if `True`,\- \ initialize applications with session cache.\n The default is `False`.\n\- \ - `std_stream_max_bytes`: the maximum size in bytes of console outputs;\n\- \ larger values may affect frontend performance\n - `pythonpath`:\- \ a list of directories to add to the Python search path.\n Directories\- \ will be added to the head of sys.path. Similar to the\n `PYTHONPATH`\- \ environment variable, the directories will be included in\n where\- \ Python will look for imported modules.\n - `dotenv`: a list of paths\- \ to `.env` files to load.\n If the file does not exist, it will be\- \ silently ignored.\n The default is `[\".env\"]` if a pyproject.toml\- \ is found, otherwise `[]`.\n - `default_sql_output`: the default output\- \ format for SQL queries. Can be one of:\n `\"auto\"`, `\"native\"\- `, `\"polars\"`, `\"lazy-polars\"`, or `\"pandas\"`.\n The default\- \ is `\"auto\"`.\n - `default_auto_download`: an Optional list of export\- \ types to automatically snapshot your notebook as:\n `html`, `markdown`,\- \ `ipynb`.\n The default is None.\n - `default_csv_encoding`: the\- \ default encoding for CSV exports.\n The default is `\"utf-8\"`."+ description: "Configuration for runtime.\n\n**Keys.**\n\n- `auto_instantiate`:\+ \ if `False`, cells won't automatically\n run on startup. This only applies\+ \ when editing a notebook,\n and not when running as an application.\n\+ \ The default is `True`.\n- `auto_reload`: if `lazy`, cells importing modified\+ \ modules will marked\n as stale; if `autorun`, affected cells will be automatically\+ \ run. similar\n to IPython's %autoreload extension but with more code intelligence.\n\+ - `reactive_tests`: if `True`, marimo will automatically run pytest on cells\+ \ containing only test functions and test classes.\n execution.\n- `on_cell_change`:\+ \ if `lazy`, cells will be marked stale when their\n ancestors run but won't\+ \ autorun; if `autorun`, cells will automatically\n run when their ancestors\+ \ run.\n- `execution_type`: if `relaxed`, marimo will not clone cell declarations;\n\+ \ if `strict` marimo will clone cell declarations by default, avoiding\n\+ \ hidden potential state build up.\n- `watcher_on_save`: how to handle file\+ \ changes when saving. `\"lazy\"` marks\n affected cells as stale, `\"\+ autorun\"` automatically runs affected cells.\n- `output_max_bytes`: the maximum\+ \ size in bytes of cell outputs; larger\n values may affect frontend performance\n\+ - `serve_cached_sessions_in_apps`: if `True`, initialize applications with\+ \ session cache.\n The default is `False`.\n- `std_stream_max_bytes`: the\+ \ maximum size in bytes of console outputs;\n larger values may affect frontend\+ \ performance\n- `pythonpath`: a list of directories to add to the Python\+ \ search path.\n Directories will be added to the head of sys.path. Similar\+ \ to the\n `PYTHONPATH` environment variable, the directories will be included\+ \ in\n where Python will look for imported modules.\n- `dotenv`: a list\+ \ of paths to `.env` files to load.\n If the file does not exist, it will\+ \ be silently ignored.\n The default is `[\".env\"]` if a pyproject.toml\+ \ is found, otherwise `[]`.\n- `default_sql_output`: the default output format\+ \ for SQL queries. Can be one of:\n `\"auto\"`, `\"native\"`, `\"polars\"\+ `, `\"lazy-polars\"`, or `\"pandas\"`.\n The default is `\"auto\"`.\n-\+ \ `default_auto_download`: an Optional list of export types to automatically\+ \ snapshot your notebook as:\n `html`, `markdown`, `ipynb`.\n The default\+ \ is None.\n- `default_csv_encoding`: the default encoding for CSV exports.\n\+ \ The default is `\"utf-8\"`."properties:auto_instantiate:type: boolean@@ -4093,8 +4251,8 @@ components:title: RuntimeConfigtype: objectSQLDatabaseMetadata:- description: "SQL database metadata.\n\n Attributes:\n connection:\- \ Connection identifier.\n database: Database name."+ description: "SQL database metadata.\n\nAttributes:\n connection: Connection\+ \ identifier.\n database: Database name."properties:connection:type: string@@ -4106,9 +4264,9 @@ components:title: SQLDatabaseMetadatatype: objectSQLMetadata:- description: "SQL database and schema metadata.\n\n Attributes:\n \- \ connection: Connection identifier.\n database: Database name.\n \- \ schema: Schema name."+ description: "SQL database and schema metadata.\n\nAttributes:\n connection:\+ \ Connection identifier.\n database: Database name.\n schema: Schema\+ \ name."properties:connection:type: string@@ -4127,10 +4285,9 @@ components:title: SQLMetadatatype: objectSQLSchemaListPreviewNotification:- description: "List of SQL schemas in a database.\n\n Attributes:\n \- \ request_id: Request ID this responds to.\n metadata: Database and\- \ schema metadata.\n schemas: Schemas in database.\n error:\- \ Error message if failed."+ description: "List of SQL schemas in a database.\n\nAttributes:\n request_id:\+ \ Request ID this responds to.\n metadata: Database and schema metadata.\n\+ \ schemas: Schemas in database.\n error: Error message if failed."properties:error:anyOf:@@ -4156,9 +4313,9 @@ components:title: SQLSchemaListPreviewNotificationtype: objectSQLTableListPreviewNotification:- description: "List of SQL tables in a schema.\n\n Attributes:\n request_id:\- \ Request ID this responds to.\n metadata: Database and schema metadata.\n\- \ tables: Tables in schema.\n error: Error message if failed."+ description: "List of SQL tables in a schema.\n\nAttributes:\n request_id:\+ \ Request ID this responds to.\n metadata: Database and schema metadata.\n\+ \ tables: Tables in schema.\n error: Error message if failed."properties:error:anyOf:@@ -4184,10 +4341,9 @@ components:title: SQLTableListPreviewNotificationtype: objectSQLTablePreviewNotification:- description: "SQL table preview.\n\n Attributes:\n request_id: Request\- \ ID this responds to.\n metadata: Database and schema metadata.\n\- \ table: Table data (None if error).\n error: Error message\- \ if failed."+ description: "SQL table preview.\n\nAttributes:\n request_id: Request ID\+ \ this responds to.\n metadata: Database and schema metadata.\n table:\+ \ Table data (None if error).\n error: Error message if failed."properties:error:anyOf:@@ -4221,10 +4377,17 @@ components:title: SaveAppConfigurationRequesttype: objectSaveConfig:- description: "Configuration for saving.\n\n **Keys.**\n\n - `autosave`:\- \ one of `\"off\"` or `\"after_delay\"`\n - `delay`: number of milliseconds\- \ to wait before autosaving\n - `format_on_save`: if `True`, format the\- \ code on save"+ description: 'Configuration for saving.+++ **Keys.**+++ - `autosave`: one of `"off"` or `"after_delay"`++ - `delay`: number of milliseconds to wait before autosaving++ - `format_on_save`: if `True`, format the code on save'properties:autosave:enum:@@ -4244,7 +4407,7 @@ components:properties:cellIds:items:- type: string+ $ref: '#/components/schemas/CellId'type: arraycodes:items:@@ -4325,9 +4488,9 @@ components:title: SchemaTabletype: objectSecretKeysResultNotification:- description: "Available secret keys from secret providers.\n\n Attributes:\n\- \ request_id: Request ID this responds to.\n secrets: Secret\- \ keys with provider info."+ description: "Available secret keys from secret providers.\n\nAttributes:\n\+ \ request_id: Request ID this responds to.\n secrets: Secret keys with\+ \ provider info."properties:op:enum:@@ -4363,12 +4526,12 @@ components:title: SecretKeysWithProvidertype: objectServerConfig:- description: "Configuration for the server.\n\n **Keys.**\n\n - `browser`:\- \ the web browser to use. `\"default\"` or a browser registered\n with\- \ Python's webbrowser module (eg, `\"firefox\"` or `\"chrome\"`)\n - `follow_symlink`:\- \ if true, the server will follow symlinks it finds\n inside its static\- \ assets directory.\n - `disable_file_downloads`: if true, the file download\- \ button will be\n hidden in the file explorer."+ description: "Configuration for the server.\n\n**Keys.**\n\n- `browser`: the\+ \ web browser to use. `\"default\"` or a browser registered\n with Python's\+ \ webbrowser module (eg, `\"firefox\"` or `\"chrome\"`)\n- `follow_symlink`:\+ \ if true, the server will follow symlinks it finds\n inside its static\+ \ assets directory.\n- `disable_file_downloads`: if true, the file download\+ \ button will be\n hidden in the file explorer."properties:browser:anyOf:@@ -4385,12 +4548,13 @@ components:title: ServerConfigtype: objectSessionId:+ format: session-idtype: stringSetCode:description: Replace a cell's source code.properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'code:type: stringtype:@@ -4406,7 +4570,7 @@ components:description: Partially update a cell's config. None fields are unchanged.properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'column:anyOf:- type: integer@@ -4434,7 +4598,7 @@ components:description: Rename a cell.properties:cellId:- type: string+ $ref: '#/components/schemas/CellId'name:type: stringtype:@@ -4470,10 +4634,16 @@ components:title: SetupRootErrortype: objectSharingConfig:- description: "Configuration for sharing features.\n\n **Keys.**\n\n -\- \ `html`: if `False`, HTML sharing options will be hidden from the UI\n \- \ - `wasm`: if `False`, WebAssembly sharing options will be hidden from the\- \ UI"+ description: 'Configuration for sharing features.+++ **Keys.**+++ - `html`: if `False`, HTML sharing options will be hidden from the UI++ - `wasm`: if `False`, WebAssembly sharing options will be hidden from the+ UI'properties:html:type: boolean@@ -4485,7 +4655,7 @@ components:ShutdownSessionRequest:properties:sessionId:- type: string+ $ref: '#/components/schemas/SessionId'required:- sessionIdtitle: ShutdownSessionRequest@@ -4532,8 +4702,13 @@ components:title: Snippetstype: objectSnippetsConfig:- description: "Configuration for snippets.\n\n **Keys.**\n\n - `custom_path`:\- \ the path to the custom snippets directory"+ description: 'Configuration for snippets.+++ **Keys.**+++ - `custom_path`: the path to the custom snippets directory'properties:custom_paths:items:@@ -4599,8 +4774,8 @@ components:title: SqlParseResulttype: objectStartupLogsNotification:- description: "Streaming kernel startup logs.\n\n Attributes:\n content:\- \ Log content to display.\n status: Stream status (start/append/done)."+ description: "Streaming kernel startup logs.\n\nAttributes:\n content: Log\+ \ content to display.\n status: Stream status (start/append/done)."properties:content:type: string@@ -4627,9 +4802,12 @@ components:title: StdinRequesttype: objectStopKernelCommand:- description: "Stop kernel execution.\n\n Signals the kernel to stop processing\- \ and shut down gracefully.\n Used when closing a notebook or terminating\- \ a session."+ description: 'Stop kernel execution.+++ Signals the kernel to stop processing and shut down gracefully.++ Used when closing a notebook or terminating a session.'properties:type:enum:@@ -4639,13 +4817,13 @@ components:title: StopKernelCommandtype: objectStorageDownloadCommand:- description: "Download a storage entry.\n\n Obtains a pre-signed URL or downloads\- \ the file locally and returns a virtual file URL\n so the frontend can\- \ fetch the contents.\n\n Attributes:\n request_id: Unique identifier\- \ for this request.\n namespace: Variable name identifying the storage\- \ backend.\n path: Full path of the entry to download.\n preview:\- \ If true, a local preview of the file is returned.\n This is useful\- \ if you need to bypass CORS."+ description: "Download a storage entry.\n\nObtains a pre-signed URL or downloads\+ \ the file locally and returns a virtual file URL\nso the frontend can fetch\+ \ the contents.\n\nAttributes:\n request_id: Unique identifier for this\+ \ request.\n namespace: Variable name identifying the storage backend.\n\+ \ path: Full path of the entry to download.\n preview: If true, a local\+ \ preview of the file is returned.\n This is useful if you need to\+ \ bypass CORS."properties:namespace:type: string@@ -4667,12 +4845,12 @@ components:title: StorageDownloadCommandtype: objectStorageDownloadReadyNotification:- description: "Signals that a storage file download is ready.\n\n The url\- \ may be a signed cloud URL (preferred) or a virtual file URL\n (fallback\- \ for backends that don't support signing).\n\n Attributes:\n request_id:\- \ Request ID this responds to.\n url: Signed or virtual-file URL to\- \ download from.\n filename: Suggested filename for the download.\n\- \ error: Error message if the download failed."+ description: "Signals that a storage file download is ready.\n\nThe url may\+ \ be a signed cloud URL (preferred) or a virtual file URL\n(fallback for backends\+ \ that don't support signing).\n\nAttributes:\n request_id: Request ID\+ \ this responds to.\n url: Signed or virtual-file URL to download from.\n\+ \ filename: Suggested filename for the download.\n error: Error message\+ \ if the download failed."properties:error:anyOf:@@ -4709,7 +4887,7 @@ components:default: falsetype: booleanrequestId:- type: string+ $ref: '#/components/schemas/RequestId'required:- requestId- namespace@@ -4717,12 +4895,12 @@ components:title: StorageDownloadRequesttype: objectStorageEntriesNotification:- description: "Result of a storage operation that returns entries.\n\n Attributes:\n\- \ request_id: Request ID this responds to.\n entries: Storage\- \ entries returned by the operation.\n namespace: Variable name of\- \ the storage backend.\n prefix: The prefix that was listed (set by\- \ list_entries).\n query: The search query that was used (set by search).\n\- \ error: Error message if the operation failed."+ description: "Result of a storage operation that returns entries.\n\nAttributes:\n\+ \ request_id: Request ID this responds to.\n entries: Storage entries\+ \ returned by the operation.\n namespace: Variable name of the storage\+ \ backend.\n prefix: The prefix that was listed (set by list_entries).\n\+ \ query: The search query that was used (set by search).\n error: Error\+ \ message if the operation failed."properties:entries:items:@@ -4759,11 +4937,11 @@ components:type: objectStorageEntry:description: "A storage entry is a file, directory, or object for external storage\- \ systems\n\n Attributes:\n path: The path of the storage entry.\n\- \ kind: The kind of the storage entry.\n size: The size of the\- \ storage entry.\n last_modified: The last modified time of the storage\- \ entry.\n metadata: The metadata of the storage entry.\n mime_type:\- \ The MIME type of the storage entry, or None for directories."+ \ systems\n\nAttributes:\n path: The path of the storage entry.\n kind:\+ \ The kind of the storage entry.\n size: The size of the storage entry.\n\+ \ last_modified: The last modified time of the storage entry.\n metadata:\+ \ The metadata of the storage entry.\n mime_type: The MIME type of the\+ \ storage entry, or None for directories."properties:kind:enum:@@ -4794,12 +4972,12 @@ components:title: StorageEntrytype: objectStorageListEntriesCommand:- description: "List storage entries at a prefix.\n\n Navigates storage like\- \ a folder tree using delimiter-based listing.\n Returns entries (files/objects)\- \ and virtual directories at one level.\n\n Attributes:\n request_id:\- \ Unique identifier for this request.\n namespace: Variable name identifying\- \ the storage backend.\n limit: Max entries to return.\n prefix:\- \ Path prefix to list (None = root)."+ description: "List storage entries at a prefix.\n\nNavigates storage like a\+ \ folder tree using delimiter-based listing.\nReturns entries (files/objects)\+ \ and virtual directories at one level.\n\nAttributes:\n request_id: Unique\+ \ identifier for this request.\n namespace: Variable name identifying the\+ \ storage backend.\n limit: Max entries to return.\n prefix: Path prefix\+ \ to list (None = root)."properties:limit:type: integer@@ -4834,7 +5012,7 @@ components:- type: 'null'default: nullrequestId:- type: string+ $ref: '#/components/schemas/RequestId'required:- requestId- namespace@@ -4843,12 +5021,12 @@ components:type: objectStorageNamespace:description: "Represents external storage systems (filesystems and object storage)\n\- \n Attributes:\n name: The variable name of the storage namespace.\n\- \ display_name: The display name of the storage namespace.\n \- \ protocol: The protocol of the storage namespace. E.g. s3, gcs, azure, http,\- \ file, in-memory.\n root_path: The root path of the storage namespace.\n\- \ backend_type: The type of the storage backend (fsspec or obstore)\n\- \ storage_entries: The storage entries in the storage namespace."+ \nAttributes:\n name: The variable name of the storage namespace.\n \+ \ display_name: The display name of the storage namespace.\n protocol:\+ \ The protocol of the storage namespace. E.g. s3, gcs, azure, http, file,\+ \ in-memory.\n root_path: The root path of the storage namespace.\n \+ \ backend_type: The type of the storage backend (fsspec or obstore)\n storage_entries:\+ \ The storage entries in the storage namespace."properties:backendType:enum:@@ -4876,8 +5054,8 @@ components:title: StorageNamespacetype: objectStorageNamespacesNotification:- description: "Available storage namespaces for storage inspector.\n\n Attributes:\n\- \ namespaces: Available storage namespaces."+ description: "Available storage namespaces for storage inspector.\n\nAttributes:\n\+ \ namespaces: Available storage namespaces."properties:namespaces:items:@@ -4914,13 +5092,13 @@ components:title: SuccessResponsetype: objectSyncGraphCommand:- description: "Synchronize the kernel graph with file manager state.\n\n Used\+ description: "Synchronize the kernel graph with file manager state.\n\nUsed\\ when the notebook file changes externally (e.g., file reload or version\- \ control).\n Updates changed cells, deletes removed cells, and optionally\- \ executes modified cells.\n\n Attributes:\n cells: All cells known\- \ to file manager, mapping cell_id to code.\n run_ids: Cells to execute\- \ or update.\n delete_ids: Cells to delete from the graph.\n \- \ timestamp: Unix timestamp when command was created."+ \ control).\nUpdates changed cells, deletes removed cells, and optionally\+ \ executes modified cells.\n\nAttributes:\n cells: All cells known to file\+ \ manager, mapping cell_id to code.\n run_ids: Cells to execute or update.\n\+ \ delete_ids: Cells to delete from the graph.\n timestamp: Unix timestamp\+ \ when command was created."properties:cells:additionalProperties:@@ -4976,9 +5154,14 @@ components:title: ToolDefinitiontype: objectTransaction:- description: "An atomic batch of changes applied to a NotebookDocument.\n\n\- \ ``source`` identifies the writer (e.g. ``\"frontend\"``, ``\"kernel\"\- ``).\n ``version`` is ``None`` when created and stamped by\n ``NotebookDocument.apply()``."+ description: 'An atomic batch of changes applied to a NotebookDocument.+++ ``source`` identifies the writer (e.g. ``"frontend"``, ``"kernel"``).++ ``version`` is ``None`` when created and stamped by++ ``NotebookDocument.apply()``.'properties:changes:items:@@ -5027,11 +5210,12 @@ components:title: TyLanguageServerConfigtype: objectUIElementId:+ format: ui-element-idtype: stringUIElementMessageNotification:- description: "Sends a message to a UI element/widget.\n\n Attributes:\n \- \ ui_element: UI element identifier.\n message: Message payload\- \ as dictionary.\n buffers: Optional binary buffers for large data."+ description: "Sends a message to a UI element/widget.\n\nAttributes:\n ui_element:\+ \ UI element identifier.\n message: Message payload as dictionary.\n \+ \ buffers: Optional binary buffers for large data."properties:buffers:anyOf:@@ -5071,10 +5255,10 @@ components:title: UnknownErrortype: objectUpdateCellConfigCommand:- description: "Update cell configuration.\n\n Updates cell-level settings\- \ like disabled state, hide code, etc.\n\n Attributes:\n configs:\- \ Cell IDs mapped to their config updates. Each config dict\n \- \ can contain partial updates."+ description: "Update cell configuration.\n\nUpdates cell-level settings like\+ \ disabled state, hide code, etc.\n\nAttributes:\n configs: Cell IDs mapped\+ \ to their config updates. Each config dict\n can contain partial\+ \ updates."properties:configs:additionalProperties:@@ -5139,16 +5323,16 @@ components:title: UpdateCellOutputsRequesttype: objectUpdateUIElementCommand:- description: "Update UI element values.\n\n Triggered when users interact\- \ with UI elements (sliders, inputs, dropdowns, etc.).\n Updates element\- \ values and re-executes dependent cells.\n\n Attributes:\n object_ids:\- \ UI elements to update.\n values: New values for the elements. Must\- \ match length of object_ids.\n request: HTTP request context if available.\n\- \ token: Unique request identifier for deduplication."+ description: "Update UI element values.\n\nTriggered when users interact with\+ \ UI elements (sliders, inputs, dropdowns, etc.).\nUpdates element values\+ \ and re-executes dependent cells.\n\nAttributes:\n object_ids: UI elements\+ \ to update.\n values: New values for the elements. Must match length of\+ \ object_ids.\n request: HTTP request context if available.\n token:\+ \ Unique request identifier for deduplication."properties:objectIds:items:- type: string+ $ref: '#/components/schemas/UIElementId'type: arrayrequest:anyOf:@@ -5172,7 +5356,7 @@ components:properties:objectIds:items:- type: string+ $ref: '#/components/schemas/UIElementId'type: arrayrequest:anyOf:@@ -5192,7 +5376,7 @@ components:properties:objectIds:items:- type: string+ $ref: '#/components/schemas/UIElementId'type: arrayvalues:type: array@@ -5202,9 +5386,9 @@ components:title: UpdateUIElementValuesRequesttype: objectUpdateUserConfigCommand:- description: "Update user configuration.\n\n Updates global marimo configuration\- \ (runtime settings, display options, editor preferences).\n\n Attributes:\n\- \ config: Complete user configuration."+ description: "Update user configuration.\n\nUpdates global marimo configuration\+ \ (runtime settings, display options, editor preferences).\n\nAttributes:\n\+ \ config: Complete user configuration."properties:config:$ref: '#/components/schemas/MarimoConfig'@@ -5225,13 +5409,13 @@ components:title: UpdateUserConfigRequesttype: objectValidateSQLCommand:- description: "Validate an SQL query.\n\n Checks if an SQL query is valid\- \ by parsing against a dialect (no DB connection)\n or validating against\- \ an actual database.\n\n Attributes:\n request_id: Unique identifier\- \ for this request.\n query: SQL query to validate.\n only_parse:\- \ If True, only parse using dialect. If False, validate against DB.\n \- \ engine: SQL engine (required if only_parse is False).\n dialect:\- \ SQL dialect for parsing (required if only_parse is True)."+ description: "Validate an SQL query.\n\nChecks if an SQL query is valid by parsing\+ \ against a dialect (no DB connection)\nor validating against an actual database.\n\+ \nAttributes:\n request_id: Unique identifier for this request.\n query:\+ \ SQL query to validate.\n only_parse: If True, only parse using dialect.\+ \ If False, validate against DB.\n engine: SQL engine (required if only_parse\+ \ is False).\n dialect: SQL dialect for parsing (required if only_parse\+ \ is True)."properties:dialect:anyOf:@@ -5248,7 +5432,7 @@ components:query:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'type:enum:- validate-sql@@ -5276,7 +5460,7 @@ components:query:type: stringrequestId:- type: string+ $ref: '#/components/schemas/RequestId'required:- requestId- query@@ -5284,10 +5468,9 @@ components:title: ValidateSQLRequesttype: objectValidateSQLResultNotification:- description: "SQL query validation result.\n\n Attributes:\n request_id:\- \ Request ID this responds to.\n parse_result: SQL parsing result.\n\- \ validate_result: Catalog validation result.\n error: Error\- \ message if failed."+ description: "SQL query validation result.\n\nAttributes:\n request_id: Request\+ \ ID this responds to.\n parse_result: SQL parsing result.\n validate_result:\+ \ Catalog validation result.\n error: Error message if failed."properties:error:anyOf:@@ -5328,16 +5511,16 @@ components:title: VariableContexttype: objectVariableDeclarationNotification:- description: "Variable declaration and usage for dataflow graph.\n\n Attributes:\n\- \ name: Variable name.\n declared_by: Cell IDs that define this\- \ variable.\n used_by: Cell IDs that use this variable."+ description: "Variable declaration and usage for dataflow graph.\n\nAttributes:\n\+ \ name: Variable name.\n declared_by: Cell IDs that define this variable.\n\+ \ used_by: Cell IDs that use this variable."properties:declared_by:items:$ref: '#/components/schemas/CellId'type: arrayname:- type: string+ $ref: '#/components/schemas/VariableName'used_by:items:$ref: '#/components/schemas/CellId'@@ -5349,11 +5532,12 @@ components:title: VariableDeclarationNotificationtype: objectVariableName:+ format: variable-nametype: stringVariableValue:- description: "Variable value and type for variables panel.\n\n Attributes:\n\- \ name: Variable name.\n value: String representation of value.\n\- \ datatype: Data type as string."+ description: "Variable value and type for variables panel.\n\nAttributes:\n\+ \ name: Variable name.\n value: String representation of value.\n \+ \ datatype: Data type as string."properties:datatype:anyOf:@@ -5372,8 +5556,8 @@ components:title: VariableValuetype: objectVariableValuesNotification:- description: "Current variable values.\n\n Attributes:\n variables:\- \ Variables with current values and types."+ description: "Current variable values.\n\nAttributes:\n variables: Variables\+ \ with current values and types."properties:op:enum:@@ -5388,8 +5572,8 @@ components:title: VariableValuesNotificationtype: objectVariablesNotification:- description: "Variable dataflow graph.\n\n Attributes:\n variables:\- \ Variable declarations and usage."+ description: "Variable dataflow graph.\n\nAttributes:\n variables: Variable\+ \ declarations and usage."properties:op:enum:@@ -5405,11 +5589,11 @@ components:type: objectVenvConfig:description: "Configuration for external Python environment in home sandbox\- \ mode.\n\n Allows specifying an existing virtualenv to use instead of\- \ creating\n ephemeral sandboxes per notebook. Only applies in home sandbox\- \ mode.\n\n **Keys.**\n\n - `path`: path to a virtualenv directory (absolute\- \ or relative to\n pyproject.toml)\n - `writable`: if true, marimo\- \ will manage script metadata (inline\n dependencies). Defaults to false."+ \ mode.\n\nAllows specifying an existing virtualenv to use instead of creating\n\+ ephemeral sandboxes per notebook. Only applies in home sandbox mode.\n\n**Keys.**\n\+ \n- `path`: path to a virtualenv directory (absolute or relative to\n pyproject.toml)\n\+ - `writable`: if true, marimo will manage script metadata (inline\n dependencies).\+ \ Defaults to false."properties:path:type: string@@ -5419,6 +5603,7 @@ components:title: VenvConfigtype: objectWidgetModelId:+ format: widget-model-idtype: stringWorkspaceFilesRequest:properties:@@ -5448,8 +5633,12 @@ components:title: WorkspaceFilesResponsetype: object_AppConfig:- description: "Program-specific configuration.\n\n Configuration for frontends\- \ or runtimes that is specific to\n a single marimo program."+ description: 'Program-specific configuration.+++ Configuration for frontends or runtimes that is specific to++ a single marimo program.'properties:app_title:anyOf:diff --git a/packages/openapi/convert_types.js b/packages/openapi/convert_types.jsindex 7d0252523c..c23a11e630 100644--- a/packages/openapi/convert_types.js+++ b/packages/openapi/convert_types.js@@ -3,59 +3,50 @@// @ts-checkimport * as fs from "node:fs";import openapiTS, { astToString, COMMENT_HEADER } from "openapi-typescript";+import ts from "typescript";/**- * Branded NewType schemas generated by the Python codegen post-processor.- * Each key is the OpenAPI schema name; the value is the TypeScript brand tag.+ * Map from OpenAPI `format` values (emitted by _enrich_branded_types in+ * commands.py) to the TypeScript brand tag used in TypedString<T>.** When a new NewType is added to marimo/_types/ids.py *and* registered in* _enrich_branded_types (commands.py), add a corresponding entry here so* the generated TypeScript carries the branded type.*/-const BRANDED_TYPES = {- Base64String: "Base64String",- CellId: "CellId",- SessionId: "SessionId",- VariableName: "VariableName",- RequestId: "RequestId",- WidgetModelId: "WidgetModelId",-};+const BRANDED_FORMATS = /** @type {const} */ ({+ base64: "Base64String",+ "cell-id": "CellId",+ "session-id": "SessionId",+ "variable-name": "VariableName",+ "request-id": "RequestId",+ "widget-model-id": "WidgetModelId",+});/*** Injected at the top of the generated file so branded schemas can reference it.*/const TYPED_STRING_HELPER =- "/** Branded string type — compile-time only. */\ntype TypedString<T extends string> = string & { __type__: T };\n";+ "/** Branded string type — compile-time only. */\ntype TypedString<T extends string> = string & { __brand: T };\n";/**- * Apply post-generation transforms to the TypeScript output.+ * Apply post-generation string transforms to the TypeScript output.** @param {string} content* @returns {string}*/-function transform(content) {+function postTransform(content) {let result = content;- // 1. Record<string, never> → Record<string, any>+ // Record<string, never> → Record<string, any>result = result.replace(/Record<string, never>/g, "Record<string, any>");- // 2. Inject TypedString helper before the first export+ // Inject TypedString helper before the first exportresult = result.replace(/^(export )/m, `${TYPED_STRING_HELPER}\n$1`);- // 3. Brand named type schemas.- // openapi-typescript emits these as top-level schema entries:- // SchemaName: string;- // We replace with:- // SchemaName: TypedString<"SchemaName">;- for (const [schemaName, brand] of Object.entries(BRANDED_TYPES)) {- const pattern = new RegExp(`(\\b${schemaName}): string;`);- const replacement = `$1: TypedString<"${brand}">;`;- result = result.replace(pattern, replacement);- }-- // 4. UIElementId is a template literal, not a simple branded string.+ // UIElementId is a template literal, not a simple branded string.result = result.replace(/\bUIElementId: string;/,+ // biome-ignore lint/suspicious/noTemplateCurlyInString: raw string, not a template'UIElementId: `${components["schemas"]["CellId"]}-${string}`;',);@@ -65,8 +56,29 @@ function transform(content) {async function main() {const source = new URL("./api.yaml", import.meta.url);const dest = new URL("./src/api.ts", import.meta.url);- const nodes = await openapiTS(source, { defaultNonNullable: false });- const content = transform(COMMENT_HEADER + astToString(nodes));++ const nodes = await openapiTS(source, {+ defaultNonNullable: false,+ transform(schemaObject) {+ if (+ schemaObject.type === "string" &&+ typeof schemaObject.format === "string" &&+ schemaObject.format in BRANDED_FORMATS+ ) {+ const brand =+ BRANDED_FORMATS[+ /** @type {keyof typeof BRANDED_FORMATS} */ (schemaObject.format)+ ];+ return ts.factory.createTypeReferenceNode("TypedString", [+ ts.factory.createLiteralTypeNode(+ ts.factory.createStringLiteral(brand),+ ),+ ]);+ }+ },+ });++ const content = postTransform(COMMENT_HEADER + astToString(nodes));fs.writeFileSync(dest, content);console.log("api.yaml → src/api.ts");}diff --git a/packages/openapi/package.json b/packages/openapi/package.jsonindex 93b98a832c..9afa58163d 100644--- a/packages/openapi/package.json+++ b/packages/openapi/package.json@@ -17,7 +17,8 @@"codegen:notebook": "openapi-typescript ../../marimo/_schemas/generated/notebook.yaml -o ./src/notebook.ts"},"devDependencies": {- "openapi-typescript": "^7.8.0"+ "openapi-typescript": "^7.8.0",+ "typescript": "^5.9.3"},"dependencies": {"openapi-fetch": "0.9.7"diff --git a/packages/openapi/src/api.ts b/packages/openapi/src/api.tsindex 9c0c85cc57..1074b08f07 100644--- a/packages/openapi/src/api.ts+++ b/packages/openapi/src/api.ts@@ -4,7 +4,7 @@*//** Branded string type — compile-time only. */-type TypedString<T extends string> = string & { __type__: T };+type TypedString<T extends string> = string & { __brand: T };export interface paths {"/@file/{filename_and_length}": {@@ -3315,24 +3315,24 @@ export interface components {* AiConfig* @description Configuration options for AI.*- * **Keys.**- *- * - `rules`: custom rules to include in all AI completion prompts- * - `max_tokens`: the maximum number of tokens to use in AI completions- * - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`- * - `inline_tooltip`: if `True`, enable inline AI tooltip suggestions- * - `models`: the models to use for AI completions- * - `open_ai`: the OpenAI config- * - `anthropic`: the Anthropic config- * - `google`: the Google AI config- * - `bedrock`: the Bedrock config- * - `azure`: the Azure config- * - `ollama`: the Ollama config- * - `github`: the GitHub config- * - `openrouter`: the OpenRouter config- * - `wandb`: the Weights & Biases config- * - `custom_providers`: a dict of custom OpenAI-compatible providers- * - `open_ai_compatible`: the OpenAI-compatible config (deprecated, use custom_providers)+ * **Keys.**+ *+ * - `rules`: custom rules to include in all AI completion prompts+ * - `max_tokens`: the maximum number of tokens to use in AI completions+ * - `mode`: the mode to use for AI completions. Can be one of: `"ask"` or `"manual"`+ * - `inline_tooltip`: if `True`, enable inline AI tooltip suggestions+ * - `models`: the models to use for AI completions+ * - `open_ai`: the OpenAI config+ * - `anthropic`: the Anthropic config+ * - `google`: the Google AI config+ * - `bedrock`: the Bedrock config+ * - `azure`: the Azure config+ * - `ollama`: the Ollama config+ * - `github`: the GitHub config+ * - `openrouter`: the OpenRouter config+ * - `wandb`: the Weights & Biases config+ * - `custom_providers`: a dict of custom OpenAI-compatible providers+ * - `open_ai_compatible`: the OpenAI-compatible config (deprecated, use custom_providers)*/AiConfig: {anthropic?: components["schemas"]["AnthropicConfig"];@@ -3369,13 +3369,13 @@ export interface components {* AiModelConfig* @description Configuration options for an AI model.*- * **Keys.**+ * **Keys.***- * - `chat_model`: the model to use for chat completions- * - `edit_model`: the model to use for edit completions- * - `autocomplete_model`: the model to use for code completion/autocomplete- * - `displayed_models`: a list of models to display in the UI- * - `custom_models`: a list of custom models to use that are not from the default list+ * - `chat_model`: the model to use for chat completions+ * - `edit_model`: the model to use for edit completions+ * - `autocomplete_model`: the model to use for code completion/autocomplete+ * - `displayed_models`: a list of models to display in the UI+ * - `custom_models`: a list of custom models to use that are not from the default list*/AiModelConfig: {autocomplete_model?: string;@@ -3388,10 +3388,10 @@ export interface components {* AlertNotification* @description User-facing alert message.*- * Attributes:- * title: Alert title.- * description: Alert body (may contain HTML).- * variant: Visual variant (e.g., "danger").+ * Attributes:+ * title: Alert title.+ * description: Alert body (may contain HTML).+ * variant: Visual variant (e.g., "danger").*/AlertNotification: {description: string;@@ -3405,9 +3405,9 @@ export interface components {* AnthropicConfig* @description Configuration options for Anthropic.*- * **Keys.**+ * **Keys.***- * - `api_key`: the Anthropic API key+ * - `api_key`: the Anthropic API key*/AnthropicConfig: {api_key?: string;@@ -3416,11 +3416,11 @@ export interface components {* BannerNotification* @description Persistent banner message at top of notebook.*- * Attributes:- * title: Banner title.- * description: Banner body (may contain HTML).- * variant: Visual variant (e.g., "danger").- * action: Optional user action (e.g., "restart").+ * Attributes:+ * title: Banner title.+ * description: Banner body (may contain HTML).+ * variant: Visual variant (e.g., "danger").+ * action: Optional user action (e.g., "restart").*/BannerNotification: {/** @default null */@@ -3432,6 +3432,7 @@ export interface components {/** @default null */variant?: "danger" | null;};+ /** Format: base64 */Base64String: TypedString<"Base64String">;/** BaseResponse */BaseResponse: {@@ -3451,12 +3452,12 @@ export interface components {* BedrockConfig* @description Configuration options for Bedrock.*- * **Keys.**+ * **Keys.***- * - `profile_name`: the AWS profile to use- * - `region_name`: the AWS region to use- * - `aws_access_key_id`: the AWS access key ID- * - `aws_secret_access_key`: the AWS secret access key+ * - `profile_name`: the AWS profile to use+ * - `region_name`: the AWS region to use+ * - `aws_access_key_id`: the AWS access key ID+ * - `aws_secret_access_key`: the AWS secret access key*/BedrockConfig: {aws_access_key_id?: string;@@ -3468,8 +3469,8 @@ export interface components {* CacheClearedNotification* @description Execution cache cleared result.*- * Attributes:- * bytes_freed: Bytes freed by clearing cache.+ * Attributes:+ * bytes_freed: Bytes freed by clearing cache.*/CacheClearedNotification: {bytes_freed: number;@@ -3480,12 +3481,12 @@ export interface components {* CacheInfoNotification* @description Execution cache statistics.*- * Attributes:- * hits: Cache hits.- * misses: Cache misses.- * time: Time spent on cache operations (seconds).- * disk_to_free: Disk space that could be freed (bytes).- * disk_total: Total disk space used (bytes).+ * Attributes:+ * hits: Cache hits.+ * misses: Cache misses.+ * time: Time spent on cache operations (seconds).+ * disk_to_free: Disk space that could be freed (bytes).+ * disk_total: Total disk space used (bytes).*/CacheInfoNotification: {disk_to_free: number;@@ -3522,23 +3523,24 @@ export interface components {/** @default false */hide_code?: boolean;};+ /** Format: cell-id */CellId: TypedString<"CellId">;/*** CellNotification* @description Updates a cell's state in the frontend.*- * Only fields that are set (not None) will update the cell state.- * Omitting a field leaves that aspect unchanged.+ * Only fields that are set (not None) will update the cell state.+ * Omitting a field leaves that aspect unchanged.*- * Attributes:- * cell_id: Unique identifier of the cell being updated.- * output: Cell's output. Use CellOutput.empty() to clear.- * console: Console messages. Single/list appends, [] clears, None unchanged.- * status: Execution status (idle/running/stale/queued/disabled-transitively).- * stale_inputs: Whether cell has stale inputs from changed dependencies.- * run_id: Execution run ID for tracing. Auto-set from context.- * serialization: Serialization status (TopLevelHints).- * timestamp: Creation timestamp, auto-set.+ * Attributes:+ * cell_id: Unique identifier of the cell being updated.+ * output: Cell's output. Use CellOutput.empty() to clear.+ * console: Console messages. Single/list appends, [] clears, None unchanged.+ * status: Execution status (idle/running/stale/queued/disabled-transitively).+ * stale_inputs: Whether cell has stale inputs from changed dependencies.+ * run_id: Execution run ID for tracing. Auto-set from context.+ * serialization: Serialization status (TopLevelHints).+ * timestamp: Creation timestamp, auto-set.*/CellNotification: {cell_id: components["schemas"]["CellId"];@@ -3655,8 +3657,8 @@ export interface components {* ClearCacheCommand* @description Clear all cached data.*- * Clears all cache contexts, freeing memory and disk space.- * Affects all cells using the @cache decorator.+ * Clears all cache contexts, freeing memory and disk space.+ * Affects all cells using the @cache decorator.*/ClearCacheCommand: {/** @enum {unknown} */@@ -3668,16 +3670,16 @@ export interface components {* CodeCompletionCommand* @description Request code completion suggestions.*- * Sent when the user requests autocomplete. Provides code context up to- * the cursor position for the language server.+ * Sent when the user requests autocomplete. Provides code context up to+ * the cursor position for the language server.*- * Attributes:- * id: Unique identifier for this request.- * document: Source code up to the cursor position.- * cell_id: Cell where completion is requested.+ * Attributes:+ * id: Unique identifier for this request.+ * document: Source code up to the cursor position.+ * cell_id: Cell where completion is requested.*/CodeCompletionCommand: {- cellId: string;+ cellId: components["schemas"]["CellId"];document: string;id: components["schemas"]["RequestId"];/** @enum {unknown} */@@ -3685,7 +3687,7 @@ export interface components {};/** CodeCompletionRequest */CodeCompletionRequest: {- cellId: string;+ cellId: components["schemas"]["CellId"];document: string;id: components["schemas"]["RequestId"];};@@ -3735,16 +3737,16 @@ export interface components {* CompletionConfig* @description Configuration for code completion.*- * A dict with key/value pairs configuring code completion in the marimo- * editor.+ * A dict with key/value pairs configuring code completion in the marimo+ * editor.*- * **Keys.**+ * **Keys.***- * - `activate_on_typing`: if `False`, completion won't activate- * until the completion hotkey is entered- * - `signature_hint_on_typing`: if `False`, signature hint won't be shown when typing- * - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`- * - `codeium_api_key`: the Codeium API key+ * - `activate_on_typing`: if `False`, completion won't activate+ * until the completion hotkey is entered+ * - `signature_hint_on_typing`: if `False`, signature hint won't be shown when typing+ * - `copilot`: one of `"github"`, `"codeium"`, or `"custom"`+ * - `codeium_api_key`: the Codeium API key*/CompletionConfig: {activate_on_typing: boolean;@@ -3765,13 +3767,13 @@ export interface components {* CompletionResultNotification* @description Code completion result from language server.*- * Attributes:- * completion_id: Request ID this responds to.- * prefix_length: Length of prefix to replace.- * options: Completion options to display.+ * Attributes:+ * completion_id: Request ID this responds to.+ * prefix_length: Length of prefix to replace.+ * options: Completion options to display.*/CompletionResultNotification: {- completion_id: string;+ completion_id: components["schemas"]["RequestId"];/** @enum {unknown} */op: "completion-result";options: components["schemas"]["CompletionOption"][];@@ -3791,7 +3793,7 @@ export interface components {after?: components["schemas"]["CellId"] | null;/** @default null */before?: components["schemas"]["CellId"] | null;- cellId: string;+ cellId: components["schemas"]["CellId"];code: string;config: components["schemas"]["CellConfig"];name: string;@@ -3802,14 +3804,14 @@ export interface components {* CreateNotebookCommand* @description Instantiate and initialize a notebook.*- * Sent when a notebook is first loaded. Contains all cells and initial UI element values.+ * Sent when a notebook is first loaded. Contains all cells and initial UI element values.*- * Attributes:- * execution_requests: ExecuteCellCommand for each notebook cell.- * cell_ids: Initial cell IDs in the notebook.- * set_ui_element_value_request: Initial UI element values.- * auto_run: Whether to automatically execute cells on instantiation.- * request: HTTP request context if available.+ * Attributes:+ * execution_requests: ExecuteCellCommand for each notebook cell.+ * cell_ids: Initial cell IDs in the notebook.+ * set_ui_element_value_request: Initial UI element values.+ * auto_run: Whether to automatically execute cells on instantiation.+ * request: HTTP request context if available.*/CreateNotebookCommand: {autoRun: boolean;@@ -3839,11 +3841,11 @@ export interface components {* DataColumnPreviewNotification* @description Data column preview with stats and visualization.*- * Inherits all ColumnPreview attributes.+ * Inherits all ColumnPreview attributes.*- * Attributes:- * table_name: Table containing the column.- * column_name: Column being previewed.+ * Attributes:+ * table_name: Table containing the column.+ * column_name: Column being previewed.*/DataColumnPreviewNotification: {/** @default null */@@ -3889,8 +3891,8 @@ export interface components {* DataSourceConnectionsNotification* @description Available data source connections for SQL cells.*- * Attributes:- * connections: Available data source connections.+ * Attributes:+ * connections: Available data source connections.*/DataSourceConnectionsNotification: {connections: components["schemas"]["DataSourceConnection"][];@@ -3981,9 +3983,9 @@ export interface components {* DatasetsNotification* @description Available datasets for data explorer.*- * Attributes:- * tables: Available data tables/datasets.- * clear_channel: If set, clears tables from this channel first.+ * Attributes:+ * tables: Available data tables/datasets.+ * clear_channel: If set, clears tables from this channel first.*/DatasetsNotification: {/** @default null */@@ -3996,11 +3998,11 @@ export interface components {* DatasourcesConfig* @description Configuration for datasources panel.*- * **Keys.**+ * **Keys.***- * - `auto_discover_schemas`: if `True`, include schemas in the datasource- * - `auto_discover_tables`: if `True`, include tables in the datasource- * - `auto_discover_columns`: if `True`, include columns & table metadata in the datasource+ * - `auto_discover_schemas`: if `True`, include schemas in the datasource+ * - `auto_discover_tables`: if `True`, include tables in the datasource+ * - `auto_discover_columns`: if `True`, include columns & table metadata in the datasource*/DatasourcesConfig: {auto_discover_columns?: boolean | "auto";@@ -4011,14 +4013,14 @@ export interface components {* DebugCellCommand* @description Enter debugger mode for a cell.*- * Starts the Python debugger (pdb) for the specified cell.+ * Starts the Python debugger (pdb) for the specified cell.*- * Attributes:- * cell_id: Cell to debug.- * request: HTTP request context if available.+ * Attributes:+ * cell_id: Cell to debug.+ * request: HTTP request context if available.*/DebugCellCommand: {- cellId: string;+ cellId: components["schemas"]["CellId"];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;/** @enum {unknown} */@@ -4026,7 +4028,7 @@ export interface components {};/** DebugCellRequest */DebugCellRequest: {- cellId: string;+ cellId: components["schemas"]["CellId"];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;};@@ -4035,7 +4037,7 @@ export interface components {* @description Remove a cell from the notebook.*/DeleteCell: {- cellId: string;+ cellId: components["schemas"]["CellId"];/** @enum {unknown} */type: "delete-cell";};@@ -4043,20 +4045,20 @@ export interface components {* DeleteCellCommand* @description Delete a cell from the notebook.*- * Removes cell from the dependency graph and cleans up its variables.- * Dependent cells may become stale.+ * Removes cell from the dependency graph and cleans up its variables.+ * Dependent cells may become stale.*- * Attributes:- * cell_id: Cell to delete.+ * Attributes:+ * cell_id: Cell to delete.*/DeleteCellCommand: {- cellId: string;+ cellId: components["schemas"]["CellId"];/** @enum {unknown} */type: "delete-cell";};/** DeleteCellRequest */DeleteCellRequest: {- cellId: string;+ cellId: components["schemas"]["CellId"];};/** DeleteSecretRequest */DeleteSecretRequest: {@@ -4082,10 +4084,10 @@ export interface components {* DiagnosticsConfig* @description Configuration options for diagnostics.*- * **Keys.**+ * **Keys.***- * - `enabled`: if `True`, diagnostics will be shown in the editor- * - `sql_linter`: if `True`, SQL cells will have linting enabled+ * - `enabled`: if `True`, diagnostics will be shown in the editor+ * - `sql_linter`: if `True`, SQL cells will have linting enabled*/DiagnosticsConfig: {enabled?: boolean;@@ -4095,17 +4097,17 @@ export interface components {* DisplayConfig* @description Configuration for display.*- * **Keys.**+ * **Keys.***- * - `theme`: `"light"`, `"dark"`, or `"system"`- * - `code_editor_font_size`: font size for the code editor- * - `cell_output`: `"above"` or `"below"`- * - `dataframes`: `"rich"` or `"plain"`- * - `custom_css`: list of paths to custom CSS files- * - `default_table_page_size`: default number of rows to display in tables- * - `default_table_max_columns`: default maximum number of columns to display in tables- * - `reference_highlighting`: if `True`, highlight reactive variable references- * - `locale`: locale for date formatting and internationalization (e.g., "en-US", "en-GB", "de-DE")+ * - `theme`: `"light"`, `"dark"`, or `"system"`+ * - `code_editor_font_size`: font size for the code editor+ * - `cell_output`: `"above"` or `"below"`+ * - `dataframes`: `"rich"` or `"plain"`+ * - `custom_css`: list of paths to custom CSS files+ * - `default_table_page_size`: default number of rows to display in tables+ * - `default_table_max_columns`: default maximum number of columns to display in tables+ * - `reference_highlighting`: if `True`, highlight reactive variable references+ * - `locale`: locale for date formatting and internationalization (e.g., "en-US", "en-GB", "de-DE")*/DisplayConfig: {/** @enum {unknown} */@@ -4127,17 +4129,17 @@ export interface components {* ExecuteCellCommand* @description Execute a single cell.*- * Executes a cell with the provided code. Dependent cells may be- * re-executed based on the reactive execution mode.+ * Executes a cell with the provided code. Dependent cells may be+ * re-executed based on the reactive execution mode.*- * Attributes:- * cell_id: Cell to execute.- * code: Python code to execute.- * request: HTTP request context if available.- * timestamp: Unix timestamp when command was created.+ * Attributes:+ * cell_id: Cell to execute.+ * code: Python code to execute.+ * request: HTTP request context if available.+ * timestamp: Unix timestamp when command was created.*/ExecuteCellCommand: {- cellId: string;+ cellId: components["schemas"]["CellId"];code: string;/** @default null */request?: components["schemas"]["HTTPRequest"] | null;@@ -4149,17 +4151,17 @@ export interface components {* ExecuteCellsCommand* @description Execute multiple cells in a batch.*- * Executes multiple cells with their corresponding code. The kernel manages- * dependency tracking and reactive execution.+ * Executes multiple cells with their corresponding code. The kernel manages+ * dependency tracking and reactive execution.*- * Attributes:- * cell_ids: Cells to execute.- * codes: Python code for each cell. Must match length of cell_ids.- * request: HTTP request context if available.- * timestamp: Unix timestamp when command was created.+ * Attributes:+ * cell_ids: Cells to execute.+ * codes: Python code for each cell. Must match length of cell_ids.+ * request: HTTP request context if available.+ * timestamp: Unix timestamp when command was created.*/ExecuteCellsCommand: {- cellIds: string[];+ cellIds: components["schemas"]["CellId"][];codes: string[];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;@@ -4169,7 +4171,7 @@ export interface components {};/** ExecuteCellsRequest */ExecuteCellsRequest: {- cellIds: string[];+ cellIds: components["schemas"]["CellId"][];codes: string[];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;@@ -4178,16 +4180,16 @@ export interface components {* ExecuteScratchpadCommand* @description Execute code in the scratchpad.*- * The scratchpad is a temporary execution environment that doesn't affect- * the notebook's cells or dependencies. Runs in an isolated cell with a copy- * of the global namespace, useful for experimentation.+ * The scratchpad is a temporary execution environment that doesn't affect+ * the notebook's cells or dependencies. Runs in an isolated cell with a copy+ * of the global namespace, useful for experimentation.*- * Attributes:- * code: Python code to execute.- * request: HTTP request context if available.- * notebook_cells: Snapshot of notebook cells from the session document.- * Used to populate the document ContextVar so code_mode can read- * cell ordering, code, names, and configs.+ * Attributes:+ * code: Python code to execute.+ * request: HTTP request context if available.+ * notebook_cells: Snapshot of notebook cells from the session document.+ * Used to populate the document ContextVar so code_mode can read+ * cell ordering, code, names, and configs.*/ExecuteScratchpadCommand: {code: string;@@ -4210,11 +4212,11 @@ export interface components {* ExecuteStaleCellsCommand* @description Execute all stale cells.*- * Cells become stale when their dependencies change but haven't been- * re-executed yet. Brings the notebook to a consistent state.+ * Cells become stale when their dependencies change but haven't been+ * re-executed yet. Brings the notebook to a consistent state.*- * Attributes:- * request: HTTP request context if available.+ * Attributes:+ * request: HTTP request context if available.*/ExecuteStaleCellsCommand: {/** @default null */@@ -4383,8 +4385,8 @@ export interface components {* FocusCellNotification* @description Focuses a cell (kiosk mode).*- * Attributes:- * cell_id: Cell to focus.+ * Attributes:+ * cell_id: Cell to focus.*/FocusCellNotification: {cell_id: components["schemas"]["CellId"];@@ -4393,7 +4395,7 @@ export interface components {};/** FocusCellRequest */FocusCellRequest: {- cellId: string;+ cellId: components["schemas"]["CellId"];};/** FormatCellsRequest */FormatCellsRequest: {@@ -4412,9 +4414,9 @@ export interface components {* FormattingConfig* @description Configuration for code formatting.*- * **Keys.**+ * **Keys.***- * - `line_length`: max line length+ * - `line_length`: max line length*/FormattingConfig: {line_length: number;@@ -4423,10 +4425,10 @@ export interface components {* FunctionCallResultNotification* @description Result of a frontend-initiated function call.*- * Attributes:- * function_call_id: ID matching the original request.- * return_value: Function return value as JSON.- * status: Human-readable success/failure status.+ * Attributes:+ * function_call_id: ID matching the original request.+ * return_value: Function return value as JSON.+ * status: Human-readable success/failure status.*/FunctionCallResultNotification: {function_call_id: components["schemas"]["RequestId"];@@ -4439,7 +4441,7 @@ export interface components {* GetCacheInfoCommand* @description Retrieve cache statistics.*- * Collects cache usage info across all contexts (hit/miss rates, time saved, disk usage).+ * Collects cache usage info across all contexts (hit/miss rates, time saved, disk usage).*/GetCacheInfoCommand: {/** @enum {unknown} */@@ -4451,13 +4453,13 @@ export interface components {* GitHubConfig* @description Configuration options for GitHub.*- * **Keys.**+ * **Keys.***- * - `api_key`: the GitHub API token- * - `base_url`: the base URL for the API- * - `copilot_settings`: configuration settings for GitHub Copilot LSP.- * Supports settings like `http` (proxy configuration), `telemetry`,- * and `github-enterprise` (enterprise URI).+ * - `api_key`: the GitHub API token+ * - `base_url`: the base URL for the API+ * - `copilot_settings`: configuration settings for GitHub Copilot LSP.+ * Supports settings like `http` (proxy configuration), `telemetry`,+ * and `github-enterprise` (enterprise URI).*/GitHubConfig: {api_key?: string;@@ -4468,9 +4470,9 @@ export interface components {* GoogleAiConfig* @description Configuration options for Google AI.*- * **Keys.**+ * **Keys.***- * - `api_key`: the Google AI API key+ * - `api_key`: the Google AI API key*/GoogleAiConfig: {api_key?: string;@@ -4479,18 +4481,18 @@ export interface components {* HTTPRequest* @description Serializable HTTP request representation.*- * Mimics Starlette/FastAPI Request but is pickle-able and contains only a safe- * subset of data. Excludes session and auth to prevent exposing sensitive data.+ * Mimics Starlette/FastAPI Request but is pickle-able and contains only a safe+ * subset of data. Excludes session and auth to prevent exposing sensitive data.*- * Attributes:- * url: Serialized URL with path, port, scheme, netloc, query, hostname.- * base_url: Serialized base URL.- * headers: Request headers (marimo-specific headers excluded).- * query_params: Query parameters mapped to lists of values.- * path_params: Path parameters from the URL route.- * cookies: Request cookies.- * meta: User-defined storage for custom data.- * user: User info from authentication middleware (e.g., is_authenticated, username).+ * Attributes:+ * url: Serialized URL with path, port, scheme, netloc, query, hostname.+ * base_url: Serialized base URL.+ * headers: Request headers (marimo-specific headers excluded).+ * query_params: Query parameters mapped to lists of values.+ * path_params: Path parameters from the URL route.+ * cookies: Request cookies.+ * meta: User-defined storage for custom data.+ * user: User info from authentication middleware (e.g., is_authenticated, username).*/HTTPRequest: {base_url: Record<string, any>;@@ -4512,10 +4514,10 @@ export interface components {* HumanReadableStatus* @description Human-readable status for operation results.*- * Attributes:- * code: Status code ("ok" or "error").- * title: Optional short title.- * message: Optional detailed description.+ * Attributes:+ * code: Status code ("ok" or "error").+ * title: Optional short title.+ * message: Optional detailed description.*/HumanReadableStatus: {/** @enum {unknown} */@@ -4537,17 +4539,17 @@ export interface components {* InstallPackagesCommand* @description Install Python packages.*- * Installs missing packages using the specified package manager. Triggered- * automatically on import errors or manually by the user.+ * Installs missing packages using the specified package manager. Triggered+ * automatically on import errors or manually by the user.*- * Attributes:- * manager: Package manager to use ('pip', 'conda', 'uv', etc.).- * versions: Package names mapped to version specifiers. Empty version- * means install latest.- * source: Where to install. "kernel" (default) dispatches to the kernel- * subprocess; "server" installs directly into the server's Python- * environment (sys.executable), used when the server itself needs- * a package (e.g. nbformat for IPYNB auto-export in sandbox mode).+ * Attributes:+ * manager: Package manager to use ('pip', 'conda', 'uv', etc.).+ * versions: Package names mapped to version specifiers. Empty version+ * means install latest.+ * source: Where to install. "kernel" (default) dispatches to the kernel+ * subprocess; "server" installs directly into the server's Python+ * environment (sys.executable), used when the server itself needs+ * a package (e.g. nbformat for IPYNB auto-export in sandbox mode).*/InstallPackagesCommand: {manager: string;@@ -4578,10 +4580,10 @@ export interface components {* InstallingPackageAlertNotification* @description Package installation progress with streaming logs.*- * Attributes:- * packages: Package name to status (queued/installing/installed/failed).- * logs: Optional streaming logs per package.- * log_status: Log stream status (append/start/done).+ * Attributes:+ * packages: Package name to status (queued/installing/installed/failed).+ * logs: Optional streaming logs per package.+ * log_status: Log stream status (append/start/done).*/InstallingPackageAlertNotification: {/** @default null */@@ -4604,7 +4606,7 @@ export interface components {codes?: {[key: string]: string;} | null;- objectIds: string[];+ objectIds: components["schemas"]["UIElementId"][];values: unknown[];};/**@@ -4632,17 +4634,17 @@ export interface components {* InvokeFunctionCommand* @description Invoke a function from a UI element.*- * Called when a UI element needs to invoke a Python function.+ * Called when a UI element needs to invoke a Python function.*- * Attributes:- * function_call_id: Unique identifier for this call.- * namespace: Namespace where the function is registered.- * function_name: Function to invoke.- * args: Keyword arguments for the function.+ * Attributes:+ * function_call_id: Unique identifier for this call.+ * namespace: Namespace where the function is registered.+ * function_name: Function to invoke.+ * args: Keyword arguments for the function.*/InvokeFunctionCommand: {args: Record<string, any>;- functionCallId: string;+ functionCallId: components["schemas"]["RequestId"];functionName: string;namespace: string;/** @enum {unknown} */@@ -4651,7 +4653,7 @@ export interface components {/** InvokeFunctionRequest */InvokeFunctionRequest: {args: Record<string, any>;- functionCallId: string;+ functionCallId: components["schemas"]["RequestId"];functionName: string;namespace: string;};@@ -4659,13 +4661,13 @@ export interface components {* KernelCapabilitiesNotification* @description Kernel capabilities detected at startup.*- * All fields auto-detected in __post_init__.+ * All fields auto-detected in __post_init__.*- * Attributes:- * terminal: Terminal access (unavailable on Windows/Pyodide).- * pylsp: Python Language Server Protocol installed.- * ty: ty type checker installed.- * basedpyright: basedpyright type checker installed.+ * Attributes:+ * terminal: Terminal access (unavailable on Windows/Pyodide).+ * pylsp: Python Language Server Protocol installed.+ * ty: ty type checker installed.+ * basedpyright: basedpyright type checker installed.*/KernelCapabilitiesNotification: {/** @default false */@@ -4683,20 +4685,20 @@ export interface components {* KernelReadyNotification* @description Kernel ready for execution. First notification sent at startup.*- * Attributes:- * cell_ids: Cell IDs in order.- * codes: Source code for each cell.- * names: Cell names/titles.- * layout: Notebook layout config.- * configs: Per-cell configuration.- * resumed: Whether resumed from previous session.- * ui_values: Previous UI element values if resumed.- * last_executed_code: Last executed code per cell if resumed.- * last_execution_time: Last execution time per cell if resumed.- * app_config: Application configuration.- * kiosk: Whether running in kiosk mode.- * capabilities: Available kernel capabilities.- * auto_instantiated: Whether cells already executed (run mode).+ * Attributes:+ * cell_ids: Cell IDs in order.+ * codes: Source code for each cell.+ * names: Cell names/titles.+ * layout: Notebook layout config.+ * configs: Per-cell configuration.+ * resumed: Whether resumed from previous session.+ * ui_values: Previous UI element values if resumed.+ * last_executed_code: Last executed code per cell if resumed.+ * last_execution_time: Last execution time per cell if resumed.+ * app_config: Application configuration.+ * kiosk: Whether running in kiosk mode.+ * capabilities: Available kernel capabilities.+ * auto_instantiated: Whether cells already executed (run mode).*/KernelReadyNotification: {app_config: components["schemas"]["_AppConfig"];@@ -4724,8 +4726,8 @@ export interface components {* KernelStartupErrorNotification* @description Kernel failed to start.*- * Attributes:- * error: Error message describing failure.+ * Attributes:+ * error: Error message describing failure.*/KernelStartupErrorNotification: {error: string;@@ -4736,12 +4738,12 @@ export interface components {* KeymapConfig* @description Configuration for keymaps.*- * **Keys.**+ * **Keys.***- * - `preset`: one of `"default"` or `"vim"`- * - `overrides`: a dict of keymap actions to their keymap override- * - `vimrc`: path to a vimrc file to load keymaps from- * - `destructive_delete`: if `True`, allows deleting cells with content.+ * - `preset`: one of `"default"` or `"vim"`+ * - `overrides`: a dict of keymap actions to their keymap override+ * - `vimrc`: path to a vimrc file to load keymaps from+ * - `destructive_delete`: if `True`, allows deleting cells with content.*/KeymapConfig: {destructive_delete?: boolean;@@ -4851,12 +4853,12 @@ export interface components {* LanguageServersConfig* @description Configuration options for language servers.*- * **Keys.**+ * **Keys.***- * - `pylsp`: the pylsp config- * - `basedpyright`: the basedpyright config- * - `ty`: the ty config- * - `pyrefly`: the pyrefly config+ * - `pylsp`: the pylsp config+ * - `basedpyright`: the basedpyright config+ * - `ty`: the ty config+ * - `pyrefly`: the pyrefly config*/LanguageServersConfig: {basedpyright?: components["schemas"]["BasedpyrightServerConfig"];@@ -4873,16 +4875,16 @@ export interface components {* LintConfig* @description Configuration for lint rule selection.*- * Follows ruff-inspired semantics for selecting which rules to run- * during ``marimo check``.+ * Follows ruff-inspired semantics for selecting which rules to run+ * during ``marimo check``.*- * **Keys.**+ * **Keys.***- * - ``select``: list of rule code prefixes that replaces the default- * enabled set. Use ``"ALL"`` to select all rules.- * Example: ``["MB", "MR001"]``- * - ``ignore``: list of rule code prefixes to remove from the- * enabled set.+ * - ``select``: list of rule code prefixes that replaces the default+ * enabled set. Use ``"ALL"`` to select all rules.+ * Example: ``["MB", "MR001"]``+ * - ``ignore``: list of rule code prefixes to remove from the+ * enabled set.*/LintConfig: {ignore?: string[];@@ -4892,10 +4894,10 @@ export interface components {* ListDataSourceConnectionCommand* @description List data source schemas.*- * Retrieves available schemas for a data source engine.+ * Retrieves available schemas for a data source engine.*- * Attributes:- * engine: Data source engine identifier.+ * Attributes:+ * engine: Data source engine identifier.*/ListDataSourceConnectionCommand: {engine: string;@@ -4914,18 +4916,18 @@ export interface components {* ListSQLSchemasCommand* @description List schemas in an SQL database.*- * Retrieves names of all schemas in a database. Used by the SQL editor for- * schema selection.+ * Retrieves names of all schemas in a database. Used by the SQL editor for+ * schema selection.*- * Attributes:- * request_id: Unique identifier for this request.- * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).- * database: Database to query.+ * Attributes:+ * request_id: Unique identifier for this request.+ * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).+ * database: Database to query.*/ListSQLSchemasCommand: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];/** @enum {unknown} */type: "list-sql-schemas";};@@ -4933,25 +4935,25 @@ export interface components {ListSQLSchemasRequest: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];};/*** ListSQLTablesCommand* @description List tables in an SQL schema.*- * Retrieves names of all tables and views in a schema. Used by the SQL- * editor for table selection.+ * Retrieves names of all tables and views in a schema. Used by the SQL+ * editor for table selection.*- * Attributes:- * request_id: Unique identifier for this request.- * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).- * database: Database to query.- * schema: Schema to list tables from.+ * Attributes:+ * request_id: Unique identifier for this request.+ * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).+ * database: Database to query.+ * schema: Schema to list tables from.*/ListSQLTablesCommand: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];schema: string;/** @enum {unknown} */type: "list-sql-tables";@@ -4960,26 +4962,26 @@ export interface components {ListSQLTablesRequest: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];schema: string;};/*** ListSecretKeysCommand* @description List available secret keys.*- * Retrieves secret names without exposing values.+ * Retrieves secret names without exposing values.*- * Attributes:- * request_id: Unique identifier for this request.+ * Attributes:+ * request_id: Unique identifier for this request.*/ListSecretKeysCommand: {- requestId: string;+ requestId: components["schemas"]["RequestId"];/** @enum {unknown} */type: "list-secret-keys";};/** ListSecretKeysRequest */ListSecretKeysRequest: {- requestId: string;+ requestId: components["schemas"]["RequestId"];};/** ListSecretKeysResponse */ListSecretKeysResponse: {@@ -5018,12 +5020,12 @@ export interface components {* LspServerHealth* @description Health status for a single LSP server.*- * Status meanings:- * - starting: process launched, initializing- * - running: healthy and responsive to pings- * - stopped: not running (never started or cleanly stopped)- * - crashed: exited with non-zero code- * - unresponsive: process alive but not responding to pings+ * Status meanings:+ * - starting: process launched, initializing+ * - running: healthy and responsive to pings+ * - stopped: not running (never started or cleanly stopped)+ * - crashed: exited with non-zero code+ * - unresponsive: process alive but not responding to pings*/LspServerHealth: {/** @default null */@@ -5127,7 +5129,7 @@ export interface components {name: string;path: string;/** @default null */- sessionId?: string | null;+ sessionId?: components["schemas"]["SessionId"] | null;};/*** MarimoInternalError@@ -5189,12 +5191,12 @@ export interface components {* MissingPackageAlertNotification* @description Alert for missing packages with install option.*- * Attributes:- * packages: Missing package names.- * isolated: Whether auto-install is possible in this environment.- * source: Which Python environment to install into. "kernel" (default)- * installs in the kernel's venv; "server" installs in the- * server's own Python env (e.g. for formatter tools like ruff).+ * Attributes:+ * packages: Missing package names.+ * isolated: Whether auto-install is possible in this environment.+ * source: Which Python environment to install into. "kernel" (default)+ * installs in the kernel's venv; "server" installs in the+ * server's own Python env (e.g. for formatter tools like ruff).*/MissingPackageAlertNotification: {isolated: boolean;@@ -5219,20 +5221,20 @@ export interface components {* ModelCommand* @description Widget model message command.*- * Handles widget model communication between frontend and backend.+ * Handles widget model communication between frontend and backend.*- * Attributes:- * model_id: Widget model identifier.- * message: Model message (update or custom).- * buffers: Base64-encoded binary buffers.- * token: Unique identifier for deduplication across dual queues.+ * Attributes:+ * model_id: Widget model identifier.+ * message: Model message (update or custom).+ * buffers: Base64-encoded binary buffers.+ * token: Unique identifier for deduplication across dual queues.*/ModelCommand: {buffers: components["schemas"]["Base64String"][];message:| components["schemas"]["ModelUpdateMessage"]| components["schemas"]["ModelCustomMessage"];- modelId: string;+ modelId: components["schemas"]["WidgetModelId"];token?: string;/** @enum {unknown} */type: "model";@@ -5251,8 +5253,8 @@ export interface components {* ModelCustomMessage* @description Custom widget message.*- * Attributes:- * content: Arbitrary content for the custom message.+ * Attributes:+ * content: Arbitrary content for the custom message.*/ModelCustomMessage: {content: unknown;@@ -5263,11 +5265,11 @@ export interface components {* ModelLifecycleNotification* @description Widget model lifecycle message.*- * Mirrors the Jupyter widget comm protocol with open/update/custom/close.+ * Mirrors the Jupyter widget comm protocol with open/update/custom/close.*- * Attributes:- * model_id: Widget model identifier.- * message: The lifecycle message (open/update/custom/close).+ * Attributes:+ * model_id: Widget model identifier.+ * message: The lifecycle message (open/update/custom/close).*/ModelLifecycleNotification: {message:@@ -5296,7 +5298,7 @@ export interface components {message:| components["schemas"]["ModelUpdateMessage"]| components["schemas"]["ModelCustomMessage"];- modelId: string;+ modelId: components["schemas"]["WidgetModelId"];token?: string;};/**@@ -5314,9 +5316,9 @@ export interface components {* ModelUpdateMessage* @description Widget model state update message.*- * Attributes:- * state: Model state updates.- * buffer_paths: Paths within state dict pointing to binary buffers.+ * Attributes:+ * state: Model state updates.+ * buffer_paths: Paths within state dict pointing to binary buffers.*/ModelUpdateMessage: {bufferPaths: (string | number)[][];@@ -5333,7 +5335,7 @@ export interface components {after?: components["schemas"]["CellId"] | null;/** @default null */before?: components["schemas"]["CellId"] | null;- cellId: string;+ cellId: components["schemas"]["CellId"];/** @enum {unknown} */type: "move-cell";};@@ -5358,8 +5360,8 @@ export interface components {* NotebookDocumentTransactionNotification* @description Broadcasts an applied transaction to the frontend.*- * Sent by the session when the document changes (from any source).- * The frontend applies the ops to update its local state.+ * Sent by the session when the document changes (from any source).+ * The frontend applies the ops to update its local state.*/NotebookDocumentTransactionNotification: {/** @enum {unknown} */@@ -5382,15 +5384,15 @@ export interface components {* OpenAiConfig* @description Configuration options for OpenAI or OpenAI-compatible services.*- * **Keys.**+ * **Keys.***- * - `api_key`: the OpenAI API key- * - `base_url`: the base URL for the API- * - `project`: the project ID for the OpenAI API- * - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx defaults to true, but some use cases to let users override to False in some testing scenarios- * - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates. Used to create custom SSL context for httpx client- * - `client_pem` : custom path of a client .pem cert used for verifying identity of client server- * - `extra_headers`: extra headers to be passed to the OpenAI client+ * - `api_key`: the OpenAI API key+ * - `base_url`: the base URL for the API+ * - `project`: the project ID for the OpenAI API+ * - `ssl_verify` : Boolean argument for httpx passed to open ai client. httpx defaults to true, but some use cases to let users override to False in some testing scenarios+ * - `ca_bundle_path`: custom ca bundle to be used for verifying SSL certificates. Used to create custom SSL context for httpx client+ * - `client_pem` : custom path of a client .pem cert used for verifying identity of client server+ * - `extra_headers`: extra headers to be passed to the OpenAI client*/OpenAiConfig: {api_key?: string;@@ -5408,9 +5410,9 @@ export interface components {* OpenGraphMetadata* @description OpenGraph-style metadata for a notebook.*- * The `image` field may be either:- * - a relative path (typically under `__marimo__/`), or- * - an absolute HTTPS URL.+ * The `image` field may be either:+ * - a relative path (typically under `__marimo__/`), or+ * - an absolute HTTPS URL.*/OpenGraphMetadata: {/** @default null */@@ -5445,9 +5447,9 @@ export interface components {* PackageManagementConfig* @description Configuration options for package management.*- * **Keys.**+ * **Keys.***- * - `manager`: the package manager to use+ * - `manager`: the package manager to use*/PackageManagementConfig: {/** @enum {unknown} */@@ -5463,15 +5465,15 @@ export interface components {* PreviewDatasetColumnCommand* @description Preview a dataset column.*- * Retrieves and displays data from a single column (dataframe or SQL table).- * Used by the data explorer UI.+ * Retrieves and displays data from a single column (dataframe or SQL table).+ * Used by the data explorer UI.*- * Attributes:- * source_type: Data source type ('dataframe', 'sql', etc.).- * source: Source identifier (connection string or variable name).- * table_name: Table or dataframe variable name.- * column_name: Column to preview.- * fully_qualified_table_name: Full database.schema.table name for SQL.+ * Attributes:+ * source_type: Data source type ('dataframe', 'sql', etc.).+ * source: Source identifier (connection string or variable name).+ * table_name: Table or dataframe variable name.+ * column_name: Column to preview.+ * fully_qualified_table_name: Full database.schema.table name for SQL.*/PreviewDatasetColumnCommand: {columnName: string;@@ -5498,20 +5500,20 @@ export interface components {* PreviewSQLTableCommand* @description Preview SQL table details.*- * Retrieves metadata and sample data for a table. Used by the SQL editor- * and data explorer.+ * Retrieves metadata and sample data for a table. Used by the SQL editor+ * and data explorer.*- * Attributes:- * request_id: Unique identifier for this request.- * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).- * database: Database containing the table.- * schema: Schema containing the table.- * table_name: Table to preview.+ * Attributes:+ * request_id: Unique identifier for this request.+ * engine: SQL engine ('postgresql', 'mysql', 'duckdb', etc.).+ * database: Database containing the table.+ * schema: Schema containing the table.+ * table_name: Table to preview.*/PreviewSQLTableCommand: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];schema: string;tableName: string;/** @enum {unknown} */@@ -5521,7 +5523,7 @@ export interface components {PreviewSQLTableRequest: {database: string;engine: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];schema: string;tableName: string;};@@ -5553,9 +5555,9 @@ export interface components {* QueryParamsAppendNotification* @description Appends value to URL query parameter.*- * Attributes:- * key: Query parameter key.- * value: Value to append.+ * Attributes:+ * key: Query parameter key.+ * value: Value to append.*/QueryParamsAppendNotification: {key: string;@@ -5575,9 +5577,9 @@ export interface components {* QueryParamsDeleteNotification* @description Deletes URL query parameter values.*- * Attributes:- * key: Query parameter key.- * value: Specific value to delete. If None, deletes all values for key.+ * Attributes:+ * key: Query parameter key.+ * value: Specific value to delete. If None, deletes all values for key.*/QueryParamsDeleteNotification: {key: string;@@ -5589,9 +5591,9 @@ export interface components {* QueryParamsSetNotification* @description Sets URL query parameter, replacing existing values.*- * Attributes:- * key: Query parameter key.- * value: Value(s) to set.+ * Attributes:+ * key: Query parameter key.+ * value: Value(s) to set.*/QueryParamsSetNotification: {key: string;@@ -5619,7 +5621,7 @@ export interface components {* RefreshSecretsCommand* @description Refresh secrets from the secrets store.*- * Reloads secrets from the provider without restarting the kernel.+ * Reloads secrets from the provider without restarting the kernel.*/RefreshSecretsCommand: {/** @enum {unknown} */@@ -5643,10 +5645,10 @@ export interface components {* RemoveUIElementsNotification* @description Removes UI elements associated with a cell.*- * Sent when cell is re-executed or deleted.+ * Sent when cell is re-executed or deleted.*- * Attributes:- * cell_id: Cell whose UI elements should be removed.+ * Attributes:+ * cell_id: Cell whose UI elements should be removed.*/RemoveUIElementsNotification: {cell_id: components["schemas"]["CellId"];@@ -5657,10 +5659,10 @@ export interface components {* RenameNotebookCommand* @description Rename or move the notebook file.*- * Updates the notebook's filename in the kernel metadata.+ * Updates the notebook's filename in the kernel metadata.*- * Attributes:- * filename: New filename or path for the notebook.+ * Attributes:+ * filename: New filename or path for the notebook.*/RenameNotebookCommand: {filename: string;@@ -5675,14 +5677,15 @@ export interface components {* ReorderCells* @description Replace the full cell ordering.*- * Cell IDs present in the document but missing from ``cell_ids``- * are appended at the end. IDs not in the document are ignored.+ * Cell IDs present in the document but missing from ``cell_ids``+ * are appended at the end. IDs not in the document are ignored.*/ReorderCells: {- cellIds: string[];+ cellIds: components["schemas"]["CellId"][];/** @enum {unknown} */type: "reorder-cells";};+ /** Format: request-id */RequestId: TypedString<"RequestId">;/** RunningNotebooksResponse */RunningNotebooksResponse: {@@ -5692,46 +5695,46 @@ export interface components {* RuntimeConfig* @description Configuration for runtime.*- * **Keys.**- *- * - `auto_instantiate`: if `False`, cells won't automatically- * run on startup. This only applies when editing a notebook,- * and not when running as an application.- * The default is `True`.- * - `auto_reload`: if `lazy`, cells importing modified modules will marked- * as stale; if `autorun`, affected cells will be automatically run. similar- * to IPython's %autoreload extension but with more code intelligence.- * - `reactive_tests`: if `True`, marimo will automatically run pytest on cells containing only test functions and test classes.- * execution.- * - `on_cell_change`: if `lazy`, cells will be marked stale when their- * ancestors run but won't autorun; if `autorun`, cells will automatically- * run when their ancestors run.- * - `execution_type`: if `relaxed`, marimo will not clone cell declarations;- * if `strict` marimo will clone cell declarations by default, avoiding- * hidden potential state build up.- * - `watcher_on_save`: how to handle file changes when saving. `"lazy"` marks- * affected cells as stale, `"autorun"` automatically runs affected cells.- * - `output_max_bytes`: the maximum size in bytes of cell outputs; larger- * values may affect frontend performance- * - `serve_cached_sessions_in_apps`: if `True`, initialize applications with session cache.- * The default is `False`.- * - `std_stream_max_bytes`: the maximum size in bytes of console outputs;- * larger values may affect frontend performance- * - `pythonpath`: a list of directories to add to the Python search path.- * Directories will be added to the head of sys.path. Similar to the- * `PYTHONPATH` environment variable, the directories will be included in- * where Python will look for imported modules.- * - `dotenv`: a list of paths to `.env` files to load.- * If the file does not exist, it will be silently ignored.- * The default is `[".env"]` if a pyproject.toml is found, otherwise `[]`.- * - `default_sql_output`: the default output format for SQL queries. Can be one of:- * `"auto"`, `"native"`, `"polars"`, `"lazy-polars"`, or `"pandas"`.- * The default is `"auto"`.- * - `default_auto_download`: an Optional list of export types to automatically snapshot your notebook as:- * `html`, `markdown`, `ipynb`.- * The default is None.- * - `default_csv_encoding`: the default encoding for CSV exports.- * The default is `"utf-8"`.+ * **Keys.**+ *+ * - `auto_instantiate`: if `False`, cells won't automatically+ * run on startup. This only applies when editing a notebook,+ * and not when running as an application.+ * The default is `True`.+ * - `auto_reload`: if `lazy`, cells importing modified modules will marked+ * as stale; if `autorun`, affected cells will be automatically run. similar+ * to IPython's %autoreload extension but with more code intelligence.+ * - `reactive_tests`: if `True`, marimo will automatically run pytest on cells containing only test functions and test classes.+ * execution.+ * - `on_cell_change`: if `lazy`, cells will be marked stale when their+ * ancestors run but won't autorun; if `autorun`, cells will automatically+ * run when their ancestors run.+ * - `execution_type`: if `relaxed`, marimo will not clone cell declarations;+ * if `strict` marimo will clone cell declarations by default, avoiding+ * hidden potential state build up.+ * - `watcher_on_save`: how to handle file changes when saving. `"lazy"` marks+ * affected cells as stale, `"autorun"` automatically runs affected cells.+ * - `output_max_bytes`: the maximum size in bytes of cell outputs; larger+ * values may affect frontend performance+ * - `serve_cached_sessions_in_apps`: if `True`, initialize applications with session cache.+ * The default is `False`.+ * - `std_stream_max_bytes`: the maximum size in bytes of console outputs;+ * larger values may affect frontend performance+ * - `pythonpath`: a list of directories to add to the Python search path.+ * Directories will be added to the head of sys.path. Similar to the+ * `PYTHONPATH` environment variable, the directories will be included in+ * where Python will look for imported modules.+ * - `dotenv`: a list of paths to `.env` files to load.+ * If the file does not exist, it will be silently ignored.+ * The default is `[".env"]` if a pyproject.toml is found, otherwise `[]`.+ * - `default_sql_output`: the default output format for SQL queries. Can be one of:+ * `"auto"`, `"native"`, `"polars"`, `"lazy-polars"`, or `"pandas"`.+ * The default is `"auto"`.+ * - `default_auto_download`: an Optional list of export types to automatically snapshot your notebook as:+ * `html`, `markdown`, `ipynb`.+ * The default is None.+ * - `default_csv_encoding`: the default encoding for CSV exports.+ * The default is `"utf-8"`.*/RuntimeConfig: {auto_instantiate: boolean;@@ -5761,9 +5764,9 @@ export interface components {* SQLDatabaseMetadata* @description SQL database metadata.*- * Attributes:- * connection: Connection identifier.- * database: Database name.+ * Attributes:+ * connection: Connection identifier.+ * database: Database name.*/SQLDatabaseMetadata: {connection: string;@@ -5773,10 +5776,10 @@ export interface components {* SQLMetadata* @description SQL database and schema metadata.*- * Attributes:- * connection: Connection identifier.- * database: Database name.- * schema: Schema name.+ * Attributes:+ * connection: Connection identifier.+ * database: Database name.+ * schema: Schema name.*/SQLMetadata: {connection: string;@@ -5789,11 +5792,11 @@ export interface components {* SQLSchemaListPreviewNotification* @description List of SQL schemas in a database.*- * Attributes:- * request_id: Request ID this responds to.- * metadata: Database and schema metadata.- * schemas: Schemas in database.- * error: Error message if failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * metadata: Database and schema metadata.+ * schemas: Schemas in database.+ * error: Error message if failed.*/SQLSchemaListPreviewNotification: {/** @default null */@@ -5809,11 +5812,11 @@ export interface components {* SQLTableListPreviewNotification* @description List of SQL tables in a schema.*- * Attributes:- * request_id: Request ID this responds to.- * metadata: Database and schema metadata.- * tables: Tables in schema.- * error: Error message if failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * metadata: Database and schema metadata.+ * tables: Tables in schema.+ * error: Error message if failed.*/SQLTableListPreviewNotification: {/** @default null */@@ -5829,11 +5832,11 @@ export interface components {* SQLTablePreviewNotification* @description SQL table preview.*- * Attributes:- * request_id: Request ID this responds to.- * metadata: Database and schema metadata.- * table: Table data (None if error).- * error: Error message if failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * metadata: Database and schema metadata.+ * table: Table data (None if error).+ * error: Error message if failed.*/SQLTablePreviewNotification: {/** @default null */@@ -5852,11 +5855,11 @@ export interface components {* SaveConfig* @description Configuration for saving.*- * **Keys.**+ * **Keys.***- * - `autosave`: one of `"off"` or `"after_delay"`- * - `delay`: number of milliseconds to wait before autosaving- * - `format_on_save`: if `True`, format the code on save+ * - `autosave`: one of `"off"` or `"after_delay"`+ * - `delay`: number of milliseconds to wait before autosaving+ * - `format_on_save`: if `True`, format the code on save*/SaveConfig: {/** @enum {unknown} */@@ -5866,7 +5869,7 @@ export interface components {};/** SaveNotebookRequest */SaveNotebookRequest: {- cellIds: string[];+ cellIds: components["schemas"]["CellId"][];codes: string[];configs: components["schemas"]["CellConfig"][];filename: string;@@ -5900,9 +5903,9 @@ export interface components {* SecretKeysResultNotification* @description Available secret keys from secret providers.*- * Attributes:- * request_id: Request ID this responds to.- * secrets: Secret keys with provider info.+ * Attributes:+ * request_id: Request ID this responds to.+ * secrets: Secret keys with provider info.*/SecretKeysResultNotification: {/** @enum {unknown} */@@ -5921,27 +5924,28 @@ export interface components {* ServerConfig* @description Configuration for the server.*- * **Keys.**+ * **Keys.***- * - `browser`: the web browser to use. `"default"` or a browser registered- * with Python's webbrowser module (eg, `"firefox"` or `"chrome"`)- * - `follow_symlink`: if true, the server will follow symlinks it finds- * inside its static assets directory.- * - `disable_file_downloads`: if true, the file download button will be- * hidden in the file explorer.+ * - `browser`: the web browser to use. `"default"` or a browser registered+ * with Python's webbrowser module (eg, `"firefox"` or `"chrome"`)+ * - `follow_symlink`: if true, the server will follow symlinks it finds+ * inside its static assets directory.+ * - `disable_file_downloads`: if true, the file download button will be+ * hidden in the file explorer.*/ServerConfig: {browser: "default" | string;disable_file_downloads?: boolean;follow_symlink: boolean;};+ /** Format: session-id */SessionId: TypedString<"SessionId">;/*** SetCode* @description Replace a cell's source code.*/SetCode: {- cellId: string;+ cellId: components["schemas"]["CellId"];code: string;/** @enum {unknown} */type: "set-code";@@ -5951,7 +5955,7 @@ export interface components {* @description Partially update a cell's config. None fields are unchanged.*/SetConfig: {- cellId: string;+ cellId: components["schemas"]["CellId"];/** @default null */column?: number | null;/** @default null */@@ -5966,7 +5970,7 @@ export interface components {* @description Rename a cell.*/SetName: {- cellId: string;+ cellId: components["schemas"]["CellId"];name: string;/** @enum {unknown} */type: "set-name";@@ -5981,10 +5985,10 @@ export interface components {* SharingConfig* @description Configuration for sharing features.*- * **Keys.**+ * **Keys.***- * - `html`: if `False`, HTML sharing options will be hidden from the UI- * - `wasm`: if `False`, WebAssembly sharing options will be hidden from the UI+ * - `html`: if `False`, HTML sharing options will be hidden from the UI+ * - `wasm`: if `False`, WebAssembly sharing options will be hidden from the UI*/SharingConfig: {html?: boolean;@@ -5992,7 +5996,7 @@ export interface components {};/** ShutdownSessionRequest */ShutdownSessionRequest: {- sessionId: string;+ sessionId: components["schemas"]["SessionId"];};/** Snippet */Snippet: {@@ -6015,9 +6019,9 @@ export interface components {* SnippetsConfig* @description Configuration for snippets.*- * **Keys.**+ * **Keys.***- * - `custom_path`: the path to the custom snippets directory+ * - `custom_path`: the path to the custom snippets directory*/SnippetsConfig: {custom_paths?: string[];@@ -6064,9 +6068,9 @@ export interface components {* StartupLogsNotification* @description Streaming kernel startup logs.*- * Attributes:- * content: Log content to display.- * status: Stream status (start/append/done).+ * Attributes:+ * content: Log content to display.+ * status: Stream status (start/append/done).*/StartupLogsNotification: {content: string;@@ -6083,8 +6087,8 @@ export interface components {* StopKernelCommand* @description Stop kernel execution.*- * Signals the kernel to stop processing and shut down gracefully.- * Used when closing a notebook or terminating a session.+ * Signals the kernel to stop processing and shut down gracefully.+ * Used when closing a notebook or terminating a session.*/StopKernelCommand: {/** @enum {unknown} */@@ -6094,15 +6098,15 @@ export interface components {* StorageDownloadCommand* @description Download a storage entry.*- * Obtains a pre-signed URL or downloads the file locally and returns a virtual file URL- * so the frontend can fetch the contents.+ * Obtains a pre-signed URL or downloads the file locally and returns a virtual file URL+ * so the frontend can fetch the contents.*- * Attributes:- * request_id: Unique identifier for this request.- * namespace: Variable name identifying the storage backend.- * path: Full path of the entry to download.- * preview: If true, a local preview of the file is returned.- * This is useful if you need to bypass CORS.+ * Attributes:+ * request_id: Unique identifier for this request.+ * namespace: Variable name identifying the storage backend.+ * path: Full path of the entry to download.+ * preview: If true, a local preview of the file is returned.+ * This is useful if you need to bypass CORS.*/StorageDownloadCommand: {namespace: string;@@ -6117,14 +6121,14 @@ export interface components {* StorageDownloadReadyNotification* @description Signals that a storage file download is ready.*- * The url may be a signed cloud URL (preferred) or a virtual file URL- * (fallback for backends that don't support signing).+ * The url may be a signed cloud URL (preferred) or a virtual file URL+ * (fallback for backends that don't support signing).*- * Attributes:- * request_id: Request ID this responds to.- * url: Signed or virtual-file URL to download from.- * filename: Suggested filename for the download.- * error: Error message if the download failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * url: Signed or virtual-file URL to download from.+ * filename: Suggested filename for the download.+ * error: Error message if the download failed.*/StorageDownloadReadyNotification: {/** @default null */@@ -6143,19 +6147,19 @@ export interface components {path: string;/** @default false */preview?: boolean;- requestId: string;+ requestId: components["schemas"]["RequestId"];};/*** StorageEntriesNotification* @description Result of a storage operation that returns entries.*- * Attributes:- * request_id: Request ID this responds to.- * entries: Storage entries returned by the operation.- * namespace: Variable name of the storage backend.- * prefix: The prefix that was listed (set by list_entries).- * query: The search query that was used (set by search).- * error: Error message if the operation failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * entries: Storage entries returned by the operation.+ * namespace: Variable name of the storage backend.+ * prefix: The prefix that was listed (set by list_entries).+ * query: The search query that was used (set by search).+ * error: Error message if the operation failed.*/StorageEntriesNotification: {entries: components["schemas"]["StorageEntry"][];@@ -6174,13 +6178,13 @@ export interface components {* StorageEntry* @description A storage entry is a file, directory, or object for external storage systems*- * Attributes:- * path: The path of the storage entry.- * kind: The kind of the storage entry.- * size: The size of the storage entry.- * last_modified: The last modified time of the storage entry.- * metadata: The metadata of the storage entry.- * mime_type: The MIME type of the storage entry, or None for directories.+ * Attributes:+ * path: The path of the storage entry.+ * kind: The kind of the storage entry.+ * size: The size of the storage entry.+ * last_modified: The last modified time of the storage entry.+ * metadata: The metadata of the storage entry.+ * mime_type: The MIME type of the storage entry, or None for directories.*/StorageEntry: {/** @enum {unknown} */@@ -6197,14 +6201,14 @@ export interface components {* StorageListEntriesCommand* @description List storage entries at a prefix.*- * Navigates storage like a folder tree using delimiter-based listing.- * Returns entries (files/objects) and virtual directories at one level.+ * Navigates storage like a folder tree using delimiter-based listing.+ * Returns entries (files/objects) and virtual directories at one level.*- * Attributes:- * request_id: Unique identifier for this request.- * namespace: Variable name identifying the storage backend.- * limit: Max entries to return.- * prefix: Path prefix to list (None = root).+ * Attributes:+ * request_id: Unique identifier for this request.+ * namespace: Variable name identifying the storage backend.+ * limit: Max entries to return.+ * prefix: Path prefix to list (None = root).*/StorageListEntriesCommand: {limit: number;@@ -6221,19 +6225,19 @@ export interface components {namespace: string;/** @default null */prefix?: string | null;- requestId: string;+ requestId: components["schemas"]["RequestId"];};/*** StorageNamespace* @description Represents external storage systems (filesystems and object storage)*- * Attributes:- * name: The variable name of the storage namespace.- * display_name: The display name of the storage namespace.- * protocol: The protocol of the storage namespace. E.g. s3, gcs, azure, http, file, in-memory.- * root_path: The root path of the storage namespace.- * backend_type: The type of the storage backend (fsspec or obstore)- * storage_entries: The storage entries in the storage namespace.+ * Attributes:+ * name: The variable name of the storage namespace.+ * display_name: The display name of the storage namespace.+ * protocol: The protocol of the storage namespace. E.g. s3, gcs, azure, http, file, in-memory.+ * root_path: The root path of the storage namespace.+ * backend_type: The type of the storage backend (fsspec or obstore)+ * storage_entries: The storage entries in the storage namespace.*/StorageNamespace: {/** @enum {unknown} */@@ -6248,8 +6252,8 @@ export interface components {* StorageNamespacesNotification* @description Available storage namespaces for storage inspector.*- * Attributes:- * namespaces: Available storage namespaces.+ * Attributes:+ * namespaces: Available storage namespaces.*/StorageNamespacesNotification: {namespaces: components["schemas"]["StorageNamespace"][];@@ -6274,14 +6278,14 @@ export interface components {* SyncGraphCommand* @description Synchronize the kernel graph with file manager state.*- * Used when the notebook file changes externally (e.g., file reload or version control).- * Updates changed cells, deletes removed cells, and optionally executes modified cells.+ * Used when the notebook file changes externally (e.g., file reload or version control).+ * Updates changed cells, deletes removed cells, and optionally executes modified cells.*- * Attributes:- * cells: All cells known to file manager, mapping cell_id to code.- * run_ids: Cells to execute or update.- * delete_ids: Cells to delete from the graph.- * timestamp: Unix timestamp when command was created.+ * Attributes:+ * cells: All cells known to file manager, mapping cell_id to code.+ * run_ids: Cells to execute or update.+ * delete_ids: Cells to delete from the graph.+ * timestamp: Unix timestamp when command was created.*/SyncGraphCommand: {cells: {@@ -6309,9 +6313,9 @@ export interface components {* Transaction* @description An atomic batch of changes applied to a NotebookDocument.*- * ``source`` identifies the writer (e.g. ``"frontend"``, ``"kernel"``).- * ``version`` is ``None`` when created and stamped by- * ``NotebookDocument.apply()``.+ * ``source`` identifies the writer (e.g. ``"frontend"``, ``"kernel"``).+ * ``version`` is ``None`` when created and stamped by+ * ``NotebookDocument.apply()``.*/Transaction: {changes: (@@ -6337,15 +6341,16 @@ export interface components {TyLanguageServerConfig: {enabled?: boolean;};+ /** Format: ui-element-id */UIElementId: `${components["schemas"]["CellId"]}-${string}`;/*** UIElementMessageNotification* @description Sends a message to a UI element/widget.*- * Attributes:- * ui_element: UI element identifier.- * message: Message payload as dictionary.- * buffers: Optional binary buffers for large data.+ * Attributes:+ * ui_element: UI element identifier.+ * message: Message payload as dictionary.+ * buffers: Optional binary buffers for large data.*/UIElementMessageNotification: {/** @default null */@@ -6367,11 +6372,11 @@ export interface components {* UpdateCellConfigCommand* @description Update cell configuration.*- * Updates cell-level settings like disabled state, hide code, etc.+ * Updates cell-level settings like disabled state, hide code, etc.*- * Attributes:- * configs: Cell IDs mapped to their config updates. Each config dict- * can contain partial updates.+ * Attributes:+ * configs: Cell IDs mapped to their config updates. Each config dict+ * can contain partial updates.*/UpdateCellConfigCommand: {configs: {@@ -6424,17 +6429,17 @@ export interface components {* UpdateUIElementCommand* @description Update UI element values.*- * Triggered when users interact with UI elements (sliders, inputs, dropdowns, etc.).- * Updates element values and re-executes dependent cells.+ * Triggered when users interact with UI elements (sliders, inputs, dropdowns, etc.).+ * Updates element values and re-executes dependent cells.*- * Attributes:- * object_ids: UI elements to update.- * values: New values for the elements. Must match length of object_ids.- * request: HTTP request context if available.- * token: Unique request identifier for deduplication.+ * Attributes:+ * object_ids: UI elements to update.+ * values: New values for the elements. Must match length of object_ids.+ * request: HTTP request context if available.+ * token: Unique request identifier for deduplication.*/UpdateUIElementCommand: {- objectIds: string[];+ objectIds: components["schemas"]["UIElementId"][];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;token?: string;@@ -6444,7 +6449,7 @@ export interface components {};/** UpdateUIElementRequest */UpdateUIElementRequest: {- objectIds: string[];+ objectIds: components["schemas"]["UIElementId"][];/** @default null */request?: components["schemas"]["HTTPRequest"] | null;token?: string;@@ -6452,17 +6457,17 @@ export interface components {};/** UpdateUIElementValuesRequest */UpdateUIElementValuesRequest: {- objectIds: string[];+ objectIds: components["schemas"]["UIElementId"][];values: unknown[];};/*** UpdateUserConfigCommand* @description Update user configuration.*- * Updates global marimo configuration (runtime settings, display options, editor preferences).+ * Updates global marimo configuration (runtime settings, display options, editor preferences).*- * Attributes:- * config: Complete user configuration.+ * Attributes:+ * config: Complete user configuration.*/UpdateUserConfigCommand: {config: components["schemas"]["MarimoConfig"];@@ -6477,15 +6482,15 @@ export interface components {* ValidateSQLCommand* @description Validate an SQL query.*- * Checks if an SQL query is valid by parsing against a dialect (no DB connection)- * or validating against an actual database.+ * Checks if an SQL query is valid by parsing against a dialect (no DB connection)+ * or validating against an actual database.*- * Attributes:- * request_id: Unique identifier for this request.- * query: SQL query to validate.- * only_parse: If True, only parse using dialect. If False, validate against DB.- * engine: SQL engine (required if only_parse is False).- * dialect: SQL dialect for parsing (required if only_parse is True).+ * Attributes:+ * request_id: Unique identifier for this request.+ * query: SQL query to validate.+ * only_parse: If True, only parse using dialect. If False, validate against DB.+ * engine: SQL engine (required if only_parse is False).+ * dialect: SQL dialect for parsing (required if only_parse is True).*/ValidateSQLCommand: {/** @default null */@@ -6494,7 +6499,7 @@ export interface components {engine?: string | null;onlyParse: boolean;query: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];/** @enum {unknown} */type: "validate-sql";};@@ -6506,17 +6511,17 @@ export interface components {engine?: string | null;onlyParse: boolean;query: string;- requestId: string;+ requestId: components["schemas"]["RequestId"];};/*** ValidateSQLResultNotification* @description SQL query validation result.*- * Attributes:- * request_id: Request ID this responds to.- * parse_result: SQL parsing result.- * validate_result: Catalog validation result.- * error: Error message if failed.+ * Attributes:+ * request_id: Request ID this responds to.+ * parse_result: SQL parsing result.+ * validate_result: Catalog validation result.+ * error: Error message if failed.*/ValidateSQLResultNotification: {/** @default null */@@ -6539,25 +6544,26 @@ export interface components {* VariableDeclarationNotification* @description Variable declaration and usage for dataflow graph.*- * Attributes:- * name: Variable name.- * declared_by: Cell IDs that define this variable.- * used_by: Cell IDs that use this variable.+ * Attributes:+ * name: Variable name.+ * declared_by: Cell IDs that define this variable.+ * used_by: Cell IDs that use this variable.*/VariableDeclarationNotification: {declared_by: components["schemas"]["CellId"][];- name: string;+ name: components["schemas"]["VariableName"];used_by: components["schemas"]["CellId"][];};+ /** Format: variable-name */VariableName: TypedString<"VariableName">;/*** VariableValue* @description Variable value and type for variables panel.*- * Attributes:- * name: Variable name.- * value: String representation of value.- * datatype: Data type as string.+ * Attributes:+ * name: Variable name.+ * value: String representation of value.+ * datatype: Data type as string.*/VariableValue: {datatype: string | null;@@ -6568,8 +6574,8 @@ export interface components {* VariableValuesNotification* @description Current variable values.*- * Attributes:- * variables: Variables with current values and types.+ * Attributes:+ * variables: Variables with current values and types.*/VariableValuesNotification: {/** @enum {unknown} */@@ -6580,8 +6586,8 @@ export interface components {* VariablesNotification* @description Variable dataflow graph.*- * Attributes:- * variables: Variable declarations and usage.+ * Attributes:+ * variables: Variable declarations and usage.*/VariablesNotification: {/** @enum {unknown} */@@ -6592,20 +6598,21 @@ export interface components {* VenvConfig* @description Configuration for external Python environment in home sandbox mode.*- * Allows specifying an existing virtualenv to use instead of creating- * ephemeral sandboxes per notebook. Only applies in home sandbox mode.+ * Allows specifying an existing virtualenv to use instead of creating+ * ephemeral sandboxes per notebook. Only applies in home sandbox mode.*- * **Keys.**+ * **Keys.***- * - `path`: path to a virtualenv directory (absolute or relative to- * pyproject.toml)- * - `writable`: if true, marimo will manage script metadata (inline- * dependencies). Defaults to false.+ * - `path`: path to a virtualenv directory (absolute or relative to+ * pyproject.toml)+ * - `writable`: if true, marimo will manage script metadata (inline+ * dependencies). Defaults to false.*/VenvConfig: {path?: string;writable?: boolean;};+ /** Format: widget-model-id */WidgetModelId: TypedString<"WidgetModelId">;/** WorkspaceFilesRequest */WorkspaceFilesRequest: {@@ -6625,8 +6632,8 @@ export interface components {* _AppConfig* @description Program-specific configuration.*- * Configuration for frontends or runtimes that is specific to- * a single marimo program.+ * Configuration for frontends or runtimes that is specific to+ * a single marimo program.*/_AppConfig: {/** @default null */diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex df99074dbe..71bf8a01c9 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -751,6 +751,9 @@ importers:openapi-typescript:specifier: ^7.8.0version: 7.8.0([email protected])+ typescript:+ specifier: ^5.9.3+ version: 5.9.3packages/smart-cells:dependencies: