@querypanel/node-sdk 1.2.2 → 1.2.3

package/README.md

@@ -93,6 +93,31 @@ const response = await qp.ask("Revenue by product", {
 });
 ```
 
+### 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).
+
+```ts
+import { QueryPanelSdkAPI, ALL_VIZ_CHART_TYPES, type ChartType } from "@querypanel/sdk";
+
+const allowed: ChartType[] = ["line", "bar", "column", "pie"];
+
+const qp = new QueryPanelSdkAPI(url, privateKey, workspaceId, {
+  supportedChartTypes: allowed,
+});
+
+// Or per request:
+await qp.ask("Revenue by month", {
+  tenantId: "t1",
+  database: "analytics",
+  chartType: "vizspec",
+  pipeline: "v2",
+  supportedChartTypes: allowed,
+});
+```
+
+Use `ALL_VIZ_CHART_TYPES` when you need the full list (for example to derive `allowed` with `.filter(...)`).
+
 ## Session History & Context-Aware Queries
 
 The SDK can link related questions into a session so follow-ups like “filter that to Europe” use prior context. The backend generates a QueryPanel session ID for every query and returns it in the response so you can reuse it.

package/dist/index.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  ALL_VIZ_CHART_TYPES: () => ALL_VIZ_CHART_TYPES,
   BigQueryAdapter: () => BigQueryAdapter,
   CallbackApiClient: () => CallbackApiClient,
   ClickHouseAdapter: () => ClickHouseAdapter,
@@ -1819,7 +1820,10 @@ async function ask(client, queryEngine, question, options, signal) {
               fields: execution.fields,
               rows: anonymizeResults(rows),
               max_retries: options.chartMaxRetries ?? 3,
-              query_id: queryResponse.data.queryId
+              query_id: queryResponse.data.queryId,
+              ...options.supportedChartTypes?.length ? {
+                supported_chart_types: options.supportedChartTypes
+              } : {}
             },
             tenantId,
             options.userId,
@@ -2160,7 +2164,8 @@ async function modifyChart(client, queryEngine, input, options, signal) {
           max_retries: options?.chartMaxRetries ?? 3,
           query_id: queryId,
           // Include viz hints for the chart generator
-          ...hasVizMods ? { encoding_hints: vizHintsForChart } : {}
+          ...hasVizMods ? { encoding_hints: vizHintsForChart } : {},
+          ...options?.supportedChartTypes?.length ? { supported_chart_types: options.supportedChartTypes } : {}
         },
         tenantId,
         options?.userId,
@@ -2307,7 +2312,8 @@ async function generateVizSpec(client, input, options, signal) {
       rows: input.rows,
       max_retries: options?.maxRetries ?? input.max_retries ?? 3,
       query_id: input.query_id,
-      encoding_hints: input.encoding_hints
+      encoding_hints: input.encoding_hints,
+      ...input.supported_chart_types?.length ? { supported_chart_types: input.supported_chart_types } : {}
     },
     tenantId,
     options?.userId,
@@ -2327,10 +2333,21 @@ function resolveTenantId8(client, tenantId) {
   return resolved;
 }
 
+// src/types/vizspec.ts
+var ALL_VIZ_CHART_TYPES = [
+  "line",
+  "bar",
+  "column",
+  "area",
+  "scatter",
+  "pie"
+];
+
 // src/index.ts
 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`.
    */
@@ -2348,6 +2365,7 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       });
     }
     this.queryEngine = new QueryEngine();
+    this.supportedChartTypes = options?.supportedChartTypes;
   }
   /**
    * Create an SDK instance that uses a request callback instead of HTTP.
@@ -2384,7 +2402,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
     const api = new CallbackApiClient(requestHandler, {
       defaultTenantId: options?.defaultTenantId
     });
-    return new _QueryPanelSdkAPI("", "", workspaceId, { api });
+    return new _QueryPanelSdkAPI("", "", workspaceId, {
+      api,
+      supportedChartTypes: options?.supportedChartTypes
+    });
   }
   // Database attachment methods
   attachClickhouse(name, clientFn, options) {
@@ -2508,7 +2529,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       this.client,
       this.queryEngine,
       question,
-      options,
+      {
+        ...options,
+        supportedChartTypes: options.supportedChartTypes ?? this.supportedChartTypes
+      },
       signal
     );
   }
@@ -2580,7 +2604,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
   async generateVizSpec(input, options, signal) {
     return await generateVizSpec(
       this.client,
-      input,
+      {
+        ...input,
+        supported_chart_types: input.supported_chart_types ?? this.supportedChartTypes
+      },
       options,
       signal
     );
@@ -2648,7 +2675,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       this.client,
       this.queryEngine,
       input,
-      options,
+      options ? {
+        ...options,
+        supportedChartTypes: options.supportedChartTypes ?? this.supportedChartTypes
+      } : this.supportedChartTypes ? { supportedChartTypes: this.supportedChartTypes } : void 0,
       signal
     );
   }
@@ -3287,6 +3317,7 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ALL_VIZ_CHART_TYPES,
   BigQueryAdapter,
   CallbackApiClient,
   ClickHouseAdapter,