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

package/dist/index.d.cts

@@ -220,11 +220,8 @@ declare class PostgresAdapter implements DatabaseAdapter {
     execute(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<DatabaseExecutionResult>;
     private validateQueryTables;
     /**
-     * Convert params to positional array for PostgreSQL.
-     * PostgreSQL expects $1, $2, $3 in SQL and an array of values [val1, val2, val3].
-     * When the record has numeric keys ("1", "2", "3") — e.g. from mapGeneratedParams —
-     * use only those in order so placeholder order matches SQL. Otherwise fall back to
-     * named keys in alphabetical order for backward compatibility.
+     * Convert params to positional array for PostgreSQL ($1, $2, …).
+     * Values must align with v2 generation order via numeric keys from mapGeneratedParams.
      */
     private convertNamedToPositionalParams;
     validate(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<void>;
@@ -733,7 +730,7 @@ interface AskOptions {
      */
     pipeline?: "v1" | "v2";
     /**
-     * Optional OpenAI model id for v2 SQL generation. Omit to use server default.
+     * Optional model id for v2 SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
      */
     model?: string;
     /**
@@ -1138,6 +1135,16 @@ declare class CallbackApiClient implements IQueryPanelApi {
     delete<T = void>(path: string, tenantId: string, userId?: string, scopes?: string[], signal?: AbortSignal, sessionId?: string): Promise<T>;
 }
 
+/**
+ * Maps v2-style param metadata (array order = $1, $2, $3 in SQL) to a ParamRecord.
+ * Numeric keys preserve placeholder order for PostgreSQL; named keys support tenant lookups.
+ */
+declare function mapGeneratedParams(params: Array<Record<string, unknown>>): ParamRecord;
+/**
+ * Normalizes run-sql / dashboard request params into a ParamRecord.
+ */
+declare function normalizeSqlParamsInput(params: unknown[] | Record<string, unknown> | null | undefined): ParamRecord;
+
 /** Options when constructing the SDK with HTTP (default) or with a custom API implementation. */
 interface QueryPanelSdkAPIOptions {
     defaultTenantId?: string;
@@ -1950,4 +1957,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 };
+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 };

package/dist/index.d.ts

@@ -220,11 +220,8 @@ declare class PostgresAdapter implements DatabaseAdapter {
     execute(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<DatabaseExecutionResult>;
     private validateQueryTables;
     /**
-     * Convert params to positional array for PostgreSQL.
-     * PostgreSQL expects $1, $2, $3 in SQL and an array of values [val1, val2, val3].
-     * When the record has numeric keys ("1", "2", "3") — e.g. from mapGeneratedParams —
-     * use only those in order so placeholder order matches SQL. Otherwise fall back to
-     * named keys in alphabetical order for backward compatibility.
+     * Convert params to positional array for PostgreSQL ($1, $2, …).
+     * Values must align with v2 generation order via numeric keys from mapGeneratedParams.
      */
     private convertNamedToPositionalParams;
     validate(sql: string, params?: Record<string, string | number | boolean | string[] | number[]>): Promise<void>;
@@ -733,7 +730,7 @@ interface AskOptions {
      */
     pipeline?: "v1" | "v2";
     /**
-     * Optional OpenAI model id for v2 SQL generation. Omit to use server default.
+     * Optional model id for v2 SQL generation (e.g. OpenAI or `gemini-*` when the API uses Gemini). Omit for server default.
      */
     model?: string;
     /**
@@ -1138,6 +1135,16 @@ declare class CallbackApiClient implements IQueryPanelApi {
     delete<T = void>(path: string, tenantId: string, userId?: string, scopes?: string[], signal?: AbortSignal, sessionId?: string): Promise<T>;
 }
 
+/**
+ * Maps v2-style param metadata (array order = $1, $2, $3 in SQL) to a ParamRecord.
+ * Numeric keys preserve placeholder order for PostgreSQL; named keys support tenant lookups.
+ */
+declare function mapGeneratedParams(params: Array<Record<string, unknown>>): ParamRecord;
+/**
+ * Normalizes run-sql / dashboard request params into a ParamRecord.
+ */
+declare function normalizeSqlParamsInput(params: unknown[] | Record<string, unknown> | null | undefined): ParamRecord;
+
 /** Options when constructing the SDK with HTTP (default) or with a custom API implementation. */
 interface QueryPanelSdkAPIOptions {
     defaultTenantId?: string;
@@ -1950,4 +1957,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 };
+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 };

package/dist/index.js

@@ -453,6 +453,37 @@ function toNumber(value) {
 }
 
 // src/adapters/postgres.ts
+function maxPostgresPlaceholderIndex(sql) {
+  let max = 0;
+  for (const match of sql.matchAll(/\$(\d+)\b/g)) {
+    const index = Number.parseInt(match[1], 10);
+    if (Number.isFinite(index) && index > max) {
+      max = index;
+    }
+  }
+  return max;
+}
+function filterParamsForPostgresSql(sql, params) {
+  if (!params || Object.keys(params).length === 0) {
+    return void 0;
+  }
+  const placeholderCount = maxPostgresPlaceholderIndex(sql);
+  if (placeholderCount === 0) {
+    return void 0;
+  }
+  const hasNumericKeys = Object.keys(params).some((key) => /^\d+$/.test(key));
+  if (hasNumericKeys) {
+    const filtered = {};
+    for (let index = 1; index <= placeholderCount; index += 1) {
+      const key = String(index);
+      if (key in params) {
+        filtered[key] = params[key];
+      }
+    }
+    return Object.keys(filtered).length > 0 ? filtered : void 0;
+  }
+  return params;
+}
 var PostgresAdapter = class {
   constructor(clientFn, options = {}) {
     this.clientFn = clientFn;
@@ -470,9 +501,10 @@ var PostgresAdapter = class {
     if (this.allowedTables) {
       this.validateQueryTables(sql);
     }
+    const boundParams = filterParamsForPostgresSql(sql, params);
     let paramArray;
-    if (params) {
-      paramArray = this.convertNamedToPositionalParams(params);
+    if (boundParams) {
+      paramArray = this.convertNamedToPositionalParams(sql, boundParams);
     }
     const result = await this.clientFn(sql, paramArray);
     const fields = result.fields.map((f) => f.name);
@@ -502,36 +534,43 @@ var PostgresAdapter = class {
     }
   }
   /**
-   * Convert params to positional array for PostgreSQL.
-   * PostgreSQL expects $1, $2, $3 in SQL and an array of values [val1, val2, val3].
-   * When the record has numeric keys ("1", "2", "3") — e.g. from mapGeneratedParams —
-   * use only those in order so placeholder order matches SQL. Otherwise fall back to
-   * named keys in alphabetical order for backward compatibility.
+   * Convert params to positional array for PostgreSQL ($1, $2, …).
+   * Values must align with v2 generation order via numeric keys from mapGeneratedParams.
    */
-  convertNamedToPositionalParams(params) {
-    const numericKeys = Object.keys(params).filter((k) => /^\d+$/.test(k)).map((k) => Number.parseInt(k, 10)).sort((a, b) => a - b);
-    if (numericKeys.length > 0) {
-      const positionalParams = [];
-      for (const key of numericKeys) {
-        let val = params[String(key)];
-        if (typeof val === "string") {
-          const match = val.match(/^<([a-zA-Z0-9_]+)>$/);
-          const namedKey = match?.[1];
-          if (namedKey && namedKey in params) {
-            val = params[namedKey];
-          }
+  convertNamedToPositionalParams(sql, params) {
+    const placeholderCount = maxPostgresPlaceholderIndex(sql);
+    if (placeholderCount === 0) {
+      return [];
+    }
+    const positionalParams = [];
+    for (let index = 1; index <= placeholderCount; index += 1) {
+      const key = String(index);
+      let val = params[key];
+      if (val === void 0 && placeholderCount === 1) {
+        const namedKeys = Object.keys(params).filter((k) => !/^\d+$/.test(k));
+        if (namedKeys.length === 1) {
+          val = params[namedKeys[0]];
         }
-        positionalParams.push(val);
       }
-      return positionalParams;
+      if (val === void 0) {
+        throw new Error(`Missing value for PostgreSQL parameter $${index}`);
+      }
+      if (typeof val === "string") {
+        const match = val.match(/^<([a-zA-Z0-9_]+)>$/);
+        const namedKey = match?.[1];
+        if (namedKey && namedKey in params) {
+          val = params[namedKey];
+        }
+      }
+      positionalParams.push(val);
     }
-    const namedKeys = Object.keys(params).filter((k) => !/^\d+$/.test(k)).sort();
-    return namedKeys.map((key) => params[key]);
+    return positionalParams;
   }
   async validate(sql, params) {
+    const boundParams = filterParamsForPostgresSql(sql, params);
     let paramArray;
-    if (params) {
-      paramArray = this.convertNamedToPositionalParams(params);
+    if (boundParams) {
+      paramArray = this.convertNamedToPositionalParams(sql, boundParams);
     }
     await this.clientFn(`EXPLAIN ${sql}`, paramArray);
   }
@@ -1174,6 +1213,45 @@ var CallbackApiClient = class {
   }
 };
 
+// src/core/map-generated-params.ts
+function mapGeneratedParams(params) {
+  const record = {};
+  params.forEach((param, index) => {
+    const value = param.value;
+    if (value === void 0) {
+      return;
+    }
+    record[String(index + 1)] = value;
+    const nameCandidate = typeof param.name === "string" && param.name.trim() || typeof param.placeholder === "string" && param.placeholder.trim() || typeof param.position === "number" && String(param.position) || String(index + 1);
+    const key = nameCandidate.replace(/[{}:$]/g, "").trim();
+    record[key] = value;
+  });
+  return record;
+}
+function normalizeSqlParamsInput(params) {
+  if (params == null) {
+    return {};
+  }
+  if (Array.isArray(params)) {
+    if (params.length === 0) {
+      return {};
+    }
+    const first = params[0];
+    if (first && typeof first === "object" && "value" in first) {
+      return mapGeneratedParams(params);
+    }
+    const positional = {};
+    params.forEach((value, index) => {
+      positional[String(index + 1)] = value;
+    });
+    return positional;
+  }
+  if (typeof params === "object") {
+    return params;
+  }
+  return {};
+}
+
 // src/core/query-engine.ts
 var QueryEngine = class {
   constructor() {
@@ -1244,18 +1322,7 @@ var QueryEngine = class {
    * - Named keys remain for tenant isolation / other lookups.
    */
   mapGeneratedParams(params) {
-    const record = {};
-    params.forEach((param, index) => {
-      const value = param.value;
-      if (value === void 0) {
-        return;
-      }
-      record[String(index + 1)] = value;
-      const nameCandidate = typeof param.name === "string" && param.name.trim() || typeof param.placeholder === "string" && param.placeholder.trim() || typeof param.position === "number" && String(param.position) || String(index + 1);
-      const key = nameCandidate.replace(/[{}:$]/g, "").trim();
-      record[key] = value;
-    });
-    return record;
+    return mapGeneratedParams(params);
   }
   ensureTenantIsolation(sql, params, metadata, tenantId) {
     if (!metadata.tenantFieldName || metadata.enforceTenantIsolation === false) {
@@ -1275,8 +1342,10 @@ var QueryEngine = class {
       params[tenantField] = tenantId;
       tenantPredicate = `${tenantField} = @${tenantField}`;
     } else {
-      const escapedId = tenantId.replace(/'/g, "''");
-      tenantPredicate = `${tenantField} = '${escapedId}'`;
+      const paramIndex = this.nextPostgresPlaceholderIndex(sql, params);
+      params[String(paramIndex)] = tenantId;
+      params[tenantField] = tenantId;
+      tenantPredicate = `${tenantField} = $${paramIndex}`;
     }
     if (/\bwhere\b/i.test(sql)) {
       return sql.replace(
@@ -1286,6 +1355,23 @@ var QueryEngine = class {
     }
     return `${sql} WHERE ${tenantPredicate}`;
   }
+  nextPostgresPlaceholderIndex(sql, params) {
+    let max = 0;
+    for (const match of sql.matchAll(/\$(\d+)\b/g)) {
+      const index = Number.parseInt(match[1], 10);
+      if (Number.isFinite(index) && index > max) {
+        max = index;
+      }
+    }
+    if (max > 0) {
+      return max + 1;
+    }
+    const numericKeys = Object.keys(params).filter((key) => /^\d+$/.test(key)).map((key) => Number.parseInt(key, 10)).filter((index) => Number.isFinite(index));
+    if (numericKeys.length > 0) {
+      return Math.max(...numericKeys) + 1;
+    }
+    return 1;
+  }
 };
 
 // src/routes/charts.ts
@@ -1820,6 +1906,7 @@ function resolveTenantId4(client, tenantId) {
 function buildSchemaRequest(databaseName, adapter, introspection, metadata) {
   const dialect = adapter.getDialect();
   const tables = introspection.tables.map((table) => ({
+    schema_name: table.schema,
     table_name: table.name,
     description: table.comment ?? `Table ${table.name}`,
     columns: table.columns.map((column) => ({
@@ -3495,6 +3582,8 @@ export {
   QueryErrorCode,
   QueryPanelSdkAPI,
   QueryPipelineError,
-  anonymizeResults
+  anonymizeResults,
+  mapGeneratedParams,
+  normalizeSqlParamsInput
 };
 //# sourceMappingURL=index.js.map