@querypanel/node-sdk 1.2.2 → 1.2.4

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,
@@ -57,12 +58,6 @@ var BigQueryAdapter = class {
       );
     }
   }
-  projectId;
-  datasetProjectId;
-  defaultDataset;
-  databaseName;
-  kind;
-  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -293,10 +288,6 @@ var ClickHouseAdapter = class {
       this.allowedTables = normalizeTableFilter2(options.allowedTables);
     }
   }
-  databaseName;
-  defaultFormat;
-  kind;
-  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -509,10 +500,6 @@ var PostgresAdapter = class {
       );
     }
   }
-  databaseName;
-  defaultSchema;
-  kind;
-  allowedTables;
   async execute(sql, params) {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
@@ -753,14 +740,8 @@ function sanitize2(value) {
 // src/core/client.ts
 var import_node_crypto = __toESM(require("crypto"), 1);
 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");
     }
@@ -1006,8 +987,6 @@ var ApiClient = class {
 
 // src/core/callback-client.ts
 var CallbackApiClient = class {
-  requestHandler;
-  defaultTenantId;
   constructor(requestHandler, options) {
     this.requestHandler = requestHandler;
     this.defaultTenantId = options?.defaultTenantId;
@@ -1111,9 +1090,10 @@ var CallbackApiClient = class {
 
 // src/core/query-engine.ts
 var QueryEngine = class {
-  databases = /* @__PURE__ */ new Map();
-  databaseMetadata = /* @__PURE__ */ new Map();
-  defaultDatabase;
+  constructor() {
+    this.databases = /* @__PURE__ */ new Map();
+    this.databaseMetadata = /* @__PURE__ */ new Map();
+  }
   attachDatabase(name, adapter, metadata) {
     this.databases.set(name, adapter);
     this.databaseMetadata.set(name, metadata);
@@ -1433,7 +1413,7 @@ async function listActiveCharts(client, queryEngine, options, signal) {
     params.set("limit", `${options.pagination.limit}`);
   if (options?.sortBy) params.set("sort_by", options.sortBy);
   if (options?.sortDir) params.set("sort_dir", options.sortDir);
-  if (options?.title) params.set("name", options.title);
+  if (options?.title) params.set("title", options.title);
   if (options?.userFilter) params.set("user_id", options.userFilter);
   if (options?.createdFrom) params.set("created_from", options.createdFrom);
   if (options?.createdTo) params.set("created_to", options.createdTo);
@@ -1462,6 +1442,60 @@ async function listActiveCharts(client, queryEngine, options, signal) {
   }
   return response;
 }
+async function listAllActiveCharts(client, queryEngine, options, signal) {
+  const tenantId = resolveTenantId2(client, options?.tenantId);
+  const response = await client.get(
+    "/active-charts/all",
+    tenantId,
+    options?.userId,
+    options?.scopes,
+    signal
+  );
+  if (options?.withData) {
+    response.data = await Promise.all(
+      response.data.map(async (active) => ({
+        ...active,
+        chart: active.chart ? await getChart(
+          client,
+          queryEngine,
+          active.chart_id,
+          options,
+          signal
+        ) : null
+      }))
+    );
+  }
+  return response.data;
+}
+async function getActiveChartsByIds(client, queryEngine, ids, options, signal) {
+  const tenantId = resolveTenantId2(client, options?.tenantId);
+  const params = new URLSearchParams();
+  for (const id of ids) {
+    params.append("ids", id);
+  }
+  const response = await client.get(
+    `/active-charts/bulk${params.toString() ? `?${params.toString()}` : ""}`,
+    tenantId,
+    options?.userId,
+    options?.scopes,
+    signal
+  );
+  if (options?.withData) {
+    response.data = await Promise.all(
+      response.data.map(async (active) => ({
+        ...active,
+        chart: active.chart ? await getChart(
+          client,
+          queryEngine,
+          active.chart_id,
+          options,
+          signal
+        ) : null
+      }))
+    );
+  }
+  return response;
+}
 async function getActiveChart(client, queryEngine, id, options, signal) {
   const tenantId = resolveTenantId2(client, options?.tenantId);
   const active = await client.get(
@@ -1819,7 +1853,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 +2197,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 +2345,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 +2366,18 @@ 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;
   /**
    * @param workspaceId - Workspace UUID (same value as your org in the dashboard). Passed to the API as JWT claim `organizationId`.
    */
@@ -2348,6 +2395,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 +2432,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 +2559,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       this.client,
       this.queryEngine,
       question,
-      options,
+      {
+        ...options,
+        supportedChartTypes: options.supportedChartTypes ?? this.supportedChartTypes
+      },
       signal
     );
   }
@@ -2580,7 +2634,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 +2705,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
     );
   }
@@ -2927,6 +2987,29 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       signal
     );
   }
+  /**
+   * Lists all active charts without pagination.
+   */
+  async listAllActiveCharts(options, signal) {
+    return await listAllActiveCharts(
+      this.client,
+      this.queryEngine,
+      options,
+      signal
+    );
+  }
+  /**
+   * Bulk gets active charts by IDs.
+   */
+  async getActiveChartsByIds(ids, options, signal) {
+    return await getActiveChartsByIds(
+      this.client,
+      this.queryEngine,
+      ids,
+      options,
+      signal
+    );
+  }
   /**
    * Retrieves a single active chart by ID.
    *
@@ -3287,6 +3370,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,