@rocicorp/zero 0.26.0-canary.2 → 0.26.0-canary.3

package/out/zero-react/src/use-zero-virtualizer.js

@@ -0,0 +1,342 @@
+import { useVirtualizer, defaultKeyExtractor } from "@tanstack/react-virtual";
+import { useReducer, useMemo, useState, useEffect, useLayoutEffect } from "react";
+import { assert } from "../../shared/src/asserts.js";
+import { pagingReducer } from "./paging-reducer.js";
+import { useRows } from "./use-rows.js";
+const MIN_PAGE_SIZE = 100;
+const NUM_ROWS_FOR_LOADING_SKELETON = 1;
+const TOP_ANCHOR = Object.freeze({
+  index: 0,
+  kind: "forward",
+  startRow: void 0
+});
+const createPermalinkAnchor = (id) => ({
+  id,
+  index: NUM_ROWS_FOR_LOADING_SKELETON,
+  kind: "permalink"
+});
+function useZeroVirtualizer({
+  // Tanstack Virtual params
+  estimateSize,
+  overscan = 5,
+  // Virtualizer defaults to 1.
+  getScrollElement,
+  getItemKey = defaultKeyExtractor,
+  // Zero specific params
+  listContextParams,
+  permalinkID,
+  getPageQuery,
+  getSingleQuery,
+  options,
+  toStartRow,
+  getRowKey,
+  // Permalink state persistence
+  permalinkState,
+  onPermalinkStateChange,
+  ...restVirtualizerOptions
+}) {
+  const [
+    {
+      estimatedTotal,
+      hasReachedStart,
+      hasReachedEnd,
+      queryAnchor,
+      pagingPhase,
+      pendingScrollAdjustment
+    },
+    dispatch
+  ] = useReducer(
+    pagingReducer,
+    void 0,
+    () => {
+      const anchor2 = permalinkState ? permalinkState.anchor : permalinkID ? createPermalinkAnchor(permalinkID) : TOP_ANCHOR;
+      return {
+        estimatedTotal: permalinkState?.estimatedTotal ?? NUM_ROWS_FOR_LOADING_SKELETON,
+        hasReachedStart: permalinkState?.hasReachedStart ?? false,
+        hasReachedEnd: permalinkState?.hasReachedEnd ?? false,
+        queryAnchor: {
+          anchor: anchor2,
+          listContextParams
+        },
+        pagingPhase: "idle",
+        pendingScrollAdjustment: 0
+      };
+    }
+  );
+  const isListContextCurrent = queryAnchor.listContextParams === listContextParams;
+  const anchor = useMemo(() => {
+    if (isListContextCurrent) {
+      return queryAnchor.anchor;
+    }
+    return permalinkID ? createPermalinkAnchor(permalinkID) : TOP_ANCHOR;
+  }, [isListContextCurrent, queryAnchor.anchor, permalinkID]);
+  const [pageSize, setPageSize] = useState(MIN_PAGE_SIZE);
+  const {
+    rowAt,
+    rowsLength,
+    complete,
+    rowsEmpty,
+    atStart,
+    atEnd,
+    firstRowIndex,
+    permalinkNotFound
+  } = useRows({
+    pageSize,
+    anchor,
+    options,
+    getPageQuery,
+    getSingleQuery,
+    toStartRow
+  });
+  const newEstimatedTotal = firstRowIndex + rowsLength;
+  const virtualizer = useVirtualizer(
+    {
+      ...restVirtualizerOptions,
+      count: Math.max(estimatedTotal, newEstimatedTotal) + (!atEnd ? NUM_ROWS_FOR_LOADING_SKELETON : 0),
+      estimateSize,
+      overscan,
+      getScrollElement,
+      getItemKey: getRowKey ? (index) => {
+        const row = rowAt(index);
+        return row ? getRowKey(row) : getItemKey(index);
+      } : getItemKey,
+      initialOffset: () => {
+        if (permalinkState?.scrollTop !== void 0) {
+          return permalinkState.scrollTop;
+        }
+        if (anchor.kind === "permalink") {
+          return anchor.index * estimateSize(0);
+        }
+        return 0;
+      },
+      horizontal: false
+    }
+  );
+  useEffect(() => {
+    const newPageSize = virtualizer.scrollRect ? Math.max(
+      MIN_PAGE_SIZE,
+      makeEven(
+        Math.ceil(
+          virtualizer.scrollRect?.height / // TODO: Support dynamic item sizes
+          estimateSize(0)
+        ) * 3
+      )
+    ) : MIN_PAGE_SIZE;
+    if (newPageSize > pageSize) {
+      setPageSize(newPageSize);
+    }
+  }, [pageSize, virtualizer.scrollRect]);
+  useEffect(() => {
+    if (!isListContextCurrent || !onPermalinkStateChange) {
+      return;
+    }
+    const timeoutId = setTimeout(() => {
+      onPermalinkStateChange({
+        anchor,
+        scrollTop: virtualizer.scrollOffset ?? 0,
+        estimatedTotal,
+        hasReachedStart,
+        hasReachedEnd
+      });
+    }, 100);
+    return () => clearTimeout(timeoutId);
+  }, [
+    anchor,
+    virtualizer.scrollOffset,
+    estimatedTotal,
+    hasReachedStart,
+    hasReachedEnd,
+    isListContextCurrent,
+    onPermalinkStateChange
+  ]);
+  useEffect(() => {
+    if (atStart) {
+      dispatch({ type: "REACHED_START" });
+    }
+  }, [atStart]);
+  useEffect(() => {
+    if (atEnd) {
+      dispatch({ type: "REACHED_END" });
+    }
+  }, [atEnd]);
+  useEffect(() => {
+    if (complete && newEstimatedTotal > estimatedTotal) {
+      dispatch({ type: "UPDATE_ESTIMATED_TOTAL", newTotal: newEstimatedTotal });
+    }
+  }, [estimatedTotal, complete, newEstimatedTotal]);
+  useLayoutEffect(() => {
+    if (pendingScrollAdjustment !== 0) {
+      virtualizer.scrollToOffset(
+        (virtualizer.scrollOffset ?? 0) + pendingScrollAdjustment * // TODO: Support dynamic item sizes
+        estimateSize(0)
+      );
+      dispatch({ type: "SCROLL_ADJUSTED" });
+    }
+  }, [pendingScrollAdjustment, virtualizer]);
+  useEffect(() => {
+    if (rowsEmpty || !isListContextCurrent) {
+      return;
+    }
+    if (pagingPhase === "skipping" && pendingScrollAdjustment === 0) {
+      dispatch({ type: "PAGING_COMPLETE" });
+      return;
+    }
+    if (pendingScrollAdjustment !== 0) {
+      return;
+    }
+    if (firstRowIndex < 0) {
+      const placeholderRows = !atStart ? NUM_ROWS_FOR_LOADING_SKELETON : 0;
+      const offset = -firstRowIndex + placeholderRows;
+      const newAnchor = {
+        ...anchor,
+        index: anchor.index + offset
+      };
+      dispatch({ type: "SHIFT_ANCHOR_DOWN", offset, newAnchor });
+      return;
+    }
+    if (atStart && firstRowIndex > 0) {
+      dispatch({ type: "RESET_TO_TOP", offset: -firstRowIndex });
+      return;
+    }
+  }, [
+    firstRowIndex,
+    anchor,
+    atStart,
+    pendingScrollAdjustment,
+    pagingPhase,
+    rowsEmpty,
+    isListContextCurrent
+    // virtualizer - omitted to avoid infinite render loops from scroll events
+  ]);
+  useLayoutEffect(() => {
+    if (!isListContextCurrent) {
+      if (permalinkState) {
+        virtualizer.scrollToOffset(permalinkState.scrollTop);
+        dispatch({
+          type: "RESET_STATE",
+          estimatedTotal: permalinkState.estimatedTotal,
+          hasReachedStart: permalinkState.hasReachedStart,
+          hasReachedEnd: permalinkState.hasReachedEnd,
+          anchor: permalinkState.anchor,
+          listContextParams
+        });
+      } else if (permalinkID) {
+        virtualizer.scrollToOffset(
+          NUM_ROWS_FOR_LOADING_SKELETON * // TODO: Support dynamic item sizes
+          estimateSize(0)
+        );
+        dispatch({
+          type: "RESET_STATE",
+          estimatedTotal: NUM_ROWS_FOR_LOADING_SKELETON,
+          hasReachedStart: false,
+          hasReachedEnd: false,
+          anchor: createPermalinkAnchor(permalinkID),
+          listContextParams
+        });
+      } else {
+        virtualizer.scrollToOffset(0);
+        dispatch({
+          type: "RESET_STATE",
+          estimatedTotal: 0,
+          hasReachedStart: true,
+          hasReachedEnd: false,
+          anchor: TOP_ANCHOR,
+          listContextParams
+        });
+      }
+    }
+  }, [
+    isListContextCurrent,
+    permalinkState,
+    permalinkID,
+    virtualizer,
+    listContextParams
+  ]);
+  const total = hasReachedStart && hasReachedEnd ? estimatedTotal : void 0;
+  const virtualItems = virtualizer.getVirtualItems();
+  useEffect(() => {
+    if (!isListContextCurrent || virtualItems.length === 0 || !complete || pagingPhase !== "idle" || pendingScrollAdjustment !== 0) {
+      return;
+    }
+    if (atStart) {
+      if (firstRowIndex !== 0) {
+        dispatch({ type: "UPDATE_ANCHOR", anchor: TOP_ANCHOR });
+        return;
+      }
+    }
+    const updateAnchorForEdge = (targetIndex, type, indexOffset) => {
+      const index = toBoundIndex(targetIndex, firstRowIndex, rowsLength);
+      const startRow = rowAt(index);
+      assert(startRow !== void 0 || type === "forward");
+      dispatch({
+        type: "UPDATE_ANCHOR",
+        anchor: {
+          index: index + indexOffset,
+          kind: type,
+          startRow
+        }
+      });
+    };
+    const firstItem = virtualItems[0];
+    const lastItem = virtualItems[virtualItems.length - 1];
+    const nearPageEdgeThreshold = getNearPageEdgeThreshold(pageSize);
+    const distanceFromStart = firstItem.index - firstRowIndex;
+    const distanceFromEnd = firstRowIndex + rowsLength - lastItem.index;
+    if (!atStart && distanceFromStart <= nearPageEdgeThreshold) {
+      updateAnchorForEdge(
+        lastItem.index + 2 * nearPageEdgeThreshold,
+        "backward",
+        0
+      );
+      return;
+    }
+    if (!atEnd && distanceFromEnd <= nearPageEdgeThreshold) {
+      updateAnchorForEdge(
+        firstItem.index - 2 * nearPageEdgeThreshold,
+        "forward",
+        1
+      );
+      return;
+    }
+  }, [
+    isListContextCurrent,
+    virtualItems,
+    pagingPhase,
+    pendingScrollAdjustment,
+    complete,
+    pageSize,
+    firstRowIndex,
+    rowsLength,
+    atStart,
+    atEnd,
+    rowAt
+  ]);
+  return {
+    virtualizer,
+    rowAt,
+    complete,
+    rowsEmpty,
+    permalinkNotFound,
+    estimatedTotal,
+    total
+  };
+}
+function toBoundIndex(targetIndex, firstRowIndex, rowsLength) {
+  if (rowsLength === 0) {
+    return firstRowIndex;
+  }
+  return Math.max(
+    firstRowIndex,
+    Math.min(firstRowIndex + rowsLength - 1, targetIndex)
+  );
+}
+function getNearPageEdgeThreshold(pageSize) {
+  return Math.ceil(pageSize / 10);
+}
+function makeEven(n) {
+  return n % 2 === 0 ? n : n + 1;
+}
+export {
+  useZeroVirtualizer
+};
+//# sourceMappingURL=use-zero-virtualizer.js.map

package/out/zero-react/src/use-zero-virtualizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-zero-virtualizer.js","sources":["../../../../zero-react/src/use-zero-virtualizer.ts"],"sourcesContent":["import {\n  defaultKeyExtractor,\n  useVirtualizer,\n  type Virtualizer,\n} from '@tanstack/react-virtual';\nimport {\n  useEffect,\n  useLayoutEffect,\n  useMemo,\n  useReducer,\n  useState,\n  type Key,\n} from 'react';\nimport {assert} from '../../shared/src/asserts.ts';\nimport {pagingReducer, type PagingState} from './paging-reducer.ts';\nimport type {UseQueryOptions} from './use-query.tsx';\nimport {\n  useRows,\n  type Anchor,\n  type GetPageQuery,\n  type GetSingleQuery,\n} from './use-rows.ts';\n\n// Make sure this is even since we half it for permalink loading\nconst MIN_PAGE_SIZE = 100;\n\nconst NUM_ROWS_FOR_LOADING_SKELETON = 1;\n\n/**\n * State object that captures the virtualizer's scroll position and pagination state.\n * Used for persisting and restoring the virtualizer state across navigation or page reloads.\n *\n * @typeParam TStartRow - The type of the start row data used for pagination anchoring\n */\nexport type PermalinkHistoryState<TStartRow> = Readonly<{\n  /** The anchor point for pagination (includes position, direction, and start row data) */\n  anchor: Anchor<TStartRow>;\n  /** The scroll position in pixels from the top of the scrollable container */\n  scrollTop: number;\n  /** The estimated total number of rows in the list */\n  estimatedTotal: number;\n  /** Whether the virtualizer has reached the start of the list */\n  hasReachedStart: boolean;\n  /** Whether the virtualizer has reached the end of the list */\n  hasReachedEnd: boolean;\n}>;\n\nconst TOP_ANCHOR = Object.freeze({\n  index: 0,\n  kind: 'forward',\n  startRow: undefined,\n}) satisfies Anchor<unknown>;\n\ntype TanstackUseVirtualizerOptions<\n  TScrollElement extends Element,\n  TItemElement extends Element,\n> = Parameters<typeof useVirtualizer<TScrollElement, TItemElement>>[0];\n\n/**\n * Options for configuring the Zero virtualizer.\n * Extends Tanstack Virtual's options with Zero-specific pagination and state management.\n *\n * @typeParam TScrollElement - The type of the scrollable container element\n * @typeParam TItemElement - The type of the individual item elements\n * @typeParam TListContextParams - The type of parameters that define the list's query context\n * @typeParam TRow - The type of row data returned from queries\n * @typeParam TStartRow - The type of data needed to anchor pagination (typically a subset of TRow)\n */\nexport type UseZeroVirtualizerOptions<\n  TScrollElement extends Element,\n  TItemElement extends Element,\n  TListContextParams,\n  TRow,\n  TStartRow,\n> = Omit<\n  TanstackUseVirtualizerOptions<TScrollElement, TItemElement>,\n  // count is managed by useZeroVirtualizer\n  | 'count'\n  // initialOffset is managed by useZeroVirtualizer\n  | 'initialOffset'\n  // Only support vertical lists for now\n  | 'horizontal'\n> & {\n  /** Parameters that define the list's query context (filters, sort order, etc.) */\n  listContextParams: TListContextParams;\n\n  /** Optional ID to highlight/scroll to a specific row (permalink functionality) */\n  permalinkID?: string | null | undefined;\n\n  /** Function that returns a query for fetching a page of rows */\n  getPageQuery: GetPageQuery<TRow, TStartRow>;\n  /** Function that returns a query for fetching a single row by ID */\n  getSingleQuery: GetSingleQuery<TRow>;\n  /** Optional query options */\n  options?: UseQueryOptions | undefined;\n  /** Function to extract the start row data from a full row (for pagination anchoring) */\n  toStartRow: (row: TRow) => TStartRow;\n\n  /**\n   * Function to extract a unique key from a row, used for stable item identification.\n   * If provided, this will override {@linkcode TanstackUseVirtualizerOptions.getItemKey}\n   */\n  getRowKey?: ((row: TRow) => Key) | undefined;\n\n  /**\n   * Optional current permalink state for restoring virtualizer position.\n   * If provided along with `onPermalinkStateChange`, enables state persistence.\n   * If not provided, virtualizer operates in uncontrolled mode.\n   */\n  permalinkState?: PermalinkHistoryState<TStartRow> | null | undefined;\n  /**\n   * Optional callback invoked when the virtualizer state changes.\n   * Use this to persist state (e.g., to browser history, local storage, etc.).\n   * Called with the new state approximately 100ms after scroll/pagination changes.\n   */\n  onPermalinkStateChange?: (state: PermalinkHistoryState<TStartRow>) => void;\n};\n\nconst createPermalinkAnchor = (id: string) =>\n  ({\n    id,\n    index: NUM_ROWS_FOR_LOADING_SKELETON,\n    kind: 'permalink',\n  }) as const;\n\n/**\n * Result object returned by the useZeroVirtualizer hook.\n *\n * @typeParam TScrollElement - The type of the scrollable container element\n * @typeParam TItemElement - The type of the individual item elements\n * @typeParam TRow - The type of row data returned from queries\n */\nexport type ZeroVirtualizerResult<\n  TScrollElement extends Element,\n  TItemElement extends Element,\n  TRow,\n> = {\n  /** The Tanstack Virtual virtualizer instance for rendering virtual items */\n  virtualizer: Virtualizer<TScrollElement, TItemElement>;\n  /** Function to get the row data at a specific index, or undefined if not loaded */\n  rowAt: (index: number) => TRow | undefined;\n  /** Whether all initially requested data has finished loading */\n  complete: boolean;\n  /** Whether the list is empty (no rows exist matching the query) */\n  rowsEmpty: boolean;\n  /** Whether the specified permalinkID was not found in the query results */\n  permalinkNotFound: boolean;\n  /** Estimated total number of rows (may be inexact until both ends are reached) */\n  estimatedTotal: number;\n  /** Exact total number of rows, or undefined if not yet known (requires reaching both ends) */\n  total: number | undefined;\n};\n\n/**\n * Hook that creates a virtualized list with bidirectional pagination and state persistence.\n *\n * This hook combines Tanstack Virtual's efficient virtualization with Zero's reactive queries\n * to create infinitely scrolling lists that load data on demand. It supports:\n * - Bidirectional scrolling (load more items at top or bottom)\n * - Permalink functionality (jump to and highlight specific items)\n * - State persistence (restore scroll position across navigation)\n * - Dynamic page sizing based on viewport\n *\n * @typeParam TScrollElement - The type of the scrollable container element\n * @typeParam TItemElement - The type of the individual item elements\n * @typeParam TListContextParams - The type of parameters that define the list's query context\n * @typeParam TRow - The type of row data returned from queries\n * @typeParam TStartRow - The type of data needed to anchor pagination\n *\n * @param options - Configuration options including query functions, sizing, and state management\n * @returns An object containing the virtualizer instance, row accessor, and state flags\n *\n * @example\n * ```tsx\n * const {virtualizer, rowAt, complete} = useZeroVirtualizer({\n *   estimateSize: () => 50,\n *   getScrollElement: () => scrollRef.current,\n *   listContextParams: {projectId: 'abc'},\n *   getPageQuery: (limit, start, dir) => z.query.issues.where(...).limit(limit),\n *   getSingleQuery: (id) => z.query.issues.where('id', id),\n *   toStartRow: (row) => ({id: row.id, created: row.created}),\n * });\n * ```\n */\nexport function useZeroVirtualizer<\n  TScrollElement extends Element,\n  TItemElement extends Element,\n  TListContextParams,\n  TRow,\n  TStartRow,\n>({\n  // Tanstack Virtual params\n  estimateSize,\n  overscan = 5, // Virtualizer defaults to 1.\n  getScrollElement,\n  getItemKey = defaultKeyExtractor,\n\n  // Zero specific params\n  listContextParams,\n  permalinkID,\n  getPageQuery,\n  getSingleQuery,\n  options,\n  toStartRow,\n  getRowKey,\n\n  // Permalink state persistence\n  permalinkState,\n  onPermalinkStateChange,\n\n  ...restVirtualizerOptions\n}: UseZeroVirtualizerOptions<\n  TScrollElement,\n  TItemElement,\n  TListContextParams,\n  TRow,\n  TStartRow\n>): ZeroVirtualizerResult<TScrollElement, TItemElement, TRow> {\n  // Initialize paging state from permalinkState directly to avoid Strict Mode double-mount rows\n  const [\n    {\n      estimatedTotal,\n      hasReachedStart,\n      hasReachedEnd,\n      queryAnchor,\n      pagingPhase,\n      pendingScrollAdjustment,\n    },\n    dispatch,\n  ] = useReducer(\n    pagingReducer<TListContextParams, TStartRow>,\n    undefined,\n    (): PagingState<TListContextParams, TStartRow> => {\n      const anchor = permalinkState\n        ? permalinkState.anchor\n        : permalinkID\n          ? createPermalinkAnchor(permalinkID)\n          : TOP_ANCHOR;\n      return {\n        estimatedTotal:\n          permalinkState?.estimatedTotal ?? NUM_ROWS_FOR_LOADING_SKELETON,\n        hasReachedStart: permalinkState?.hasReachedStart ?? false,\n        hasReachedEnd: permalinkState?.hasReachedEnd ?? false,\n        queryAnchor: {\n          anchor,\n          listContextParams,\n        },\n        pagingPhase: 'idle',\n        pendingScrollAdjustment: 0,\n      };\n    },\n  );\n\n  const isListContextCurrent =\n    queryAnchor.listContextParams === listContextParams;\n\n  const anchor = useMemo(() => {\n    if (isListContextCurrent) {\n      return queryAnchor.anchor;\n    }\n    return permalinkID ? createPermalinkAnchor(permalinkID) : TOP_ANCHOR;\n  }, [isListContextCurrent, queryAnchor.anchor, permalinkID]);\n\n  const [pageSize, setPageSize] = useState(MIN_PAGE_SIZE);\n\n  const {\n    rowAt,\n    rowsLength,\n    complete,\n    rowsEmpty,\n    atStart,\n    atEnd,\n    firstRowIndex,\n    permalinkNotFound,\n  } = useRows({\n    pageSize,\n    anchor,\n    options,\n    getPageQuery,\n    getSingleQuery,\n    toStartRow,\n  });\n\n  const newEstimatedTotal = firstRowIndex + rowsLength;\n\n  const virtualizer: Virtualizer<TScrollElement, TItemElement> = useVirtualizer(\n    {\n      ...restVirtualizerOptions,\n      count:\n        Math.max(estimatedTotal, newEstimatedTotal) +\n        (!atEnd ? NUM_ROWS_FOR_LOADING_SKELETON : 0),\n      estimateSize,\n      overscan,\n      getScrollElement,\n      getItemKey: getRowKey\n        ? (index: number) => {\n            const row = rowAt(index);\n            return row ? getRowKey(row) : getItemKey(index);\n          }\n        : getItemKey,\n      initialOffset: () => {\n        if (permalinkState?.scrollTop !== undefined) {\n          return permalinkState.scrollTop;\n        }\n        if (anchor.kind === 'permalink') {\n          // TODO: Support dynamic item sizes\n          return anchor.index * estimateSize(0);\n        }\n        return 0;\n      },\n      horizontal: false,\n    },\n  );\n\n  useEffect(() => {\n    // Make sure page size is enough to fill the scroll element at least\n    // 3 times.  Don't shrink page size.\n    const newPageSize = virtualizer.scrollRect\n      ? Math.max(\n          MIN_PAGE_SIZE,\n          makeEven(\n            Math.ceil(\n              virtualizer.scrollRect?.height /\n                // TODO: Support dynamic item sizes\n                estimateSize(0),\n            ) * 3,\n          ),\n        )\n      : MIN_PAGE_SIZE;\n    if (newPageSize > pageSize) {\n      setPageSize(newPageSize);\n    }\n  }, [pageSize, virtualizer.scrollRect]);\n\n  useEffect(() => {\n    if (!isListContextCurrent || !onPermalinkStateChange) {\n      return;\n    }\n    const timeoutId = setTimeout(() => {\n      onPermalinkStateChange({\n        anchor,\n        scrollTop: virtualizer.scrollOffset ?? 0,\n        estimatedTotal,\n        hasReachedStart,\n        hasReachedEnd,\n      });\n    }, 100);\n\n    return () => clearTimeout(timeoutId);\n  }, [\n    anchor,\n    virtualizer.scrollOffset,\n    estimatedTotal,\n    hasReachedStart,\n    hasReachedEnd,\n    isListContextCurrent,\n    onPermalinkStateChange,\n  ]);\n\n  useEffect(() => {\n    if (atStart) {\n      dispatch({type: 'REACHED_START'});\n    }\n  }, [atStart]);\n\n  useEffect(() => {\n    if (atEnd) {\n      dispatch({type: 'REACHED_END'});\n    }\n  }, [atEnd]);\n\n  useEffect(() => {\n    if (complete && newEstimatedTotal > estimatedTotal) {\n      dispatch({type: 'UPDATE_ESTIMATED_TOTAL', newTotal: newEstimatedTotal});\n    }\n  }, [estimatedTotal, complete, newEstimatedTotal]);\n\n  // Apply scroll adjustments synchronously with layout to prevent visual jumps\n  useLayoutEffect(() => {\n    if (pendingScrollAdjustment !== 0) {\n      virtualizer.scrollToOffset(\n        (virtualizer.scrollOffset ?? 0) +\n          pendingScrollAdjustment *\n            // TODO: Support dynamic item sizes\n            estimateSize(0),\n      );\n\n      dispatch({type: 'SCROLL_ADJUSTED'});\n    }\n  }, [pendingScrollAdjustment, virtualizer]);\n\n  useEffect(() => {\n    if (rowsEmpty || !isListContextCurrent) {\n      return;\n    }\n\n    if (pagingPhase === 'skipping' && pendingScrollAdjustment === 0) {\n      dispatch({type: 'PAGING_COMPLETE'});\n      return;\n    }\n\n    // Skip if there's a pending scroll adjustment - let useLayoutEffect handle it\n    if (pendingScrollAdjustment !== 0) {\n      return;\n    }\n\n    // First row is before start of list - need to shift down\n    if (firstRowIndex < 0) {\n      const placeholderRows = !atStart ? NUM_ROWS_FOR_LOADING_SKELETON : 0;\n      const offset = -firstRowIndex + placeholderRows;\n      const newAnchor = {\n        ...anchor,\n        index: anchor.index + offset,\n      };\n      dispatch({type: 'SHIFT_ANCHOR_DOWN', offset, newAnchor});\n      return;\n    }\n\n    if (atStart && firstRowIndex > 0) {\n      dispatch({type: 'RESET_TO_TOP', offset: -firstRowIndex});\n      return;\n    }\n  }, [\n    firstRowIndex,\n    anchor,\n    atStart,\n    pendingScrollAdjustment,\n    pagingPhase,\n    rowsEmpty,\n    isListContextCurrent,\n    // virtualizer - omitted to avoid infinite render loops from scroll events\n  ]);\n\n  // Use layoutEffect to restore scroll position synchronously to avoid visual jumps\n  useLayoutEffect(() => {\n    if (!isListContextCurrent) {\n      if (permalinkState) {\n        virtualizer.scrollToOffset(permalinkState.scrollTop);\n        dispatch({\n          type: 'RESET_STATE',\n          estimatedTotal: permalinkState.estimatedTotal,\n          hasReachedStart: permalinkState.hasReachedStart,\n          hasReachedEnd: permalinkState.hasReachedEnd,\n          anchor: permalinkState.anchor,\n          listContextParams,\n        });\n      } else if (permalinkID) {\n        virtualizer.scrollToOffset(\n          NUM_ROWS_FOR_LOADING_SKELETON *\n            // TODO: Support dynamic item sizes\n            estimateSize(0),\n        );\n        dispatch({\n          type: 'RESET_STATE',\n          estimatedTotal: NUM_ROWS_FOR_LOADING_SKELETON,\n          hasReachedStart: false,\n          hasReachedEnd: false,\n          anchor: createPermalinkAnchor(permalinkID),\n          listContextParams,\n        });\n      } else {\n        virtualizer.scrollToOffset(0);\n        dispatch({\n          type: 'RESET_STATE',\n          estimatedTotal: 0,\n          hasReachedStart: true,\n          hasReachedEnd: false,\n          anchor: TOP_ANCHOR,\n          listContextParams,\n        });\n      }\n    }\n  }, [\n    isListContextCurrent,\n    permalinkState,\n    permalinkID,\n    virtualizer,\n    listContextParams,\n  ]);\n\n  const total = hasReachedStart && hasReachedEnd ? estimatedTotal : undefined;\n\n  const virtualItems = virtualizer.getVirtualItems();\n\n  useEffect(() => {\n    if (\n      !isListContextCurrent ||\n      virtualItems.length === 0 ||\n      !complete ||\n      pagingPhase !== 'idle' ||\n      pendingScrollAdjustment !== 0\n    ) {\n      return;\n    }\n\n    if (atStart) {\n      if (firstRowIndex !== 0) {\n        dispatch({type: 'UPDATE_ANCHOR', anchor: TOP_ANCHOR});\n        return;\n      }\n    }\n\n    const updateAnchorForEdge = (\n      targetIndex: number,\n      type: 'forward' | 'backward',\n      indexOffset: number,\n    ) => {\n      const index = toBoundIndex(targetIndex, firstRowIndex, rowsLength);\n      const startRow = rowAt(index);\n      assert(startRow !== undefined || type === 'forward');\n      dispatch({\n        type: 'UPDATE_ANCHOR',\n        anchor: {\n          index: index + indexOffset,\n          kind: type,\n          startRow,\n        } as Anchor<TStartRow>,\n      });\n    };\n\n    const firstItem = virtualItems[0];\n    const lastItem = virtualItems[virtualItems.length - 1];\n    const nearPageEdgeThreshold = getNearPageEdgeThreshold(pageSize);\n\n    const distanceFromStart = firstItem.index - firstRowIndex;\n    const distanceFromEnd = firstRowIndex + rowsLength - lastItem.index;\n\n    if (!atStart && distanceFromStart <= nearPageEdgeThreshold) {\n      updateAnchorForEdge(\n        lastItem.index + 2 * nearPageEdgeThreshold,\n        'backward',\n        0,\n      );\n      return;\n    }\n\n    if (!atEnd && distanceFromEnd <= nearPageEdgeThreshold) {\n      updateAnchorForEdge(\n        firstItem.index - 2 * nearPageEdgeThreshold,\n        'forward',\n        1,\n      );\n      return;\n    }\n  }, [\n    isListContextCurrent,\n    virtualItems,\n    pagingPhase,\n    pendingScrollAdjustment,\n    complete,\n    pageSize,\n    firstRowIndex,\n    rowsLength,\n    atStart,\n    atEnd,\n    rowAt,\n  ]);\n\n  return {\n    virtualizer,\n    rowAt,\n    complete,\n    rowsEmpty,\n    permalinkNotFound,\n    estimatedTotal,\n    total,\n  };\n}\n\n/**\n * Clamps an index to be within the valid range of rows.\n * @param targetIndex - The desired index to clamp\n * @param firstRowIndex - The first valid row index\n * @param rowsLength - The number of rows available\n * @returns The clamped index within [firstRowIndex, firstRowIndex + rowsLength - 1]\n */\nfunction toBoundIndex(\n  targetIndex: number,\n  firstRowIndex: number,\n  rowsLength: number,\n): number {\n  if (rowsLength === 0) {\n    return firstRowIndex;\n  }\n  return Math.max(\n    firstRowIndex,\n    Math.min(firstRowIndex + rowsLength - 1, targetIndex),\n  );\n}\n\nfunction getNearPageEdgeThreshold(pageSize: number) {\n  return Math.ceil(pageSize / 10);\n}\n\nfunction makeEven(n: number) {\n  return n % 2 === 0 ? n : n + 1;\n}\n"],"names":["anchor"],"mappings":";;;;;AAwBA,MAAM,gBAAgB;AAEtB,MAAM,gCAAgC;AAqBtC,MAAM,aAAa,OAAO,OAAO;AAAA,EAC/B,OAAO;AAAA,EACP,MAAM;AAAA,EACN,UAAU;AACZ,CAAC;AAmED,MAAM,wBAAwB,CAAC,QAC5B;AAAA,EACC;AAAA,EACA,OAAO;AAAA,EACP,MAAM;AACR;AA6DK,SAAS,mBAMd;AAAA;AAAA,EAEA;AAAA,EACA,WAAW;AAAA;AAAA,EACX;AAAA,EACA,aAAa;AAAA;AAAA,EAGb;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAGA;AAAA,EACA;AAAA,EAEA,GAAG;AACL,GAM8D;AAE5D,QAAM;AAAA,IACJ;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,IAEF;AAAA,EAAA,IACE;AAAA,IACF;AAAA,IACA;AAAA,IACA,MAAkD;AAChD,YAAMA,UAAS,iBACX,eAAe,SACf,cACE,sBAAsB,WAAW,IACjC;AACN,aAAO;AAAA,QACL,gBACE,gBAAgB,kBAAkB;AAAA,QACpC,iBAAiB,gBAAgB,mBAAmB;AAAA,QACpD,eAAe,gBAAgB,iBAAiB;AAAA,QAChD,aAAa;AAAA,UACX,QAAAA;AAAAA,UACA;AAAA,QAAA;AAAA,QAEF,aAAa;AAAA,QACb,yBAAyB;AAAA,MAAA;AAAA,IAE7B;AAAA,EAAA;AAGF,QAAM,uBACJ,YAAY,sBAAsB;AAEpC,QAAM,SAAS,QAAQ,MAAM;AAC3B,QAAI,sBAAsB;AACxB,aAAO,YAAY;AAAA,IACrB;AACA,WAAO,cAAc,sBAAsB,WAAW,IAAI;AAAA,EAC5D,GAAG,CAAC,sBAAsB,YAAY,QAAQ,WAAW,CAAC;AAE1D,QAAM,CAAC,UAAU,WAAW,IAAI,SAAS,aAAa;AAEtD,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,IACE,QAAQ;AAAA,IACV;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,QAAM,oBAAoB,gBAAgB;AAE1C,QAAM,cAAyD;AAAA,IAC7D;AAAA,MACE,GAAG;AAAA,MACH,OACE,KAAK,IAAI,gBAAgB,iBAAiB,KACzC,CAAC,QAAQ,gCAAgC;AAAA,MAC5C;AAAA,MACA;AAAA,MACA;AAAA,MACA,YAAY,YACR,CAAC,UAAkB;AACjB,cAAM,MAAM,MAAM,KAAK;AACvB,eAAO,MAAM,UAAU,GAAG,IAAI,WAAW,KAAK;AAAA,MAChD,IACA;AAAA,MACJ,eAAe,MAAM;AACnB,YAAI,gBAAgB,cAAc,QAAW;AAC3C,iBAAO,eAAe;AAAA,QACxB;AACA,YAAI,OAAO,SAAS,aAAa;AAE/B,iBAAO,OAAO,QAAQ,aAAa,CAAC;AAAA,QACtC;AACA,eAAO;AAAA,MACT;AAAA,MACA,YAAY;AAAA,IAAA;AAAA,EACd;AAGF,YAAU,MAAM;AAGd,UAAM,cAAc,YAAY,aAC5B,KAAK;AAAA,MACH;AAAA,MACA;AAAA,QACE,KAAK;AAAA,UACH,YAAY,YAAY;AAAA,UAEtB,aAAa,CAAC;AAAA,QAAA,IACd;AAAA,MAAA;AAAA,IACN,IAEF;AACJ,QAAI,cAAc,UAAU;AAC1B,kBAAY,WAAW;AAAA,IACzB;AAAA,EACF,GAAG,CAAC,UAAU,YAAY,UAAU,CAAC;AAErC,YAAU,MAAM;AACd,QAAI,CAAC,wBAAwB,CAAC,wBAAwB;AACpD;AAAA,IACF;AACA,UAAM,YAAY,WAAW,MAAM;AACjC,6BAAuB;AAAA,QACrB;AAAA,QACA,WAAW,YAAY,gBAAgB;AAAA,QACvC;AAAA,QACA;AAAA,QACA;AAAA,MAAA,CACD;AAAA,IACH,GAAG,GAAG;AAEN,WAAO,MAAM,aAAa,SAAS;AAAA,EACrC,GAAG;AAAA,IACD;AAAA,IACA,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,YAAU,MAAM;AACd,QAAI,SAAS;AACX,eAAS,EAAC,MAAM,iBAAgB;AAAA,IAClC;AAAA,EACF,GAAG,CAAC,OAAO,CAAC;AAEZ,YAAU,MAAM;AACd,QAAI,OAAO;AACT,eAAS,EAAC,MAAM,eAAc;AAAA,IAChC;AAAA,EACF,GAAG,CAAC,KAAK,CAAC;AAEV,YAAU,MAAM;AACd,QAAI,YAAY,oBAAoB,gBAAgB;AAClD,eAAS,EAAC,MAAM,0BAA0B,UAAU,mBAAkB;AAAA,IACxE;AAAA,EACF,GAAG,CAAC,gBAAgB,UAAU,iBAAiB,CAAC;AAGhD,kBAAgB,MAAM;AACpB,QAAI,4BAA4B,GAAG;AACjC,kBAAY;AAAA,SACT,YAAY,gBAAgB,KAC3B;AAAA,QAEE,aAAa,CAAC;AAAA,MAAA;AAGpB,eAAS,EAAC,MAAM,mBAAkB;AAAA,IACpC;AAAA,EACF,GAAG,CAAC,yBAAyB,WAAW,CAAC;AAEzC,YAAU,MAAM;AACd,QAAI,aAAa,CAAC,sBAAsB;AACtC;AAAA,IACF;AAEA,QAAI,gBAAgB,cAAc,4BAA4B,GAAG;AAC/D,eAAS,EAAC,MAAM,mBAAkB;AAClC;AAAA,IACF;AAGA,QAAI,4BAA4B,GAAG;AACjC;AAAA,IACF;AAGA,QAAI,gBAAgB,GAAG;AACrB,YAAM,kBAAkB,CAAC,UAAU,gCAAgC;AACnE,YAAM,SAAS,CAAC,gBAAgB;AAChC,YAAM,YAAY;AAAA,QAChB,GAAG;AAAA,QACH,OAAO,OAAO,QAAQ;AAAA,MAAA;AAExB,eAAS,EAAC,MAAM,qBAAqB,QAAQ,WAAU;AACvD;AAAA,IACF;AAEA,QAAI,WAAW,gBAAgB,GAAG;AAChC,eAAS,EAAC,MAAM,gBAAgB,QAAQ,CAAC,eAAc;AACvD;AAAA,IACF;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA;AAAA,EAAA,CAED;AAGD,kBAAgB,MAAM;AACpB,QAAI,CAAC,sBAAsB;AACzB,UAAI,gBAAgB;AAClB,oBAAY,eAAe,eAAe,SAAS;AACnD,iBAAS;AAAA,UACP,MAAM;AAAA,UACN,gBAAgB,eAAe;AAAA,UAC/B,iBAAiB,eAAe;AAAA,UAChC,eAAe,eAAe;AAAA,UAC9B,QAAQ,eAAe;AAAA,UACvB;AAAA,QAAA,CACD;AAAA,MACH,WAAW,aAAa;AACtB,oBAAY;AAAA,UACV;AAAA,UAEE,aAAa,CAAC;AAAA,QAAA;AAElB,iBAAS;AAAA,UACP,MAAM;AAAA,UACN,gBAAgB;AAAA,UAChB,iBAAiB;AAAA,UACjB,eAAe;AAAA,UACf,QAAQ,sBAAsB,WAAW;AAAA,UACzC;AAAA,QAAA,CACD;AAAA,MACH,OAAO;AACL,oBAAY,eAAe,CAAC;AAC5B,iBAAS;AAAA,UACP,MAAM;AAAA,UACN,gBAAgB;AAAA,UAChB,iBAAiB;AAAA,UACjB,eAAe;AAAA,UACf,QAAQ;AAAA,UACR;AAAA,QAAA,CACD;AAAA,MACH;AAAA,IACF;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,QAAM,QAAQ,mBAAmB,gBAAgB,iBAAiB;AAElE,QAAM,eAAe,YAAY,gBAAA;AAEjC,YAAU,MAAM;AACd,QACE,CAAC,wBACD,aAAa,WAAW,KACxB,CAAC,YACD,gBAAgB,UAChB,4BAA4B,GAC5B;AACA;AAAA,IACF;AAEA,QAAI,SAAS;AACX,UAAI,kBAAkB,GAAG;AACvB,iBAAS,EAAC,MAAM,iBAAiB,QAAQ,YAAW;AACpD;AAAA,MACF;AAAA,IACF;AAEA,UAAM,sBAAsB,CAC1B,aACA,MACA,gBACG;AACH,YAAM,QAAQ,aAAa,aAAa,eAAe,UAAU;AACjE,YAAM,WAAW,MAAM,KAAK;AAC5B,aAAO,aAAa,UAAa,SAAS,SAAS;AACnD,eAAS;AAAA,QACP,MAAM;AAAA,QACN,QAAQ;AAAA,UACN,OAAO,QAAQ;AAAA,UACf,MAAM;AAAA,UACN;AAAA,QAAA;AAAA,MACF,CACD;AAAA,IACH;AAEA,UAAM,YAAY,aAAa,CAAC;AAChC,UAAM,WAAW,aAAa,aAAa,SAAS,CAAC;AACrD,UAAM,wBAAwB,yBAAyB,QAAQ;AAE/D,UAAM,oBAAoB,UAAU,QAAQ;AAC5C,UAAM,kBAAkB,gBAAgB,aAAa,SAAS;AAE9D,QAAI,CAAC,WAAW,qBAAqB,uBAAuB;AAC1D;AAAA,QACE,SAAS,QAAQ,IAAI;AAAA,QACrB;AAAA,QACA;AAAA,MAAA;AAEF;AAAA,IACF;AAEA,QAAI,CAAC,SAAS,mBAAmB,uBAAuB;AACtD;AAAA,QACE,UAAU,QAAQ,IAAI;AAAA,QACtB;AAAA,QACA;AAAA,MAAA;AAEF;AAAA,IACF;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA,CACD;AAED,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EAAA;AAEJ;AASA,SAAS,aACP,aACA,eACA,YACQ;AACR,MAAI,eAAe,GAAG;AACpB,WAAO;AAAA,EACT;AACA,SAAO,KAAK;AAAA,IACV;AAAA,IACA,KAAK,IAAI,gBAAgB,aAAa,GAAG,WAAW;AAAA,EAAA;AAExD;AAEA,SAAS,yBAAyB,UAAkB;AAClD,SAAO,KAAK,KAAK,WAAW,EAAE;AAChC;AAEA,SAAS,SAAS,GAAW;AAC3B,SAAO,IAAI,MAAM,IAAI,IAAI,IAAI;AAC/B;"}

package/out/zero-react/src/zero-provider.js

@@ -57,7 +57,7 @@ function ZeroProvider({ children, init, ...props }) {
     };
   }, [init, ...keysWithoutAuth]);
   useEffect(() => {
-    if (!zero) return;
+    if (!zero || isExternalZero) return;
     const authChanged = auth !== prevAuthRef.current;
     if (authChanged) {
       prevAuthRef.current = auth;

package/out/zero-react/src/zero-provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"zero-provider.js","sources":["../../../../zero-react/src/zero-provider.tsx"],"sourcesContent":["import {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n  type ReactNode,\n} from 'react';\nimport {stringCompare} from '../../shared/src/string-compare.ts';\nimport {\n  Zero,\n  type CustomMutatorDefs,\n  type DefaultContext,\n  type DefaultSchema,\n  type Schema,\n  type ZeroOptions,\n} from './zero.ts';\n\n// oxlint-disable-next-line no-explicit-any\nexport const ZeroContext = createContext<Zero<any, any, any> | undefined>(\n  undefined,\n);\n\nexport function useZero<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>(): Zero<S, MD, Context> {\n  const zero = useContext(ZeroContext);\n  if (zero === undefined) {\n    throw new Error('useZero must be used within a ZeroProvider');\n  }\n  return zero as Zero<S, MD, Context>;\n}\n\n/**\n * @deprecated Use {@linkcode useZero} instead, alongside default types defined with:\n *\n * ```ts\n * declare module '@rocicorp/zero' {\n *   interface DefaultTypes {\n *     schema: typeof schema;\n *     context: Context;\n *   }\n * }\n */\nexport function createUseZero<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>() {\n  return () => useZero<S, MD, Context>();\n}\n\nexport type ZeroProviderProps<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n> = (ZeroOptions<S, MD, Context> | {zero: Zero<S, MD, Context>}) & {\n  init?: (zero: Zero<S, MD, Context>) => void;\n  children: ReactNode;\n};\n\nconst NO_AUTH_SET = Symbol();\n\nexport function ZeroProvider<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>({children, init, ...props}: ZeroProviderProps<S, MD, Context>) {\n  const isExternalZero = 'zero' in props;\n\n  const [zero, setZero] = useState<Zero<S, MD, Context> | undefined>(\n    isExternalZero ? props.zero : undefined,\n  );\n\n  const auth = 'auth' in props ? props.auth : NO_AUTH_SET;\n  const prevAuthRef = useRef<typeof auth>(auth);\n\n  const keysWithoutAuth = useMemo(\n    () =>\n      Object.entries(props)\n        .filter(([key]) => key !== 'auth')\n        .sort(([a], [b]) => stringCompare(a, b))\n        .map(([_, value]) => value),\n    [props],\n  );\n\n  // If Zero is not passed in, we construct it, but only client-side.\n  // Zero doesn't really work SSR today so this is usually the right thing.\n  // When we support Zero SSR this will either become a breaking change or\n  // more likely server support will be opt-in with a new prop on this\n  // component.\n  useEffect(() => {\n    if (isExternalZero) {\n      setZero(props.zero);\n      return;\n    }\n\n    const z = new Zero(props);\n    init?.(z);\n    setZero(z);\n\n    return () => {\n      void z.close();\n      setZero(undefined);\n    };\n    // we intentionally don't include auth in the dependency array\n    // to avoid closing zero when auth changes\n  }, [init, ...keysWithoutAuth]);\n\n  useEffect(() => {\n    if (!zero) return;\n\n    const authChanged = auth !== prevAuthRef.current;\n\n    if (authChanged) {\n      prevAuthRef.current = auth;\n      void zero.connection.connect({\n        auth: auth === NO_AUTH_SET ? undefined : auth,\n      });\n    }\n  }, [auth, zero]);\n\n  return (\n    zero && <ZeroContext.Provider value={zero}>{children}</ZeroContext.Provider>\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAoBO,MAAM,cAAc;AAAA,EACzB;AACF;AAEO,SAAS,UAIU;AACxB,QAAM,OAAO,WAAW,WAAW;AACnC,MAAI,SAAS,QAAW;AACtB,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AACA,SAAO;AACT;AAaO,SAAS,gBAIZ;AACF,SAAO,MAAM,QAAA;AACf;AAWA,MAAM,cAAc,OAAA;AAEb,SAAS,aAId,EAAC,UAAU,MAAM,GAAG,SAA2C;AAC/D,QAAM,iBAAiB,UAAU;AAEjC,QAAM,CAAC,MAAM,OAAO,IAAI;AAAA,IACtB,iBAAiB,MAAM,OAAO;AAAA,EAAA;AAGhC,QAAM,OAAO,UAAU,QAAQ,MAAM,OAAO;AAC5C,QAAM,cAAc,OAAoB,IAAI;AAE5C,QAAM,kBAAkB;AAAA,IACtB,MACE,OAAO,QAAQ,KAAK,EACjB,OAAO,CAAC,CAAC,GAAG,MAAM,QAAQ,MAAM,EAChC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,EACtC,IAAI,CAAC,CAAC,GAAG,KAAK,MAAM,KAAK;AAAA,IAC9B,CAAC,KAAK;AAAA,EAAA;AAQR,YAAU,MAAM;AACd,QAAI,gBAAgB;AAClB,cAAQ,MAAM,IAAI;AAClB;AAAA,IACF;AAEA,UAAM,IAAI,IAAI,KAAK,KAAK;AACxB,WAAO,CAAC;AACR,YAAQ,CAAC;AAET,WAAO,MAAM;AACX,WAAK,EAAE,MAAA;AACP,cAAQ,MAAS;AAAA,IACnB;AAAA,EAGF,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC;AAE7B,YAAU,MAAM;AACd,QAAI,CAAC,KAAM;AAEX,UAAM,cAAc,SAAS,YAAY;AAEzC,QAAI,aAAa;AACf,kBAAY,UAAU;AACtB,WAAK,KAAK,WAAW,QAAQ;AAAA,QAC3B,MAAM,SAAS,cAAc,SAAY;AAAA,MAAA,CAC1C;AAAA,IACH;AAAA,EACF,GAAG,CAAC,MAAM,IAAI,CAAC;AAEf,SACE,QAAQ,oBAAC,YAAY,UAAZ,EAAqB,OAAO,MAAO,UAAS;AAEzD;"}
+{"version":3,"file":"zero-provider.js","sources":["../../../../zero-react/src/zero-provider.tsx"],"sourcesContent":["import {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n  type ReactNode,\n} from 'react';\nimport {stringCompare} from '../../shared/src/string-compare.ts';\nimport {\n  Zero,\n  type CustomMutatorDefs,\n  type DefaultContext,\n  type DefaultSchema,\n  type Schema,\n  type ZeroOptions,\n} from './zero.ts';\n\n// oxlint-disable-next-line no-explicit-any\nexport const ZeroContext = createContext<Zero<any, any, any> | undefined>(\n  undefined,\n);\n\nexport function useZero<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>(): Zero<S, MD, Context> {\n  const zero = useContext(ZeroContext);\n  if (zero === undefined) {\n    throw new Error('useZero must be used within a ZeroProvider');\n  }\n  return zero as Zero<S, MD, Context>;\n}\n\n/**\n * @deprecated Use {@linkcode useZero} instead, alongside default types defined with:\n *\n * ```ts\n * declare module '@rocicorp/zero' {\n *   interface DefaultTypes {\n *     schema: typeof schema;\n *     context: Context;\n *   }\n * }\n */\nexport function createUseZero<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>() {\n  return () => useZero<S, MD, Context>();\n}\n\nexport type ZeroProviderProps<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n> = (ZeroOptions<S, MD, Context> | {zero: Zero<S, MD, Context>}) & {\n  init?: (zero: Zero<S, MD, Context>) => void;\n  children: ReactNode;\n};\n\nconst NO_AUTH_SET = Symbol();\n\nexport function ZeroProvider<\n  S extends Schema = DefaultSchema,\n  MD extends CustomMutatorDefs | undefined = undefined,\n  Context = DefaultContext,\n>({children, init, ...props}: ZeroProviderProps<S, MD, Context>) {\n  const isExternalZero = 'zero' in props;\n\n  const [zero, setZero] = useState<Zero<S, MD, Context> | undefined>(\n    isExternalZero ? props.zero : undefined,\n  );\n\n  const auth = 'auth' in props ? props.auth : NO_AUTH_SET;\n  const prevAuthRef = useRef<typeof auth>(auth);\n\n  const keysWithoutAuth = useMemo(\n    () =>\n      Object.entries(props)\n        .filter(([key]) => key !== 'auth')\n        .sort(([a], [b]) => stringCompare(a, b))\n        .map(([_, value]) => value),\n    [props],\n  );\n\n  // If Zero is not passed in, we construct it, but only client-side.\n  // Zero doesn't really work SSR today so this is usually the right thing.\n  // When we support Zero SSR this will either become a breaking change or\n  // more likely server support will be opt-in with a new prop on this\n  // component.\n  useEffect(() => {\n    if (isExternalZero) {\n      setZero(props.zero);\n      return;\n    }\n\n    const z = new Zero(props);\n    init?.(z);\n    setZero(z);\n\n    return () => {\n      void z.close();\n      setZero(undefined);\n    };\n    // we intentionally don't include auth in the dependency array\n    // to avoid closing zero when auth changes\n  }, [init, ...keysWithoutAuth]);\n\n  useEffect(() => {\n    if (!zero || isExternalZero) return;\n\n    const authChanged = auth !== prevAuthRef.current;\n\n    if (authChanged) {\n      prevAuthRef.current = auth;\n      void zero.connection.connect({\n        auth: auth === NO_AUTH_SET ? undefined : auth,\n      });\n    }\n  }, [auth, zero]);\n\n  return (\n    zero && <ZeroContext.Provider value={zero}>{children}</ZeroContext.Provider>\n  );\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAoBO,MAAM,cAAc;AAAA,EACzB;AACF;AAEO,SAAS,UAIU;AACxB,QAAM,OAAO,WAAW,WAAW;AACnC,MAAI,SAAS,QAAW;AACtB,UAAM,IAAI,MAAM,4CAA4C;AAAA,EAC9D;AACA,SAAO;AACT;AAaO,SAAS,gBAIZ;AACF,SAAO,MAAM,QAAA;AACf;AAWA,MAAM,cAAc,OAAA;AAEb,SAAS,aAId,EAAC,UAAU,MAAM,GAAG,SAA2C;AAC/D,QAAM,iBAAiB,UAAU;AAEjC,QAAM,CAAC,MAAM,OAAO,IAAI;AAAA,IACtB,iBAAiB,MAAM,OAAO;AAAA,EAAA;AAGhC,QAAM,OAAO,UAAU,QAAQ,MAAM,OAAO;AAC5C,QAAM,cAAc,OAAoB,IAAI;AAE5C,QAAM,kBAAkB;AAAA,IACtB,MACE,OAAO,QAAQ,KAAK,EACjB,OAAO,CAAC,CAAC,GAAG,MAAM,QAAQ,MAAM,EAChC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,EACtC,IAAI,CAAC,CAAC,GAAG,KAAK,MAAM,KAAK;AAAA,IAC9B,CAAC,KAAK;AAAA,EAAA;AAQR,YAAU,MAAM;AACd,QAAI,gBAAgB;AAClB,cAAQ,MAAM,IAAI;AAClB;AAAA,IACF;AAEA,UAAM,IAAI,IAAI,KAAK,KAAK;AACxB,WAAO,CAAC;AACR,YAAQ,CAAC;AAET,WAAO,MAAM;AACX,WAAK,EAAE,MAAA;AACP,cAAQ,MAAS;AAAA,IACnB;AAAA,EAGF,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC;AAE7B,YAAU,MAAM;AACd,QAAI,CAAC,QAAQ,eAAgB;AAE7B,UAAM,cAAc,SAAS,YAAY;AAEzC,QAAI,aAAa;AACf,kBAAY,UAAU;AACtB,WAAK,KAAK,WAAW,QAAQ;AAAA,QAC3B,MAAM,SAAS,cAAc,SAAY;AAAA,MAAA,CAC1C;AAAA,IACH;AAAA,EACF,GAAG,CAAC,MAAM,IAAI,CAAC;AAEf,SACE,QAAQ,oBAAC,YAAY,UAAZ,EAAqB,OAAO,MAAO,UAAS;AAEzD;"}

package/out/zero-server/src/adapters/drizzle.d.ts

@@ -1,4 +1,3 @@
-import { type SQL } from 'drizzle-orm';
 import type { PgDatabase, PgQueryResultHKT, PgTransaction } from 'drizzle-orm/pg-core';
 import type { ExtractTablesWithRelations } from 'drizzle-orm/relations';
 import type { Schema } from '../../../zero-types/src/schema.ts';
@@ -17,10 +16,6 @@ export declare class DrizzleConnection<TDrizzle extends DrizzleDatabase, TTransa
     constructor(drizzle: TDrizzle);
     transaction<T>(fn: (tx: DBTransaction<TTransaction>) => Promise<T>): Promise<T>;
 }
-/**
- * Turn `$1, $2...` placeholders into a Drizzle SQL object with bound params.
- */
-export declare function fromDollarParams(text: string, params: unknown[]): SQL;
 export declare function toIterableRows(result: unknown): Iterable<Row>;
 /**
  * Wrap a `drizzle-orm` database for Zero ZQL.
@@ -35,24 +30,29 @@ export declare function toIterableRows(result: unknown): Iterable<Row>;
  * ```ts
  * import {Pool} from 'pg';
  * import {drizzle} from 'drizzle-orm/node-postgres';
- * import type {ServerTransaction} from '@rocicorp/zero';
+ * import {defineMutator, defineMutators} from '@rocicorp/zero';
+ * import {zeroDrizzle} from '@rocicorp/zero/server/adapters/drizzle';
+ * import {z} from 'zod/mini';
  *
  * const pool = new Pool({connectionString: process.env.ZERO_UPSTREAM_DB!});
  * const drizzleDb = drizzle(pool, {schema: drizzleSchema});
- *
  * const zql = zeroDrizzle(schema, drizzleDb);
  *
- * // Define the server mutator transaction type using the helper
- * type ServerTx = ServerTransaction<Schema, DrizzleTransaction<typeof drizzleDb>>;
- *
- * async function createUser(
- *   tx: ServerTx,
- *   {id, name}: {id: string; name: string},
- * ) {
- *   await tx.dbTransaction.wrappedTransaction
- *     .insert(drizzleSchema.user)
- *     .values({id, name})
- * }
+ * export const serverMutators = defineMutators({
+ *   user: {
+ *     create: defineMutator(
+ *       z.object({id: z.string(), name: z.string()}),
+ *       async ({tx, args}) => {
+ *         if (tx.location !== 'server') {
+ *           throw new Error('Server-only mutator');
+ *         }
+ *         await tx.dbTransaction.wrappedTransaction
+ *           .insert(drizzleSchema.user)
+ *           .values({id: args.id, name: args.name, status: 'active'});
+ *       },
+ *     ),
+ *   },
+ * });
  * ```
  */
 export declare function zeroDrizzle<TSchema extends Schema, TDrizzle extends DrizzleDatabase>(schema: TSchema, client: TDrizzle): ZQLDatabase<TSchema, DrizzleTransaction<TDrizzle>>;

package/out/zero-server/src/adapters/drizzle.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"drizzle.d.ts","sourceRoot":"","sources":["../../../../../zero-server/src/adapters/drizzle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAM,KAAK,GAAG,EAAC,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAC,0BAA0B,EAAC,MAAM,uBAAuB,CAAC;AAGtE,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAE9D,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,GAAG,EACJ,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,YAAY,EAAC,WAAW,EAAC,CAAC;AAE1B,MAAM,MAAM,eAAe,CACzB,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC/D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAC5B,WAAW,SAAS,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,SAAS,UAAU,CACtE,gBAAgB,EAChB,MAAM,eAAe,CACtB,GACG,eAAe,GACf,WAAW,IACb,aAAa,CACf,gBAAgB,EAChB,OAAO,EACP,0BAA0B,CAAC,OAAO,CAAC,CACpC,CAAC;AAEF,qBAAa,iBAAiB,CAC5B,QAAQ,SAAS,eAAe,EAChC,YAAY,SACV,kBAAkB,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAC7D,YAAW,YAAY,CAAC,YAAY,CAAC;;gBAIzB,OAAO,EAAE,QAAQ;IAI7B,WAAW,CAAC,CAAC,EACX,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,CAAC,CAAC;CASd;AAkCD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,CAiBrE;AAUD,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAuB7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,MAAM,EACtB,QAAQ,SAAS,eAAe,EAEhC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,QAAQ,GACf,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAKpD"}
+{"version":3,"file":"drizzle.d.ts","sourceRoot":"","sources":["../../../../../zero-server/src/adapters/drizzle.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,aAAa,EACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAC,0BAA0B,EAAC,MAAM,uBAAuB,CAAC;AAGtE,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAE9D,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,GAAG,EACJ,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,YAAY,EAAC,WAAW,EAAC,CAAC;AAE1B,MAAM,MAAM,eAAe,CACzB,YAAY,SAAS,gBAAgB,GAAG,gBAAgB,EACxD,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC/D,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAC5B,WAAW,SAAS,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7D,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,SAAS,UAAU,CACtE,gBAAgB,EAChB,MAAM,eAAe,CACtB,GACG,eAAe,GACf,WAAW,IACb,aAAa,CACf,gBAAgB,EAChB,OAAO,EACP,0BAA0B,CAAC,OAAO,CAAC,CACpC,CAAC;AAEF,qBAAa,iBAAiB,CAC5B,QAAQ,SAAS,eAAe,EAChC,YAAY,SACV,kBAAkB,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAC7D,YAAW,YAAY,CAAC,YAAY,CAAC;;gBAIzB,OAAO,EAAE,QAAQ;IAI7B,WAAW,CAAC,CAAC,EACX,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,CAAC,YAAY,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,CAAC,CAAC;CASd;AA+CD,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAuB7D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,MAAM,EACtB,QAAQ,SAAS,eAAe,EAEhC,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,QAAQ,GACf,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC,CAKpD"}

package/out/zero-server/src/adapters/drizzle.js

@@ -1,4 +1,3 @@
-import { sql } from "drizzle-orm";
 import { executePostgresQuery } from "../pg-query-executor.js";
 import { ZQLDatabase } from "../zql-database.js";
 class DrizzleConnection {
@@ -30,29 +29,17 @@ class DrizzleInternalTransaction {
       serverSchema
     );
   }
-  async query(sql2, params) {
-    const stmt = fromDollarParams(sql2, params);
-    const result = await this.wrappedTransaction.execute(stmt);
+  async query(sql, params) {
+    const prepared = this.wrappedTransaction._.session.prepareQuery(
+      { sql, params },
+      void 0,
+      void 0,
+      false
+    );
+    const result = await prepared.execute();
     return toIterableRows(result);
   }
 }
-function fromDollarParams(text, params) {
-  const re = /\$(\d+)/g;
-  const s = sql.empty();
-  let last = 0;
-  let m;
-  while ((m = re.exec(text)) !== null) {
-    const idx = Number(m[1]) - 1;
-    if (idx < 0 || idx >= params.length) {
-      throw new Error(`Missing param for $${m[1]}`);
-    }
-    if (m.index > last) s.append(sql.raw(text.slice(last, m.index)));
-    s.append(sql`${params[idx]}`);
-    last = m.index + m[0].length;
-  }
-  if (last < text.length) s.append(sql.raw(text.slice(last)));
-  return s;
-}
 function isIterable(value) {
   return (
     // oxlint-disable-next-line eqeqeq
@@ -91,7 +78,6 @@ function zeroDrizzle(schema, client) {
 }
 export {
   DrizzleConnection,
-  fromDollarParams,
   toIterableRows,
   zeroDrizzle
 };

package/out/zero-server/src/adapters/drizzle.js.map

@@ -1 +1 @@
-{"version":3,"file":"drizzle.js","sources":["../../../../../zero-server/src/adapters/drizzle.ts"],"sourcesContent":["import {sql, type SQL} from 'drizzle-orm';\nimport type {\n  PgDatabase,\n  PgQueryResultHKT,\n  PgTransaction,\n} from 'drizzle-orm/pg-core';\nimport type {ExtractTablesWithRelations} from 'drizzle-orm/relations';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport type {Format} from '../../../zero-types/src/format.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport type {ServerSchema} from '../../../zero-types/src/server-schema.ts';\nimport type {\n  DBConnection,\n  DBTransaction,\n  Row,\n} from '../../../zql/src/mutate/custom.ts';\nimport type {HumanReadable} from '../../../zql/src/query/query.ts';\nimport {executePostgresQuery} from '../pg-query-executor.ts';\nimport {ZQLDatabase} from '../zql-database.ts';\n\nexport type {ZQLDatabase};\n\nexport type DrizzleDatabase<\n  TQueryResult extends PgQueryResultHKT = PgQueryResultHKT,\n  TSchema extends Record<string, unknown> = Record<string, unknown>,\n> = PgDatabase<TQueryResult, TSchema>;\n\n/**\n * Helper type for the wrapped transaction used by drizzle-orm.\n *\n * @remarks Use with `ServerTransaction` as `ServerTransaction<Schema, DrizzleTransaction<typeof drizzleDb>>`.\n */\nexport type DrizzleTransaction<\n  TDbOrSchema extends DrizzleDatabase | Record<string, unknown>,\n  TSchema extends Record<string, unknown> = TDbOrSchema extends PgDatabase<\n    PgQueryResultHKT,\n    infer TInferredSchema\n  >\n    ? TInferredSchema\n    : TDbOrSchema,\n> = PgTransaction<\n  PgQueryResultHKT,\n  TSchema,\n  ExtractTablesWithRelations<TSchema>\n>;\n\nexport class DrizzleConnection<\n  TDrizzle extends DrizzleDatabase,\n  TTransaction extends\n    DrizzleTransaction<TDrizzle> = DrizzleTransaction<TDrizzle>,\n> implements DBConnection<TTransaction>\n{\n  readonly #drizzle: TDrizzle;\n\n  constructor(drizzle: TDrizzle) {\n    this.#drizzle = drizzle;\n  }\n\n  transaction<T>(\n    fn: (tx: DBTransaction<TTransaction>) => Promise<T>,\n  ): Promise<T> {\n    return this.#drizzle.transaction(drizzleTx =>\n      fn(\n        new DrizzleInternalTransaction(\n          drizzleTx,\n        ) as DBTransaction<TTransaction>,\n      ),\n    );\n  }\n}\n\nclass DrizzleInternalTransaction<\n  TTransaction extends DrizzleTransaction<DrizzleDatabase>,\n> implements DBTransaction<TTransaction>\n{\n  readonly wrappedTransaction: TTransaction;\n\n  constructor(drizzleTx: TTransaction) {\n    this.wrappedTransaction = drizzleTx;\n  }\n\n  runQuery<TReturn>(\n    ast: AST,\n    format: Format,\n    schema: Schema,\n    serverSchema: ServerSchema,\n  ): Promise<HumanReadable<TReturn>> {\n    return executePostgresQuery<TReturn>(\n      this,\n      ast,\n      format,\n      schema,\n      serverSchema,\n    );\n  }\n\n  async query(sql: string, params: unknown[]): Promise<Iterable<Row>> {\n    const stmt = fromDollarParams(sql, params);\n    const result = await this.wrappedTransaction.execute(stmt);\n    return toIterableRows(result);\n  }\n}\n\n/**\n * Turn `$1, $2...` placeholders into a Drizzle SQL object with bound params.\n */\nexport function fromDollarParams(text: string, params: unknown[]): SQL {\n  const re = /\\$(\\d+)/g;\n  const s = sql.empty();\n  let last = 0;\n  let m: RegExpExecArray | null;\n\n  while ((m = re.exec(text)) !== null) {\n    const idx = Number(m[1]) - 1;\n    if (idx < 0 || idx >= params.length) {\n      throw new Error(`Missing param for $${m[1]}`);\n    }\n    if (m.index > last) s.append(sql.raw(text.slice(last, m.index)));\n    s.append(sql`${params[idx]}`); // parameterized value\n    last = m.index + m[0].length;\n  }\n  if (last < text.length) s.append(sql.raw(text.slice(last)));\n  return s;\n}\n\nfunction isIterable(value: unknown): value is Iterable<unknown> {\n  return (\n    // oxlint-disable-next-line eqeqeq\n    value != null &&\n    typeof (value as Iterable<unknown>)[Symbol.iterator] === 'function'\n  );\n}\n\nexport function toIterableRows(result: unknown): Iterable<Row> {\n  if (result === null || result === undefined) {\n    return [] as Row[];\n  }\n  if (Array.isArray(result)) {\n    return result as Row[];\n  }\n  if (isIterable(result)) {\n    return result as Iterable<Row>;\n  }\n  if (typeof result === 'object') {\n    const rows = (result as {rows?: unknown}).rows;\n    if (rows === null || rows === undefined) {\n      return [] as Row[];\n    }\n    if (Array.isArray(rows)) {\n      return rows as Row[];\n    }\n    if (isIterable(rows)) {\n      return rows as Iterable<Row>;\n    }\n  }\n  throw new TypeError('Drizzle query result is not iterable');\n}\n\n/**\n * Wrap a `drizzle-orm` database for Zero ZQL.\n *\n * Provides ZQL querying plus access to the underlying drizzle transaction.\n * Use {@link DrizzleTransaction} to type your server mutator transaction.\n *\n * @param schema - Zero schema.\n * @param client - Drizzle database.\n *\n * @example\n * ```ts\n * import {Pool} from 'pg';\n * import {drizzle} from 'drizzle-orm/node-postgres';\n * import type {ServerTransaction} from '@rocicorp/zero';\n *\n * const pool = new Pool({connectionString: process.env.ZERO_UPSTREAM_DB!});\n * const drizzleDb = drizzle(pool, {schema: drizzleSchema});\n *\n * const zql = zeroDrizzle(schema, drizzleDb);\n *\n * // Define the server mutator transaction type using the helper\n * type ServerTx = ServerTransaction<Schema, DrizzleTransaction<typeof drizzleDb>>;\n *\n * async function createUser(\n *   tx: ServerTx,\n *   {id, name}: {id: string; name: string},\n * ) {\n *   await tx.dbTransaction.wrappedTransaction\n *     .insert(drizzleSchema.user)\n *     .values({id, name})\n * }\n * ```\n */\nexport function zeroDrizzle<\n  TSchema extends Schema,\n  TDrizzle extends DrizzleDatabase,\n>(\n  schema: TSchema,\n  client: TDrizzle,\n): ZQLDatabase<TSchema, DrizzleTransaction<TDrizzle>> {\n  return new ZQLDatabase(\n    new DrizzleConnection<TDrizzle, DrizzleTransaction<TDrizzle>>(client),\n    schema,\n  );\n}\n"],"names":["sql"],"mappings":";;;AA8CO,MAAM,kBAKb;AAAA,EACW;AAAA,EAET,YAAY,SAAmB;AAC7B,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,YACE,IACY;AACZ,WAAO,KAAK,SAAS;AAAA,MAAY,CAAA,cAC/B;AAAA,QACE,IAAI;AAAA,UACF;AAAA,QAAA;AAAA,MACF;AAAA,IACF;AAAA,EAEJ;AACF;AAEA,MAAM,2BAGN;AAAA,EACW;AAAA,EAET,YAAY,WAAyB;AACnC,SAAK,qBAAqB;AAAA,EAC5B;AAAA,EAEA,SACE,KACA,QACA,QACA,cACiC;AACjC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,MAAM,MAAMA,MAAa,QAA2C;AAClE,UAAM,OAAO,iBAAiBA,MAAK,MAAM;AACzC,UAAM,SAAS,MAAM,KAAK,mBAAmB,QAAQ,IAAI;AACzD,WAAO,eAAe,MAAM;AAAA,EAC9B;AACF;AAKO,SAAS,iBAAiB,MAAc,QAAwB;AACrE,QAAM,KAAK;AACX,QAAM,IAAI,IAAI,MAAA;AACd,MAAI,OAAO;AACX,MAAI;AAEJ,UAAQ,IAAI,GAAG,KAAK,IAAI,OAAO,MAAM;AACnC,UAAM,MAAM,OAAO,EAAE,CAAC,CAAC,IAAI;AAC3B,QAAI,MAAM,KAAK,OAAO,OAAO,QAAQ;AACnC,YAAM,IAAI,MAAM,sBAAsB,EAAE,CAAC,CAAC,EAAE;AAAA,IAC9C;AACA,QAAI,EAAE,QAAQ,KAAM,GAAE,OAAO,IAAI,IAAI,KAAK,MAAM,MAAM,EAAE,KAAK,CAAC,CAAC;AAC/D,MAAE,OAAO,MAAM,OAAO,GAAG,CAAC,EAAE;AAC5B,WAAO,EAAE,QAAQ,EAAE,CAAC,EAAE;AAAA,EACxB;AACA,MAAI,OAAO,KAAK,OAAQ,GAAE,OAAO,IAAI,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC;AAC1D,SAAO;AACT;AAEA,SAAS,WAAW,OAA4C;AAC9D;AAAA;AAAA,IAEE,SAAS,QACT,OAAQ,MAA4B,OAAO,QAAQ,MAAM;AAAA;AAE7D;AAEO,SAAS,eAAe,QAAgC;AAC7D,MAAI,WAAW,QAAQ,WAAW,QAAW;AAC3C,WAAO,CAAA;AAAA,EACT;AACA,MAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,WAAO;AAAA,EACT;AACA,MAAI,WAAW,MAAM,GAAG;AACtB,WAAO;AAAA,EACT;AACA,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,OAAQ,OAA4B;AAC1C,QAAI,SAAS,QAAQ,SAAS,QAAW;AACvC,aAAO,CAAA;AAAA,IACT;AACA,QAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,IAAI,GAAG;AACpB,aAAO;AAAA,IACT;AAAA,EACF;AACA,QAAM,IAAI,UAAU,sCAAsC;AAC5D;AAmCO,SAAS,YAId,QACA,QACoD;AACpD,SAAO,IAAI;AAAA,IACT,IAAI,kBAA0D,MAAM;AAAA,IACpE;AAAA,EAAA;AAEJ;"}
+{"version":3,"file":"drizzle.js","sources":["../../../../../zero-server/src/adapters/drizzle.ts"],"sourcesContent":["import type {\n  PgDatabase,\n  PgQueryResultHKT,\n  PgTransaction,\n} from 'drizzle-orm/pg-core';\nimport type {ExtractTablesWithRelations} from 'drizzle-orm/relations';\nimport type {AST} from '../../../zero-protocol/src/ast.ts';\nimport type {Format} from '../../../zero-types/src/format.ts';\nimport type {Schema} from '../../../zero-types/src/schema.ts';\nimport type {ServerSchema} from '../../../zero-types/src/server-schema.ts';\nimport type {\n  DBConnection,\n  DBTransaction,\n  Row,\n} from '../../../zql/src/mutate/custom.ts';\nimport type {HumanReadable} from '../../../zql/src/query/query.ts';\nimport {executePostgresQuery} from '../pg-query-executor.ts';\nimport {ZQLDatabase} from '../zql-database.ts';\n\nexport type {ZQLDatabase};\n\nexport type DrizzleDatabase<\n  TQueryResult extends PgQueryResultHKT = PgQueryResultHKT,\n  TSchema extends Record<string, unknown> = Record<string, unknown>,\n> = PgDatabase<TQueryResult, TSchema>;\n\n/**\n * Helper type for the wrapped transaction used by drizzle-orm.\n *\n * @remarks Use with `ServerTransaction` as `ServerTransaction<Schema, DrizzleTransaction<typeof drizzleDb>>`.\n */\nexport type DrizzleTransaction<\n  TDbOrSchema extends DrizzleDatabase | Record<string, unknown>,\n  TSchema extends Record<string, unknown> = TDbOrSchema extends PgDatabase<\n    PgQueryResultHKT,\n    infer TInferredSchema\n  >\n    ? TInferredSchema\n    : TDbOrSchema,\n> = PgTransaction<\n  PgQueryResultHKT,\n  TSchema,\n  ExtractTablesWithRelations<TSchema>\n>;\n\nexport class DrizzleConnection<\n  TDrizzle extends DrizzleDatabase,\n  TTransaction extends\n    DrizzleTransaction<TDrizzle> = DrizzleTransaction<TDrizzle>,\n> implements DBConnection<TTransaction>\n{\n  readonly #drizzle: TDrizzle;\n\n  constructor(drizzle: TDrizzle) {\n    this.#drizzle = drizzle;\n  }\n\n  transaction<T>(\n    fn: (tx: DBTransaction<TTransaction>) => Promise<T>,\n  ): Promise<T> {\n    return this.#drizzle.transaction(drizzleTx =>\n      fn(\n        new DrizzleInternalTransaction(\n          drizzleTx,\n        ) as DBTransaction<TTransaction>,\n      ),\n    );\n  }\n}\n\nclass DrizzleInternalTransaction<\n  TTransaction extends DrizzleTransaction<DrizzleDatabase>,\n> implements DBTransaction<TTransaction>\n{\n  readonly wrappedTransaction: TTransaction;\n\n  constructor(drizzleTx: TTransaction) {\n    this.wrappedTransaction = drizzleTx;\n  }\n\n  runQuery<TReturn>(\n    ast: AST,\n    format: Format,\n    schema: Schema,\n    serverSchema: ServerSchema,\n  ): Promise<HumanReadable<TReturn>> {\n    return executePostgresQuery<TReturn>(\n      this,\n      ast,\n      format,\n      schema,\n      serverSchema,\n    );\n  }\n\n  async query(sql: string, params: unknown[]): Promise<Iterable<Row>> {\n    const prepared = this.wrappedTransaction._.session.prepareQuery(\n      {sql, params},\n      undefined,\n      undefined,\n      false,\n    );\n    const result = await prepared.execute();\n    return toIterableRows(result);\n  }\n}\n\nfunction isIterable(value: unknown): value is Iterable<unknown> {\n  return (\n    // oxlint-disable-next-line eqeqeq\n    value != null &&\n    typeof (value as Iterable<unknown>)[Symbol.iterator] === 'function'\n  );\n}\n\nexport function toIterableRows(result: unknown): Iterable<Row> {\n  if (result === null || result === undefined) {\n    return [] as Row[];\n  }\n  if (Array.isArray(result)) {\n    return result as Row[];\n  }\n  if (isIterable(result)) {\n    return result as Iterable<Row>;\n  }\n  if (typeof result === 'object') {\n    const rows = (result as {rows?: unknown}).rows;\n    if (rows === null || rows === undefined) {\n      return [] as Row[];\n    }\n    if (Array.isArray(rows)) {\n      return rows as Row[];\n    }\n    if (isIterable(rows)) {\n      return rows as Iterable<Row>;\n    }\n  }\n  throw new TypeError('Drizzle query result is not iterable');\n}\n\n/**\n * Wrap a `drizzle-orm` database for Zero ZQL.\n *\n * Provides ZQL querying plus access to the underlying drizzle transaction.\n * Use {@link DrizzleTransaction} to type your server mutator transaction.\n *\n * @param schema - Zero schema.\n * @param client - Drizzle database.\n *\n * @example\n * ```ts\n * import {Pool} from 'pg';\n * import {drizzle} from 'drizzle-orm/node-postgres';\n * import {defineMutator, defineMutators} from '@rocicorp/zero';\n * import {zeroDrizzle} from '@rocicorp/zero/server/adapters/drizzle';\n * import {z} from 'zod/mini';\n *\n * const pool = new Pool({connectionString: process.env.ZERO_UPSTREAM_DB!});\n * const drizzleDb = drizzle(pool, {schema: drizzleSchema});\n * const zql = zeroDrizzle(schema, drizzleDb);\n *\n * export const serverMutators = defineMutators({\n *   user: {\n *     create: defineMutator(\n *       z.object({id: z.string(), name: z.string()}),\n *       async ({tx, args}) => {\n *         if (tx.location !== 'server') {\n *           throw new Error('Server-only mutator');\n *         }\n *         await tx.dbTransaction.wrappedTransaction\n *           .insert(drizzleSchema.user)\n *           .values({id: args.id, name: args.name, status: 'active'});\n *       },\n *     ),\n *   },\n * });\n * ```\n */\nexport function zeroDrizzle<\n  TSchema extends Schema,\n  TDrizzle extends DrizzleDatabase,\n>(\n  schema: TSchema,\n  client: TDrizzle,\n): ZQLDatabase<TSchema, DrizzleTransaction<TDrizzle>> {\n  return new ZQLDatabase(\n    new DrizzleConnection<TDrizzle, DrizzleTransaction<TDrizzle>>(client),\n    schema,\n  );\n}\n"],"names":[],"mappings":";;AA6CO,MAAM,kBAKb;AAAA,EACW;AAAA,EAET,YAAY,SAAmB;AAC7B,SAAK,WAAW;AAAA,EAClB;AAAA,EAEA,YACE,IACY;AACZ,WAAO,KAAK,SAAS;AAAA,MAAY,CAAA,cAC/B;AAAA,QACE,IAAI;AAAA,UACF;AAAA,QAAA;AAAA,MACF;AAAA,IACF;AAAA,EAEJ;AACF;AAEA,MAAM,2BAGN;AAAA,EACW;AAAA,EAET,YAAY,WAAyB;AACnC,SAAK,qBAAqB;AAAA,EAC5B;AAAA,EAEA,SACE,KACA,QACA,QACA,cACiC;AACjC,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,MAAM,MAAM,KAAa,QAA2C;AAClE,UAAM,WAAW,KAAK,mBAAmB,EAAE,QAAQ;AAAA,MACjD,EAAC,KAAK,OAAA;AAAA,MACN;AAAA,MACA;AAAA,MACA;AAAA,IAAA;AAEF,UAAM,SAAS,MAAM,SAAS,QAAA;AAC9B,WAAO,eAAe,MAAM;AAAA,EAC9B;AACF;AAEA,SAAS,WAAW,OAA4C;AAC9D;AAAA;AAAA,IAEE,SAAS,QACT,OAAQ,MAA4B,OAAO,QAAQ,MAAM;AAAA;AAE7D;AAEO,SAAS,eAAe,QAAgC;AAC7D,MAAI,WAAW,QAAQ,WAAW,QAAW;AAC3C,WAAO,CAAA;AAAA,EACT;AACA,MAAI,MAAM,QAAQ,MAAM,GAAG;AACzB,WAAO;AAAA,EACT;AACA,MAAI,WAAW,MAAM,GAAG;AACtB,WAAO;AAAA,EACT;AACA,MAAI,OAAO,WAAW,UAAU;AAC9B,UAAM,OAAQ,OAA4B;AAC1C,QAAI,SAAS,QAAQ,SAAS,QAAW;AACvC,aAAO,CAAA;AAAA,IACT;AACA,QAAI,MAAM,QAAQ,IAAI,GAAG;AACvB,aAAO;AAAA,IACT;AACA,QAAI,WAAW,IAAI,GAAG;AACpB,aAAO;AAAA,IACT;AAAA,EACF;AACA,QAAM,IAAI,UAAU,sCAAsC;AAC5D;AAwCO,SAAS,YAId,QACA,QACoD;AACpD,SAAO,IAAI;AAAA,IACT,IAAI,kBAA0D,MAAM;AAAA,IACpE;AAAA,EAAA;AAEJ;"}

package/out/zero-server/src/adapters/pg.d.ts

@@ -37,23 +37,29 @@ export declare class NodePgTransactionInternal implements DBTransaction<NodePgTr
  * @example
  * ```ts
  * import {Pool} from 'pg';
+ * import {defineMutator, defineMutators} from '@rocicorp/zero';
+ * import {zeroNodePg} from '@rocicorp/zero/server/adapters/pg';
+ * import {z} from 'zod/mini';
  *
  * const pool = new Pool({connectionString: process.env.ZERO_UPSTREAM_DB!});
  * const zql = zeroNodePg(schema, pool);
  *
- * // Define the server mutator transaction type using the helper
- * type ServerTx = ServerTransaction<
- *   Schema,
- *   NodePgTransaction
- * >;
- *
- * async function createUser(
- *   tx: ServerTx,
- *   {id, name}: {id: string; name: string},
- * ) {
- *   await tx.dbTransaction.wrappedTransaction
- *     .query('SELECT * FROM "user" WHERE id = $1', [id]);
- * }
+ * export const serverMutators = defineMutators({
+ *   user: {
+ *     create: defineMutator(
+ *       z.object({id: z.string(), name: z.string()}),
+ *       async ({tx, args}) => {
+ *         if (tx.location !== 'server') {
+ *           throw new Error('Server-only mutator');
+ *         }
+ *         await tx.dbTransaction.wrappedTransaction.query(
+ *           'INSERT INTO "user" (id, name, status) VALUES ($1, $2, $3)',
+ *           [args.id, args.name, 'active'],
+ *         );
+ *       },
+ *     ),
+ *   },
+ * });
  * ```
  */
 export declare function zeroNodePg<S extends Schema>(schema: S, pg: NodePgTransaction | string): ZQLDatabase<S, NodePgTransaction>;

package/out/zero-server/src/adapters/pg.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pg.d.ts","sourceRoot":"","sources":["../../../../../zero-server/src/adapters/pg.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAC,IAAI,EAAE,KAAK,UAAU,EAAC,MAAM,IAAI,CAAC;AACzC,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,mCAAmC,CAAC;AAC3D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,0CAA0C,CAAC;AAC3E,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,GAAG,EACJ,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,YAAY,EAAC,WAAW,EAAC,CAAC;AAE1B;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,GAAG,UAAU,GAAG,MAAM,CAAC;AAE3D,qBAAa,gBAAiB,YAAW,YAAY,CAAC,iBAAiB,CAAC;;gBAG1D,IAAI,EAAE,iBAAiB;IAI7B,WAAW,CAAC,IAAI,EACpB,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,CAAC,iBAAiB,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC;CAqBjB;AAED,qBAAa,yBACX,YAAW,aAAa,CAAC,iBAAiB,CAAC;IAE3C,QAAQ,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;gBAEnC,MAAM,EAAE,iBAAiB;IAIrC,QAAQ,CAAC,OAAO,EACd,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAU5B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;CAI5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,MAAM,EAAE,CAAC,EACT,EAAE,EAAE,iBAAiB,GAAG,MAAM,qCAM/B"}
+{"version":3,"file":"pg.d.ts","sourceRoot":"","sources":["../../../../../zero-server/src/adapters/pg.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAC,IAAI,EAAE,KAAK,UAAU,EAAC,MAAM,IAAI,CAAC;AACzC,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,mCAAmC,CAAC;AAC3D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,mCAAmC,CAAC;AAC9D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,0CAA0C,CAAC;AAC3E,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,GAAG,EACJ,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,iCAAiC,CAAC;AAEnE,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAE/C,YAAY,EAAC,WAAW,EAAC,CAAC;AAE1B;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,IAAI,GAAG,UAAU,GAAG,MAAM,CAAC;AAE3D,qBAAa,gBAAiB,YAAW,YAAY,CAAC,iBAAiB,CAAC;;gBAG1D,IAAI,EAAE,iBAAiB;IAI7B,WAAW,CAAC,IAAI,EACpB,EAAE,EAAE,CAAC,EAAE,EAAE,aAAa,CAAC,iBAAiB,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAC1D,OAAO,CAAC,IAAI,CAAC;CAqBjB;AAED,qBAAa,yBACX,YAAW,aAAa,CAAC,iBAAiB,CAAC;IAE3C,QAAQ,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;gBAEnC,MAAM,EAAE,iBAAiB;IAIrC,QAAQ,CAAC,OAAO,EACd,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAU5B,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;CAI5D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EACzC,MAAM,EAAE,CAAC,EACT,EAAE,EAAE,iBAAiB,GAAG,MAAM,qCAM/B"}