@lightdash/common 0.2881.2 → 0.2881.3

package/dist/cjs/constants/screenshot.d.ts

@@ -13,6 +13,24 @@
  * - Backend: Waited for by UnfurlService.saveScreenshot()
  */
 export declare const SCREENSHOT_READY_INDICATOR_ID = "lightdash-ready-indicator";
+/**
+ * ID of an element that is always mounted on minimal pages and exposes the
+ * current screenshot progress: which tiles are expected, ready, and errored.
+ *
+ * Unlike SCREENSHOT_READY_INDICATOR_ID, this element exists from first paint
+ * so the UnfurlService can read it on timeout to identify which tile UUIDs
+ * are still unaccounted for.
+ *
+ * Data attributes:
+ * - data-tiles-expected: JSON array of tile UUIDs expected to render
+ * - data-tiles-ready:    JSON array of tile UUIDs that called markTileScreenshotReady
+ * - data-tiles-errored:  JSON array of tile UUIDs that called markTileScreenshotErrored
+ *
+ * Usage:
+ * - Frontend: Rendered by ScreenshotProgressIndicator on minimal pages
+ * - Backend:  Read by UnfurlService when waitForSelector(READY_INDICATOR) times out
+ */
+export declare const SCREENSHOT_PROGRESS_INDICATOR_ID = "lightdash-screenshot-progress";
 /**
  * Class name for tile loading skeleton overlays.
  * The UnfurlService waits for these elements to be hidden (loading complete).
@@ -74,6 +92,8 @@ export declare const LOGIN_PAGE_ID = "lightdash-login-page";
 export declare const SCREENSHOT_SELECTORS: {
     /** ID selector: #lightdash-ready-indicator */
     readonly READY_INDICATOR: "#lightdash-ready-indicator";
+    /** ID selector: #lightdash-screenshot-progress */
+    readonly PROGRESS_INDICATOR: "#lightdash-screenshot-progress";
     /** Class selector: .loading_chart_overlay */
     readonly LOADING_OVERLAY: ".loading_chart_overlay";
     /** Class selector: .loading_chart */

package/dist/cjs/constants/screenshot.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../../src/constants/screenshot.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,8BAA8B,CAAC;AAEzE;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,0BAA0B,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,6BAA6B,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,yBAAyB,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,oBAAoB;IAC7B,8CAA8C;;IAE9C,6CAA6C;;IAE7C,qCAAqC;;IAErC,qCAAqC;;IAErC,yCAAyC;;IAEzC,6CAA6C;;IAE7C,yCAAyC;;CAEnC,CAAC"}
+{"version":3,"file":"screenshot.d.ts","sourceRoot":"","sources":["../../../src/constants/screenshot.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,8BAA8B,CAAC;AAEzE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,gCAAgC,kCAAkC,CAAC;AAEhF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,0BAA0B,CAAC;AAEnE;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,kBAAkB,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,sBAAsB,CAAC;AAExD;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,6BAA6B,CAAC;AAE5D;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,yBAAyB,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,oBAAoB;IAC7B,8CAA8C;;IAE9C,kDAAkD;;IAElD,6CAA6C;;IAE7C,qCAAqC;;IAErC,qCAAqC;;IAErC,yCAAyC;;IAEzC,6CAA6C;;IAE7C,yCAAyC;;CAEnC,CAAC"}

package/dist/cjs/constants/screenshot.js

@@ -6,7 +6,7 @@
  * IMPORTANT: Changes to these constants must be coordinated between frontend and backend deployments.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SCREENSHOT_SELECTORS = exports.LOGIN_PAGE_ID = exports.ERROR_BOUNDARY_ID = exports.DASHBOARD_GRID_CLASS = exports.MARKDOWN_TILE_CLASS = exports.LOADING_CHART_CLASS = exports.LOADING_CHART_OVERLAY_CLASS = exports.SCREENSHOT_READY_INDICATOR_ID = void 0;
+exports.SCREENSHOT_SELECTORS = exports.LOGIN_PAGE_ID = exports.ERROR_BOUNDARY_ID = exports.DASHBOARD_GRID_CLASS = exports.MARKDOWN_TILE_CLASS = exports.LOADING_CHART_CLASS = exports.LOADING_CHART_OVERLAY_CLASS = exports.SCREENSHOT_PROGRESS_INDICATOR_ID = exports.SCREENSHOT_READY_INDICATOR_ID = void 0;
 /**
  * ID of the element that signals when a dashboard/chart is ready for screenshot.
  * The UnfurlService waits for this element to appear before taking a screenshot.
@@ -16,6 +16,24 @@ exports.SCREENSHOT_SELECTORS = exports.LOGIN_PAGE_ID = exports.ERROR_BOUNDARY_ID
  * - Backend: Waited for by UnfurlService.saveScreenshot()
  */
 exports.SCREENSHOT_READY_INDICATOR_ID = 'lightdash-ready-indicator';
+/**
+ * ID of an element that is always mounted on minimal pages and exposes the
+ * current screenshot progress: which tiles are expected, ready, and errored.
+ *
+ * Unlike SCREENSHOT_READY_INDICATOR_ID, this element exists from first paint
+ * so the UnfurlService can read it on timeout to identify which tile UUIDs
+ * are still unaccounted for.
+ *
+ * Data attributes:
+ * - data-tiles-expected: JSON array of tile UUIDs expected to render
+ * - data-tiles-ready:    JSON array of tile UUIDs that called markTileScreenshotReady
+ * - data-tiles-errored:  JSON array of tile UUIDs that called markTileScreenshotErrored
+ *
+ * Usage:
+ * - Frontend: Rendered by ScreenshotProgressIndicator on minimal pages
+ * - Backend:  Read by UnfurlService when waitForSelector(READY_INDICATOR) times out
+ */
+exports.SCREENSHOT_PROGRESS_INDICATOR_ID = 'lightdash-screenshot-progress';
 /**
  * Class name for tile loading skeleton overlays.
  * The UnfurlService waits for these elements to be hidden (loading complete).
@@ -77,6 +95,8 @@ exports.LOGIN_PAGE_ID = 'lightdash-login-page';
 exports.SCREENSHOT_SELECTORS = {
     /** ID selector: #lightdash-ready-indicator */
     READY_INDICATOR: `#${exports.SCREENSHOT_READY_INDICATOR_ID}`,
+    /** ID selector: #lightdash-screenshot-progress */
+    PROGRESS_INDICATOR: `#${exports.SCREENSHOT_PROGRESS_INDICATOR_ID}`,
     /** Class selector: .loading_chart_overlay */
     LOADING_OVERLAY: `.${exports.LOADING_CHART_OVERLAY_CLASS}`,
     /** Class selector: .loading_chart */

package/dist/cjs/constants/screenshot.js.map

@@ -1 +1 @@
-{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../../src/constants/screenshot.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG,2BAA2B,CAAC;AAEzE;;;;;;;GAOG;AACU,QAAA,2BAA2B,GAAG,uBAAuB,CAAC;AAEnE;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEnD;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEnD;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AAExD;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,0BAA0B,CAAC;AAE5D;;;;;;;;GAQG;AACU,QAAA,aAAa,GAAG,sBAAsB,CAAC;AAEpD;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAChC,8CAA8C;IAC9C,eAAe,EAAE,IAAI,qCAA6B,EAAE;IACpD,6CAA6C;IAC7C,eAAe,EAAE,IAAI,mCAA2B,EAAE;IAClD,qCAAqC;IACrC,aAAa,EAAE,IAAI,2BAAmB,EAAE;IACxC,qCAAqC;IACrC,aAAa,EAAE,IAAI,2BAAmB,EAAE;IACxC,yCAAyC;IACzC,cAAc,EAAE,IAAI,4BAAoB,EAAE;IAC1C,6CAA6C;IAC7C,cAAc,EAAE,IAAI,yBAAiB,EAAE;IACvC,yCAAyC;IACzC,UAAU,EAAE,IAAI,qBAAa,EAAE;CACzB,CAAC"}
+{"version":3,"file":"screenshot.js","sourceRoot":"","sources":["../../../src/constants/screenshot.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH;;;;;;;GAOG;AACU,QAAA,6BAA6B,GAAG,2BAA2B,CAAC;AAEzE;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,gCAAgC,GAAG,+BAA+B,CAAC;AAEhF;;;;;;;GAOG;AACU,QAAA,2BAA2B,GAAG,uBAAuB,CAAC;AAEnE;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEnD;;;;;;;GAOG;AACU,QAAA,mBAAmB,GAAG,eAAe,CAAC;AAEnD;;;;;;;GAOG;AACU,QAAA,oBAAoB,GAAG,mBAAmB,CAAC;AAExD;;;;;;;GAOG;AACU,QAAA,iBAAiB,GAAG,0BAA0B,CAAC;AAE5D;;;;;;;;GAQG;AACU,QAAA,aAAa,GAAG,sBAAsB,CAAC;AAEpD;;GAEG;AACU,QAAA,oBAAoB,GAAG;IAChC,8CAA8C;IAC9C,eAAe,EAAE,IAAI,qCAA6B,EAAE;IACpD,kDAAkD;IAClD,kBAAkB,EAAE,IAAI,wCAAgC,EAAE;IAC1D,6CAA6C;IAC7C,eAAe,EAAE,IAAI,mCAA2B,EAAE;IAClD,qCAAqC;IACrC,aAAa,EAAE,IAAI,2BAAmB,EAAE;IACxC,qCAAqC;IACrC,aAAa,EAAE,IAAI,2BAAmB,EAAE;IACxC,yCAAyC;IACzC,cAAc,EAAE,IAAI,4BAAoB,EAAE;IAC1C,6CAA6C;IAC7C,cAAc,EAAE,IAAI,yBAAiB,EAAE;IACvC,yCAAyC;IACzC,UAAU,EAAE,IAAI,qBAAa,EAAE;CACzB,CAAC"}