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

package/README.md

@@ -73,6 +73,7 @@ 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);
@@ -82,17 +83,18 @@ console.log(response.chart.vegaLiteSpec);
 
 ### Custom system instructions (v2 pipeline)
 
-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:
+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):
 
 ```ts
 const response = await qp.ask("Revenue by product", {
   tenantId: "tenant_123",
   database: "analytics",
-  pipeline: "v2",
   systemPrompt: "Retention policy: only query data from the last 30 days.",
 });
 ```
 
+> **Deprecated:** `pipeline: "v1"` still hits `POST /query` for compatibility. Prefer omitting `pipeline` or passing `"v2"`.
+
 ### Restricting VizSpec 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).

package/dist/index.cjs

@@ -40,7 +40,8 @@ __export(index_exports, {
   QueryPipelineError: () => QueryPipelineError,
   anonymizeResults: () => anonymizeResults,
   mapGeneratedParams: () => mapGeneratedParams,
-  normalizeSqlParamsInput: () => normalizeSqlParamsInput
+  normalizeSqlParamsInput: () => normalizeSqlParamsInput,
+  resolveQueryPipeline: () => resolveQueryPipeline
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -1982,6 +1983,9 @@ 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";
+}
 async function ask(client, queryEngine, question, options, signal) {
   const tenantId = resolveTenantId5(client, options.tenantId);
   const sessionId = import_node_crypto3.default.randomUUID();
@@ -1990,7 +1994,8 @@ async function ask(client, queryEngine, question, options, signal) {
   let attempt = 0;
   let lastError = options.lastError;
   let previousSql = options.previousSql;
-  const queryEndpoint = options.pipeline === "v2" ? "/v2/query" : "/query";
+  const pipeline = resolveQueryPipeline(options.pipeline);
+  const queryEndpoint = pipeline === "v2" ? "/v2/query" : "/query";
   while (attempt <= maxRetry) {
     const databaseName = options.database ?? queryEngine.getDefaultDatabase();
     const metadata = databaseName ? queryEngine.getDatabaseMetadata(databaseName) : void 0;
@@ -2014,7 +2019,7 @@ async function ask(client, queryEngine, question, options, signal) {
         ...databaseName ? { database: databaseName } : {},
         ...metadata?.dialect ? { dialect: metadata.dialect } : {},
         ...options.model?.trim() ? { model: options.model.trim() } : {},
-        ...options.pipeline === "v2" && options.systemPrompt?.trim() ? { system_prompt: options.systemPrompt.trim() } : {},
+        ...pipeline === "v2" && options.systemPrompt?.trim() ? { system_prompt: options.systemPrompt.trim() } : {},
         debug: options.debug ?? false
       },
       tenantId,
@@ -2329,7 +2334,8 @@ async function modifyChart(client, queryEngine, input, options, signal) {
   const hasSqlMods = !!input.sqlModifications;
   const hasVizMods = !!input.vizModifications;
   const hasCustomSql = !!input.sqlModifications?.customSql;
-  const queryEndpoint = options?.pipeline === "v2" ? "/v2/query" : "/query";
+  const pipeline = resolveQueryPipeline(options?.pipeline);
+  const queryEndpoint = pipeline === "v2" ? "/v2/query" : "/query";
   let finalSql = input.sql;
   let finalParams = input.params ?? {};
   let paramMetadata = [];
@@ -2361,10 +2367,10 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     const modifiedQuestion = buildModifiedQuestion(
       input.question,
       input.sqlModifications,
-      options?.pipeline,
+      pipeline,
       hasQuerypanelSessionContext
     );
-    if (options?.pipeline === "v2") {
+    if (pipeline === "v2") {
       finalQuestion = modifiedQuestion;
     }
     const queryResponse = await client.post(
@@ -2388,7 +2394,7 @@ async function modifyChart(client, queryEngine, input, options, signal) {
     finalSql = queryResponse.sql;
     paramMetadata = Array.isArray(queryResponse.params) ? queryResponse.params : [];
     finalParams = queryEngine.mapGeneratedParams(paramMetadata);
-    if (options?.pipeline === "v2") {
+    if (pipeline === "v2") {
       applyDateRangeOverrides(
         input.sqlModifications?.dateRange,
         finalParams,
@@ -3631,6 +3637,7 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
   QueryPipelineError,
   anonymizeResults,
   mapGeneratedParams,
-  normalizeSqlParamsInput
+  normalizeSqlParamsInput,
+  resolveQueryPipeline
 });
 //# sourceMappingURL=index.cjs.map