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

package/dist/index.d.cts

@@ -724,13 +724,14 @@ interface AskOptions {
      */
     querypanelSessionId?: string;
     /**
-     * Pipeline version to use for query generation.
-     * - "v1" (default): Original query pipeline
-     * - "v2": Improved pipeline with intent planning, hybrid retrieval, schema linking, and SQL reflection
+     * Pipeline version for query generation.
+     * Defaults to `"v2"` (`POST /v2/query`).
+     * - `"v2"` (default): intent planning, hybrid retrieval, schema linking, SQL reflection
+     * - `"v1"` (**deprecated**): legacy `POST /query` pipeline — prefer omitting or `"v2"`
      */
     pipeline?: "v1" | "v2";
     /**
-     * Optional model id for v2 SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
+     * Optional model id for SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
      */
     model?: string;
     /**
@@ -742,7 +743,7 @@ interface AskOptions {
      * Use this for tenant-specific policies (e.g. retention windows) that must
      * be enforced on every query.
      *
-     * Only sent when `pipeline: "v2"`.
+     * Sent when the resolved pipeline is `"v2"` (the default).
      */
     systemPrompt?: string;
     /**
@@ -819,6 +820,10 @@ interface AskResponse {
     /** Pipeline execution trace from v2 pipeline. */
     trace?: PipelineTrace;
 }
+/**
+ * Resolve ask/modify pipeline. Defaults to v2; `"v1"` remains available but deprecated.
+ */
+declare function resolveQueryPipeline(pipeline?: "v1" | "v2"): "v1" | "v2";
 declare function anonymizeResults(rows: Array<Record<string, unknown>>): Array<Record<string, string>>;
 
 /**
@@ -962,9 +967,10 @@ interface ChartModifyOptions {
     /** Chart generation method: 'vega-lite' or 'vizspec' */
     chartType?: "vega-lite" | "vizspec";
     /**
-     * Pipeline version to use for SQL regeneration.
-     * - "v1" (default): Original query pipeline
-     * - "v2": Improved pipeline with intent planning, hybrid retrieval, schema linking, and SQL reflection
+     * Pipeline version for SQL regeneration.
+     * Defaults to `"v2"` (`POST /v2/query`).
+     * - `"v2"` (default): intent planning, hybrid retrieval, schema linking, SQL reflection
+     * - `"v1"` (**deprecated**): legacy `POST /query` pipeline — prefer omitting or `"v2"`
      */
     pipeline?: "v1" | "v2";
     /**
@@ -1957,4 +1963,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, 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 ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, 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, mapGeneratedParams, normalizeSqlParamsInput };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, 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 ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, 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, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };

package/dist/index.d.ts

@@ -724,13 +724,14 @@ interface AskOptions {
      */
     querypanelSessionId?: string;
     /**
-     * Pipeline version to use for query generation.
-     * - "v1" (default): Original query pipeline
-     * - "v2": Improved pipeline with intent planning, hybrid retrieval, schema linking, and SQL reflection
+     * Pipeline version for query generation.
+     * Defaults to `"v2"` (`POST /v2/query`).
+     * - `"v2"` (default): intent planning, hybrid retrieval, schema linking, SQL reflection
+     * - `"v1"` (**deprecated**): legacy `POST /query` pipeline — prefer omitting or `"v2"`
      */
     pipeline?: "v1" | "v2";
     /**
-     * Optional model id for v2 SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
+     * Optional model id for SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
      */
     model?: string;
     /**
@@ -742,7 +743,7 @@ interface AskOptions {
      * Use this for tenant-specific policies (e.g. retention windows) that must
      * be enforced on every query.
      *
-     * Only sent when `pipeline: "v2"`.
+     * Sent when the resolved pipeline is `"v2"` (the default).
      */
     systemPrompt?: string;
     /**
@@ -819,6 +820,10 @@ interface AskResponse {
     /** Pipeline execution trace from v2 pipeline. */
     trace?: PipelineTrace;
 }
+/**
+ * Resolve ask/modify pipeline. Defaults to v2; `"v1"` remains available but deprecated.
+ */
+declare function resolveQueryPipeline(pipeline?: "v1" | "v2"): "v1" | "v2";
 declare function anonymizeResults(rows: Array<Record<string, unknown>>): Array<Record<string, string>>;
 
 /**
@@ -962,9 +967,10 @@ interface ChartModifyOptions {
     /** Chart generation method: 'vega-lite' or 'vizspec' */
     chartType?: "vega-lite" | "vizspec";
     /**
-     * Pipeline version to use for SQL regeneration.
-     * - "v1" (default): Original query pipeline
-     * - "v2": Improved pipeline with intent planning, hybrid retrieval, schema linking, and SQL reflection
+     * Pipeline version for SQL regeneration.
+     * Defaults to `"v2"` (`POST /v2/query`).
+     * - `"v2"` (default): intent planning, hybrid retrieval, schema linking, SQL reflection
+     * - `"v1"` (**deprecated**): legacy `POST /query` pipeline — prefer omitting or `"v2"`
      */
     pipeline?: "v1" | "v2";
     /**
@@ -1957,4 +1963,4 @@ declare class QueryPanelSdkAPI {
     }, signal?: AbortSignal): Promise<SdkDashboard[]>;
 }
 
-export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, 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 ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, 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, mapGeneratedParams, normalizeSqlParamsInput };
+export { ALL_VIZ_CHART_TYPES, type ActiveChartBulkGetResponse, 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 ChartBulkGetResponse, type ChartCreateInput, type ChartEncoding, type ChartEnvelope, type ChartListAllOptions, 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, mapGeneratedParams, normalizeSqlParamsInput, resolveQueryPipeline };

package/dist/index.js

@@ -1936,6 +1936,9 @@ import crypto4 from "crypto";
 
 // src/routes/query.ts
 import crypto3 from "crypto";
+function resolveQueryPipeline(pipeline) {
+  return pipeline ?? "v2";
+}
 async function ask(client, queryEngine, question, options, signal) {
   const tenantId = resolveTenantId5(client, options.tenantId);
   const sessionId = crypto3.randomUUID();
@@ -1944,7 +1947,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;
@@ -1968,7 +1972,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,
@@ -2283,7 +2287,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 = [];
@@ -2315,10 +2320,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(
@@ -2342,7 +2347,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,
@@ -3584,6 +3589,7 @@ export {
   QueryPipelineError,
   anonymizeResults,
   mapGeneratedParams,
-  normalizeSqlParamsInput
+  normalizeSqlParamsInput,
+  resolveQueryPipeline
 };
 //# sourceMappingURL=index.js.map