@lightdash/query-sdk 0.2663.1 → 0.2664.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
+export { query } from './query';
 export { createClient, LightdashClient } from './client';
 export { useLightdash } from './useLightdash';
-export { LightdashProvider } from './LightdashProvider';
-export type { Filter, FilterOperator, FilterValue, LightdashClientConfig, LightdashUser, Row, Sort, UnitOfTime, } from './types';
+export { LightdashProvider, useLightdashClient } from './LightdashProvider';
+export type { Column, Filter, FilterOperator, FilterValue, FormatFunction, LightdashClientConfig, LightdashUser, Row, Sort, UnitOfTime, } from './types';

package/dist/index.js

@@ -1,6 +1,8 @@
+// Query builder
+export { query } from './query';
 // Client
 export { createClient, LightdashClient } from './client';
 // React hook
 export { useLightdash } from './useLightdash';
 // Provider
-export { LightdashProvider } from './LightdashProvider';
+export { LightdashProvider, useLightdashClient } from './LightdashProvider';

package/dist/query.d.ts

@@ -2,8 +2,7 @@
  * Chainable query builder.
  *
  * Usage:
- *   lightdash
- *     .model('orders')
+ *   query('orders')
  *     .dimensions(['customer_segment', 'order_date'])
  *     .metrics(['total_revenue', 'order_count'])
  *     .filters([{ field: 'order_date', operator: 'inThePast', value: 90, unit: 'days' }])
@@ -13,6 +12,16 @@
  * The builder is immutable -- each method returns a new instance.
  */
 import type { Filter, InternalFilterDefinition, QueryDefinition, Sort } from './types';
+/**
+ * Create a query builder for a model.
+ *
+ * Usage:
+ *   query('orders')
+ *     .dimensions(['customer_segment'])
+ *     .metrics(['total_revenue'])
+ *     .limit(100)
+ */
+export declare function query(modelName: string): QueryBuilder;
 export declare class QueryBuilder {
     private readonly _explore;
     private readonly _dimensions;

package/dist/query.js

@@ -2,8 +2,7 @@
  * Chainable query builder.
  *
  * Usage:
- *   lightdash
- *     .model('orders')
+ *   query('orders')
  *     .dimensions(['customer_segment', 'order_date'])
  *     .metrics(['total_revenue', 'order_count'])
  *     .filters([{ field: 'order_date', operator: 'inThePast', value: 90, unit: 'days' }])
@@ -12,6 +11,18 @@
  *
  * The builder is immutable -- each method returns a new instance.
  */
+/**
+ * Create a query builder for a model.
+ *
+ * Usage:
+ *   query('orders')
+ *     .dimensions(['customer_segment'])
+ *     .metrics(['total_revenue'])
+ *     .limit(100)
+ */
+export function query(modelName) {
+    return new QueryBuilder(modelName);
+}
 export class QueryBuilder {
     constructor(explore, dimensions = [], metrics = [], filters = [], sorts = [], limit = 500) {
         this._explore = explore;

package/dist/useLightdash.d.ts

@@ -13,10 +13,14 @@
  *   // [{ customer_segment: 'Enterprise', total_revenue: 124000 }]
  */
 import type { QueryBuilder } from './query';
-import type { Row } from './types';
+import type { Column, FormatFunction, Row } from './types';
 type UseLightdashResult = {
     /** Result rows as flat objects. Numbers are numbers, strings are strings. */
     data: Row[];
+    /** Column metadata (name, label, type) */
+    columns: Column[];
+    /** Format a field value for display: format(row, 'total_revenue') → "$1,234" */
+    format: FormatFunction;
     /** True while the query is executing */
     loading: boolean;
     /** Error if the query failed, null otherwise */

package/dist/useLightdash.js

@@ -14,9 +14,12 @@
  */
 import { useCallback, useEffect, useMemo, useState } from 'react';
 import { useTransport } from './LightdashProvider';
+const noopFormat = (_row, _fieldId) => '';
 export function useLightdash(query) {
     const transport = useTransport();
     const [data, setData] = useState([]);
+    const [columns, setColumns] = useState([]);
+    const [format, setFormat] = useState(() => noopFormat);
     const [loading, setLoading] = useState(true);
     const [error, setError] = useState(null);
     const [fetchCount, setFetchCount] = useState(0);
@@ -34,6 +37,8 @@ export function useLightdash(query) {
             .then((res) => {
             if (!cancelled) {
                 setData(res.rows);
+                setColumns(res.columns);
+                setFormat(() => res.format);
                 setLoading(false);
             }
         })
@@ -48,5 +53,5 @@ export function useLightdash(query) {
         };
         // queryKey tracks query identity. query is intentionally omitted.
     }, [queryKey, transport, fetchCount]); // eslint-disable-line
-    return { data, loading, error, refetch };
+    return { data, columns, format, loading, error, refetch };
 }

package/package.json

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