@liiift-studio/sanity-visitor-insights 0.9.0 → 0.11.0

package/dist/index.d.mts

@@ -1,7 +1,7 @@
 import * as sanity from 'sanity';
 import React from 'react';
-import { R as ReportEnvelope, a as ReportName, b as RangeKey, M as MetricValue, A as AcquisitionData, D as DiagnosticReport, J as JourneyData, c as MeasurementHealthData, T as TypefaceInterestData } from './ranges-B1YwjGGt.mjs';
-export { C as Coverage, d as DateRange, E as EventCutover, P as PREEXISTING, e as REPORT_NAMES, f as ReportError, S as SiteAnalyticsConfig, g as SourceName, h as SourceStatus, U as UnavailableReason, i as coverageForRange, j as isReportName, o as ok, p as partial, k as previousRange, r as resolveRange, u as unavailable, v as validateSiteConfig, l as valueOrNull } from './ranges-B1YwjGGt.mjs';
+import { R as ReportEnvelope, a as ReportName, b as RangeKey, M as MetricValue, A as AcquisitionData, D as DiagnosticReport, J as JourneyData, c as MeasurementHealthData, T as TypefaceInterestData } from './ranges-YGStz1nR.mjs';
+export { C as Coverage, d as DateRange, E as EventCutover, P as PREEXISTING, e as REPORT_NAMES, f as ReportError, S as SiteAnalyticsConfig, g as SourceName, h as SourceStatus, U as UnavailableReason, i as coverageForRange, j as isReportName, o as ok, p as partial, k as previousRange, r as resolveRange, u as unavailable, v as validateSiteConfig, l as valueOrNull } from './ranges-YGStz1nR.mjs';
 
 /**
  * The Visitor Insights Studio tool.
@@ -57,6 +57,11 @@ type ReportState<T> = {
 };
 /** Options for useReport. */
 interface UseReportOptions {
+    /** Explicit dates, required when `range` is 'custom' and ignored otherwise. */
+    custom?: {
+        start: string;
+        end: string;
+    };
     /** Base URL of the site serving the reports, e.g. `https://dardenstudio.com`. */
     apiBaseUrl: string;
     report: ReportName;
@@ -67,7 +72,7 @@ interface UseReportOptions {
  *
  * @returns the current state plus a `reload` for manual refresh
  */
-declare function useReport<T>({ apiBaseUrl, report, range }: UseReportOptions): {
+declare function useReport<T>({ apiBaseUrl, report, range, custom }: UseReportOptions): {
     state: ReportState<T>;
     reload: () => void;
 };
@@ -165,7 +170,7 @@ declare function MeasurementHealthPanel({ data }: {
 declare function AcquisitionPanel({ data }: {
     data: AcquisitionData;
 }): React.ReactElement;
-/** Journey — per-step totals with adjacent drop-off, explicitly not a tracked path. */
+/** Journey — a funnel, drawn as a tracked sequence or as independent totals, whichever the report used. */
 declare function JourneyPanel({ data }: {
     data: JourneyData;
 }): React.ReactElement;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as sanity from 'sanity';
 import React from 'react';
-import { R as ReportEnvelope, a as ReportName, b as RangeKey, M as MetricValue, A as AcquisitionData, D as DiagnosticReport, J as JourneyData, c as MeasurementHealthData, T as TypefaceInterestData } from './ranges-B1YwjGGt.js';
-export { C as Coverage, d as DateRange, E as EventCutover, P as PREEXISTING, e as REPORT_NAMES, f as ReportError, S as SiteAnalyticsConfig, g as SourceName, h as SourceStatus, U as UnavailableReason, i as coverageForRange, j as isReportName, o as ok, p as partial, k as previousRange, r as resolveRange, u as unavailable, v as validateSiteConfig, l as valueOrNull } from './ranges-B1YwjGGt.js';
+import { R as ReportEnvelope, a as ReportName, b as RangeKey, M as MetricValue, A as AcquisitionData, D as DiagnosticReport, J as JourneyData, c as MeasurementHealthData, T as TypefaceInterestData } from './ranges-YGStz1nR.js';
+export { C as Coverage, d as DateRange, E as EventCutover, P as PREEXISTING, e as REPORT_NAMES, f as ReportError, S as SiteAnalyticsConfig, g as SourceName, h as SourceStatus, U as UnavailableReason, i as coverageForRange, j as isReportName, o as ok, p as partial, k as previousRange, r as resolveRange, u as unavailable, v as validateSiteConfig, l as valueOrNull } from './ranges-YGStz1nR.js';
 
 /**
  * The Visitor Insights Studio tool.
@@ -57,6 +57,11 @@ type ReportState<T> = {
 };
 /** Options for useReport. */
 interface UseReportOptions {
+    /** Explicit dates, required when `range` is 'custom' and ignored otherwise. */
+    custom?: {
+        start: string;
+        end: string;
+    };
     /** Base URL of the site serving the reports, e.g. `https://dardenstudio.com`. */
     apiBaseUrl: string;
     report: ReportName;
@@ -67,7 +72,7 @@ interface UseReportOptions {
  *
  * @returns the current state plus a `reload` for manual refresh
  */
-declare function useReport<T>({ apiBaseUrl, report, range }: UseReportOptions): {
+declare function useReport<T>({ apiBaseUrl, report, range, custom }: UseReportOptions): {
     state: ReportState<T>;
     reload: () => void;
 };
@@ -165,7 +170,7 @@ declare function MeasurementHealthPanel({ data }: {
 declare function AcquisitionPanel({ data }: {
     data: AcquisitionData;
 }): React.ReactElement;
-/** Journey — per-step totals with adjacent drop-off, explicitly not a tracked path. */
+/** Journey — a funnel, drawn as a tracked sequence or as independent totals, whichever the report used. */
 declare function JourneyPanel({ data }: {
     data: JourneyData;
 }): React.ReactElement;