Skip to content

Package Structure

Below is a full breakdown of all Core, Feature, Experimental, and Utility packages available in SQLRooms. Each package can be installed independently via pnpm add @sqlrooms/<name> and mixed‑and‑matched to suit your app's needs.

Core Packages

  • @sqlrooms/artifacts — Artifact registry, workspace tab helpers, and layout integration for dashboards, notebooks, documents, canvases, pivots, and apps.
  • @sqlrooms/blocks — Shared block contracts and vocabulary for composable SQLRooms blocks and block containers.
  • @sqlrooms/room-config — Zod schemas and types for persisted room configuration.
  • @sqlrooms/room-shell — Central application shell and Zustand‑based state manager with panel system and DuckDB integration.
  • @sqlrooms/room-store — Core state management utilities, RoomStore, and React context providers.
  • @sqlrooms/duckdb — WebAssembly build of DuckDB plus helper hooks for query execution and data import.
  • @sqlrooms/duckdb-core — Shared DuckDB connector contracts and core query/import utilities.
  • @sqlrooms/duckdb-node — Node.js DuckDB connector for server-side SQLRooms runtimes.
  • @sqlrooms/db — DuckDB-centered orchestration layer for multi-database execution.
  • @sqlrooms/db-settings — Database connection settings state and UI components.
  • @sqlrooms/ui — Tailwind‑powered component library and theme manager used across all other packages.
  • @sqlrooms/ai — Natural‑language querying and AI‑assisted analytics tools.
  • @sqlrooms/ai-config — Zod schemas and defaults for persisted AI slice configuration.
  • @sqlrooms/ai-core — Lower-level AI slice, chat UI primitives, and tool-streaming utilities.
  • @sqlrooms/ai-settings — AI provider/model settings state and UI components.
  • @sqlrooms/layout — Panel layout management built on react‑mosaic.
  • @sqlrooms/layout-config — Zod schemas and types for persisted layout configuration.

Feature Packages

Experimental Packages

  • @sqlrooms/ai-rag — Retrieval-augmented generation slice for semantic search over DuckDB-backed embeddings.
  • @sqlrooms/canvas — React Flow-based artifact canvas for SQL, Vega, and dataflow node DAGs.
  • @sqlrooms/crdt — Loro-backed CRDT slice, persistence, and sync helpers.
  • @sqlrooms/discuss — Threaded discussion system with anchor links to data points.
  • @sqlrooms/notebook — Artifact-scoped notebook UI and state slice for SQL, text, Markdown, Vega, and input cells.
  • @sqlrooms/pivot — Slice-driven pivot table UI backed by DuckDB SQL and Vega-Lite charts.
  • @sqlrooms/webcontainer — WebContainer state slice and runtime helpers for app-building workflows.

Utility Packages

  • @sqlrooms/utils — Shared helper functions for colors, formatting, random IDs, and string utilities.

Extension Points