@querypanel/node-sdk 1.3.0-beta.2 → 1.3.1

package/README.md

@@ -286,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
 
@@ -516,7 +544,7 @@ Every request is signed with `RS256` using the private key you pass to the const
 
 - HTTP errors propagate as thrown `Error` instances that include `status` (and `details` when available).
 - `syncSchema` automatically skips embedding if the schema hasn't changed (drift detection). Use `syncSchema(..., { forceReindex: true })` to force updates.
-- `ask()` raises immediately for guardrail/moderation errors because `/query` responds with 4xx/5xx.
+- `ask()` raises immediately for guardrail/moderation errors because `/v2/query` responds with 4xx/5xx. `pipeline: "v1"` is not accepted.
 
 ### Automatic SQL repair and retry
 

package/dist/index.cjs

@@ -61,6 +61,13 @@ var BigQueryAdapter = class {
       );
     }
   }
+  clientFn;
+  projectId;
+  datasetProjectId;
+  defaultDataset;
+  databaseName;
+  kind;
+  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -291,6 +298,11 @@ var ClickHouseAdapter = class {
       this.allowedTables = normalizeTableFilter2(options.allowedTables);
     }
   }
+  clientFn;
+  databaseName;
+  defaultFormat;
+  kind;
+  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -544,6 +556,11 @@ var PostgresAdapter = class {
       );
     }
   }
+  clientFn;
+  databaseName;
+  defaultSchema;
+  kind;
+  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -852,6 +869,9 @@ var QueryPipelineError = class extends Error {
     this.status = status;
     this.name = "QueryPipelineError";
   }
+  code;
+  details;
+  status;
   /**
    * Check if this is a moderation error
    */
@@ -904,8 +924,14 @@ var QueryPipelineError = class extends Error {
 
 // src/core/client.ts
 var ApiClient = class {
+  baseUrl;
+  privateKey;
+  organizationId;
+  defaultTenantId;
+  additionalHeaders;
+  fetchImpl;
+  cryptoKey = null;
   constructor(baseUrl, privateKey, organizationId, options) {
-    this.cryptoKey = null;
     if (!baseUrl) {
       throw new Error("Base URL is required");
     }
@@ -1159,6 +1185,8 @@ var ApiClient = class {
 
 // src/core/callback-client.ts
 var CallbackApiClient = class {
+  requestHandler;
+  defaultTenantId;
   constructor(requestHandler, options) {
     this.requestHandler = requestHandler;
     this.defaultTenantId = options?.defaultTenantId;
@@ -1301,10 +1329,9 @@ function normalizeSqlParamsInput(params) {
 
 // src/core/query-engine.ts
 var QueryEngine = class {
-  constructor() {
-    this.databases = /* @__PURE__ */ new Map();
-    this.databaseMetadata = /* @__PURE__ */ new Map();
-  }
+  databases = /* @__PURE__ */ new Map();
+  databaseMetadata = /* @__PURE__ */ new Map();
+  defaultDatabase;
   attachDatabase(name, adapter, metadata) {
     this.databases.set(name, adapter);
     this.databaseMetadata.set(name, metadata);
@@ -1990,7 +2017,13 @@ var import_node_crypto4 = __toESM(require("crypto"), 1);
 // src/routes/query.ts
 var import_node_crypto3 = __toESM(require("crypto"), 1);
 function resolveQueryPipeline(pipeline) {
-  return pipeline ?? "v2";
+  const requested = pipeline;
+  if (requested != null && requested !== "v2") {
+    throw new Error(
+      `Query pipeline "${requested}" was removed. ask() and modifyChart() always use POST /v2/query.`
+    );
+  }
+  return "v2";
 }
 async function ask(client, queryEngine, question, options, signal) {
   const tenantId = resolveTenantId5(client, options.tenantId);
@@ -2000,8 +2033,9 @@ async function ask(client, queryEngine, question, options, signal) {
   let attempt = 0;
   let lastError = options.lastError;
   let previousSql = options.previousSql;
-  const pipeline = resolveQueryPipeline(options.pipeline);
-  const queryEndpoint = pipeline === "v2" ? "/v2/query" : "/query";
+  let parentQueryId;
+  resolveQueryPipeline(options.pipeline);
+  const queryEndpoint = "/v2/query";
   while (attempt <= maxRetry) {
     const databaseName = options.database ?? queryEngine.getDefaultDatabase();
     const metadata = databaseName ? queryEngine.getDatabaseMetadata(databaseName) : void 0;
@@ -2031,7 +2065,8 @@ async function ask(client, queryEngine, question, options, signal) {
         ...databaseName ? { database: databaseName } : {},
         ...metadata?.dialect ? { dialect: metadata.dialect } : {},
         ...options.model?.trim() ? { model: options.model.trim() } : {},
-        ...pipeline === "v2" && options.systemPrompt?.trim() ? { system_prompt: options.systemPrompt.trim() } : {},
+        ...options.systemPrompt?.trim() ? { system_prompt: options.systemPrompt.trim() } : {},
+        ...parentQueryId ? { parent_query_id: parentQueryId } : {},
         debug: options.debug ?? false
       },
       tenantId,
@@ -2053,6 +2088,9 @@ async function ask(client, queryEngine, question, options, signal) {
     if (!sql || !dialect) {
       throw new Error("Query response missing required SQL or dialect");
     }
+    if (queryResponse.data.queryId) {
+      parentQueryId = queryResponse.data.queryId;
+    }
     const dbName = queryResponse.data.database ?? options.database ?? queryEngine.getDefaultDatabase();
     if (!dbName) {
       throw new Error(
@@ -2194,34 +2232,53 @@ 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
+  };
+}
+async function markQueryExecuted(client, queryId, options, signal) {
+  try {
+    await client.post(
+      `/v2/queries/${encodeURIComponent(queryId)}/executed`,
+      {},
+      options.tenantId,
+      options.userId,
+      options.scopes,
+      signal
+    );
+  } catch {
+  }
+}
+
 // src/routes/modify.ts
-function buildModifiedQuestion(originalQuestion, modifications, pipeline, hasSessionContext = false) {
+function buildModifiedQuestion(originalQuestion, modifications, hasSessionContext = false) {
   const hints = [];
   if (modifications.timeGranularity) {
     hints.push(`group results by ${modifications.timeGranularity}`);
   }
   if (modifications.dateRange) {
-    if (pipeline === "v2") {
-      const from = normalizeDateInput(modifications.dateRange.from);
-      const to = normalizeDateInput(modifications.dateRange.to);
-      if (from && to) {
-        hints.push(`change date range to ${from} through ${to}`);
-      } else if (from) {
-        hints.push(`change start date to ${from}`);
-      } else if (to) {
-        hints.push(`change end date to ${to}`);
-      }
-    } else {
-      const parts = [];
-      if (modifications.dateRange.from) {
-        parts.push(`from ${modifications.dateRange.from}`);
-      }
-      if (modifications.dateRange.to) {
-        parts.push(`to ${modifications.dateRange.to}`);
-      }
-      if (parts.length > 0) {
-        hints.push(`filter date range ${parts.join(" ")}`);
-      }
+    const from = normalizeDateInput(modifications.dateRange.from);
+    const to = normalizeDateInput(modifications.dateRange.to);
+    if (from && to) {
+      hints.push(`change date range to ${from} through ${to}`);
+    } else if (from) {
+      hints.push(`change start date to ${from}`);
+    } else if (to) {
+      hints.push(`change end date to ${to}`);
     }
   }
   if (modifications.additionalInstructions) {
@@ -2230,7 +2287,7 @@ function buildModifiedQuestion(originalQuestion, modifications, pipeline, hasSes
   if (hints.length === 0) {
     return originalQuestion;
   }
-  if (pipeline === "v2" && hasSessionContext) {
+  if (hasSessionContext) {
     return hints.join(", ");
   }
   return `${originalQuestion} (${hints.join(", ")})`;
@@ -2346,13 +2403,30 @@ async function modifyChart(client, queryEngine, input, options, signal) {
   const hasSqlMods = !!input.sqlModifications;
   const hasVizMods = !!input.vizModifications;
   const hasCustomSql = !!input.sqlModifications?.customSql;
-  const pipeline = resolveQueryPipeline(options?.pipeline);
-  const queryEndpoint = pipeline === "v2" ? "/v2/query" : "/query";
-  let finalSql = input.sql;
+  resolveQueryPipeline(options?.pipeline);
+  const queryEndpoint = "/v2/query";
+  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();
@@ -2380,23 +2454,21 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     finalSql = input.sqlModifications.customSql;
     finalParams = {};
     paramMetadata = [];
+    queryId = void 0;
     sqlChanged = true;
   } else if (hasSqlMods && !hasCustomSql) {
     const modifiedQuestion = buildModifiedQuestion(
       input.question,
       input.sqlModifications,
-      pipeline,
       hasQuerypanelSessionContext
     );
-    if (pipeline === "v2") {
-      finalQuestion = modifiedQuestion;
-    }
+    finalQuestion = modifiedQuestion;
     const queryResponse = await client.post(
       queryEndpoint,
       {
         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 } : {},
@@ -2412,16 +2484,14 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     finalSql = queryResponse.sql;
     paramMetadata = Array.isArray(queryResponse.params) ? queryResponse.params : [];
     finalParams = queryEngine.mapGeneratedParams(paramMetadata);
-    if (pipeline === "v2") {
-      applyDateRangeOverrides(
-        input.sqlModifications?.dateRange,
-        finalParams,
-        paramMetadata
-      );
-    }
+    applyDateRangeOverrides(
+      input.sqlModifications?.dateRange,
+      finalParams,
+      paramMetadata
+    );
     rationale = queryResponse.rationale;
     queryId = queryResponse.queryId;
-    sqlChanged = finalSql !== input.sql;
+    sqlChanged = finalSql !== currentSql;
   }
   const execution = await queryEngine.validateAndExecute(
     finalSql,
@@ -2636,6 +2706,9 @@ function resolveAttachEnforceTenantIsolation(tenantFieldName, enforceTenantIsola
   return tenantFieldName ? true : void 0;
 }
 var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
+  client;
+  queryEngine;
+  supportedChartTypes;
   /**
    * @param workspaceId - Workspace UUID (same value as your org in the dashboard). Passed to the API as JWT claim `organizationId`.
    */
@@ -2866,13 +2939,32 @@ 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
     );
+    if (input.queryId) {
+      await markQueryExecuted(this.client, input.queryId, {
+        tenantId
+      });
+    }
     return { rows: result.rows, fields: result.fields };
   }
   // VizSpec generation