@marimo-team/islands 0.25.3-dev29 → 0.25.3-dev291

package/src/hooks/useDebounce.ts

@@ -2,6 +2,7 @@
 import { debounce } from "lodash-es";
 import { useEffect, useMemo, useState } from "react";
 import useEvent from "react-use-event-hook";
+import { useInternalStateWithSync } from "./useInternalStateWithSync";
 
 export function useDebounce<T>(value: T, delay: number): T {
   const [debouncedValue, setDebouncedValue] = useState<T>(value);
@@ -41,18 +42,14 @@ export function useDebounceControlledState<T>(opts: {
   disabled?: boolean;
 }) {
   const { initialValue, onChange, delay, disabled } = opts;
-  const [internalValue, setInternalValue] = useState<T>(initialValue);
+  const [internalValue, setInternalValue] = useInternalStateWithSync(
+    initialValue,
+    Object.is,
+  );
   const debouncedValue = useDebounce(internalValue, delay || 200);
 
   const onUpdate = useEvent(onChange);
 
-  // Handle external changes:
-  useEffect(() => {
-    // TODO: Replace this synchronization with a controlled-state primitive.
-    // oxlint-disable-next-line react/no-deriving-state-in-effects -- Synchronize the debounced draft when the controlled value changes.
-    setInternalValue(initialValue);
-  }, [initialValue]);
-
   // Handle debounced updates for user input
   useEffect(() => {
     if (disabled) {
@@ -80,8 +77,7 @@ export function useDebounceControlledState<T>(opts: {
   };
 }
 
-// oxlint-disable-next-line typescript/no-explicit-any
-export function useDebouncedCallback<T extends (...args: any[]) => unknown>(
+export function useDebouncedCallback<T extends (...args: never[]) => unknown>(
   callback: T,
   delay: number,
 ) {

package/src/hooks/useDeepCompareMemoize.ts

@@ -12,7 +12,7 @@ import React from "react";
  * Useful when the re-render if more expensive than the deep compare.
  */
 export function useDeepCompareMemoize<T>(value: T) {
-  const ref = React.useRef<T>(value);
+  const ref = React.useRef(value);
 
   if (!dequal(value, ref.current)) {
     ref.current = value;

package/src/hooks/useDelayElapsed.ts

@@ -1,6 +1,6 @@
 /* Copyright 2026 Marimo. All rights reserved. */
 
-import { useLayoutEffect, useState } from "react";
+import { useEffect, useState } from "react";
 
 /**
  * Returns `false` until `delayMs` has elapsed since mount (or since `delayMs`
@@ -8,20 +8,24 @@ import { useLayoutEffect, useState } from "react";
  * `delayMs <= 0`. Useful for suppressing spinner/fallback flashes.
  */
 export function useDelayElapsed(delayMs: number): boolean {
-  const [elapsed, setElapsed] = useState(delayMs <= 0);
+  const [timer, setTimer] = useState({ delayMs, elapsed: delayMs <= 0 });
 
-  // Layout effect (not a plain effect) so that when `delayMs` flips from `<= 0`
-  // to `> 0` — e.g. a gate re-closing — we reset `elapsed` to `false` before
-  // the browser paints, rather than briefly flashing the fallback for a frame.
-  useLayoutEffect(() => {
+  // Reset during render so a changed delay never commits a stale `elapsed`
+  // (e.g. a gate re-closing shows no fallback flash before paint)
+  if (!Object.is(timer.delayMs, delayMs)) {
+    setTimer({ delayMs, elapsed: delayMs <= 0 });
+  }
+
+  useEffect(() => {
     if (delayMs <= 0) {
-      setElapsed(true);
       return;
     }
-    setElapsed(false);
-    const timeout = setTimeout(() => setElapsed(true), delayMs);
+    const timeout = setTimeout(
+      () => setTimer({ delayMs, elapsed: true }),
+      delayMs,
+    );
     return () => clearTimeout(timeout);
   }, [delayMs]);
 
-  return elapsed;
+  return timer.elapsed;
 }

package/src/hooks/useElapsedTime.ts

@@ -1,13 +1,13 @@
 /* Copyright 2026 Marimo. All rights reserved. */
 
-import { useEffect, useRef, useState } from "react";
+import { useEffect, useState } from "react";
 import { type Milliseconds, Time } from "@/utils/time";
 
 /**
  * Returns the elapsed time since mount, in milliseconds.
  */
 export function useElapsedTime(initialStartTimeMs: Milliseconds) {
-  const startTime = useRef(initialStartTimeMs);
+  const [startTime] = useState(initialStartTimeMs);
   const [endTime, setEndTime] = useState(initialStartTimeMs);
 
   useEffect(() => {
@@ -21,5 +21,5 @@ export function useElapsedTime(initialStartTimeMs: Milliseconds) {
     return () => clearInterval(interval);
   }, []);
 
-  return endTime - startTime.current;
+  return endTime - startTime;
 }

package/src/hooks/useEventListener.ts

@@ -62,8 +62,7 @@ export function useEventListener(
       return;
     }
 
-    // oxlint-disable-next-line typescript/no-explicit-any
-    const eventListener = (event: any) => savedListener.current(event);
+    const eventListener = (event: Event) => savedListener.current(event);
     target.addEventListener(type, eventListener, options);
 
     return () => {

package/src/hooks/useInputHistory.ts

@@ -37,12 +37,9 @@ export function useInputHistory({
   const historyIndexRef = React.useRef<number>(-1);
   // Store the current input when navigating history
   const pendingInputRef = React.useRef<string>("");
-  // Keep a ref to history for use in callbacks without causing re-renders
-  const historyRef = React.useRef(history);
-  historyRef.current = history;
 
   const navigateUp = React.useCallback(() => {
-    const currentHistory = historyRef.current;
+    const currentHistory = history;
     if (currentHistory.length === 0) {
       return;
     }
@@ -59,10 +56,10 @@ export function useInputHistory({
       historyIndexRef.current = newIndex;
       setValue(currentHistory[currentHistory.length - 1 - newIndex]);
     }
-  }, [value, setValue]);
+  }, [history, value, setValue]);
 
   const navigateDown = React.useCallback(() => {
-    const currentHistory = historyRef.current;
+    const currentHistory = history;
     if (currentHistory.length === 0) {
       return;
     }
@@ -79,7 +76,7 @@ export function useInputHistory({
       historyIndexRef.current = -1;
       setValue(pendingInputRef.current);
     }
-  }, [setValue]);
+  }, [history, setValue]);
 
   const addToHistory = React.useCallback((command: string) => {
     setHistory((prev) => {

package/src/hooks/useInternalStateWithSync.ts

@@ -1,5 +1,5 @@
 /* Copyright 2026 Marimo. All rights reserved. */
-import { useRef, useState } from "react";
+import { useState } from "react";
 
 type EqualityFn<T> = (a: T, b: T) => boolean;
 
@@ -13,13 +13,13 @@ export function useInternalStateWithSync<T>(
   initial: T,
   equalityFn: EqualityFn<T> = defaultEqualityFn,
 ) {
-  const [state, setState] = useState(initial);
-  const ref = useRef(initial);
+  const [state, setState] = useState(() => initial);
+  const [previousInitial, setPreviousInitial] = useState(() => initial);
 
   // Whenever the outside state changes, update the internal state
-  if (!equalityFn(ref.current, initial)) {
-    setState(initial); // react is ok to setState during render
-    ref.current = initial;
+  if (!equalityFn(previousInitial, initial)) {
+    setState(() => initial);
+    setPreviousInitial(() => initial);
   }
 
   return [state, setState] as const;

package/src/hooks/useResizeObserver.ts

@@ -6,6 +6,7 @@
 
 import type { RefObject } from "react";
 import { useEffect, useRef } from "react";
+import useEvent from "react-use-event-hook";
 
 interface Size {
   width: number | undefined;
@@ -30,9 +31,7 @@ export function useResizeObserver<T extends HTMLElement = HTMLElement>(
   const { ref, box = "content-box", skip } = options;
   // oxlint-disable-next-line react/hook-use-state
   const previousSize = useRef<Size>({ ...initialSize });
-  const onResize = useRef<((size: Size) => void) | undefined>(undefined);
-  // oxlint-disable-next-line react-hooks/react-compiler
-  onResize.current = options.onResize;
+  const onResize = useEvent((size: Size) => options.onResize?.(size));
 
   useEffect(() => {
     if (!ref.current || skip) {
@@ -63,9 +62,7 @@ export function useResizeObserver<T extends HTMLElement = HTMLElement>(
         previousSize.current.width = newWidth;
         previousSize.current.height = newHeight;
 
-        if (onResize.current) {
-          onResize.current(newSize);
-        }
+        onResize(newSize);
       }
     });
 
@@ -74,7 +71,7 @@ export function useResizeObserver<T extends HTMLElement = HTMLElement>(
     return () => {
       observer.disconnect();
     };
-  }, [box, ref, skip]);
+  }, [box, ref, skip, onResize]);
 }
 
 type BoxSizesKey = keyof Pick<

package/src/hooks/useScript.ts

@@ -1,90 +1,87 @@
 /* Copyright 2026 Marimo. All rights reserved. */
-import React from "react";
+import { useCallback, useSyncExternalStore } from "react";
 
 type ScriptStatus = "loading" | "ready" | "error" | "unknown";
 interface ScriptOptions {
   removeOnUnmount?: boolean;
 }
 
+interface ScriptEntry {
+  element: HTMLScriptElement;
+  listeners: Set<() => void>;
+  /** Whether useScript created the element, and so may remove it. */
+  owned: boolean;
+}
+
 const defaultOptions = { removeOnUnmount: false };
 
+// One entry per src, so reading the status on render is a map lookup
+const scripts = new Map<string, ScriptEntry>();
+
+function findScript(src: string): HTMLScriptElement | undefined {
+  // Compare attributes rather than building a selector, which `src` could break
+  return [...document.scripts].find(
+    (script) => script.getAttribute("src") === src,
+  );
+}
+
+function acquireScript(src: string): ScriptEntry {
+  const cached = scripts.get(src);
+  if (cached?.element.isConnected) {
+    return cached;
+  }
+  const existing = findScript(src);
+  const element = existing ?? document.createElement("script");
+  const entry: ScriptEntry = {
+    element,
+    listeners: new Set(),
+    owned: !existing,
+  };
+  const setStatus = (status: ScriptStatus) => {
+    element.dataset.status = status;
+    entry.listeners.forEach((listener) => listener());
+  };
+  // Listen for the script's lifetime rather than per subscriber, so the
+  // status still settles if the first subscriber unmounts mid-load.
+  element.addEventListener("load", () => setStatus("ready"), { once: true });
+  element.addEventListener("error", () => setStatus("error"), { once: true });
+  if (!existing) {
+    element.src = src;
+    element.async = true;
+    element.dataset.status = "loading";
+    document.body.append(element);
+  }
+  scripts.set(src, entry);
+  return entry;
+}
+
 export function useScript(
   src: string,
   options: ScriptOptions = defaultOptions,
 ) {
-  const [status, setStatus] = React.useState<ScriptStatus>(() => {
-    const existingScript = document.querySelector<HTMLScriptElement>(
-      `script[src="${src}"]`,
-    );
-    return (existingScript?.dataset.status as ScriptStatus) || "unknown";
-  });
-
-  React.useEffect(() => {
-    let script = document.querySelector<HTMLScriptElement>(
-      `script[src="${src}"]`,
-    );
-
-    const updateStatus = (newStatus: ScriptStatus) => {
-      if (script) {
-        script.dataset.status = newStatus;
-        setStatus(newStatus);
-      }
-    };
-
-    const handleScriptLoad = () => updateStatus("ready");
-    const handleScriptError = () => updateStatus("error");
-
-    // observes DOM changes and updates the status
-    const observeScript = (script: HTMLScriptElement) => {
-      const observer = new MutationObserver(() => {
-        const newStatus = script.dataset.status;
-        if (newStatus) {
-          setStatus(newStatus as ScriptStatus);
-        }
-      });
-      observer.observe(script, {
-        attributes: true,
-        attributeFilter: ["data-status"],
-      });
-      return observer;
-    };
-
-    if (!script) {
-      script = document.createElement("script");
-      script.src = src;
-      script.async = true;
-      updateStatus("loading");
-      document.body.append(script);
-
-      script.addEventListener("load", handleScriptLoad);
-      script.addEventListener("error", handleScriptError);
-
-      const observer = observeScript(script);
+  const { removeOnUnmount } = options;
+  const getSnapshot = useCallback((): ScriptStatus => {
+    const cached = scripts.get(src)?.element;
+    const element = cached?.isConnected ? cached : findScript(src);
+    return (element?.dataset.status as ScriptStatus) || "unknown";
+  }, [src]);
 
+  const subscribe = useCallback(
+    (onChange: () => void) => {
+      const entry = acquireScript(src);
+      entry.listeners.add(onChange);
       return () => {
-        observer.disconnect();
-        if (script) {
-          script.removeEventListener("load", handleScriptLoad);
-          script.removeEventListener("error", handleScriptError);
-
-          if (options.removeOnUnmount) {
-            script.remove();
+        entry.listeners.delete(onChange);
+        if (removeOnUnmount && entry.owned && entry.listeners.size === 0) {
+          entry.element.remove();
+          if (scripts.get(src) === entry) {
+            scripts.delete(src);
           }
         }
       };
-    }
-
-    const domStatus = script.dataset.status;
-    if (domStatus) {
-      if (domStatus === "ready" || domStatus === "error") {
-        return;
-      }
-      const observer = observeScript(script);
-      return () => observer.disconnect();
-    }
-
-    setStatus("unknown");
-  }, [src, options.removeOnUnmount]);
+    },
+    [src, removeOnUnmount],
+  );
 
-  return status;
+  return useSyncExternalStore(subscribe, getSnapshot);
 }

package/src/hooks/useStateForKey.ts

@@ -0,0 +1,93 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+import { type SetStateAction, useCallback, useReducer } from "react";
+
+interface KeyedState<T> {
+  key: unknown;
+  value: T;
+}
+
+type KeyedAction<T> =
+  | { type: "reset"; state: KeyedState<T> }
+  | { type: "update"; key: unknown; update: SetStateAction<T> };
+
+function reduceKeyedState<T>(
+  previous: KeyedState<T>,
+  action: KeyedAction<T>,
+): KeyedState<T> {
+  if (action.type === "reset") {
+    return action.state;
+  }
+  if (!Object.is(previous.key, action.key)) {
+    return previous;
+  }
+  const value =
+    typeof action.update === "function"
+      ? (action.update as (previous: T) => T)(previous.value)
+      : action.update;
+  return Object.is(previous.value, value)
+    ? previous
+    : { key: action.key, value };
+}
+
+/**
+ * Local state that resets when its owner key changes.
+ *
+ * The key uses Object.is. NaN matches NaN, 0 differs from -0, and objects match
+ * by reference. Keep the key stable between resets. An inline object such as
+ * `{ id }` creates a new key on each render and causes a render loop.
+ *
+ * On a key change, this hook calls initialize() and schedules a state update
+ * during render. React retries the calling component before rendering its
+ * children. Children and effects receive the reset value without an intervening
+ * commit of the old value. This resets only this hook's state. The component
+ * stays mounted, and its other hooks keep their state.
+ *
+ * initialize must be pure. React can call it more than once in Strict Mode or
+ * when retrying an interrupted render. A new initializer alone does not reset
+ * state. The next key change uses the initializer from that render. After
+ * committed key changes A -> B -> A, A starts fresh instead of restoring its
+ * earlier value. If React abandons a pending render for B, the visible state
+ * for A remains intact, including edits made while B was pending.
+ *
+ * The setter accepts values or pure updater functions, like useState. To store
+ * a function, use setValue(() => callback). Its identity is stable for the same
+ * key and changes with the key. Updates from a different key are ignored,
+ * including their updater functions. After A -> B -> A, an old setter for A
+ * can update A again. This hook does not cancel requests. For request results,
+ * use a distinct key for each lifetime so late results stay invalid.
+ *
+ * React can still call the component for ignored or same-value updates.
+ * Render counts do not indicate how many changes React commits to the screen.
+ *
+ * Use useInternalStateWithSync when the external value itself supplies the
+ * reset value. Use this hook when a separate key controls the reset.
+ *
+ * @example
+ * const [expanded, setExpanded] = useStateForKey(tree, () => new Set<string>());
+ *
+ * @see https://react.dev/reference/react/useState#storing-information-from-previous-renders
+ */
+export function useStateForKey<T>(key: unknown, initialize: () => T) {
+  // useState can eagerly evaluate an updater against a suspended render's
+  // state. A reducer checks the key when React processes each render's queue,
+  // so the still-visible owner can accept edits during a transition.
+  const [stored, dispatch] = useReducer(reduceKeyedState<T>, key, (key) => ({
+    key,
+    value: initialize(),
+  }));
+  const current = Object.is(stored.key, key)
+    ? stored
+    : { key, value: initialize() };
+  if (current !== stored) {
+    dispatch({ type: "reset", state: current });
+  }
+
+  const setValue = useCallback(
+    (update: SetStateAction<T>) => {
+      dispatch({ type: "update", key, update });
+    },
+    [key],
+  );
+
+  return [current.value, setValue] as const;
+}

package/src/mount.tsx

@@ -5,8 +5,8 @@ import { Provider } from "jotai";
 import { createRoot } from "react-dom/client";
 import { z } from "zod";
 import {
-  appConfigAtom,
   configOverridesAtom,
+  pageAppConfigAtom,
   userConfigAtom,
 } from "@/core/config/config";
 import { KnownQueryParams } from "@/core/constants";
@@ -21,7 +21,7 @@ import {
 import { Logger } from "@/utils/Logger";
 import { ErrorBoundary } from "./components/editor/boundary/ErrorBoundary";
 import { notebookAtom } from "./core/cells/cells";
-import { notebookStateFromSession } from "./core/cells/session";
+import { readExport } from "./core/cells/session";
 import {
   parseAppConfig,
   parseConfigOverrides,
@@ -62,7 +62,8 @@ import {
 import { maybeRegisterVSCodeBindings } from "./core/vscode/vscode-bindings";
 import type { FileStore } from "./core/wasm/store";
 import { notebookFileStore } from "./core/wasm/store";
-import { ConnectionState } from "./core/websocket/types";
+import { embeddedSnapshotAtom } from "./core/session/embedded";
+import { ConnectionState } from "./core/session/types";
 import {
   handleWidgetMessage,
   WIDGET_REGISTRY,
@@ -274,8 +275,6 @@ const mountOptionsSchema = z.object({
       .transform((val) => val as api.Notebook["NotebookV1"]),
   ]),
 
-  notebookId: z.string().optional(),
-
   /**
    * Runtime configs
    */
@@ -286,7 +285,6 @@ const mountOptionsSchema = z.object({
         // Lazy by default, but can be overridden by the runtime config
         lazy: z.boolean().default(true),
         authToken: z.string().nullish(),
-        notebookId: z.string().optional(),
       }),
     )
     .nullish()
@@ -349,7 +347,8 @@ function initStore(options: unknown) {
     parseConfigOverrides(parsedOptions.data.configOverrides),
   );
   store.set(userConfigAtom, parseUserConfig(parsedOptions.data.config));
-  store.set(appConfigAtom, parseAppConfig(parsedOptions.data.appConfig));
+  store.set(pageAppConfigAtom, parsedOptions.data.appConfig);
+  const appConfig = parseAppConfig(parsedOptions.data.appConfig);
   store.set(pairConfigAtom, parsedOptions.data.pairConfig);
 
   // Runtime config
@@ -367,20 +366,26 @@ function initStore(options: unknown) {
   } else {
     store.set(runtimeConfigAtom, {
       ...DEFAULT_RUNTIME_CONFIG,
-      notebookId: parsedOptions.data.notebookId,
       lazy: false,
       serverToken: parsedOptions.data.serverToken,
     });
   }
 
-  // Session/notebook
-  const notebook = notebookStateFromSession(
-    parsedOptions.data.session,
-    parsedOptions.data.notebook,
-  );
+  // The notebook the page was served with shows until the host answers.
+  const { snapshot, cellRuntime } = readExport({
+    session: parsedOptions.data.session,
+    notebook: parsedOptions.data.notebook,
+    filename: parsedOptions.data.filename,
+    appConfig,
+  });
+  store.set(embeddedSnapshotAtom, snapshot);
   store.set(layoutStateAtom, initialLayoutState(parsedOptions.data.layout));
-  if (notebook) {
-    store.set(notebookAtom, notebook);
+  if (snapshot !== null) {
+    // The scratch cell keeps its own runtime; the snapshot has none for it.
+    store.set(notebookAtom, (state) => ({
+      ...state,
+      cellRuntime: { ...state.cellRuntime, ...cellRuntime },
+    }));
   }
 }
 

package/src/plugins/__tests__/plugin-object-schemas.test.ts

@@ -0,0 +1,104 @@
+/* Copyright 2026 Marimo. All rights reserved. */
+
+import { describe, expect, it } from "vitest";
+import { DataEditorPlugin } from "../impl/DataEditorPlugin";
+import { DataTablePlugin } from "../impl/DataTablePlugin";
+import { DataFramePlugin } from "../impl/data-frames/DataFramePlugin";
+import { PlotlyPlugin } from "../impl/plotly/PlotlyPlugin";
+import { VegaPlugin } from "../impl/vega/VegaPlugin";
+
+describe("plugin object schemas", () => {
+  const rows = [{ value: 1, extra: { nested: true } }];
+  const styles = { "0": { value: { color: "red", customProperty: 1 } } };
+  const tableData = {
+    initialValue: [],
+    label: null,
+    data: rows,
+    totalRows: 1,
+    totalColumns: 1,
+    rowHeaders: [],
+    cellStyles: styles,
+  };
+
+  it("preserves table rows and arbitrary cell style fields", () => {
+    expect(DataTablePlugin.validator.parse(tableData)).toMatchObject({
+      data: rows,
+      cellStyles: styles,
+      pageSize: 10,
+    });
+  });
+
+  it("preserves data editor row fields", () => {
+    expect(
+      DataEditorPlugin.validator.parse({
+        initialValue: { edits: [] },
+        label: null,
+        data: rows,
+        editableColumns: "all",
+      }),
+    ).toMatchObject({ data: rows, columnNames: [] });
+  });
+
+  it("preserves table RPC payload fields", () => {
+    const functions = DataTablePlugin.functions!;
+    const searchResult = {
+      data: rows,
+      total_rows: 1,
+      cell_styles: styles,
+      cell_hover_texts: null,
+    };
+    expect(functions.search.output.parse(searchResult)).toEqual(searchResult);
+    expect(functions.get_row_ids!.input.parse({ custom: true })).toEqual({
+      custom: true,
+    });
+    expect(functions.get_data_url!.input.parse({ custom: true })).toEqual({
+      custom: true,
+    });
+    expect(
+      functions.get_data_url!.output.parse({ data_url: rows, format: "json" }),
+    ).toEqual({ data_url: rows, format: "json" });
+  });
+
+  it("preserves dataframe search row fields", () => {
+    const result = { data: rows, total_rows: 1 };
+    expect(DataFramePlugin.functions!.search.output.parse(result)).toEqual(
+      result,
+    );
+  });
+
+  it("preserves Plotly figure and config fields", () => {
+    const data = {
+      figure: { data: [], layout: { title: "Chart" } },
+      config: { responsive: true },
+    };
+    expect(new PlotlyPlugin().validator.parse(data)).toEqual(data);
+  });
+
+  it("preserves Vega spec and embed options fields and defaults", () => {
+    const spec = { mark: "bar", encoding: { x: { field: "value" } } };
+    const validator = new VegaPlugin().validator;
+    expect(validator.parse({ spec })).toEqual({
+      spec,
+      chartSelection: true,
+      fieldSelection: true,
+      embedOptions: {},
+    });
+    expect(
+      validator.parse({ spec, embedOptions: { actions: false } }).embedOptions,
+    ).toEqual({ actions: false });
+  });
+
+  it("rejects scalar values where plugin objects are required", () => {
+    expect(
+      DataTablePlugin.validator.safeParse({ ...tableData, data: [42] }).success,
+    ).toBe(false);
+    expect(
+      new PlotlyPlugin().validator.safeParse({ figure: 42, config: {} })
+        .success,
+    ).toBe(false);
+    expect(
+      new VegaPlugin().validator.safeParse({ spec: {}, embedOptions: 42 })
+        .success,
+    ).toBe(false);
+  });
+});