@lightdash/query-sdk 1.34.0 → 1.36.0

package/dist/delivery.d.ts

@@ -4,7 +4,7 @@
  * filters, period pickers) rather than a static module-scope manifest.
  */
 import { QueryBuilder } from './query';
-import { type SavedChartQuery } from './savedChart';
+import type { SavedChartQuery } from './savedChart';
 import type { InternalFilterDefinition, ParametersValuesMap, QueryDefinition } from './types';
 /**
  * A query declared for scheduled delivery. `label` is the tab/file name in the
@@ -23,30 +23,11 @@ export type DeliveryQuery = {
     filters?: InternalFilterDefinition[];
 };
 export declare function toDeliveryQuery(query: QueryBuilder | SavedChartQuery, name?: string): DeliveryQuery | null;
-export declare const DELIVERY_AVAILABLE_MESSAGE_TYPE = "lightdash:delivery:available";
-export type DeliveryAvailableMessage = {
-    type: typeof DELIVERY_AVAILABLE_MESSAGE_TYPE;
-    queries: DeliveryQuery[];
-};
-export declare function registerDeliveryQuery(id: string, declaration: DeliveryQuery): void;
-export declare function unregisterDeliveryQuery(id: string): void;
-export declare function getDeliveryQueries(): DeliveryQuery[];
-/** Test-only: clears module state between cases. */
-export declare function resetDeliveryRegistry(): void;
-/**
- * Announce the declared set to the host. Silent while the registry is empty —
- * an unconditional announce would unlock a data delivery format for an app
- * that declares nothing, which is the lineage failure mode (see lineage.ts).
- *
- * The registry is read when the timer fires, not when it is scheduled, so a
- * declaration registered and removed within one tick never reaches the host.
- */
-export declare function publishDeliveryQueries(target: Window): void;
-export declare function nextDeliveryId(): string;
 /**
- * Declare that this query's results belong in the app's scheduled deliveries.
- * Call it alongside the `useLightdash(q)` that renders the same query.
+ * @deprecated Inert since the v2 delivery design: scheduled deliveries now
+ * capture the app's executed queries host-side, so no declaration is needed.
+ * Kept exported so apps generated while this API was advertised don't crash.
  */
-export declare function useDelivery(query: QueryBuilder | SavedChartQuery, options?: {
+export declare function useDelivery(_query: QueryBuilder | SavedChartQuery, _options?: {
     name?: string;
 }): void;

package/dist/delivery.js

@@ -3,9 +3,7 @@
  * delivery. Declared during render, so they reflect live app state (global
  * filters, period pickers) rather than a static module-scope manifest.
  */
-import { useEffect, useMemo, useRef } from 'react';
 import { QueryBuilder } from './query';
-import { savedChartQueryKey } from './savedChart';
 export function toDeliveryQuery(query, name) {
     if (query instanceof QueryBuilder) {
         const built = query.build();
@@ -31,94 +29,11 @@ export function toDeliveryQuery(query, name) {
     console.warn('[lightdash] useDelivery expects a query() or savedChart() — skipping this declaration.');
     return null;
 }
-export const DELIVERY_AVAILABLE_MESSAGE_TYPE = 'lightdash:delivery:available';
-// Insertion-ordered: Map preserves it, and that order becomes the tab/file
-// order in the delivery.
-const registry = new Map();
-// Every mounted useDelivery publishes on mount, so a page with N declared
-// queries would post N times with a growing set. Coalescing collapses that to
-// one message carrying the settled set.
-const PUBLISH_COALESCE_MS = 0;
-let publishTimer = null;
-export function registerDeliveryQuery(id, declaration) {
-    registry.set(id, declaration);
-}
-export function unregisterDeliveryQuery(id) {
-    registry.delete(id);
-}
-export function getDeliveryQueries() {
-    return [...registry.values()];
-}
-/** Test-only: clears module state between cases. */
-export function resetDeliveryRegistry() {
-    registry.clear();
-    if (publishTimer !== null) {
-        clearTimeout(publishTimer);
-        publishTimer = null;
-    }
-}
 /**
- * Announce the declared set to the host. Silent while the registry is empty —
- * an unconditional announce would unlock a data delivery format for an app
- * that declares nothing, which is the lineage failure mode (see lineage.ts).
- *
- * The registry is read when the timer fires, not when it is scheduled, so a
- * declaration registered and removed within one tick never reaches the host.
+ * @deprecated Inert since the v2 delivery design: scheduled deliveries now
+ * capture the app's executed queries host-side, so no declaration is needed.
+ * Kept exported so apps generated while this API was advertised don't crash.
  */
-export function publishDeliveryQueries(target) {
-    if (typeof window === 'undefined')
-        return;
-    if (publishTimer !== null)
-        return;
-    publishTimer = setTimeout(() => {
-        publishTimer = null;
-        const queries = getDeliveryQueries();
-        if (queries.length === 0)
-            return;
-        // Bundles are served from the host page's own origin, and
-        // location.origin is URL-derived so it survives the sandboxed
-        // (opaque-origin) iframe.
-        const { origin } = window.location;
-        const targetOrigin = origin && origin !== 'null' ? origin : '*';
-        const message = {
-            type: DELIVERY_AVAILABLE_MESSAGE_TYPE,
-            queries,
-        };
-        target.postMessage(message, targetOrigin);
-    }, PUBLISH_COALESCE_MS);
-}
-let idCounter = 0;
-export function nextDeliveryId() {
-    idCounter += 1;
-    return `delivery-${idCounter}`;
-}
-/**
- * Declare that this query's results belong in the app's scheduled deliveries.
- * Call it alongside the `useLightdash(q)` that renders the same query.
- */
-export function useDelivery(query, options) {
-    const idRef = useRef(null);
-    if (idRef.current === null)
-        idRef.current = nextDeliveryId();
-    const id = idRef.current;
-    const name = options?.name;
-    const queryKey = useMemo(() => query instanceof QueryBuilder
-        ? JSON.stringify(query.build())
-        : savedChartQueryKey(query), [query]);
-    useEffect(() => {
-        const declaration = toDeliveryQuery(query, name);
-        if (declaration) {
-            registerDeliveryQuery(id, declaration);
-        }
-        else {
-            unregisterDeliveryQuery(id);
-        }
-        if (typeof window !== 'undefined' && window.parent !== window) {
-            publishDeliveryQueries(window.parent);
-        }
-        return () => {
-            unregisterDeliveryQuery(id);
-        };
-        // queryKey tracks query identity. query is intentionally omitted.
-    }, [id, queryKey, name]); // eslint-disable-line
+export function useDelivery(_query, _options) {
+    // no-op
 }

package/dist/features.js

@@ -65,12 +65,6 @@ export const SDK_FEATURES = [
         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().',
     },
-    {
-        key: 'delivery',
-        label: 'Data in scheduled deliveries',
-        description: "Include the app's query results as .csv/.xlsx in scheduled deliveries, instead of only a screenshot. Offer it when an app is used for reporting.",
-        wiring: 'Call useDelivery(q) alongside each useLightdash(q) whose data should be delivered; without it the delivery format stays image-only.',
-    },
 ];
 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.34.0";
+export declare const SDK_VERSION = "1.36.0";

package/dist/generated/sdkVersion.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightdash/query-sdk",
-  "version": "1.34.0",
+  "version": "1.36.0",
   "private": false,
   "type": "module",
   "description": "SDK for building custom data apps against the Lightdash semantic layer",
@@ -34,7 +34,7 @@
     "jsdom": "26.1.0",
     "typescript": "7.0.2",
     "vitest": "4.1.6",
-    "@lightdash/common": "1.34.0"
+    "@lightdash/common": "1.36.0"
   },
   "scripts": {
     "prebuild": "node ./scripts/generateSdkVersion.mjs",