@liiift-studio/sanity-visitor-insights 0.21.0 → 0.23.0

package/dist/index.d.mts

@@ -52,6 +52,7 @@ type ReportState<T> = {
     status: 'ready';
     envelope: ReportEnvelope<T>;
     stale?: boolean;
+    revalidationError?: string;
 } | {
     status: 'error';
     message: string;
@@ -159,8 +160,15 @@ interface ComparisonBarProps {
     metric: MetricValue;
     /** Largest value across the sibling bars, used to scale width. */
     max: number;
-    /** Tone conveys category, but never carries meaning on its own. */
-    tone?: 'primary' | 'positive' | 'caution' | 'default';
+    /**
+     * What full width means, named.
+     *
+     * A ComparisonBar scales to the largest sibling, so a full bar means only "biggest of these" —
+     * and unlike the other two bar idioms, which print their share and their total, this one said
+     * nothing at all. There was a `tone` prop instead, which both call sites passed different
+     * values to and which the component destructured and never used.
+     */
+    outOf?: string;
 }
 /**
  * A horizontal bar with its value printed alongside.
@@ -169,7 +177,7 @@ interface ComparisonBarProps {
  * values, which a labelled bar does as well as a chart while avoiding a large dependency in the
  * Studio bundle and the theme-token bridging that a chart library would need for light and dark.
  */
-declare function ComparisonBar({ label, metric, max, tone }: ComparisonBarProps): React.ReactElement;
+declare function ComparisonBar({ label, metric, max, outOf }: ComparisonBarProps): React.ReactElement;
 /** Props for ChartData. */
 interface ChartDataProps<Row> {
     /** What the disclosure is called. Names the chart it belongs to. */
@@ -327,6 +335,8 @@ interface SortableTableProps<Row> {
     exportName?: string;
     /** Shown under the table when the server truncated the row set. */
     truncatedNote?: string;
+    /** Allow per-row exclusion even without a filter box. */
+    onExclude?: boolean;
 }
 /**
  * A table whose columns sort.
@@ -340,7 +350,7 @@ interface SortableTableProps<Row> {
  * unavailable metric is not a zero, and letting it lead an ascending sort would restate exactly the
  * confusion the MetricValue type exists to prevent.
  */
-declare function SortableTable<Row>({ caption, columns, rows, rowKey, initialSort, filterPlaceholder, filterOn, exportName, truncatedNote, }: SortableTableProps<Row>): React.ReactElement;
+declare function SortableTable<Row>({ caption, columns, rows, rowKey, initialSort, filterPlaceholder, filterOn, exportName, truncatedNote, onExclude, }: SortableTableProps<Row>): React.ReactElement;
 
 /**
  * One time axis, every source stacked against it.
@@ -389,6 +399,16 @@ interface Series {
     /** Whether the line's source sees everything. Drives the stroke and the wording. */
     complete: boolean;
     unit: SeriesUnit;
+    /**
+     * How the row is drawn. Defaults to `line`.
+     *
+     * `events` is for a quantity that only exists on the days it happened — orders, revenue. Darden
+     * does seven orders a quarter, and a monotone curve through those seven points drew a smooth
+     * rise and fall across eighty-three days on which nothing occurred, with the curve's overshoot
+     * putting non-zero revenue on days that had none. A stem per day says what a sale is: a discrete
+     * event, on a date, of a size. Days with nothing draw nothing, which is the truth.
+     */
+    mark?: 'line' | 'events';
     points: SeriesPoint[];
     /**
      * What a lossier source saw of the same thing.
@@ -437,7 +457,7 @@ interface CrossSourceTimelineProps {
 declare function CrossSourceTimeline({ series, markers, currency, onBrush }: CrossSourceTimelineProps): React.ReactElement | null;
 
 /**
- * The four report panels.
+ * The report panels.
  *
  * Every panel renders a table or labelled bars rather than a chart, and every one surfaces its own
  * caveats inline. Tables are the accessible representation as well as the visual one, so there is
@@ -451,11 +471,6 @@ declare function CrossSourceTimeline({ series, markers, currency, onBrush }: Cro
  * undefined". A panel must degrade to showing less, never to a stack trace.
  */
 
-/**
- * Measurement Health — how much of reality each source sees.
- * Compares pageviews to pageviews. Sessions and orders sit alongside as context and are never
- * subtracted from a pageview count.
- */
 /**
  * Overview — the five-minute read.
  *
@@ -547,4 +562,4 @@ interface VisitorInsightsPluginOptions {
  */
 declare const visitorInsights: sanity.Plugin<VisitorInsightsPluginOptions>;
 
-export { AcquisitionData, AcquisitionPanel, ChartData, type ChartDataProps, ComparisonBar, CrossSourceTimeline, type CrossSourceTimelineProps, DataHealthPanel, Delta, type DeltaProps, DiagnosticReport, DiagnosticsPanel, FunnelChart, JourneyData, JourneyPanel, MeasurementHealthData, MetricFigure, MetricValue, NoticeList, OverviewPanel, type ProportionBar, ProportionChart, type ProportionChartProps, RangeKey, ReportEnvelope, ReportName, type ReportState, type Series, type SeriesPoint, type SortColumn, SortableTable, type SortableTableProps, type TimelineMarker, TrendChart, TypefaceInterestData, TypefaceInterestPanel, type UseReportOptions, type VisitorInsightsPluginOptions, VisitorInsightsTool, type VisitorInsightsToolProps, visitorInsights as default, formatCount, formatMoney, formatPercent, useReport, visitorInsights };
+export { AcquisitionData, AcquisitionPanel, ChartData, type ChartDataProps, ComparisonBar, CrossSourceTimeline, type CrossSourceTimelineProps, DataHealthPanel, Delta, type DeltaProps, DiagnosticReport, DiagnosticsPanel, FunnelChart, JourneyData, JourneyPanel, MeasurementHealthData, DataHealthPanel as MeasurementHealthPanel, MetricFigure, MetricValue, NoticeList, OverviewPanel, type ProportionBar, ProportionChart, type ProportionChartProps, RangeKey, ReportEnvelope, ReportName, type ReportState, type Series, type SeriesPoint, type SortColumn, SortableTable, type SortableTableProps, type TimelineMarker, TrendChart, TypefaceInterestData, TypefaceInterestPanel, type UseReportOptions, type VisitorInsightsPluginOptions, VisitorInsightsTool, type VisitorInsightsToolProps, visitorInsights as default, formatCount, formatMoney, formatPercent, useReport, visitorInsights };

package/dist/index.d.ts

@@ -52,6 +52,7 @@ type ReportState<T> = {
     status: 'ready';
     envelope: ReportEnvelope<T>;
     stale?: boolean;
+    revalidationError?: string;
 } | {
     status: 'error';
     message: string;
@@ -159,8 +160,15 @@ interface ComparisonBarProps {
     metric: MetricValue;
     /** Largest value across the sibling bars, used to scale width. */
     max: number;
-    /** Tone conveys category, but never carries meaning on its own. */
-    tone?: 'primary' | 'positive' | 'caution' | 'default';
+    /**
+     * What full width means, named.
+     *
+     * A ComparisonBar scales to the largest sibling, so a full bar means only "biggest of these" —
+     * and unlike the other two bar idioms, which print their share and their total, this one said
+     * nothing at all. There was a `tone` prop instead, which both call sites passed different
+     * values to and which the component destructured and never used.
+     */
+    outOf?: string;
 }
 /**
  * A horizontal bar with its value printed alongside.
@@ -169,7 +177,7 @@ interface ComparisonBarProps {
  * values, which a labelled bar does as well as a chart while avoiding a large dependency in the
  * Studio bundle and the theme-token bridging that a chart library would need for light and dark.
  */
-declare function ComparisonBar({ label, metric, max, tone }: ComparisonBarProps): React.ReactElement;
+declare function ComparisonBar({ label, metric, max, outOf }: ComparisonBarProps): React.ReactElement;
 /** Props for ChartData. */
 interface ChartDataProps<Row> {
     /** What the disclosure is called. Names the chart it belongs to. */
@@ -327,6 +335,8 @@ interface SortableTableProps<Row> {
     exportName?: string;
     /** Shown under the table when the server truncated the row set. */
     truncatedNote?: string;
+    /** Allow per-row exclusion even without a filter box. */
+    onExclude?: boolean;
 }
 /**
  * A table whose columns sort.
@@ -340,7 +350,7 @@ interface SortableTableProps<Row> {
  * unavailable metric is not a zero, and letting it lead an ascending sort would restate exactly the
  * confusion the MetricValue type exists to prevent.
  */
-declare function SortableTable<Row>({ caption, columns, rows, rowKey, initialSort, filterPlaceholder, filterOn, exportName, truncatedNote, }: SortableTableProps<Row>): React.ReactElement;
+declare function SortableTable<Row>({ caption, columns, rows, rowKey, initialSort, filterPlaceholder, filterOn, exportName, truncatedNote, onExclude, }: SortableTableProps<Row>): React.ReactElement;
 
 /**
  * One time axis, every source stacked against it.
@@ -389,6 +399,16 @@ interface Series {
     /** Whether the line's source sees everything. Drives the stroke and the wording. */
     complete: boolean;
     unit: SeriesUnit;
+    /**
+     * How the row is drawn. Defaults to `line`.
+     *
+     * `events` is for a quantity that only exists on the days it happened — orders, revenue. Darden
+     * does seven orders a quarter, and a monotone curve through those seven points drew a smooth
+     * rise and fall across eighty-three days on which nothing occurred, with the curve's overshoot
+     * putting non-zero revenue on days that had none. A stem per day says what a sale is: a discrete
+     * event, on a date, of a size. Days with nothing draw nothing, which is the truth.
+     */
+    mark?: 'line' | 'events';
     points: SeriesPoint[];
     /**
      * What a lossier source saw of the same thing.
@@ -437,7 +457,7 @@ interface CrossSourceTimelineProps {
 declare function CrossSourceTimeline({ series, markers, currency, onBrush }: CrossSourceTimelineProps): React.ReactElement | null;
 
 /**
- * The four report panels.
+ * The report panels.
  *
  * Every panel renders a table or labelled bars rather than a chart, and every one surfaces its own
  * caveats inline. Tables are the accessible representation as well as the visual one, so there is
@@ -451,11 +471,6 @@ declare function CrossSourceTimeline({ series, markers, currency, onBrush }: Cro
  * undefined". A panel must degrade to showing less, never to a stack trace.
  */
 
-/**
- * Measurement Health — how much of reality each source sees.
- * Compares pageviews to pageviews. Sessions and orders sit alongside as context and are never
- * subtracted from a pageview count.
- */
 /**
  * Overview — the five-minute read.
  *
@@ -547,4 +562,4 @@ interface VisitorInsightsPluginOptions {
  */
 declare const visitorInsights: sanity.Plugin<VisitorInsightsPluginOptions>;
 
-export { AcquisitionData, AcquisitionPanel, ChartData, type ChartDataProps, ComparisonBar, CrossSourceTimeline, type CrossSourceTimelineProps, DataHealthPanel, Delta, type DeltaProps, DiagnosticReport, DiagnosticsPanel, FunnelChart, JourneyData, JourneyPanel, MeasurementHealthData, MetricFigure, MetricValue, NoticeList, OverviewPanel, type ProportionBar, ProportionChart, type ProportionChartProps, RangeKey, ReportEnvelope, ReportName, type ReportState, type Series, type SeriesPoint, type SortColumn, SortableTable, type SortableTableProps, type TimelineMarker, TrendChart, TypefaceInterestData, TypefaceInterestPanel, type UseReportOptions, type VisitorInsightsPluginOptions, VisitorInsightsTool, type VisitorInsightsToolProps, visitorInsights as default, formatCount, formatMoney, formatPercent, useReport, visitorInsights };
+export { AcquisitionData, AcquisitionPanel, ChartData, type ChartDataProps, ComparisonBar, CrossSourceTimeline, type CrossSourceTimelineProps, DataHealthPanel, Delta, type DeltaProps, DiagnosticReport, DiagnosticsPanel, FunnelChart, JourneyData, JourneyPanel, MeasurementHealthData, DataHealthPanel as MeasurementHealthPanel, MetricFigure, MetricValue, NoticeList, OverviewPanel, type ProportionBar, ProportionChart, type ProportionChartProps, RangeKey, ReportEnvelope, ReportName, type ReportState, type Series, type SeriesPoint, type SortColumn, SortableTable, type SortableTableProps, type TimelineMarker, TrendChart, TypefaceInterestData, TypefaceInterestPanel, type UseReportOptions, type VisitorInsightsPluginOptions, VisitorInsightsTool, type VisitorInsightsToolProps, visitorInsights as default, formatCount, formatMoney, formatPercent, useReport, visitorInsights };