turbine-orm 0.36.1 → 0.38.0

package/dist/cli/studio.d.ts

@@ -20,8 +20,9 @@
  *     $N params compiled through the query builders
  *   • Read routes run in a READ ONLY transaction (belt-and-suspenders)
  *   • Write routes (only when `--write` is set) run in a plain BEGIN/COMMIT
- *     transaction, require a matching Origin header (CSRF), and target exactly
- *     one row by its full primary key
+ *     transaction, require a matching Origin header (CSRF), and address every
+ *     row by its full primary key (single row, or a capped `rows` array of
+ *     PK-addressed statements run atomically)
  *   • 30s statement timeout via parameterized set_config()
  *   • Per-session rate limiting, cross-origin refusal, security headers, and a
  *     per-request CSP nonce for the inline script (no `unsafe-inline`)
@@ -30,12 +31,14 @@
  * every row-bearing response (the literal `•• redacted ••`) unless the server
  * was started with `--show-pii`.
  *
- * Write model (opt-in): update/insert/delete a single row. DDL and multi-row or
- * unconditional writes are deliberately unsupported. Use the CLI or migrate for
- * schema changes and bulk operations.
+ * Write model (opt-in): update a single row; insert/delete one row or a capped
+ * list of PK-addressed rows in one all-or-nothing transaction. DDL and
+ * predicate-based (unconditional) writes are deliberately unsupported. Use the
+ * CLI or migrate for schema changes and true bulk operations.
  */
 import { type IncomingMessage, type ServerResponse } from 'node:http';
-import pg from 'pg';
+import type { PgCompatPool } from '../client.js';
+import type { Dialect } from '../dialect.js';
 import type { SchemaMetadata, TableMetadata } from '../schema.js';
 export interface StudioOptions {
     url: string;
@@ -58,6 +61,13 @@ export interface StudioOptions {
      * Reveal PII-tagged column values instead of redacting them. Default `false`.
      */
     showPii?: boolean;
+    /**
+     * Boot with a seeded, in-memory sample database instead of connecting to a
+     * real one (no DATABASE_URL required). Backed by Turbine's own SQLite engine
+     * over `node:sqlite` `:memory:`; nothing is ever persisted. Enables the live
+     * three-mode switcher (`/api/demo/mode`). Default `false`.
+     */
+    demo?: boolean;
 }
 export interface StudioHandle {
     /** Shut down the server + pool cleanly. */
@@ -68,7 +78,14 @@ export interface StudioHandle {
     url: string;
 }
 export interface StudioContext {
-    pool: pg.Pool;
+    /**
+     * The pg-compatible pool. A real `pg.Pool` in normal mode, a `SqlitePool`
+     * over an in-memory database in demo mode. Typed as the minimal
+     * `PgCompatPool` contract so both shapes work through one code path (pg.Pool
+     * satisfies it; the query builders take `pg.Pool` via a cast, matching the
+     * external-pool seam in client.ts).
+     */
+    pool: PgCompatPool;
     metadata: SchemaMetadata;
     options: StudioOptions;
     authToken: string;
@@ -85,11 +102,29 @@ export interface StudioContext {
     }>;
     /**
      * True when write mode is enabled (`--write`): the `/api/row/*` routes exist
-     * and the UI renders write affordances. Absent/false → read-only.
+     * and the UI renders write affordances. Absent/false → read-only. In demo
+     * mode this is toggled live by the `/api/demo/mode` switcher.
      */
     writable?: boolean;
     /** True when PII redaction is disabled (`--show-pii`). Absent/false → redact. */
     showPii?: boolean;
+    /**
+     * True when Studio is running against the seeded in-memory demo store
+     * (`--demo`). Branches the handful of Postgres-specific statements onto their
+     * SQLite equivalents and enables the `/api/demo/mode` live switcher.
+     */
+    demo?: boolean;
+    /**
+     * SQL dialect the builder/write handlers compile against. Absent → Postgres
+     * (the default). Set to the SQLite dialect in demo mode.
+     */
+    dialect?: Dialect;
+    /**
+     * Demo mode only: saved queries live here instead of on disk, honoring the
+     * "nothing you do here is saved anywhere" promise. Absent in normal mode
+     * (saved queries persist to `<stateDir>/studio-queries.json`).
+     */
+    memorySavedQueries?: SavedQueriesFile;
 }
 /**
  * Start the Studio server. Returns a handle with the session token, a pre-built
@@ -102,14 +137,29 @@ export interface StudioContext {
  */
 export declare function startStudio(options: StudioOptions): Promise<StudioHandle>;
 export declare function handleRequest(req: IncomingMessage, res: ServerResponse, ctx: StudioContext): Promise<void>;
+export declare function apiDemoMode(req: IncomingMessage, res: ServerResponse, ctx: StudioContext): Promise<void>;
 export declare function apiTableRows(res: ServerResponse, ctx: StudioContext, rawTableName: string, params: URLSearchParams): Promise<void>;
 export declare function resolveColumnName(table: TableMetadata, nameOrField: string): string | null;
 export declare function isTextishType(pgType: string): boolean;
 export declare function escapeLikePattern(s: string): string;
 export declare function apiBuilder(req: IncomingMessage, res: ServerResponse, ctx: StudioContext): Promise<void>;
 export declare function apiRowWrite(req: IncomingMessage, res: ServerResponse, ctx: StudioContext, op: 'update' | 'insert' | 'delete'): Promise<void>;
+interface SavedQuery {
+    id: string;
+    table: string;
+    name: string;
+    /** Studio only saves visual-builder queries — there is no raw-SQL surface. */
+    kind: 'builder';
+    args?: unknown;
+    createdAt: string;
+}
+interface SavedQueriesFile {
+    version: 1;
+    queries: SavedQuery[];
+}
 export declare function apiListSavedQueries(res: ServerResponse, ctx: StudioContext, params: URLSearchParams): void;
 export declare function apiCreateSavedQuery(req: IncomingMessage, res: ServerResponse, ctx: StudioContext): Promise<void>;
 export declare function apiDeleteSavedQuery(res: ServerResponse, ctx: StudioContext, id: string): void;
 /** The literal replacement value for a redacted PII cell. */
 export declare const PII_REDACTED = "\u2022\u2022 redacted \u2022\u2022";
+export {};