@lightdash/query-sdk 0.2774.0 → 0.2774.1

package/dist/apiTransport.js

@@ -109,7 +109,7 @@ export function createApiTransport(config, adapter) {
                         descending: s.descending,
                     })),
                     limit: query.limit,
-                    tableCalculations: [],
+                    tableCalculations: query.tableCalculations,
                 },
             };
             // Pass label as transport metadata (not in the API body)

package/dist/index.d.ts

@@ -4,5 +4,5 @@ export { useLightdash } from './useLightdash';
 export { LightdashProvider, useLightdashClient } from './LightdashProvider';
 export { createApiTransport, type FetchAdapter } from './apiTransport';
 export { createPostMessageTransport } from './postMessageTransport';
-export type { Column, Filter, FilterOperator, FilterValue, FormatFunction, LightdashClientConfig, LightdashUser, QueryDefinition, QueryResult, Row, Sort, Transport, UnitOfTime, } from './types';
+export type { Column, Filter, FilterOperator, FilterValue, FormatFunction, LightdashClientConfig, LightdashUser, QueryDefinition, QueryResult, Row, Sort, TableCalculation, Transport, UnitOfTime, } from './types';
 export type { SdkFetchRequest, SdkFetchResponse, SdkReadyMessage, } from './postMessageTransport';

package/dist/query.d.ts

@@ -11,7 +11,7 @@
  *
  * The builder is immutable -- each method returns a new instance.
  */
-import type { Filter, InternalFilterDefinition, QueryDefinition, Sort } from './types';
+import type { Filter, InternalFilterDefinition, QueryDefinition, Sort, TableCalculation } from './types';
 /**
  * Create a query builder for a model.
  *
@@ -28,12 +28,13 @@ export declare class QueryBuilder {
     private readonly _metrics;
     private readonly _filters;
     private readonly _sorts;
+    private readonly _tableCalculations;
     private readonly _limit;
     private readonly _label;
     constructor(explore: string, dimensions?: string[], metrics?: string[], filters?: InternalFilterDefinition[], sorts?: {
         fieldId: string;
         descending: boolean;
-    }[], limit?: number, label?: string);
+    }[], limit?: number, label?: string, tableCalculations?: TableCalculation[]);
     /** Human-readable label for dev tools / query inspector */
     label(name: string): QueryBuilder;
     /** Set dimension fields (GROUP BY columns) */
@@ -44,6 +45,8 @@ export declare class QueryBuilder {
     filters(filters: Filter[]): QueryBuilder;
     /** Add sorts */
     sorts(sorts: Sort[]): QueryBuilder;
+    /** Add table calculations (computed columns evaluated after the query) */
+    tableCalculations(calcs: TableCalculation[]): QueryBuilder;
     /** Set the maximum number of rows to return (default: 500) */
     limit(n: number): QueryBuilder;
     /** Convert to a plain QueryDefinition object */

package/dist/query.js

@@ -24,26 +24,27 @@ export function query(modelName) {
     return new QueryBuilder(modelName);
 }
 export class QueryBuilder {
-    constructor(explore, dimensions = [], metrics = [], filters = [], sorts = [], limit = 500, label) {
+    constructor(explore, dimensions = [], metrics = [], filters = [], sorts = [], limit = 500, label, tableCalculations = []) {
         this._explore = explore;
         this._dimensions = dimensions;
         this._metrics = metrics;
         this._filters = filters;
         this._sorts = sorts;
+        this._tableCalculations = tableCalculations;
         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);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, this._limit, name, this._tableCalculations);
     }
     /** Set dimension fields (GROUP BY columns) */
     dimensions(fields) {
-        return new QueryBuilder(this._explore, [...this._dimensions, ...fields], this._metrics, this._filters, this._sorts, this._limit, this._label);
+        return new QueryBuilder(this._explore, [...this._dimensions, ...fields], this._metrics, this._filters, this._sorts, this._limit, this._label, this._tableCalculations);
     }
     /** Set metric fields (aggregations) */
     metrics(fields) {
-        return new QueryBuilder(this._explore, this._dimensions, [...this._metrics, ...fields], this._filters, this._sorts, this._limit, this._label);
+        return new QueryBuilder(this._explore, this._dimensions, [...this._metrics, ...fields], this._filters, this._sorts, this._limit, this._label, this._tableCalculations);
     }
     /** Add filters */
     filters(filters) {
@@ -64,7 +65,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, this._label);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, [...this._filters, ...converted], this._sorts, this._limit, this._label, this._tableCalculations);
     }
     /** Add sorts */
     sorts(sorts) {
@@ -72,11 +73,15 @@ 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, this._label);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, [...this._sorts, ...converted], this._limit, this._label, this._tableCalculations);
+    }
+    /** Add table calculations (computed columns evaluated after the query) */
+    tableCalculations(calcs) {
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, this._limit, this._label, [...this._tableCalculations, ...calcs]);
     }
     /** 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, this._label);
+        return new QueryBuilder(this._explore, this._dimensions, this._metrics, this._filters, this._sorts, n, this._label, this._tableCalculations);
     }
     /** Convert to a plain QueryDefinition object */
     build() {
@@ -86,6 +91,7 @@ export class QueryBuilder {
             metrics: this._metrics,
             filters: this._filters,
             sorts: this._sorts,
+            tableCalculations: this._tableCalculations,
             limit: this._limit,
             ...(this._label ? { label: this._label } : {}),
         };

package/dist/types.d.ts

@@ -14,6 +14,14 @@ export type Sort = {
     field: string;
     direction: 'asc' | 'desc';
 };
+export type TableCalculation = {
+    /** Internal name of the table calculation (used as the field ID in results) */
+    name: string;
+    /** Display name shown in the UI */
+    displayName: string;
+    /** SQL expression for the calculation */
+    sql: string;
+};
 export type InternalFilterDefinition = {
     fieldId: string;
     operator: string;
@@ -31,6 +39,7 @@ export type QueryDefinition = {
         fieldId: string;
         descending: boolean;
     }[];
+    tableCalculations: TableCalculation[];
     limit: number;
     /** Human-readable label for dev tools / query inspector (not sent to the API) */
     label?: string;

package/package.json

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