@opendata-ai/openchart-engine 6.11.0 → 6.12.0

package/dist/index.d.ts

@@ -101,6 +101,8 @@ interface GraphCompilation {
     };
     /** Force simulation configuration. */
     simulationConfig: SimulationConfig;
+    /** Whether to show the brand watermark. */
+    watermark: boolean;
 }
 
 /**
@@ -212,6 +214,8 @@ interface NormalizedChartSpec {
     responsive: boolean;
     theme: ThemeConfig;
     darkMode: DarkMode;
+    /** Whether the tryOpenData.ai watermark is enabled. */
+    watermark: boolean;
     /** Series names to hide from rendering. */
     hiddenSeries: string[];
     /** Per-series visual style overrides. */
@@ -226,6 +230,7 @@ interface NormalizedTableSpec {
     chrome: NormalizedChrome;
     theme: ThemeConfig;
     darkMode: DarkMode;
+    watermark: boolean;
     search: boolean;
     pagination: boolean | {
         pageSize: number;
@@ -247,6 +252,7 @@ interface NormalizedGraphSpec {
     annotations: Annotation[];
     theme: ThemeConfig;
     darkMode: DarkMode;
+    watermark: boolean;
 }
 /** Discriminated union of all normalized spec types. */
 type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec;
@@ -303,6 +309,7 @@ interface NormalizedSankeySpec {
     legend?: LegendConfig;
     theme: ThemeConfig;
     darkMode: DarkMode;
+    watermark: boolean;
     animation?: AnimationSpec;
     valueFormat?: string;
     linkOpacity?: number;

package/dist/index.js

@@ -6244,7 +6244,8 @@ function normalizeChartSpec(spec, warnings) {
     theme: spec.theme ?? {},
     darkMode: spec.darkMode ?? "off",
     hiddenSeries: spec.hiddenSeries ?? [],
-    seriesStyles: spec.seriesStyles ?? {}
+    seriesStyles: spec.seriesStyles ?? {},
+    watermark: spec.watermark ?? true
   };
 }
 function normalizeTableSpec(spec, _warnings) {
@@ -6261,7 +6262,8 @@ function normalizeTableSpec(spec, _warnings) {
     stickyFirstColumn: spec.stickyFirstColumn ?? false,
     compact: spec.compact ?? false,
     responsive: spec.responsive ?? true,
-    animation: spec.animation
+    animation: spec.animation,
+    watermark: spec.watermark ?? true
   };
 }
 function normalizeSankeySpec(spec, _warnings) {
@@ -6281,7 +6283,8 @@ function normalizeSankeySpec(spec, _warnings) {
     darkMode: spec.darkMode ?? "off",
     animation: spec.animation,
     valueFormat: spec.valueFormat,
-    linkOpacity: spec.linkOpacity
+    linkOpacity: spec.linkOpacity,
+    watermark: spec.watermark ?? true
   };
 }
 function normalizeGraphSpec(spec, _warnings) {
@@ -6304,7 +6307,8 @@ function normalizeGraphSpec(spec, _warnings) {
     chrome: normalizeChrome(spec.chrome),
     annotations: normalizeAnnotations(spec.annotations),
     theme: spec.theme ?? {},
-    darkMode: spec.darkMode ?? "off"
+    darkMode: spec.darkMode ?? "off",
+    watermark: spec.watermark ?? true
   };
 }
 function normalizeSpec(spec, warnings = []) {
@@ -6331,14 +6335,23 @@ function normalizeSpec(spec, warnings = []) {
     `Unknown spec shape. Expected mark (chart), layer, type: 'table', type: 'graph', or type: 'sankey'.`
   );
 }
-function flattenLayers(spec, parentData, parentEncoding, parentTransforms) {
+function flattenLayers(spec, parentData, parentEncoding, parentTransforms, parentWatermark) {
   const resolvedData = spec.data ?? parentData;
   const resolvedEncoding = parentEncoding && spec.encoding ? { ...parentEncoding, ...spec.encoding } : spec.encoding ?? parentEncoding;
   const resolvedTransforms = [...parentTransforms ?? [], ...spec.transform ?? []];
+  const resolvedWatermark = spec.watermark ?? parentWatermark;
   const leaves = [];
   for (const child of spec.layer) {
     if (isLayerSpec(child)) {
-      leaves.push(...flattenLayers(child, resolvedData, resolvedEncoding, resolvedTransforms));
+      leaves.push(
+        ...flattenLayers(
+          child,
+          resolvedData,
+          resolvedEncoding,
+          resolvedTransforms,
+          resolvedWatermark
+        )
+      );
     } else {
       const mergedData = child.data ?? resolvedData ?? [];
       const mergedEncoding = resolvedEncoding ? { ...resolvedEncoding, ...child.encoding } : child.encoding;
@@ -6347,7 +6360,9 @@ function flattenLayers(spec, parentData, parentEncoding, parentTransforms) {
         ...child,
         data: mergedData,
         encoding: mergedEncoding,
-        transform: mergedTransforms.length > 0 ? mergedTransforms : void 0
+        transform: mergedTransforms.length > 0 ? mergedTransforms : void 0,
+        // Inherit parent watermark if child doesn't explicitly set one
+        ...child.watermark === void 0 && resolvedWatermark !== void 0 ? { watermark: resolvedWatermark } : {}
       });
     }
   }
@@ -7406,6 +7421,8 @@ function compileGraph(spec, options) {
     );
   }
   const graphSpec = normalized;
+  const rawWatermark = spec.watermark;
+  const watermark = rawWatermark !== void 0 ? graphSpec.watermark : options.watermark ?? true;
   const mergedThemeConfig = options.theme ? { ...graphSpec.theme, ...options.theme } : graphSpec.theme;
   let theme = resolveTheme(mergedThemeConfig);
   if (options.darkMode) {
@@ -7473,7 +7490,10 @@ function compileGraph(spec, options) {
     },
     theme,
     options.width,
-    options.measureText
+    options.measureText,
+    "full",
+    void 0,
+    watermark
   );
   return {
     nodes: compiledNodes,
@@ -7487,7 +7507,8 @@ function compileGraph(spec, options) {
       width: options.width,
       height: options.height
     },
-    simulationConfig
+    simulationConfig,
+    watermark
   };
 }
 var DEFAULT_COLLISION_PADDING = 5;
@@ -7786,7 +7807,7 @@ function scalePadding(basePadding, width, height) {
 }
 var MIN_CHART_WIDTH = 60;
 var MIN_CHART_HEIGHT = 40;
-function computeDimensions(spec, options, legendLayout, theme, strategy) {
+function computeDimensions(spec, options, legendLayout, theme, strategy, watermark = true) {
   const { width, height } = options;
   const padding = scalePadding(theme.spacing.padding, width, height);
   const axisMargin = theme.spacing.axisMargin;
@@ -7797,7 +7818,8 @@ function computeDimensions(spec, options, legendLayout, theme, strategy) {
     width,
     options.measureText,
     chromeMode,
-    padding
+    padding,
+    watermark
   );
   const total = { x: 0, y: 0, width, height };
   const isRadial = spec.markType === "arc";
@@ -7955,7 +7977,8 @@ function computeDimensions(spec, options, legendLayout, theme, strategy) {
       width,
       options.measureText,
       fallbackMode,
-      padding
+      padding,
+      watermark
     );
     const fallbackTopAxisGap = isRadial && fallbackChrome.topHeight === 0 ? 0 : axisMargin;
     const newTop = padding + fallbackChrome.topHeight + fallbackTopAxisGap;
@@ -8441,7 +8464,7 @@ function truncateEntries(entries, maxCount) {
   });
   return truncated;
 }
-function computeLegend(spec, strategy, theme, chartArea) {
+function computeLegend(spec, strategy, theme, chartArea, watermark = true) {
   if (spec.legend?.show === false || strategy.legendMaxHeight === 0) {
     return {
       position: "top",
@@ -8518,7 +8541,7 @@ function computeLegend(spec, strategy, theme, chartArea) {
       entryGap: 4
     };
   }
-  const availableWidth = chartArea.width - LEGEND_PADDING * 2 - BRAND_RESERVE_WIDTH;
+  const availableWidth = chartArea.width - LEGEND_PADDING * 2 - (watermark ? BRAND_RESERVE_WIDTH : 0);
   if (spec.legend?.symbolLimit != null) {
     const limit = Math.max(1, spec.legend.symbolLimit);
     if (limit < entries.length) {
@@ -9137,6 +9160,8 @@ function compileSankey(spec, options) {
     );
   }
   const sankeySpec = normalized;
+  const rawWatermark = spec.watermark;
+  const watermark = rawWatermark !== void 0 ? sankeySpec.watermark : options.watermark ?? true;
   const mergedThemeConfig = options.theme ? { ...sankeySpec.theme, ...options.theme } : sankeySpec.theme;
   const lightTheme = resolveTheme2(mergedThemeConfig);
   let theme = lightTheme;
@@ -9157,7 +9182,10 @@ function compileSankey(spec, options) {
     },
     theme,
     options.width,
-    options.measureText
+    options.measureText,
+    "full",
+    void 0,
+    watermark
   );
   const padding = theme.spacing.padding;
   const fullArea = {
@@ -9167,7 +9195,7 @@ function compileSankey(spec, options) {
     height: options.height - chrome.topHeight - chrome.bottomHeight - padding * 2
   };
   if (fullArea.width <= 0 || fullArea.height <= 0) {
-    return emptyLayout(fullArea, chrome, theme, options);
+    return emptyLayout(fullArea, chrome, theme, options, watermark);
   }
   const sourceField = sankeySpec.encoding.source.field;
   const targetField = sankeySpec.encoding.target.field;
@@ -9203,7 +9231,7 @@ function compileSankey(spec, options) {
     height: fullArea.height - legend.bounds.height - legendGap
   };
   if (area.height <= 0) {
-    return emptyLayout(area, chrome, theme, options);
+    return emptyLayout(area, chrome, theme, options, watermark);
   }
   const labelFontSize = theme.fonts.sizes.small;
   const labelFontWeight = theme.fonts.weights.normal;
@@ -9347,7 +9375,8 @@ function compileSankey(spec, options) {
       width: options.width,
       height: options.height
     },
-    animation: resolvedAnimation
+    animation: resolvedAnimation,
+    watermark
   };
 }
 function buildSankeyLegend(nodeColorMap, colorField, data, sourceField, targetField, theme, area) {
@@ -9454,7 +9483,7 @@ function buildTooltipDescriptors(nodes, links, valueFormat) {
   }
   return descriptors;
 }
-function emptyLayout(area, chrome, theme, options) {
+function emptyLayout(area, chrome, theme, options, watermark) {
   return {
     area,
     chrome,
@@ -9486,7 +9515,8 @@ function emptyLayout(area, chrome, theme, options) {
     dimensions: {
       width: options.width,
       height: options.height
-    }
+    },
+    watermark
   };
 }
 
@@ -10086,6 +10116,7 @@ function compileTableLayout(spec, options, theme) {
     });
     return { id: rowId, cells, data: row };
   });
+  const watermark = spec.watermark;
   const chrome = computeChrome4(
     {
       title: spec.chrome.title,
@@ -10096,7 +10127,10 @@ function compileTableLayout(spec, options, theme) {
     },
     theme,
     options.width,
-    options.measureText
+    options.measureText,
+    "full",
+    void 0,
+    watermark
   );
   const titleText = spec.chrome.title?.text ?? "";
   const caption = titleText ? `Table: ${titleText}` : `Data table with ${data.length} rows`;
@@ -10118,7 +10152,8 @@ function compileTableLayout(spec, options, theme) {
       summary: `${resolvedColumns.length} columns, ${totalFiltered} rows`
     },
     theme,
-    animation: resolveAnimation(spec.animation)
+    animation: resolveAnimation(spec.animation),
+    watermark
   };
 }
 
@@ -10564,6 +10599,8 @@ function compileChart(spec, options) {
     throw new Error("compileChart received a sankey spec. Use compileSankey instead.");
   }
   let chartSpec = normalized;
+  const rawWatermark = spec.watermark;
+  const watermark = rawWatermark !== void 0 ? chartSpec.watermark : options.watermark ?? true;
   const rawTransforms = spec.transform;
   if (rawTransforms && rawTransforms.length > 0) {
     chartSpec = { ...chartSpec, data: runTransforms(chartSpec.data, rawTransforms) };
@@ -10622,8 +10659,8 @@ function compileChart(spec, options) {
     width: options.width,
     height: options.height
   };
-  const legendLayout = computeLegend(chartSpec, strategy, theme, preliminaryArea);
-  const dims = computeDimensions(chartSpec, options, legendLayout, theme, strategy);
+  const legendLayout = computeLegend(chartSpec, strategy, theme, preliminaryArea, watermark);
+  const dims = computeDimensions(chartSpec, options, legendLayout, theme, strategy, watermark);
   const chartArea = dims.chartArea;
   const legendArea = { ...chartArea };
   if (legendLayout.entries.length > 0) {
@@ -10641,7 +10678,7 @@ function compileChart(spec, options) {
         break;
     }
   }
-  const finalLegend = computeLegend(chartSpec, strategy, theme, legendArea);
+  const finalLegend = computeLegend(chartSpec, strategy, theme, legendArea, watermark);
   let renderData = chartSpec.data;
   if (chartSpec.hiddenSeries.length > 0 && chartSpec.encoding.color && "field" in chartSpec.encoding.color) {
     const colorField = chartSpec.encoding.color.field;
@@ -10708,12 +10745,14 @@ function compileChart(spec, options) {
       obstacles.push(computeLabelBounds(mark.label));
     }
   }
-  const brandPadding = theme.spacing.padding;
-  const brandX = dims.total.width - brandPadding - BRAND_RESERVE_WIDTH2;
-  const xAxisExtent = axes.x?.label ? 48 : axes.x ? 26 : 0;
-  const firstBottomChrome = dims.chrome.source ?? dims.chrome.byline ?? dims.chrome.footer;
-  const brandY = firstBottomChrome ? chartArea.y + chartArea.height + xAxisExtent + firstBottomChrome.y : chartArea.y + chartArea.height + xAxisExtent + theme.spacing.chartToFooter;
-  obstacles.push({ x: brandX, y: brandY, width: BRAND_RESERVE_WIDTH2, height: 30 });
+  if (watermark) {
+    const brandPadding = theme.spacing.padding;
+    const brandX = dims.total.width - brandPadding - BRAND_RESERVE_WIDTH2;
+    const xAxisExtent = axes.x?.label ? 48 : axes.x ? 26 : 0;
+    const firstBottomChrome = dims.chrome.source ?? dims.chrome.byline ?? dims.chrome.footer;
+    const brandY = firstBottomChrome ? chartArea.y + chartArea.height + xAxisExtent + firstBottomChrome.y : chartArea.y + chartArea.height + xAxisExtent + theme.spacing.chartToFooter;
+    obstacles.push({ x: brandX, y: brandY, width: BRAND_RESERVE_WIDTH2, height: 30 });
+  }
   const annotations = computeAnnotations(
     chartSpec,
     scales,
@@ -10794,7 +10833,8 @@ function compileChart(spec, options) {
       width: options.width,
       height: options.height
     },
-    animation: resolvedAnimation
+    animation: resolvedAnimation,
+    watermark
   };
 }
 function getMarkPrimaryValue(mark) {
@@ -10864,6 +10904,7 @@ function buildPrimarySpec(leaves, layerSpec) {
     responsive: layerSpec.responsive ?? leaves[0].responsive,
     theme: layerSpec.theme ?? leaves[0].theme,
     darkMode: layerSpec.darkMode ?? leaves[0].darkMode,
+    watermark: layerSpec.watermark ?? leaves[0].watermark,
     hiddenSeries: layerSpec.hiddenSeries ?? leaves[0].hiddenSeries
   };
   return primary;
@@ -10880,7 +10921,9 @@ function compileTable(spec, options) {
   if (options.darkMode) {
     theme = adaptTheme3(theme);
   }
-  return compileTableLayout(tableSpec, options, theme);
+  const rawWatermark = spec.watermark;
+  const watermark = rawWatermark !== void 0 ? tableSpec.watermark : options.watermark ?? true;
+  return compileTableLayout({ ...tableSpec, watermark }, options, theme);
 }
 function compileGraph2(spec, options) {
   return compileGraph(spec, options);