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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -32,7 +32,6 @@ interface VisitorInsightsToolComponentProps extends Partial<VisitorInsightsToolP
32
32
  options?: Partial<VisitorInsightsToolProps>;
33
33
  };
34
34
  }
35
- /** The tool itself. */
36
35
  declare function VisitorInsightsTool(props: VisitorInsightsToolComponentProps): React.ReactElement;
37
36
 
38
37
  /**
@@ -43,6 +42,20 @@ declare function VisitorInsightsTool(props: VisitorInsightsToolComponentProps):
43
42
  * extractable.
44
43
  */
45
44
 
45
+ /**
46
+ * What is known about GA4's coverage of this site and window, or null when nothing is.
47
+ *
48
+ * Null is a real answer and must render as nothing: a panel that cannot say how lossy its source is
49
+ * should not imply the source is fine.
50
+ *
51
+ * @param base - the site's API base URL, as passed to the tool
52
+ * @param range - the range name currently selected
53
+ * @param custom - the custom bounds, when the range is custom
54
+ */
55
+ declare function knownShortfall(base: string, range: string, custom?: {
56
+ start: string;
57
+ end: string;
58
+ }): number | null;
46
59
  /** Loading state for a report. */
47
60
  type ReportState<T> = {
48
61
  status: 'idle';
@@ -562,4 +575,4 @@ interface VisitorInsightsPluginOptions {
562
575
  */
563
576
  declare const visitorInsights: sanity.Plugin<VisitorInsightsPluginOptions>;
564
577
 
565
- 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 };
578
+ 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, knownShortfall, useReport, visitorInsights };
package/dist/index.d.ts CHANGED
@@ -32,7 +32,6 @@ interface VisitorInsightsToolComponentProps extends Partial<VisitorInsightsToolP
32
32
  options?: Partial<VisitorInsightsToolProps>;
33
33
  };
34
34
  }
35
- /** The tool itself. */
36
35
  declare function VisitorInsightsTool(props: VisitorInsightsToolComponentProps): React.ReactElement;
37
36
 
38
37
  /**
@@ -43,6 +42,20 @@ declare function VisitorInsightsTool(props: VisitorInsightsToolComponentProps):
43
42
  * extractable.
44
43
  */
45
44
 
45
+ /**
46
+ * What is known about GA4's coverage of this site and window, or null when nothing is.
47
+ *
48
+ * Null is a real answer and must render as nothing: a panel that cannot say how lossy its source is
49
+ * should not imply the source is fine.
50
+ *
51
+ * @param base - the site's API base URL, as passed to the tool
52
+ * @param range - the range name currently selected
53
+ * @param custom - the custom bounds, when the range is custom
54
+ */
55
+ declare function knownShortfall(base: string, range: string, custom?: {
56
+ start: string;
57
+ end: string;
58
+ }): number | null;
46
59
  /** Loading state for a report. */
47
60
  type ReportState<T> = {
48
61
  status: 'idle';
@@ -562,4 +575,4 @@ interface VisitorInsightsPluginOptions {
562
575
  */
563
576
  declare const visitorInsights: sanity.Plugin<VisitorInsightsPluginOptions>;
564
577
 
565
- 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 };
578
+ 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, knownShortfall, useReport, visitorInsights };