@carto/ps-react-ui 5.0.0 → 5.2.0

package/src/widgets-v2/spread/download.ts

@@ -1,6 +1,7 @@
 import {
   buildCsvDownloadItem,
   buildPngDownloadItem,
+  type DownloadContext,
   type DownloadItem,
 } from '../actions/download'
 import type { SpreadWidgetData } from './types'
@@ -13,8 +14,8 @@ import type { SpreadWidgetData } from './types'
  */
 export function createSpreadDownloadConfig(args: {
   filename: string
-  getData: () => SpreadWidgetData
-  getCaptureEl?: () => HTMLElement | null
+  getData: (ctx: DownloadContext) => SpreadWidgetData
+  getCaptureEl?: (ctx: DownloadContext) => HTMLElement | null
   pngPixelRatio?: number
   pngBackgroundColor?: string | null
 }): DownloadItem[] {
@@ -32,8 +33,8 @@ export function createSpreadDownloadConfig(args: {
   items.push(
     buildCsvDownloadItem({
       filename: args.filename,
-      getRows: () => {
-        const data = args.getData()
+      getRows: (ctx) => {
+        const data = args.getData(ctx)
         const rows: unknown[][] = [
           ['series', 'prefix', 'min', 'max', 'suffix', 'note'],
         ]

package/src/widgets-v2/table/download.test.ts

@@ -56,7 +56,9 @@ describe('createTableDownloadConfig', () => {
       getData: () => data,
       columns,
     })
-    const handle = await items.find((i) => i.id === 'csv')!.resolve()
+    const handle = await items
+      .find((i) => i.id === 'csv')!
+      .resolve({ id: null })
     expect(handle.filename).toBe('t.csv')
     expect(csvText).toBe('Name,Score\nAlpha,10\nBeta,20')
   })
@@ -67,7 +69,7 @@ describe('createTableDownloadConfig', () => {
       getData: () => [{ id: 1, name: '=HYPERLINK("x")', score: 1 }],
       columns,
     })
-    await items.find((i) => i.id === 'csv')!.resolve()
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
     expect(csvText).toBe('Name,Score\n"\'=HYPERLINK(""x"")",1')
   })
 
@@ -79,7 +81,7 @@ describe('createTableDownloadConfig', () => {
       columns,
     })
     snapshot = [{ id: 9, name: 'Gamma', score: 99 }]
-    await items.find((i) => i.id === 'csv')!.resolve()
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
     expect(csvText).toBe('Name,Score\nGamma,99')
   })
 })

package/src/widgets-v2/table/download.ts

@@ -1,6 +1,7 @@
 import {
   buildCsvDownloadItem,
   buildPngDownloadItem,
+  type DownloadContext,
   type DownloadItem,
 } from '../actions/download'
 import { tableDataToCsv } from './helpers'
@@ -16,9 +17,9 @@ import type { TableColumn, TableWidgetData } from './types'
  */
 export function createTableDownloadConfig(opts: {
   filename: string
-  getData: () => TableWidgetData
+  getData: (ctx: DownloadContext) => TableWidgetData
   columns: readonly TableColumn[]
-  getCaptureEl?: () => HTMLElement | null
+  getCaptureEl?: (ctx: DownloadContext) => HTMLElement | null
   pngPixelRatio?: number
   pngBackgroundColor?: string | null
 }): DownloadItem[] {
@@ -36,7 +37,7 @@ export function createTableDownloadConfig(opts: {
   items.push(
     buildCsvDownloadItem({
       filename: opts.filename,
-      getCsv: () => tableDataToCsv(opts.getData(), opts.columns),
+      getCsv: (ctx) => tableDataToCsv(opts.getData(ctx), opts.columns),
     }),
   )
   return items

package/src/widgets-v2/timeseries/download.test.ts

@@ -53,7 +53,9 @@ describe('createTimeseriesDownloadConfig', () => {
       filename: 't',
       getData: () => data,
     })
-    const handle = await items.find((i) => i.id === 'csv')!.resolve()
+    const handle = await items
+      .find((i) => i.id === 'csv')!
+      .resolve({ id: null })
     expect(handle.filename).toBe('t.csv')
     expect(csvText).toBe(
       'time,series_1,series_2\n' +
@@ -69,7 +71,7 @@ describe('createTimeseriesDownloadConfig', () => {
       filename: 't',
       getData: () => data,
     })
-    await items.find((i) => i.id === 'csv')!.resolve()
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
     expect(csvText).toContain('2024-01-01T00:00:00.000Z,7')
   })
 
@@ -79,7 +81,7 @@ describe('createTimeseriesDownloadConfig', () => {
       filename: 't',
       getData: () => data,
     })
-    await items.find((i) => i.id === 'csv')!.resolve()
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
     expect(csvText).toContain('2024-Q1,1')
   })
 
@@ -89,7 +91,7 @@ describe('createTimeseriesDownloadConfig', () => {
       getData: () => [[{ name: '2024', value: 1 }]],
       seriesNames: ['revenue'],
     })
-    await items.find((i) => i.id === 'csv')!.resolve()
+    await items.find((i) => i.id === 'csv')!.resolve({ id: null })
     expect(csvText.split('\n')[0]).toBe('time,revenue')
   })
 })

package/src/widgets-v2/timeseries/download.ts

@@ -1,6 +1,7 @@
 import {
   buildCsvDownloadItem,
   buildPngDownloadItem,
+  type DownloadContext,
   type DownloadItem,
 } from '../actions/download'
 import type { TimeseriesWidgetData } from './types'
@@ -14,9 +15,9 @@ import type { TimeseriesWidgetData } from './types'
  */
 export function createTimeseriesDownloadConfig(args: {
   filename: string
-  getData: () => TimeseriesWidgetData
+  getData: (ctx: DownloadContext) => TimeseriesWidgetData
   seriesNames?: readonly string[]
-  getCaptureEl?: () => HTMLElement | null
+  getCaptureEl?: (ctx: DownloadContext) => HTMLElement | null
   pngPixelRatio?: number
   pngBackgroundColor?: string | null
 }): DownloadItem[] {
@@ -34,8 +35,8 @@ export function createTimeseriesDownloadConfig(args: {
   items.push(
     buildCsvDownloadItem({
       filename: args.filename,
-      getRows: () => {
-        const data = args.getData()
+      getRows: (ctx) => {
+        const data = args.getData(ctx)
         const seriesCount = data.length
 
         // Collect every unique time, preserving insertion order.

package/src/widgets-v2/toolbox/toolbox.tsx

@@ -56,7 +56,7 @@ export interface ToolboxProps {
  * Smart overflow toolbar with **single-mount** items. Children mount once
  * into a stable, hidden host element and are *physically reparented* via
  * `appendChild` between the inline preview area and the overflow `<Paper>`
- * as the popper opens / closes — same pattern as `Widget.FullScreen.Slot`.
+ * as the popper opens / closes.
  * Items with no inline space when closed are kept mounted but visually
  * hidden via `display: none`.
  *