@lightdash/query-sdk 1.12.0 → 1.14.0

package/dist/features.js

@@ -59,6 +59,12 @@ export const SDK_FEATURES = [
         label: 'Dashboard visualization context',
         description: 'Receive query context when app visualizations are embedded in dashboards.',
     },
+    {
+        key: 'viz-config-options',
+        label: 'Visualization config options',
+        description: "Let viewers adjust the visualization from the Lightdash config panel — toggles, dropdowns, numbers, text and colours — and take series colours from the chart's palette, without regenerating the app.",
+        wiring: 'Declare configOptions (and colorPalette, if the viz colours series) in the viz schema, then read options[name] and colorPalette from useVizContext().',
+    },
 ];
 export const SDK_FEATURE_KEYS = SDK_FEATURES.map((f) => f.key);
 export const SDK_MANIFEST_MESSAGE_TYPE = 'lightdash:sdk:manifest';

package/dist/generated/sdkVersion.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.12.0";
+export declare const SDK_VERSION = "1.14.0";

package/dist/generated/sdkVersion.js

@@ -1,2 +1,2 @@
 // Generated by scripts/generateSdkVersion.mjs (prebuild) — do not edit.
-export const SDK_VERSION = '1.12.0';
+export const SDK_VERSION = '1.14.0';

package/dist/vizContext.d.ts

@@ -26,13 +26,16 @@ export type VizContextRow = Record<string, VizContextCell | undefined>;
 /**
  * A config option value. Its shape follows the option's declared type:
  * `boolean` → boolean, `number` → number, `select`/`text`/`color` → string.
+ * Series colours are not an option — they arrive on `colorPalette`.
  */
 export type VizContextOptionValue = boolean | number | string;
 /**
  * Pushed by the host into the iframe. `fieldMapping` maps each field name the
  * renderer declared to the query field id it resolves to; `rows` are the
  * host-fetched result rows keyed by field id; `options` holds the current
- * value of each config option the renderer declared.
+ * value of each config option the renderer declared; `colorPalette` is the
+ * Lightdash palette resolved for this chart, pushed whether or not the
+ * renderer declared one.
  */
 export type DataAppVizContextMessage = {
     type: 'lightdash:sdk:data-app-viz-context';
@@ -40,6 +43,8 @@ export type DataAppVizContextMessage = {
     rows: VizContextRow[];
     /** Absent when the installed host predates config-option delivery. */
     options?: Record<string, VizContextOptionValue>;
+    /** Absent when the installed host predates palette delivery. */
+    colorPalette?: string[];
 };
 /** Posted by the iframe on mount so the host pushes the current context. */
 export type VizContextRequestMessage = {
@@ -56,6 +61,13 @@ export type VizContext = {
     rows: VizContextRow[];
     /** Config option name → current value (the user's choice, else the declared default). */
     options: Record<string, VizContextOptionValue>;
+    /**
+     * Ordered series colours resolved from the Lightdash palette the viewer
+     * picked. Colour multi-series charts with
+     * `colorPalette[i % colorPalette.length]`. Empty only when the host
+     * resolved no palette; keep a fallback array in your own code for that.
+     */
+    colorPalette: string[];
     /** False until the first context arrives — render a placeholder while false. */
     ready: boolean;
 };
@@ -63,12 +75,14 @@ type VizContextValue = {
     fieldMapping: Record<string, string>;
     rows: VizContextRow[];
     options: Record<string, VizContextOptionValue>;
+    colorPalette: string[];
 };
 type VizContextState = VizContextValue | null;
 /**
  * Normalises an inbound host message into provider state. The payload crosses a
- * postMessage boundary so every key is treated as untrusted; `options` is also
- * absent from hosts predating it, and falls back to `{}`.
+ * postMessage boundary so every key is treated as untrusted; `options` and
+ * `colorPalette` are also absent from hosts predating them, and fall back to
+ * `{}` / `[]`.
  */
 export declare function toVizContextState(message: DataAppVizContextMessage): VizContextValue;
 declare const NO_PROVIDER: unique symbol;
@@ -86,7 +100,7 @@ export declare function VizContextProvider({ children }: {
  * still works standalone. Re-renders whenever the host pushes (on load, on
  * mapping change, on query change). Resolve a declared field to its bound cell
  * with `fieldMapping[name]` then `getFormatted`/`getRaw`; read a declared
- * config option with `options[name]`.
+ * config option with `options[name]`, and colour series from `colorPalette`.
  */
 export declare function useVizContext(): VizContext;
 export {};

package/dist/vizContext.js

@@ -41,14 +41,18 @@ const normalizeOptions = (options) => {
 };
 /**
  * Normalises an inbound host message into provider state. The payload crosses a
- * postMessage boundary so every key is treated as untrusted; `options` is also
- * absent from hosts predating it, and falls back to `{}`.
+ * postMessage boundary so every key is treated as untrusted; `options` and
+ * `colorPalette` are also absent from hosts predating them, and fall back to
+ * `{}` / `[]`.
  */
 export function toVizContextState(message) {
     return {
         fieldMapping: message.fieldMapping ?? {},
         rows: Array.isArray(message.rows) ? message.rows : [],
         options: normalizeOptions(message.options),
+        colorPalette: Array.isArray(message.colorPalette)
+            ? message.colorPalette.filter((color) => typeof color === 'string')
+            : [],
     };
 }
 // Distinguishes "no provider mounted" from "provider present, no context yet".
@@ -98,7 +102,7 @@ export function VizContextProvider({ children }) {
  * still works standalone. Re-renders whenever the host pushes (on load, on
  * mapping change, on query change). Resolve a declared field to its bound cell
  * with `fieldMapping[name]` then `getFormatted`/`getRaw`; read a declared
- * config option with `options[name]`.
+ * config option with `options[name]`, and colour series from `colorPalette`.
  */
 export function useVizContext() {
     const fromProvider = useContext(VizContextContext);
@@ -113,6 +117,7 @@ export function useVizContext() {
         fieldMapping: context?.fieldMapping ?? {},
         rows: context?.rows ?? [],
         options: context?.options ?? {},
+        colorPalette: context?.colorPalette ?? [],
         ready: context !== null,
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/query-sdk",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "private": false,
   "type": "module",
   "description": "SDK for building custom data apps against the Lightdash semantic layer",
@@ -35,7 +35,7 @@
     "typescript": "npm:@typescript/typescript6@6.0.1",
     "typescript-7": "npm:typescript@7.0.1-rc",
     "vitest": "4.1.6",
-    "@lightdash/common": "1.12.0"
+    "@lightdash/common": "1.14.0"
   },
   "scripts": {
     "prebuild": "node ./scripts/generateSdkVersion.mjs",