@lightdash/query-sdk 0.2753.0 → 0.2755.0

package/dist/apiTransport.d.ts

@@ -13,7 +13,7 @@ import type { Column, LightdashClientConfig, Transport } from './types';
  * The default implementation uses `Authorization: ApiKey` header.
  * Supply a custom adapter to use session cookies or other auth mechanisms.
  */
-export type FetchAdapter = <T>(method: string, path: string, body?: unknown) => Promise<T>;
+export type FetchAdapter = <T>(method: string, path: string, body?: unknown, metadata?: Record<string, unknown>) => Promise<T>;
 export declare function mapColumnType(type: string): Column['type'];
 /**
  * Creates a transport that executes queries via the Lightdash REST API.

package/dist/apiTransport.js

@@ -112,7 +112,12 @@ export function createApiTransport(config, adapter) {
                     tableCalculations: [],
                 },
             };
-            const execResult = await fetchFn('POST', `/api/v2/projects/${config.projectUuid}/query/metric-query`, body);
+            // Pass label as transport metadata (not in the API body)
+            // so the parent bridge can display it in the query inspector.
+            const metadata = query.label
+                ? { label: query.label }
+                : undefined;
+            const execResult = await fetchFn('POST', `/api/v2/projects/${config.projectUuid}/query/metric-query`, body, metadata);
             const { queryUuid, fields } = execResult;
             // Step 2: Poll for results
             let attempts = 0;

package/dist/postMessageTransport.d.ts

@@ -15,6 +15,8 @@ export type SdkFetchRequest = {
     method: string;
     path: string;
     body?: unknown;
+    /** Transport metadata for dev tools (not sent to the API) */
+    metadata?: Record<string, unknown>;
 };
 export type SdkFetchResponse = {
     type: 'lightdash:sdk:fetch-response';

package/dist/postMessageTransport.js

@@ -51,7 +51,7 @@ function createPostMessageFetchAdapter(config) {
             }
         }
     });
-    return async (method, path, body) => {
+    return async (method, path, body, metadata) => {
         await readyPromise;
         const id = crypto.randomUUID();
         return new Promise((resolve, reject) => {
@@ -70,6 +70,7 @@ function createPostMessageFetchAdapter(config) {
                 method,
                 path,
                 body,
+                ...(metadata ? { metadata } : {}),
             };
             targetWindow.postMessage(message, '*');
         });

package/dist/query.d.ts

@@ -29,10 +29,13 @@ export declare class QueryBuilder {
     private readonly _filters;
     private readonly _sorts;
     private readonly _limit;
+    private readonly _label;
     constructor(explore: string, dimensions?: string[], metrics?: string[], filters?: InternalFilterDefinition[], sorts?: {
         fieldId: string;
         descending: boolean;
-    }[], limit?: number);
+    }[], limit?: number, label?: string);
+    /** Human-readable label for dev tools / query inspector */
+    label(name: string): QueryBuilder;
     /** Set dimension fields (GROUP BY columns) */
     dimensions(fields: string[]): QueryBuilder;
     /** Set metric fields (aggregations) */

package/dist/query.js

@@ -24,21 +24,26 @@ export function query(modelName) {
     return new QueryBuilder(modelName);
 }
 export class QueryBuilder {
-    constructor(explore, dimensions = [], metrics = [], filters = [], sorts = [], limit = 500) {
+    constructor(explore, dimensions = [], metrics = [], filters = [], sorts = [], limit = 500, label) {
         this._explore = explore;
         this._dimensions = dimensions;
         this._metrics = metrics;
         this._filters = filters;
         this._sorts = sorts;
         this._limit = limit;
+        this._label = label;
+    }
+    /** Human-readable label for dev tools / query inspector */
+    label(name) {
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, this._limit, name);
     }
     /** Set dimension fields (GROUP BY columns) */
     dimensions(fields) {
-        return new QueryBuilder(this._explore, [...this._dimensions, ...fields], this._metrics, this._filters, this._sorts, this._limit);
+        return new QueryBuilder(this._explore, [...this._dimensions, ...fields], this._metrics, this._filters, this._sorts, this._limit, this._label);
     }
     /** Set metric fields (aggregations) */
     metrics(fields) {
-        return new QueryBuilder(this._explore, this._dimensions, [...this._metrics, ...fields], this._filters, this._sorts, this._limit);
+        return new QueryBuilder(this._explore, this._dimensions, [...this._metrics, ...fields], this._filters, this._sorts, this._limit, this._label);
     }
     /** Add filters */
     filters(filters) {
@@ -59,7 +64,7 @@ export class QueryBuilder {
                 settings: f.unit ? { unitOfTime: f.unit } : null,
             };
         });
-        return new QueryBuilder(this._explore, this._dimensions, this._metrics, [...this._filters, ...converted], this._sorts, this._limit);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, [...this._filters, ...converted], this._sorts, this._limit, this._label);
     }
     /** Add sorts */
     sorts(sorts) {
@@ -67,11 +72,11 @@ export class QueryBuilder {
             fieldId: s.field,
             descending: s.direction === 'desc',
         }));
-        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, [...this._sorts, ...converted], this._limit);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, [...this._sorts, ...converted], this._limit, this._label);
     }
     /** Set the maximum number of rows to return (default: 500) */
     limit(n) {
-        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, n);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, n, this._label);
     }
     /** Convert to a plain QueryDefinition object */
     build() {
@@ -82,6 +87,7 @@ export class QueryBuilder {
             filters: this._filters,
             sorts: this._sorts,
             limit: this._limit,
+            ...(this._label ? { label: this._label } : {}),
         };
     }
 }

package/dist/types.d.ts

@@ -32,6 +32,8 @@ export type QueryDefinition = {
         descending: boolean;
     }[];
     limit: number;
+    /** Human-readable label for dev tools / query inspector (not sent to the API) */
+    label?: string;
 };
 export type ColumnType = 'string' | 'number' | 'date' | 'timestamp' | 'boolean';
 export type Column = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/query-sdk",
-  "version": "0.2753.0",
+  "version": "0.2755.0",
   "private": false,
   "type": "module",
   "description": "SDK for building custom data apps against the Lightdash semantic layer",