@querypanel/node-sdk 1.3.0 → 1.3.3

package/README.md

@@ -544,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(
@@ -2212,35 +2250,35 @@ async function resolveQuery(client, queryEngine, queryId, options, signal) {
     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) {
@@ -2249,11 +2287,12 @@ 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(", ")})`;
 }
+var REWRITE_DATEFILTER_ENDPOINT = "/v2/rewrite-datefilter";
 var START_PARAM_KEY_REGEX = /(^|_)(start|from)(_|$)/i;
 var END_PARAM_KEY_REGEX = /(^|_)(end|to)(_|$)/i;
 var ISO_DATETIME_RE = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?Z?$/;
@@ -2290,31 +2329,118 @@ function normalizeGeneratedParamKey(param, index) {
   const nameCandidate = typeof param.name === "string" && param.name.trim() || typeof param.placeholder === "string" && param.placeholder.trim() || typeof param.position === "number" && String(param.position) || String(index + 1);
   return nameCandidate.replace(/[{}]/g, "").replace(/(.+):.*$/, "$1").replace(/^[:$]/, "").trim();
 }
-function applyDateRangeOverrides(dateRange, params, paramMetadata) {
+function collectParamKeys(params, paramMetadata) {
+  const keys = new Set(Object.keys(params));
+  for (let i = 0; i < paramMetadata.length; i++) {
+    const param = paramMetadata[i];
+    if (!param) continue;
+    keys.add(normalizeGeneratedParamKey(param, i));
+  }
+  return [...keys];
+}
+function placeholderKey(token) {
+  if (token.startsWith("$") || token.startsWith("@")) return token.slice(1);
+  return token.slice(1, -1).replace(/:.+$/, "").trim();
+}
+function isDateLike(value) {
+  return typeof value === "string" && /^\d{4}-\d{2}-\d{2}/.test(value.trim());
+}
+function dateBoundKeysFromSql(sql) {
+  const start = /* @__PURE__ */ new Set();
+  const end = /* @__PURE__ */ new Set();
+  const comparison = /(>=|<=|>|<)\s*(\$\d+|\{[^}]+\}|@[A-Za-z_][\w]*)/g;
+  const between = /BETWEEN\s+(\$\d+|\{[^}]+\}|@[A-Za-z_][\w]*)\s+AND\s+(\$\d+|\{[^}]+\}|@[A-Za-z_][\w]*)/gi;
+  for (const match of sql.matchAll(comparison)) {
+    const key = placeholderKey(match[2] ?? "");
+    if (!key) continue;
+    if (match[1] === ">=" || match[1] === ">") start.add(key);
+    else end.add(key);
+  }
+  for (const match of sql.matchAll(between)) {
+    const startKey = placeholderKey(match[1] ?? "");
+    const endKey = placeholderKey(match[2] ?? "");
+    if (startKey) start.add(startKey);
+    if (endKey) end.add(endKey);
+  }
+  return { start, end };
+}
+function paramValueForKey(key, params, paramMetadata) {
+  if (key in params) return params[key];
+  for (let i = 0; i < paramMetadata.length; i++) {
+    const param = paramMetadata[i];
+    if (!param) continue;
+    if (normalizeGeneratedParamKey(param, i) === key) return param.value;
+  }
+  return void 0;
+}
+function dateBoundKeys(sql, params, paramMetadata, boundary) {
+  const fromSql = dateBoundKeysFromSql(sql)[boundary];
+  const keys = [];
+  for (const key of collectParamKeys(params, paramMetadata)) {
+    const named = keyLooksLikeDateBoundary(key, boundary);
+    if (!named && !fromSql.has(key)) continue;
+    if (!isDateLike(paramValueForKey(key, params, paramMetadata))) continue;
+    keys.push(key);
+  }
+  return keys;
+}
+function canSubstituteDateRangeParams(dateRange, sql, params, paramMetadata = []) {
+  if (!dateRange) return false;
+  const from = normalizeDateInput(dateRange.from);
+  const to = normalizeDateInput(dateRange.to);
+  if (!from && !to) return false;
+  if (from && dateBoundKeys(sql, params, paramMetadata, "start").length === 0) {
+    return false;
+  }
+  if (to && dateBoundKeys(sql, params, paramMetadata, "end").length === 0) {
+    return false;
+  }
+  return true;
+}
+function isDateRangeOnlySqlModification(modifications) {
+  if (!modifications?.dateRange) return false;
+  if (modifications.customSql) return false;
+  if (modifications.timeGranularity) return false;
+  if (typeof modifications.additionalInstructions === "string" && modifications.additionalInstructions.trim().length > 0) {
+    return false;
+  }
+  return true;
+}
+function applyDateRangeOverrides(dateRange, sql, params, paramMetadata) {
   if (!dateRange) return;
   const from = normalizeDateInput(dateRange.from);
   const to = normalizeDateInput(dateRange.to);
   if (!from && !to) return;
+  const startKeys = new Set(
+    from ? dateBoundKeys(sql, params, paramMetadata, "start") : []
+  );
+  const endKeys = new Set(
+    to ? dateBoundKeys(sql, params, paramMetadata, "end") : []
+  );
   for (const [key, value] of Object.entries(params)) {
-    if (from && keyLooksLikeDateBoundary(key, "start")) {
-      params[key] = formatDateOverride(from, "start", value);
+    if (startKeys.has(key)) {
+      params[key] = formatDateOverride(from ?? "", "start", value);
     }
-    if (to && keyLooksLikeDateBoundary(key, "end")) {
-      params[key] = formatDateOverride(to, "end", value);
+    if (endKeys.has(key)) {
+      params[key] = formatDateOverride(to ?? "", "end", value);
     }
   }
   for (let i = 0; i < paramMetadata.length; i++) {
     const param = paramMetadata[i];
     if (!param) continue;
     const key = normalizeGeneratedParamKey(param, i);
-    if (from && keyLooksLikeDateBoundary(key, "start")) {
-      param.value = formatDateOverride(from, "start", param.value);
+    if (startKeys.has(key)) {
+      param.value = formatDateOverride(from ?? "", "start", param.value);
     }
-    if (to && keyLooksLikeDateBoundary(key, "end")) {
-      param.value = formatDateOverride(to, "end", param.value);
+    if (endKeys.has(key)) {
+      param.value = formatDateOverride(to ?? "", "end", param.value);
     }
   }
 }
+function buildPreviousParams(params, paramMetadata) {
+  if (paramMetadata.length > 0) return paramMetadata;
+  return Object.entries(params).map(([name, value]) => ({ name, value }));
+}
 function buildVizHints(modifications) {
   const hints = {};
   if (modifications.kind) {
@@ -2365,8 +2491,11 @@ 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";
+  const lightweight = options?.lightweight === true;
+  const dateOnly = lightweight && isDateRangeOnlySqlModification(input.sqlModifications);
+  const skipChartLlm = lightweight && !hasCustomSql && (dateOnly || hasVizMods && !hasSqlMods);
+  resolveQueryPipeline(options?.pipeline);
+  const queryEndpoint = "/v2/query";
   let currentSql = input.sql;
   let finalParams = input.params ?? {};
   let paramMetadata = [];
@@ -2418,28 +2547,57 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     paramMetadata = [];
     queryId = void 0;
     sqlChanged = true;
+  } else if (dateOnly && canSubstituteDateRangeParams(
+    input.sqlModifications?.dateRange,
+    finalSql,
+    finalParams,
+    paramMetadata
+  )) {
+    finalParams = { ...finalParams };
+    applyDateRangeOverrides(
+      input.sqlModifications?.dateRange,
+      finalSql,
+      finalParams,
+      paramMetadata
+    );
+    sqlChanged = false;
   } else if (hasSqlMods && !hasCustomSql) {
     const modifiedQuestion = buildModifiedQuestion(
       input.question,
       input.sqlModifications,
-      pipeline,
       hasQuerypanelSessionContext
     );
-    if (pipeline === "v2") {
-      finalQuestion = modifiedQuestion;
-    }
-    const queryResponse = await client.post(
+    finalQuestion = modifiedQuestion;
+    const sharedBody = {
+      session_id: querypanelSessionId,
+      previous_sql: currentSql,
+      ...tenantSettings ? { tenant_settings: tenantSettings } : {},
+      ...databaseName ? { database: databaseName } : {},
+      ...metadata?.dialect ? { dialect: metadata.dialect } : {},
+      debug: options?.debug ?? false
+    };
+    const [endpoint, body] = dateOnly ? [
+      REWRITE_DATEFILTER_ENDPOINT,
+      {
+        ...sharedBody,
+        question: input.question,
+        previous_params: buildPreviousParams(finalParams, paramMetadata),
+        date_range: {
+          from: normalizeDateInput(input.sqlModifications?.dateRange?.from),
+          to: normalizeDateInput(input.sqlModifications?.dateRange?.to)
+        }
+      }
+    ] : [
       queryEndpoint,
       {
+        ...sharedBody,
         question: modifiedQuestion,
-        session_id: querypanelSessionId,
-        previous_sql: currentSql,
-        ...options?.maxRetry ? { max_retry: options.maxRetry } : {},
-        ...tenantSettings ? { tenant_settings: tenantSettings } : {},
-        ...databaseName ? { database: databaseName } : {},
-        ...metadata?.dialect ? { dialect: metadata.dialect } : {},
-        debug: options?.debug ?? false
-      },
+        ...options?.maxRetry ? { max_retry: options.maxRetry } : {}
+      }
+    ];
+    const queryResponse = await client.post(
+      endpoint,
+      body,
       tenantId,
       options?.userId,
       options?.scopes,
@@ -2449,13 +2607,12 @@ 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,
+      finalSql,
+      finalParams,
+      paramMetadata
+    );
     rationale = queryResponse.rationale;
     queryId = queryResponse.queryId;
     sqlChanged = finalSql !== currentSql;
@@ -2473,7 +2630,7 @@ async function modifyChart(client, queryEngine, input, options, signal) {
   };
   const vizHints = hasVizMods ? buildVizHints(input.vizModifications) : {};
   const vizHintsForChart = chartType === "vizspec" ? vizHints : stripVizSpecOnlyHints(vizHints);
-  if (chartType === "vizspec") {
+  if (!skipChartLlm && chartType === "vizspec") {
     const vizspecResponse = await client.post(
       "/vizspec",
       {
@@ -2500,7 +2657,7 @@ async function modifyChart(client, queryEngine, input, options, signal) {
       specType: "vizspec",
       notes: rows.length === 0 ? vizspecResponse.notes ?? "Query returned no rows." : vizspecResponse.notes
     };
-  } else {
+  } else if (!skipChartLlm) {
     const chartResponse = await client.post(
       "/chart",
       {
@@ -2673,6 +2830,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`.
    */
@@ -2924,6 +3084,11 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       databaseName,
       tenantId
     );
+    if (input.queryId) {
+      await markQueryExecuted(this.client, input.queryId, {
+        tenantId
+      });
+    }
     return { rows: result.rows, fields: result.fields };
   }
   // VizSpec generation