@querypanel/node-sdk 1.3.0-beta.1 → 1.3.0

package/README.md

@@ -56,7 +56,7 @@ const createPostgresClient = () => async (sql: string, params?: unknown[]) => {
 	});
 
 qp.attachClickhouse(
-  "clicks", // uniq identifier for QueryPanel
+  "analytics", // uniq identifier for QueryPanel
   (params) => clickhouse.query(params),
   {
     database: "analytics", // database name
@@ -65,15 +65,10 @@ qp.attachClickhouse(
   },
 );
 
-// Syncs schema. Skips embedding if schema hasn't changed (no drift).
-// Pass { forceReindex: true } to force re-embedding.
-await qp.syncSchema("analytics", { tenantId: "tenant_123" });
-
 const response = await qp.ask("Top countries by revenue", {
   tenantId: "tenant_123",
   database: "analytics",
 });
-// Defaults to pipeline "v2" (POST /v2/query). Pass pipeline: "v1" only for legacy.
 
 console.log(response.sql);
 console.log(response.params);
@@ -81,23 +76,71 @@ console.table(response.rows);
 console.log(response.chart.vegaLiteSpec);
 ```
 
-### Custom system instructions (v2 pipeline)
+Run `syncSchema` separately — see [Schema sync](#schema-sync).
+
+### Schema sync
+
+`syncSchema` introspects an attached database and uploads table/column metadata so natural-language questions can generate accurate SQL. Treat it like a **migration**, not part of `ask()`:
 
-If you need to enforce tenant-specific policies that should apply to every query (for example, data retention windows), you can inject additional **system prompt** instructions into the v2 pipeline (the default):
+- Run it once when you first connect a database.
+- Run it again when tables or columns change.
+- Do not call it on every request — put it in a setup/deploy script instead.
 
 ```ts
-const response = await qp.ask("Revenue by product", {
+// scripts/sync-schema.ts — run once at setup, or after schema changes
+await qp.syncSchema("pg_demo", { tenantId: "tenant_123" });
+await qp.syncSchema("analytics", { tenantId: "tenant_123" });
+
+// Unchanged schemas skip re-embedding. Force a rebuild only when needed:
+await qp.syncSchema("analytics", {
   tenantId: "tenant_123",
+  forceReindex: true,
+});
+```
+
+Optionally limit the payload with `tables: ["orders"]`.
+
+### Custom system prompt (`systemPrompt`)
+
+Pass `systemPrompt` on `ask()` to inject extra instructions for SQL generation. Use it when a **client** needs policies QueryPanel does not know about — retention windows, a max date range, excluded event types, and similar product rules. Look up that client’s config in your backend and pass it on every question.
+
+The text is appended to the SQL generator (and reflection) prompts. When it conflicts with generic defaults (for example the usual 30-day trend window), the caller instructions win. It does **not** replace tenant isolation — still attach with `tenantFieldName` and pass `tenantId`. Max length is 8,000 characters. There is no constructor default; `modifyChart()` does not take `systemPrompt`.
+
+```ts
+function systemPromptForClient(client: { retentionDays: number }) {
+  return [
+    `Data retention: only query rows from the last ${client.retentionDays} days.`,
+    `Never return a date range longer than ${client.retentionDays} days, even if the user asks for all time or a wider window.`,
+    "Clamp any requested range to that maximum and bind start/end dates as parameters.",
+  ].join(" ");
+}
+
+const client = await loadClient(req); // your auth + billing/retention settings
+
+const response = await qp.ask("Revenue by product over all time", {
+  tenantId: client.tenantId,
   database: "analytics",
-  systemPrompt: "Retention policy: only query data from the last 30 days.",
+  systemPrompt: systemPromptForClient(client),
 });
 ```
 
-> **Deprecated:** `pipeline: "v1"` still hits `POST /query` for compatibility. Prefer omitting `pipeline` or passing `"v2"`.
+Other per-client instructions:
+
+```ts
+const response = await qp.ask("Show order volume by week", {
+  tenantId: client.tenantId,
+  database: "analytics",
+  systemPrompt: [
+    "Default time range: last 90 days unless the user names a shorter window.",
+    "Maximum lookback: 90 days from today.",
+    "Exclude orders with status refunded or cancelled.",
+  ].join(" "),
+});
+```
 
-### Restricting VizSpec chart types
+### Restricting chart types
 
-If your UI only supports a subset of VizSpec chart kinds (for example no area or scatter), set **`supportedChartTypes`** on the SDK constructor or on each `ask` / `modifyChart` call. The API’s `/vizspec` step then steers generation toward allowed types only (`line`, `bar`, `column`, `area`, `scatter`, `pie`). This applies whenever you use **`chartType: "vizspec"`** (including the default v2 flow after SQL runs).
+If your UI only supports a subset of chart kinds (for example no area or scatter), set **`supportedChartTypes`** on the SDK constructor or on each `ask` / `modifyChart` call (`line`, `bar`, `column`, `area`, `scatter`, `pie`).
 
 ```ts
 import { QueryPanelSdkAPI, ALL_VIZ_CHART_TYPES, type ChartType } from "@querypanel/sdk";
@@ -112,8 +155,6 @@ const qp = new QueryPanelSdkAPI(url, privateKey, workspaceId, {
 await qp.ask("Revenue by month", {
   tenantId: "t1",
   database: "analytics",
-  chartType: "vizspec",
-  pipeline: "v2",
   supportedChartTypes: allowed,
 });
 ```
@@ -245,9 +286,37 @@ const { data, missingIds } = await qp.getChartsByIds(
 Saved charts now include the original `prompt` so you can show the question
 alongside chart history or reuse it in follow-up workflows.
 
+## Referencing Queries by `queryId` (recommended)
+
+`ask()` and `modifyChart()` return a server-issued `queryId`. The server stores the generated SQL and bind params for that id, scoped to the authenticated workspace and tenant. **Pass the id instead of SQL** so your clients never send executable SQL or bind params:
+
+```ts
+const response = await qp.ask("revenue by country", { tenantId, database: "analytics" });
+
+// Modify: SQL and params are loaded from the server, client `sql` / `params` are ignored
+const modified = await qp.modifyChart(
+  { queryId: response.queryId, question: "revenue by country", database: "analytics",
+    vizModifications: { chartType: "bar" } },
+  { tenantId },
+);
+
+// Run a stored query (e.g. in a dashboard)
+await qp.runSqlForDashboard({ queryId: response.queryId, database: "analytics" }, { tenantId });
+
+// Save a chart: the server stores the SQL and params it holds for `query_id`
+await qp.createChart({ title: "Revenue", query_id: modified.queryId, vega_lite_spec: spec }, { tenantId });
+```
+
+- When `queryId` / `query_id` is present it **takes priority**: any `sql` / `sql_params` you also send is ignored.
+- An id that belongs to another tenant, or does not exist, is rejected (`404`).
+- `sql` is still accepted when no id is sent, for backward compatibility. Charts saved without a `query_id` (for example older charts) keep using their stored SQL.
+- `modifyChart()` returns the input `queryId` when only visualization changes, and a new `queryId` when SQL is regenerated. Custom SQL (`customSql`) has no id.
+- Generation fails if the server cannot record the query, so a successful `ask()` always returns a `queryId`.
+- Requires an API that supports `GET /v2/queries/:id`; upgrade the API before the SDK.
+
 ## Modifying Charts
 
-The `modifyChart()` method allows you to edit SQL and/or visualization settings, then re-execute and regenerate charts. It works with both fresh `ask()` responses and saved charts.
+The `modifyChart()` method allows you to edit SQL and/or visualization settings, then re-execute and regenerate charts. It works with both fresh `ask()` responses and saved charts. Prefer `queryId` over `sql` (see above).
 
 ### Changing Visualization Settings
 

package/dist/index.cjs

@@ -1968,11 +1968,17 @@ function buildSchemaRequest(databaseName, adapter, introspection, metadata) {
     dialect,
     tables
   };
-  if (metadata?.tenantFieldName && metadata?.tenantFieldType && metadata?.enforceTenantIsolation !== void 0) {
+  if (metadata?.enforceTenantIsolation === false) {
+    request.tenant_settings = {
+      tenantFieldName: metadata.tenantFieldName ?? "",
+      tenantFieldType: metadata.tenantFieldType ?? "String",
+      enforceTenantIsolation: false
+    };
+  } else if (metadata?.tenantFieldName && metadata?.tenantFieldType) {
     request.tenant_settings = {
       tenantFieldName: metadata.tenantFieldName,
       tenantFieldType: metadata.tenantFieldType,
-      enforceTenantIsolation: metadata.enforceTenantIsolation
+      enforceTenantIsolation: true
     };
   }
   return request;
@@ -2000,11 +2006,17 @@ async function ask(client, queryEngine, question, options, signal) {
     const databaseName = options.database ?? queryEngine.getDefaultDatabase();
     const metadata = databaseName ? queryEngine.getDatabaseMetadata(databaseName) : void 0;
     let tenantSettings;
-    if (metadata?.tenantFieldName) {
+    if (metadata?.enforceTenantIsolation === false) {
+      tenantSettings = {
+        tenantFieldName: metadata.tenantFieldName ?? "",
+        tenantFieldType: metadata.tenantFieldType ?? "String",
+        enforceTenantIsolation: false
+      };
+    } else if (metadata?.tenantFieldName) {
       tenantSettings = {
         tenantFieldName: metadata.tenantFieldName,
         tenantFieldType: metadata.tenantFieldType,
-        enforceTenantIsolation: metadata.enforceTenantIsolation
+        enforceTenantIsolation: true
       };
     }
     const queryResponse = await client.postWithHeaders(
@@ -2182,6 +2194,25 @@ function anonymizeResults(rows) {
   });
 }
 
+// src/routes/queries.ts
+async function resolveQuery(client, queryEngine, queryId, options, signal) {
+  const response = await client.get(
+    `/v2/queries/${encodeURIComponent(queryId)}`,
+    options.tenantId,
+    options.userId,
+    options.scopes,
+    signal
+  );
+  const paramMetadata = Array.isArray(response.params) ? response.params : [];
+  return {
+    queryId: response.queryId,
+    sql: response.sql,
+    params: queryEngine.mapGeneratedParams(paramMetadata),
+    paramMetadata,
+    dialect: response.dialect
+  };
+}
+
 // src/routes/modify.ts
 function buildModifiedQuestion(originalQuestion, modifications, pipeline, hasSessionContext = false) {
   const hints = [];
@@ -2336,11 +2367,28 @@ async function modifyChart(client, queryEngine, input, options, signal) {
   const hasCustomSql = !!input.sqlModifications?.customSql;
   const pipeline = resolveQueryPipeline(options?.pipeline);
   const queryEndpoint = pipeline === "v2" ? "/v2/query" : "/query";
-  let finalSql = input.sql;
+  let currentSql = input.sql;
   let finalParams = input.params ?? {};
   let paramMetadata = [];
   let rationale;
   let queryId;
+  if (input.queryId) {
+    const resolved = await resolveQuery(
+      client,
+      queryEngine,
+      input.queryId,
+      { tenantId, userId: options?.userId, scopes: options?.scopes },
+      signal
+    );
+    currentSql = resolved.sql;
+    finalParams = resolved.params;
+    paramMetadata = resolved.paramMetadata;
+    queryId = resolved.queryId;
+  }
+  if (!currentSql) {
+    throw new Error("modifyChart requires either queryId or sql.");
+  }
+  let finalSql = currentSql;
   let sqlChanged = false;
   let finalQuestion = input.question;
   const databaseName = input.database ?? queryEngine.getDefaultDatabase();
@@ -2351,17 +2399,24 @@ async function modifyChart(client, queryEngine, input, options, signal) {
   }
   const metadata = queryEngine.getDatabaseMetadata(databaseName);
   let tenantSettings;
-  if (metadata?.tenantFieldName) {
+  if (metadata?.enforceTenantIsolation === false) {
+    tenantSettings = {
+      tenantFieldName: metadata.tenantFieldName ?? "",
+      tenantFieldType: metadata.tenantFieldType ?? "String",
+      enforceTenantIsolation: false
+    };
+  } else if (metadata?.tenantFieldName) {
     tenantSettings = {
       tenantFieldName: metadata.tenantFieldName,
       tenantFieldType: metadata.tenantFieldType,
-      enforceTenantIsolation: metadata.enforceTenantIsolation
+      enforceTenantIsolation: true
     };
   }
   if (hasCustomSql) {
     finalSql = input.sqlModifications.customSql;
     finalParams = {};
     paramMetadata = [];
+    queryId = void 0;
     sqlChanged = true;
   } else if (hasSqlMods && !hasCustomSql) {
     const modifiedQuestion = buildModifiedQuestion(
@@ -2378,7 +2433,7 @@ async function modifyChart(client, queryEngine, input, options, signal) {
       {
         question: modifiedQuestion,
         session_id: querypanelSessionId,
-        previous_sql: input.sql,
+        previous_sql: currentSql,
         ...options?.maxRetry ? { max_retry: options.maxRetry } : {},
         ...tenantSettings ? { tenant_settings: tenantSettings } : {},
         ...databaseName ? { database: databaseName } : {},
@@ -2403,7 +2458,7 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     }
     rationale = queryResponse.rationale;
     queryId = queryResponse.queryId;
-    sqlChanged = finalSql !== input.sql;
+    sqlChanged = finalSql !== currentSql;
   }
   const execution = await queryEngine.validateAndExecute(
     finalSql,
@@ -2611,6 +2666,12 @@ var ALL_VIZ_CHART_TYPES = [
 ];
 
 // src/index.ts
+function resolveAttachEnforceTenantIsolation(tenantFieldName, enforceTenantIsolation) {
+  if (enforceTenantIsolation !== void 0) {
+    return enforceTenantIsolation;
+  }
+  return tenantFieldName ? true : void 0;
+}
 var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
   /**
    * @param workspaceId - Workspace UUID (same value as your org in the dashboard). Passed to the API as JWT claim `organizationId`.
@@ -2681,7 +2742,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       tags: options?.tags,
       tenantFieldName: options?.tenantFieldName,
       tenantFieldType: options?.tenantFieldType ?? "String",
-      enforceTenantIsolation: options?.tenantFieldName ? options?.enforceTenantIsolation ?? true : void 0
+      enforceTenantIsolation: resolveAttachEnforceTenantIsolation(
+        options?.tenantFieldName,
+        options?.enforceTenantIsolation
+      )
     };
     this.queryEngine.attachDatabase(name, adapter, metadata);
   }
@@ -2694,7 +2758,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       tags: options?.tags,
       tenantFieldName: options?.tenantFieldName,
       tenantFieldType: options?.tenantFieldType ?? "String",
-      enforceTenantIsolation: options?.tenantFieldName ? options?.enforceTenantIsolation ?? true : void 0
+      enforceTenantIsolation: resolveAttachEnforceTenantIsolation(
+        options?.tenantFieldName,
+        options?.enforceTenantIsolation
+      )
     };
     this.queryEngine.attachDatabase(name, adapter, metadata);
   }
@@ -2707,7 +2774,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       tags: options?.tags,
       tenantFieldName: options?.tenantFieldName,
       tenantFieldType: options?.tenantFieldType ?? "String",
-      enforceTenantIsolation: options?.tenantFieldName ? options?.enforceTenantIsolation ?? true : void 0
+      enforceTenantIsolation: resolveAttachEnforceTenantIsolation(
+        options?.tenantFieldName,
+        options?.enforceTenantIsolation
+      )
     };
     this.queryEngine.attachDatabase(name, adapter, metadata);
   }
@@ -2833,9 +2903,23 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       throw new Error("tenantId is required");
     }
     const databaseName = input.database ?? "db";
-    const params = input.params ?? {};
+    let sql = input.sql;
+    let params = input.params ?? {};
+    if (input.queryId) {
+      const resolved = await resolveQuery(
+        this.client,
+        this.queryEngine,
+        input.queryId,
+        { tenantId }
+      );
+      sql = resolved.sql;
+      params = resolved.params;
+    }
+    if (!sql) {
+      throw new Error("Either queryId or sql is required");
+    }
     const result = await this.queryEngine.validateAndExecute(
-      input.sql,
+      sql,
       params,
       databaseName,
       tenantId