@querypanel/node-sdk 1.0.41 → 1.0.42

package/README.md

@@ -42,18 +42,26 @@ const createPostgresClient = () => async (sql: string, params?: unknown[]) => {
   }
 };
 
-qp.attachPostgres("analytics", createPostgresClient(), {
-  description: "Primary analytics warehouse",
-  tenantFieldName: "tenant_id",
-});
+	// Attach PostgreSQL database using the SDK's PostgresAdapter
+	// The SDK will automatically handle tenant isolation when tenantFieldName is provided
+	qp.attachPostgres(
+  "pg_demo",  // a uniq identifier for QueryPanel
+  createPostgresClientFn(),
+  {
+		database: "pg_demo", // database name
+		description: "PostgreSQL demo database", // some description that QueryPanel can use
+		tenantFieldName: "tenant_id", // SDK will automatically filter by tenant_id
+		enforceTenantIsolation: true, // Ensures all queries include tenant_id filter
+		allowedTables: ["orders"], // Only sync 'orders' table - 'users' will be excluded
+	});
 
 qp.attachClickhouse(
-  "clicks",
+  "clicks", // uniq identifier for QueryPanel
   (params) => clickhouse.query(params),
   {
-    database: "analytics",
-    tenantFieldName: "customer_id",
-    tenantFieldType: "String",
+    database: "analytics", // database name
+    tenantFieldName: "customer_id", // SDK will automatically filter by tenant_id
+    tenantFieldType: "String", // SDK will use it in the clickhouse query as {customer_id::String}
   },
 );
 

package/dist/index.cjs

@@ -348,8 +348,9 @@ var PostgresAdapter = class {
     const allowedSet = new Set(
       this.allowedTables.map((t) => tableKey(t.schema, t.table))
     );
+    const neutralizedSql = sql.replace(/EXTRACT\s*\([^)]*FROM\s+[^)]+\)/gi, "EXTRACT(/*neutralized*/)").replace(/SUBSTRING\s*\([^)]*FROM\s+[^)]+\)/gi, "SUBSTRING(/*neutralized*/)").replace(/TRIM\s*\([^)]*FROM\s+[^)]+\)/gi, "TRIM(/*neutralized*/)").replace(/POSITION\s*\([^)]*FROM\s+[^)]+\)/gi, "POSITION(/*neutralized*/)");
     const tablePattern = /(?:FROM|JOIN)\s+(?:ONLY\s+)?(?:([a-zA-Z_][a-zA-Z0-9_]*)\.)?(["']?[a-zA-Z_][a-zA-Z0-9_]*["']?)/gi;
-    const matches = sql.matchAll(tablePattern);
+    const matches = neutralizedSql.matchAll(tablePattern);
     for (const match of matches) {
       const schema = match[1] ?? this.defaultSchema;
       const table = match[2]?.replace(/['"]/g, "");
@@ -1174,13 +1175,26 @@ async function ask(client, queryEngine, question, options, signal) {
   let previousSql = options.previousSql;
   while (attempt <= maxRetry) {
     console.log({ lastError, previousSql });
+    const databaseName = options.database ?? queryEngine.getDefaultDatabase();
+    const metadata = databaseName ? queryEngine.getDatabaseMetadata(databaseName) : void 0;
+    let tenantSettings;
+    if (metadata?.tenantFieldName) {
+      tenantSettings = {
+        tenantFieldName: metadata.tenantFieldName,
+        tenantFieldType: metadata.tenantFieldType,
+        enforceTenantIsolation: metadata.enforceTenantIsolation
+      };
+    }
     const queryResponse = await client.post(
       "/query",
       {
         question,
         ...lastError ? { last_error: lastError } : {},
         ...previousSql ? { previous_sql: previousSql } : {},
-        ...options.maxRetry ? { max_retry: options.maxRetry } : {}
+        ...options.maxRetry ? { max_retry: options.maxRetry } : {},
+        ...tenantSettings ? { tenant_settings: tenantSettings } : {},
+        ...databaseName ? { database: databaseName } : {},
+        ...metadata?.dialect ? { dialect: metadata.dialect } : {}
       },
       tenantId,
       options.userId,
@@ -1188,8 +1202,8 @@ async function ask(client, queryEngine, question, options, signal) {
       signal,
       sessionId
     );
-    const databaseName = queryResponse.database ?? options.database ?? queryEngine.getDefaultDatabase();
-    if (!databaseName) {
+    const dbName = queryResponse.database ?? options.database ?? queryEngine.getDefaultDatabase();
+    if (!dbName) {
       throw new Error(
         "No database attached. Call attachPostgres/attachClickhouse first."
       );
@@ -1200,7 +1214,7 @@ async function ask(client, queryEngine, question, options, signal) {
       const execution = await queryEngine.validateAndExecute(
         queryResponse.sql,
         paramValues,
-        databaseName,
+        dbName,
         tenantId
       );
       const rows = execution.rows ?? [];
@@ -1273,7 +1287,7 @@ async function ask(client, queryEngine, question, options, signal) {
         chart,
         context: queryResponse.context,
         attempts: attempt + 1,
-        target_db: databaseName
+        target_db: dbName
       };
     } catch (error) {
       attempt++;
@@ -1375,6 +1389,7 @@ var QueryPanelSdkAPI = class {
       description: options?.description,
       tags: options?.tags,
       tenantFieldName: options?.tenantFieldName,
+      tenantFieldType: options?.tenantFieldType ?? "String",
       enforceTenantIsolation: options?.tenantFieldName ? options?.enforceTenantIsolation ?? true : void 0
     };
     this.queryEngine.attachDatabase(name, adapter, metadata);