@querypanel/node-sdk 1.2.1 → 1.2.3

package/dist/index.d.cts

@@ -554,6 +554,8 @@ interface VizSpecBase {
 }
 type VizSpecKind = VizSpecBase["kind"];
 type ChartType = 'line' | 'bar' | 'column' | 'area' | 'scatter' | 'pie';
+/** Full VizSpec chart catalog; use when building a custom `supportedChartTypes` list. */
+declare const ALL_VIZ_CHART_TYPES: readonly ChartType[];
 type StackingMode = 'none' | 'stacked' | 'percent';
 interface ChartEncoding {
     chartType: ChartType;
@@ -708,6 +710,23 @@ interface AskOptions {
      * Optional OpenAI model id for v2 SQL generation. Omit to use server default.
      */
     model?: string;
+    /**
+     * Optional additional system prompt text for the v2 pipeline.
+     *
+     * This is appended to the backend's SQL generator/reflection system prompts
+     * (it does not change tenant isolation mechanics; it only guides the LLM).
+     *
+     * Use this for tenant-specific policies (e.g. retention windows) that must
+     * be enforced on every query.
+     *
+     * Only sent when `pipeline: "v2"`.
+     */
+    systemPrompt?: string;
+    /**
+     * Restrict VizSpec `chartType` values when `chartType` is `"vizspec"`.
+     * Sent to `POST /vizspec` as `supported_chart_types`. Omitted allows all standard types.
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Intent analysis result from the v2 pipeline.
@@ -928,6 +947,10 @@ interface ChartModifyOptions {
      * the original question with modification hints.
      */
     querypanelSessionId?: string;
+    /**
+     * Restrict VizSpec chart types for this call (merged with SDK default from constructor when omitted).
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Response from modifyChart(), extending AskResponse with modification metadata.
@@ -1042,6 +1065,8 @@ interface VizSpecGenerateInput {
      * When provided, these guide the LLM to generate specific visualization configurations.
      */
     encoding_hints?: EncodingHints;
+    /** When set, VizSpec kind "chart" may only use these chart types (API: supported_chart_types). */
+    supported_chart_types?: ChartType[];
 }
 interface VizSpecGenerateOptions {
     tenantId?: string;
@@ -1088,6 +1113,12 @@ interface QueryPanelSdkAPIOptions {
      * use this when calling the SDK from within your own API to avoid recursion.
      */
     api?: IQueryPanelApi;
+    /**
+     * Restrict VizSpec chart kinds (when using `chartType: "vizspec"`).
+     * Omitted means all types: line, bar, column, area, scatter, pie.
+     * Per-request `supportedChartTypes` on `ask` / `modifyChart` overrides this default.
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Main SDK class - Thin orchestrator
@@ -1097,6 +1128,7 @@ interface QueryPanelSdkAPIOptions {
 declare class QueryPanelSdkAPI {
     private readonly client;
     private readonly queryEngine;
+    private readonly supportedChartTypes?;
     /**
      * @param workspaceId - Workspace UUID (same value as your org in the dashboard). Passed to the API as JWT claim `organizationId`.
      */
@@ -1134,6 +1166,7 @@ declare class QueryPanelSdkAPI {
      */
     static withCallbacks(workspaceId: string, requestHandler: RequestHandler, options?: {
         defaultTenantId?: string;
+        supportedChartTypes?: ChartType[];
     }): QueryPanelSdkAPI;
     attachClickhouse(name: string, clientFn: ClickHouseClientFn, options?: ClickHouseAdapterOptions & {
         description?: string;
@@ -1865,4 +1898,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults };

package/dist/index.d.ts

@@ -554,6 +554,8 @@ interface VizSpecBase {
 }
 type VizSpecKind = VizSpecBase["kind"];
 type ChartType = 'line' | 'bar' | 'column' | 'area' | 'scatter' | 'pie';
+/** Full VizSpec chart catalog; use when building a custom `supportedChartTypes` list. */
+declare const ALL_VIZ_CHART_TYPES: readonly ChartType[];
 type StackingMode = 'none' | 'stacked' | 'percent';
 interface ChartEncoding {
     chartType: ChartType;
@@ -708,6 +710,23 @@ interface AskOptions {
      * Optional OpenAI model id for v2 SQL generation. Omit to use server default.
      */
     model?: string;
+    /**
+     * Optional additional system prompt text for the v2 pipeline.
+     *
+     * This is appended to the backend's SQL generator/reflection system prompts
+     * (it does not change tenant isolation mechanics; it only guides the LLM).
+     *
+     * Use this for tenant-specific policies (e.g. retention windows) that must
+     * be enforced on every query.
+     *
+     * Only sent when `pipeline: "v2"`.
+     */
+    systemPrompt?: string;
+    /**
+     * Restrict VizSpec `chartType` values when `chartType` is `"vizspec"`.
+     * Sent to `POST /vizspec` as `supported_chart_types`. Omitted allows all standard types.
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Intent analysis result from the v2 pipeline.
@@ -928,6 +947,10 @@ interface ChartModifyOptions {
      * the original question with modification hints.
      */
     querypanelSessionId?: string;
+    /**
+     * Restrict VizSpec chart types for this call (merged with SDK default from constructor when omitted).
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Response from modifyChart(), extending AskResponse with modification metadata.
@@ -1042,6 +1065,8 @@ interface VizSpecGenerateInput {
      * When provided, these guide the LLM to generate specific visualization configurations.
      */
     encoding_hints?: EncodingHints;
+    /** When set, VizSpec kind "chart" may only use these chart types (API: supported_chart_types). */
+    supported_chart_types?: ChartType[];
 }
 interface VizSpecGenerateOptions {
     tenantId?: string;
@@ -1088,6 +1113,12 @@ interface QueryPanelSdkAPIOptions {
      * use this when calling the SDK from within your own API to avoid recursion.
      */
     api?: IQueryPanelApi;
+    /**
+     * Restrict VizSpec chart kinds (when using `chartType: "vizspec"`).
+     * Omitted means all types: line, bar, column, area, scatter, pie.
+     * Per-request `supportedChartTypes` on `ask` / `modifyChart` overrides this default.
+     */
+    supportedChartTypes?: ChartType[];
 }
 /**
  * Main SDK class - Thin orchestrator
@@ -1097,6 +1128,7 @@ interface QueryPanelSdkAPIOptions {
 declare class QueryPanelSdkAPI {
     private readonly client;
     private readonly queryEngine;
+    private readonly supportedChartTypes?;
     /**
      * @param workspaceId - Workspace UUID (same value as your org in the dashboard). Passed to the API as JWT claim `organizationId`.
      */
@@ -1134,6 +1166,7 @@ declare class QueryPanelSdkAPI {
      */
     static withCallbacks(workspaceId: string, requestHandler: RequestHandler, options?: {
         defaultTenantId?: string;
+        supportedChartTypes?: ChartType[];
     }): QueryPanelSdkAPI;
     attachClickhouse(name: string, clientFn: ClickHouseClientFn, options?: ClickHouseAdapterOptions & {
         description?: string;
@@ -1865,4 +1898,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartCreateInput, type ActiveChartListOptions, type ActiveChartUpdateInput, type AggregateOp, type AskOptions, type AskResponse, type AxisField, type AxisFieldInput, BigQueryAdapter, type BigQueryAdapterOptions, type BigQueryClientFn, type BigQueryQueryRequest, type BigQueryQueryResult, CallbackApiClient, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListOptions, type ChartModifyInput, type ChartModifyOptions, type ChartModifyResponse, type ChartSpec, type ChartType, type ChartUpdateInput, ClickHouseAdapter, type ClickHouseAdapterOptions, type ClickHouseClientFn, type ContextDocument, type DashboardCreateInput, type DashboardForkInput, type DashboardForkUpdateInput, type DashboardListOptions, type DashboardUpdateInput, type DatabaseAdapter, type DatabaseDialect, type DateRangeInput, type EncodingHints, type FieldRef, type FieldRefInput, type FieldType, type IQueryPanelApi, type IngestResponse, type IntentResult, type MetricEncoding, type MetricField, type MetricSpec, type PaginatedResponse$1 as PaginatedResponse, type PaginationInfo$1 as PaginationInfo, type PaginationQuery$1 as PaginationQuery, type ParamRecord, type ParamValue, type PipelineTrace, PostgresAdapter, type PostgresAdapterOptions, type PostgresClientFn, QueryErrorCode, QueryErrorCode as QueryErrorCodeType, QueryPanelSdkAPI, type QueryPanelSdkAPIOptions, QueryPipelineError, type RequestHandler, type RequestHandlerOptions, type RequestHandlerResult, type SchemaIntrospection, type SchemaSyncOptions, type SdkActiveChart, type SdkChart, type SdkDashboard, type SdkSession, type SdkSessionTurn, type SessionGetOptions, type SessionListOptions, type SessionUpdateInput, type SqlModifications, type StackingMode, type TableColumn, type TableEncoding, type TableSpec, type TimeUnit, type ValueFormat, type VizModifications, type VizSpec, type VizSpecGenerateInput, type VizSpecGenerateOptions, type VizSpecGeneratorInput, type VizSpecKind, type VizSpecResponse, type VizSpecResult, anonymizeResults };

package/dist/index.js

@@ -1722,7 +1722,8 @@ async function ask(client, queryEngine, question, options, signal) {
         ...tenantSettings ? { tenant_settings: tenantSettings } : {},
         ...databaseName ? { database: databaseName } : {},
         ...metadata?.dialect ? { dialect: metadata.dialect } : {},
-        ...options.model?.trim() ? { model: options.model.trim() } : {}
+        ...options.model?.trim() ? { model: options.model.trim() } : {},
+        ...options.pipeline === "v2" && options.systemPrompt?.trim() ? { system_prompt: options.systemPrompt.trim() } : {}
       },
       tenantId,
       options.userId,
@@ -1775,7 +1776,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,
@@ -2116,7 +2120,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,
@@ -2263,7 +2268,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,
@@ -2283,10 +2289,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`.
    */
@@ -2304,6 +2321,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.
@@ -2340,7 +2358,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) {
@@ -2464,7 +2485,10 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
       this.client,
       this.queryEngine,
       question,
-      options,
+      {
+        ...options,
+        supportedChartTypes: options.supportedChartTypes ?? this.supportedChartTypes
+      },
       signal
     );
   }
@@ -2536,7 +2560,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
     );
@@ -2604,7 +2631,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
     );
   }
@@ -3242,6 +3272,7 @@ var QueryPanelSdkAPI = class _QueryPanelSdkAPI {
   }
 };
 export {
+  ALL_VIZ_CHART_TYPES,
   BigQueryAdapter,
   CallbackApiClient,
   ClickHouseAdapter,