@10x-media/analytics 1.0.0-beta.7 → 1.0.0-beta.8
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/CHANGELOG.md +48 -0
- package/README.md +8 -2
- package/dist/adapters/ga4/ga4.js +3 -2
- package/dist/adapters/ga4/ga4.js.map +1 -1
- package/dist/adapters/plausible/plausible.js +2 -1
- package/dist/adapters/plausible/plausible.js.map +1 -1
- package/dist/capture/slots.js +16 -5
- package/dist/capture/slots.js.map +1 -1
- package/dist/capture/trackerConfig.d.ts +1 -0
- package/dist/capture/trackerConfig.js +28 -3
- package/dist/capture/trackerConfig.js.map +1 -1
- package/dist/charts/BarList.d.ts +15 -1
- package/dist/charts/BarList.js +34 -18
- package/dist/charts/BarList.js.map +1 -1
- package/dist/charts/TrendChart.d.ts +16 -3
- package/dist/charts/TrendChart.js +172 -106
- package/dist/charts/TrendChart.js.map +1 -1
- package/dist/charts/bars.d.ts +2 -0
- package/dist/charts/bars.js +2 -1
- package/dist/charts/bars.js.map +1 -1
- package/dist/charts/bucket.js +10 -1
- package/dist/charts/bucket.js.map +1 -1
- package/dist/charts/spline.js +2 -2
- package/dist/charts/spline.js.map +1 -1
- package/dist/charts/styles.js +18 -1
- package/dist/charts/styles.js.map +1 -1
- package/dist/core/cacheKey.js +13 -1
- package/dist/core/cacheKey.js.map +1 -1
- package/dist/core/contract.d.ts +14 -7
- package/dist/core/contract.js +29 -1
- package/dist/core/contract.js.map +1 -1
- package/dist/core/granularity.js +1 -1
- package/dist/core/options.d.ts +54 -5
- package/dist/core/options.js +59 -2
- package/dist/core/options.js.map +1 -1
- package/dist/core/scopedRead.js +33 -23
- package/dist/core/scopedRead.js.map +1 -1
- package/dist/core/serverEvent.d.ts +42 -0
- package/dist/core/serverEvent.js +12 -0
- package/dist/core/serverEvent.js.map +1 -0
- package/dist/exports/client.d.ts +8 -2
- package/dist/exports/client.js +6 -1
- package/dist/exports/rsc.d.ts +5 -1
- package/dist/exports/rsc.js +6 -3
- package/dist/exports/types.d.ts +12 -4
- package/dist/exports/types.js +2 -2
- package/dist/fields/AnalyticsPanelClient.js +1 -1
- package/dist/fields/AnalyticsPanelField.js +1 -1
- package/dist/fields/AnalyticsStatField.js +2 -2
- package/dist/fields/config/MetricSelectField.js +2 -2
- package/dist/fields/config/MetricSelectField.js.map +1 -1
- package/dist/fields/config/SourceSelectField.js +2 -2
- package/dist/fields/config/SourceSelectField.js.map +1 -1
- package/dist/fields/config/fetchSources.d.ts +5 -1
- package/dist/fields/readForDocument.d.ts +5 -0
- package/dist/fields/readForDocument.js +5 -5
- package/dist/fields/readForDocument.js.map +1 -1
- package/dist/goals/GoalSelectField.d.ts +7 -0
- package/dist/goals/GoalSelectField.js +77 -0
- package/dist/goals/GoalSelectField.js.map +1 -0
- package/dist/goals/collection.js +250 -0
- package/dist/goals/collection.js.map +1 -0
- package/dist/goals/currency.js +14 -0
- package/dist/goals/currency.js.map +1 -0
- package/dist/goals/fetchGoals.d.ts +18 -0
- package/dist/goals/fetchGoals.js +29 -0
- package/dist/goals/fetchGoals.js.map +1 -0
- package/dist/goals/goalField.d.ts +31 -0
- package/dist/goals/goalField.js +56 -0
- package/dist/goals/goalField.js.map +1 -0
- package/dist/goals/goalsEndpoint.d.ts +1 -0
- package/dist/goals/goalsEndpoint.js +55 -0
- package/dist/goals/goalsEndpoint.js.map +1 -0
- package/dist/goals/resolver.d.ts +8 -0
- package/dist/goals/resolver.js +147 -0
- package/dist/goals/resolver.js.map +1 -0
- package/dist/goals/trackGoalAction.d.ts +74 -0
- package/dist/goals/trackGoalAction.js +139 -0
- package/dist/goals/trackGoalAction.js.map +1 -0
- package/dist/goals/useAnalyticsGoals.d.ts +20 -0
- package/dist/goals/useAnalyticsGoals.js +67 -0
- package/dist/goals/useAnalyticsGoals.js.map +1 -0
- package/dist/index.d.ts +10 -3
- package/dist/index.js +74 -11
- package/dist/index.js.map +1 -1
- package/dist/native/ingest/device.js +11 -3
- package/dist/native/ingest/device.js.map +1 -1
- package/dist/native/ingest/endpoint.d.ts +1 -0
- package/dist/native/ingest/endpoint.js +2 -17
- package/dist/native/ingest/endpoint.js.map +1 -1
- package/dist/native/ingest/normalizeEvent.d.ts +20 -0
- package/dist/native/ingest/normalizeEvent.js +3 -2
- package/dist/native/ingest/normalizeEvent.js.map +1 -1
- package/dist/native/ingest/serverTrack.d.ts +20 -0
- package/dist/native/ingest/serverTrack.js +99 -0
- package/dist/native/ingest/serverTrack.js.map +1 -0
- package/dist/native/ingest/validate.js +27 -0
- package/dist/native/ingest/validate.js.map +1 -0
- package/dist/native/nativeAdapter.d.ts +1 -1
- package/dist/native/nativeAdapter.js +21 -10
- package/dist/native/nativeAdapter.js.map +1 -1
- package/dist/native/retention/pruneTask.js +1 -1
- package/dist/native/rollups/insertIfNew.js +36 -2
- package/dist/native/rollups/insertIfNew.js.map +1 -1
- package/dist/plugin/documentEndpoint.js +27 -9
- package/dist/plugin/documentEndpoint.js.map +1 -1
- package/dist/plugin/paths.js +5 -1
- package/dist/plugin/paths.js.map +1 -1
- package/dist/plugin/queryEndpoint.js +113 -0
- package/dist/plugin/queryEndpoint.js.map +1 -0
- package/dist/plugin/readContextForRequest.js +71 -0
- package/dist/plugin/readContextForRequest.js.map +1 -0
- package/dist/plugin/realtimeEndpoint.js +6 -3
- package/dist/plugin/realtimeEndpoint.js.map +1 -1
- package/dist/plugin/runtime.js +31 -1
- package/dist/plugin/runtime.js.map +1 -1
- package/dist/plugin/scopeFieldBoot.js +22 -0
- package/dist/plugin/scopeFieldBoot.js.map +1 -0
- package/dist/plugin/sourcesEndpoint.js +13 -51
- package/dist/plugin/sourcesEndpoint.js.map +1 -1
- package/dist/plugin/warmTask.js +0 -0
- package/dist/plugin/warmTask.js.map +1 -1
- package/dist/providers/collection.js +15 -9
- package/dist/providers/collection.js.map +1 -1
- package/dist/providers/resolver.js.map +1 -1
- package/dist/query/dates.js +64 -0
- package/dist/query/dates.js.map +1 -0
- package/dist/query/errors.d.ts +17 -0
- package/dist/query/errors.js +10 -0
- package/dist/query/errors.js.map +1 -0
- package/dist/query/fetchQuery.d.ts +59 -0
- package/dist/query/fetchQuery.js +110 -0
- package/dist/query/fetchQuery.js.map +1 -0
- package/dist/query/parse.d.ts +22 -0
- package/dist/query/parse.js +168 -0
- package/dist/query/parse.js.map +1 -0
- package/dist/query/response.d.ts +36 -0
- package/dist/timeframe/tz.js +17 -6
- package/dist/timeframe/tz.js.map +1 -1
- package/dist/translations/ar.js +98 -1
- package/dist/translations/ar.js.map +1 -1
- package/dist/translations/de.js +98 -1
- package/dist/translations/de.js.map +1 -1
- package/dist/translations/en.js +98 -1
- package/dist/translations/en.js.map +1 -1
- package/dist/translations/es.js +98 -1
- package/dist/translations/es.js.map +1 -1
- package/dist/translations/fr.js +98 -1
- package/dist/translations/fr.js.map +1 -1
- package/dist/translations/id.js +98 -1
- package/dist/translations/id.js.map +1 -1
- package/dist/translations/keys.d.ts +97 -0
- package/dist/translations/keys.js +98 -1
- package/dist/translations/keys.js.map +1 -1
- package/dist/translations/ko.js +98 -1
- package/dist/translations/ko.js.map +1 -1
- package/dist/translations/metricKeys.js +1 -1
- package/dist/translations/metricKeys.js.map +1 -1
- package/dist/translations/pt.js +98 -1
- package/dist/translations/pt.js.map +1 -1
- package/dist/translations/ru.js +98 -1
- package/dist/translations/ru.js.map +1 -1
- package/dist/translations/uk.js +98 -1
- package/dist/translations/uk.js.map +1 -1
- package/dist/translations/zh.js +98 -1
- package/dist/translations/zh.js.map +1 -1
- package/dist/view/AnalyticsNavLink.d.ts +19 -0
- package/dist/view/AnalyticsNavLink.js +40 -0
- package/dist/view/AnalyticsNavLink.js.map +1 -0
- package/dist/view/AnalyticsView.d.ts +23 -0
- package/dist/view/AnalyticsView.js +45 -0
- package/dist/view/AnalyticsView.js.map +1 -0
- package/dist/view/AnalyticsViewClient.d.ts +15 -0
- package/dist/view/AnalyticsViewClient.js +189 -0
- package/dist/view/AnalyticsViewClient.js.map +1 -0
- package/dist/view/authRedirect.js +32 -0
- package/dist/view/authRedirect.js.map +1 -0
- package/dist/view/conversionRate.js +18 -0
- package/dist/view/conversionRate.js.map +1 -0
- package/dist/view/dayRange.js +68 -0
- package/dist/view/dayRange.js.map +1 -0
- package/dist/view/gating.d.ts +1 -0
- package/dist/view/gating.js +105 -0
- package/dist/view/gating.js.map +1 -0
- package/dist/view/labels.js +44 -0
- package/dist/view/labels.js.map +1 -0
- package/dist/view/registerView.js +48 -0
- package/dist/view/registerView.js.map +1 -0
- package/dist/view/sections/Breakdowns.js +157 -0
- package/dist/view/sections/Breakdowns.js.map +1 -0
- package/dist/view/sections/EmptyStates.js +92 -0
- package/dist/view/sections/EmptyStates.js.map +1 -0
- package/dist/view/sections/FilterChips.js +41 -0
- package/dist/view/sections/FilterChips.js.map +1 -0
- package/dist/view/sections/GoalsPanel.js +81 -0
- package/dist/view/sections/GoalsPanel.js.map +1 -0
- package/dist/view/sections/OverviewCards.js +65 -0
- package/dist/view/sections/OverviewCards.js.map +1 -0
- package/dist/view/sections/RealtimeStrip.js +77 -0
- package/dist/view/sections/RealtimeStrip.js.map +1 -0
- package/dist/view/sections/Toolbar.js +179 -0
- package/dist/view/sections/Toolbar.js.map +1 -0
- package/dist/view/sections/Trend.js +119 -0
- package/dist/view/sections/Trend.js.map +1 -0
- package/dist/view/sections/styles.js +74 -0
- package/dist/view/sections/styles.js.map +1 -0
- package/dist/view/state.js +206 -0
- package/dist/view/state.js.map +1 -0
- package/dist/view/useViewQueries.js +150 -0
- package/dist/view/useViewQueries.js.map +1 -0
- package/dist/view/viewProps.d.ts +40 -0
- package/dist/view/viewProps.js +90 -0
- package/dist/view/viewProps.js.map +1 -0
- package/dist/widgets/AnalyticsBreakdownWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsBreakdownWidget.js +22 -4
- package/dist/widgets/AnalyticsBreakdownWidget.js.map +1 -1
- package/dist/widgets/AnalyticsGoalsWidget.d.ts +14 -0
- package/dist/widgets/AnalyticsGoalsWidget.js +188 -0
- package/dist/widgets/AnalyticsGoalsWidget.js.map +1 -0
- package/dist/widgets/AnalyticsMetricWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsMetricWidget.js +35 -12
- package/dist/widgets/AnalyticsMetricWidget.js.map +1 -1
- package/dist/widgets/AnalyticsRealtimeWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsRealtimeWidget.js +42 -22
- package/dist/widgets/AnalyticsRealtimeWidget.js.map +1 -1
- package/dist/widgets/AnalyticsTrendWidget.d.ts +2 -1
- package/dist/widgets/AnalyticsTrendWidget.js +51 -15
- package/dist/widgets/AnalyticsTrendWidget.js.map +1 -1
- package/dist/widgets/WidgetViewLink.js +17 -0
- package/dist/widgets/WidgetViewLink.js.map +1 -0
- package/dist/widgets/breakdownTypes.js +28 -1
- package/dist/widgets/breakdownTypes.js.map +1 -1
- package/dist/widgets/cardChrome.js +31 -7
- package/dist/widgets/cardChrome.js.map +1 -1
- package/dist/widgets/range.js +43 -12
- package/dist/widgets/range.js.map +1 -1
- package/dist/widgets/readForWidget.d.ts +12 -0
- package/dist/widgets/readForWidget.js +6 -5
- package/dist/widgets/readForWidget.js.map +1 -1
- package/dist/widgets/readForWidgetBreakdown.d.ts +15 -0
- package/dist/widgets/readForWidgetBreakdown.js +10 -7
- package/dist/widgets/readForWidgetBreakdown.js.map +1 -1
- package/dist/widgets/readForWidgetGoals.d.ts +57 -0
- package/dist/widgets/readForWidgetGoals.js +126 -0
- package/dist/widgets/readForWidgetGoals.js.map +1 -0
- package/dist/widgets/readForWidgetSeries.d.ts +13 -0
- package/dist/widgets/readForWidgetSeries.js +30 -12
- package/dist/widgets/readForWidgetSeries.js.map +1 -1
- package/dist/widgets/registerWidgets.js +49 -6
- package/dist/widgets/registerWidgets.js.map +1 -1
- package/dist/widgets/types.js +12 -1
- package/dist/widgets/types.js.map +1 -1
- package/dist/widgets/viewLink.d.ts +22 -0
- package/dist/widgets/viewLink.js +83 -0
- package/dist/widgets/viewLink.js.map +1 -0
- package/package.json +9 -4
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { keys } from "../translations/keys.js";
|
|
3
|
+
import { useTranslation as useTranslation$1 } from "../translations/useTranslation.js";
|
|
4
|
+
import { Fragment, jsx, jsxs } from "react/jsx-runtime";
|
|
5
|
+
import { Link } from "@payloadcms/ui";
|
|
6
|
+
import { usePathname } from "next/navigation";
|
|
7
|
+
//#region src/view/AnalyticsNavLink.tsx
|
|
8
|
+
const baseClass = "nav";
|
|
9
|
+
/** A blank override is an unset one: an empty nav entry is worse than the default label. */
|
|
10
|
+
const usable = (value) => value && value.trim() !== "" ? value : void 0;
|
|
11
|
+
/**
|
|
12
|
+
* The analytics entry in the admin nav, styled with Payload's own nav classes so it sits
|
|
13
|
+
* with the collection links rather than beside them. Mounted through `afterNavLinks`,
|
|
14
|
+
* which renders below the collection groups.
|
|
15
|
+
*/
|
|
16
|
+
function AnalyticsNavLink({ href, label }) {
|
|
17
|
+
const { i18n, t } = useTranslation$1();
|
|
18
|
+
const pathname = usePathname();
|
|
19
|
+
const text = (typeof label === "string" ? usable(label) : usable(label?.[i18n.language]) ?? usable(label?.en)) ?? t(keys.viewNavLabel);
|
|
20
|
+
const content = /* @__PURE__ */ jsxs(Fragment, { children: [(pathname === href || Boolean(pathname?.startsWith(`${href}/`))) && /* @__PURE__ */ jsx("div", { className: `${baseClass}__link-indicator` }), /* @__PURE__ */ jsx("span", {
|
|
21
|
+
className: `${baseClass}__link-label`,
|
|
22
|
+
children: text
|
|
23
|
+
})] });
|
|
24
|
+
if (pathname === href) return /* @__PURE__ */ jsx("div", {
|
|
25
|
+
className: `${baseClass}__link`,
|
|
26
|
+
id: "nav-analytics",
|
|
27
|
+
children: content
|
|
28
|
+
});
|
|
29
|
+
return /* @__PURE__ */ jsx(Link, {
|
|
30
|
+
className: `${baseClass}__link`,
|
|
31
|
+
href,
|
|
32
|
+
id: "nav-analytics",
|
|
33
|
+
prefetch: false,
|
|
34
|
+
children: content
|
|
35
|
+
});
|
|
36
|
+
}
|
|
37
|
+
//#endregion
|
|
38
|
+
export { AnalyticsNavLink };
|
|
39
|
+
|
|
40
|
+
//# sourceMappingURL=AnalyticsNavLink.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AnalyticsNavLink.js","names":["useTranslation"],"sources":["../../src/view/AnalyticsNavLink.tsx"],"sourcesContent":["'use client'\n\nimport { Link } from '@payloadcms/ui'\nimport { usePathname } from 'next/navigation'\nimport { keys } from '../translations/keys'\nimport { useTranslation } from '../translations/useTranslation'\n\nexport interface AnalyticsNavLinkProps {\n\t/** Admin-prefixed href the plugin resolved at config time. */\n\thref: string\n\t/** `view.navLabel`: a plain string, or a map keyed by admin language code. */\n\tlabel?: string | Record<string, string>\n}\n\nconst baseClass = 'nav'\n\n/** A blank override is an unset one: an empty nav entry is worse than the default label. */\nconst usable = (value: string | undefined): string | undefined =>\n\tvalue && value.trim() !== '' ? value : undefined\n\n/**\n * The analytics entry in the admin nav, styled with Payload's own nav classes so it sits\n * with the collection links rather than beside them. Mounted through `afterNavLinks`,\n * which renders below the collection groups.\n */\nexport function AnalyticsNavLink({ href, label }: AnalyticsNavLinkProps) {\n\tconst { i18n, t } = useTranslation()\n\tconst pathname = usePathname()\n\n\tconst override =\n\t\ttypeof label === 'string'\n\t\t\t? usable(label)\n\t\t\t: (usable(label?.[i18n.language]) ?? usable(label?.en))\n\tconst text = override ?? t(keys.viewNavLabel)\n\n\tconst isActive = pathname === href || Boolean(pathname?.startsWith(`${href}/`))\n\tconst content = (\n\t\t<>\n\t\t\t{isActive && <div className={`${baseClass}__link-indicator`} />}\n\t\t\t<span className={`${baseClass}__link-label`}>{text}</span>\n\t\t</>\n\t)\n\n\tif (pathname === href) {\n\t\treturn (\n\t\t\t<div className={`${baseClass}__link`} id=\"nav-analytics\">\n\t\t\t\t{content}\n\t\t\t</div>\n\t\t)\n\t}\n\n\treturn (\n\t\t<Link className={`${baseClass}__link`} href={href} id=\"nav-analytics\" prefetch={false}>\n\t\t\t{content}\n\t\t</Link>\n\t)\n}\n"],"mappings":";;;;;;;AAcA,MAAM,YAAY;;AAGlB,MAAM,UAAU,UACf,SAAS,MAAM,KAAK,MAAM,KAAK,QAAQ,KAAA;;;;;;AAOxC,SAAgB,iBAAiB,EAAE,MAAM,SAAgC;CACxE,MAAM,EAAE,MAAM,MAAMA,iBAAe;CACnC,MAAM,WAAW,YAAY;CAM7B,MAAM,QAHL,OAAO,UAAU,WACd,OAAO,KAAK,IACX,OAAO,QAAQ,KAAK,SAAS,KAAK,OAAO,OAAO,EAAE,MAC9B,EAAE,KAAK,YAAY;CAG5C,MAAM,UACL,qBAAA,UAAA,EAAA,UAAA,EAFgB,aAAa,QAAQ,QAAQ,UAAU,WAAW,GAAG,KAAK,EAAE,CAAC,MAG/D,oBAAC,OAAD,EAAK,WAAW,GAAG,UAAU,kBAAoB,CAAA,GAC9D,oBAAC,QAAD;EAAM,WAAW,GAAG,UAAU;YAAgB;CAAW,CAAA,CACxD,EAAA,CAAA;CAGH,IAAI,aAAa,MAChB,OACC,oBAAC,OAAD;EAAK,WAAW,GAAG,UAAU;EAAS,IAAG;YACvC;CACG,CAAA;CAIP,OACC,oBAAC,MAAD;EAAM,WAAW,GAAG,UAAU;EAAe;EAAM,IAAG;EAAgB,UAAU;YAC9E;CACI,CAAA;AAER"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { AnalyticsPluginOptions } from "../core/options.js";
|
|
2
|
+
import { AdminViewServerProps } from "payload";
|
|
3
|
+
|
|
4
|
+
//#region src/view/AnalyticsView.d.ts
|
|
5
|
+
type AnalyticsViewProps = AdminViewServerProps & {
|
|
6
|
+
pluginOptions: AnalyticsPluginOptions;
|
|
7
|
+
};
|
|
8
|
+
/**
|
|
9
|
+
* The analytics dashboard's server shell. It resolves the request's sources, goals and
|
|
10
|
+
* timezone once, then hands them to the client body, which reads everything else through
|
|
11
|
+
* the public query endpoint. A reader `access.view` denies gets the admin chrome with a
|
|
12
|
+
* message rather than a redirect: they are signed in, and bouncing them to a login form
|
|
13
|
+
* they already passed would loop.
|
|
14
|
+
*/
|
|
15
|
+
declare function AnalyticsView({
|
|
16
|
+
initPageResult,
|
|
17
|
+
params,
|
|
18
|
+
searchParams,
|
|
19
|
+
pluginOptions
|
|
20
|
+
}: AnalyticsViewProps): Promise<import("react/jsx-runtime").JSX.Element>;
|
|
21
|
+
//#endregion
|
|
22
|
+
export { AnalyticsView, AnalyticsViewProps };
|
|
23
|
+
//# sourceMappingURL=AnalyticsView.d.ts.map
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { keys } from "../translations/keys.js";
|
|
2
|
+
import { asTranslate } from "../translations/server.js";
|
|
3
|
+
import { resolveOptions } from "../core/options.js";
|
|
4
|
+
import { AnalyticsViewClient } from "./AnalyticsViewClient.js";
|
|
5
|
+
import { loginRedirectUrl } from "./authRedirect.js";
|
|
6
|
+
import { resolveViewProps } from "./viewProps.js";
|
|
7
|
+
import { jsx } from "react/jsx-runtime";
|
|
8
|
+
import { Gutter } from "@payloadcms/ui";
|
|
9
|
+
import { redirect } from "next/navigation";
|
|
10
|
+
import { DefaultTemplate } from "@payloadcms/next/templates";
|
|
11
|
+
//#region src/view/AnalyticsView.tsx
|
|
12
|
+
/**
|
|
13
|
+
* The analytics dashboard's server shell. It resolves the request's sources, goals and
|
|
14
|
+
* timezone once, then hands them to the client body, which reads everything else through
|
|
15
|
+
* the public query endpoint. A reader `access.view` denies gets the admin chrome with a
|
|
16
|
+
* message rather than a redirect: they are signed in, and bouncing them to a login form
|
|
17
|
+
* they already passed would loop.
|
|
18
|
+
*/
|
|
19
|
+
async function AnalyticsView({ initPageResult, params, searchParams, pluginOptions }) {
|
|
20
|
+
const { req } = initPageResult;
|
|
21
|
+
const { user } = req;
|
|
22
|
+
const t = asTranslate(req.i18n.t);
|
|
23
|
+
if (!user) redirect(loginRedirectUrl({
|
|
24
|
+
config: req.payload.config,
|
|
25
|
+
params,
|
|
26
|
+
searchParams
|
|
27
|
+
}));
|
|
28
|
+
const result = await resolveViewProps(req, resolveOptions(pluginOptions));
|
|
29
|
+
return /* @__PURE__ */ jsx(DefaultTemplate, {
|
|
30
|
+
i18n: req.i18n,
|
|
31
|
+
locale: initPageResult.locale,
|
|
32
|
+
params,
|
|
33
|
+
payload: req.payload,
|
|
34
|
+
permissions: initPageResult.permissions,
|
|
35
|
+
searchParams,
|
|
36
|
+
user,
|
|
37
|
+
visibleEntities: initPageResult.visibleEntities,
|
|
38
|
+
req,
|
|
39
|
+
children: /* @__PURE__ */ jsx(Gutter, { children: result.denied ? /* @__PURE__ */ jsx("p", { children: t(keys.viewNoAccess) }) : /* @__PURE__ */ jsx(AnalyticsViewClient, { ...result.props }, result.props.scopeKey) })
|
|
40
|
+
});
|
|
41
|
+
}
|
|
42
|
+
//#endregion
|
|
43
|
+
export { AnalyticsView };
|
|
44
|
+
|
|
45
|
+
//# sourceMappingURL=AnalyticsView.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AnalyticsView.js","names":[],"sources":["../../src/view/AnalyticsView.tsx"],"sourcesContent":["import { DefaultTemplate } from '@payloadcms/next/templates'\nimport { Gutter } from '@payloadcms/ui'\nimport { redirect } from 'next/navigation'\nimport type { AdminViewServerProps } from 'payload'\nimport { type AnalyticsPluginOptions, resolveOptions } from '../core/options'\nimport { keys } from '../translations/keys'\nimport { asTranslate } from '../translations/server'\nimport { AnalyticsViewClient } from './AnalyticsViewClient'\nimport { loginRedirectUrl } from './authRedirect'\nimport { resolveViewProps } from './viewProps'\n\nexport type AnalyticsViewProps = AdminViewServerProps & {\n\tpluginOptions: AnalyticsPluginOptions\n}\n\n/**\n * The analytics dashboard's server shell. It resolves the request's sources, goals and\n * timezone once, then hands them to the client body, which reads everything else through\n * the public query endpoint. A reader `access.view` denies gets the admin chrome with a\n * message rather than a redirect: they are signed in, and bouncing them to a login form\n * they already passed would loop.\n */\nexport async function AnalyticsView({\n\tinitPageResult,\n\tparams,\n\tsearchParams,\n\tpluginOptions,\n}: AnalyticsViewProps) {\n\tconst { req } = initPageResult\n\tconst { user } = req\n\tconst t = asTranslate(req.i18n.t)\n\n\tif (!user) {\n\t\tredirect(loginRedirectUrl({ config: req.payload.config, params, searchParams }))\n\t}\n\n\tconst resolved = resolveOptions(pluginOptions)\n\tconst result = await resolveViewProps(req, resolved)\n\n\treturn (\n\t\t<DefaultTemplate\n\t\t\ti18n={req.i18n}\n\t\t\tlocale={initPageResult.locale}\n\t\t\tparams={params}\n\t\t\tpayload={req.payload}\n\t\t\tpermissions={initPageResult.permissions}\n\t\t\tsearchParams={searchParams}\n\t\t\tuser={user}\n\t\t\tvisibleEntities={initPageResult.visibleEntities}\n\t\t\treq={req}\n\t\t>\n\t\t\t<Gutter>\n\t\t\t\t{result.denied ? (\n\t\t\t\t\t<p>{t(keys.viewNoAccess)}</p>\n\t\t\t\t) : (\n\t\t\t\t\t<AnalyticsViewClient key={result.props.scopeKey} {...result.props} />\n\t\t\t\t)}\n\t\t\t</Gutter>\n\t\t</DefaultTemplate>\n\t)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAsBA,eAAsB,cAAc,EACnC,gBACA,QACA,cACA,iBACsB;CACtB,MAAM,EAAE,QAAQ;CAChB,MAAM,EAAE,SAAS;CACjB,MAAM,IAAI,YAAY,IAAI,KAAK,CAAC;CAEhC,IAAI,CAAC,MACJ,SAAS,iBAAiB;EAAE,QAAQ,IAAI,QAAQ;EAAQ;EAAQ;CAAa,CAAC,CAAC;CAIhF,MAAM,SAAS,MAAM,iBAAiB,KADrB,eAAe,aACkB,CAAC;CAEnD,OACC,oBAAC,iBAAD;EACC,MAAM,IAAI;EACV,QAAQ,eAAe;EACf;EACR,SAAS,IAAI;EACb,aAAa,eAAe;EACd;EACR;EACN,iBAAiB,eAAe;EAC3B;YAEL,oBAAC,QAAD,EAAA,UACE,OAAO,SACP,oBAAC,KAAD,EAAA,UAAI,EAAE,KAAK,YAAY,EAAK,CAAA,IAE5B,oBAAC,qBAAD,EAAiD,GAAI,OAAO,MAAQ,GAA1C,OAAO,MAAM,QAA6B,EAE9D,CAAA;CACQ,CAAA;AAEnB"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { AnalyticsViewClientProps } from "./viewProps.js";
|
|
2
|
+
|
|
3
|
+
//#region src/view/AnalyticsViewClient.d.ts
|
|
4
|
+
/**
|
|
5
|
+
* The analytics dashboard. Its whole state is the URL, so a link is a view: the query
|
|
6
|
+
* string is parsed on every render, coerced to what the selected source serves, and
|
|
7
|
+
* written back through `router.push` as the reader works (a debounced day edit uses
|
|
8
|
+
* `replace`, so Back skips the typing). A coerced value is applied to
|
|
9
|
+
* the reads but deliberately not written back, so a link built for a richer source still
|
|
10
|
+
* opens as intended once that source is selected again.
|
|
11
|
+
*/
|
|
12
|
+
declare function AnalyticsViewClient(props: AnalyticsViewClientProps): import("react/jsx-runtime").JSX.Element;
|
|
13
|
+
//#endregion
|
|
14
|
+
export { AnalyticsViewClient };
|
|
15
|
+
//# sourceMappingURL=AnalyticsViewClient.d.ts.map
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
import { keys } from "../translations/keys.js";
|
|
3
|
+
import { useTranslation } from "../translations/useTranslation.js";
|
|
4
|
+
import { dayRangeCaption } from "./dayRange.js";
|
|
5
|
+
import { autoGranularity, gate, resolveSource } from "./gating.js";
|
|
6
|
+
import { coerceState, parseViewState, rangeFor, serializeViewState } from "./state.js";
|
|
7
|
+
import { useViewQueries } from "./useViewQueries.js";
|
|
8
|
+
import { NoSources } from "./sections/EmptyStates.js";
|
|
9
|
+
import { Breakdowns } from "./sections/Breakdowns.js";
|
|
10
|
+
import { GoalsPanel } from "./sections/GoalsPanel.js";
|
|
11
|
+
import { OverviewCards } from "./sections/OverviewCards.js";
|
|
12
|
+
import { RealtimeStrip } from "./sections/RealtimeStrip.js";
|
|
13
|
+
import { ViewStyles } from "./sections/styles.js";
|
|
14
|
+
import { Toolbar } from "./sections/Toolbar.js";
|
|
15
|
+
import { Trend } from "./sections/Trend.js";
|
|
16
|
+
import { useCallback, useEffect, useMemo, useRef } from "react";
|
|
17
|
+
import { jsx, jsxs } from "react/jsx-runtime";
|
|
18
|
+
import { usePathname, useRouter, useSearchParams } from "next/navigation";
|
|
19
|
+
//#region src/view/AnalyticsViewClient.tsx
|
|
20
|
+
/** A day input fires on every keystroke; only the pause between them is worth a history entry. */
|
|
21
|
+
const COMMIT_DELAY_MS = 400;
|
|
22
|
+
/**
|
|
23
|
+
* The analytics dashboard. Its whole state is the URL, so a link is a view: the query
|
|
24
|
+
* string is parsed on every render, coerced to what the selected source serves, and
|
|
25
|
+
* written back through `router.push` as the reader works (a debounced day edit uses
|
|
26
|
+
* `replace`, so Back skips the typing). A coerced value is applied to
|
|
27
|
+
* the reads but deliberately not written back, so a link built for a richer source still
|
|
28
|
+
* opens as intended once that source is selected again.
|
|
29
|
+
*/
|
|
30
|
+
function AnalyticsViewClient(props) {
|
|
31
|
+
const { t } = useTranslation();
|
|
32
|
+
const router = useRouter();
|
|
33
|
+
const pathname = usePathname();
|
|
34
|
+
const search = useSearchParams().toString();
|
|
35
|
+
const parsed = useMemo(() => parseViewState(new URLSearchParams(search), props.defaults), [search, props.defaults]);
|
|
36
|
+
const source = resolveSource(props.sources, parsed.source);
|
|
37
|
+
const served = useMemo(() => source ? gate(source.capabilities) : null, [source]);
|
|
38
|
+
const state = served ? coerceState(parsed, served) : parsed;
|
|
39
|
+
const queries = useViewQueries(props, state);
|
|
40
|
+
const query = useCallback((next) => serializeViewState(next, props.defaults).toString(), [props.defaults]);
|
|
41
|
+
const href = useCallback((next) => {
|
|
42
|
+
const search = query(next);
|
|
43
|
+
return search === "" ? pathname : `${pathname}?${search}`;
|
|
44
|
+
}, [pathname, query]);
|
|
45
|
+
const pending = useRef(null);
|
|
46
|
+
/**
|
|
47
|
+
* A click is a step the reader took, so Back undoes it rather than leaving the view. It
|
|
48
|
+
* also drops any day edit still waiting out its debounce, whose later `replace` would
|
|
49
|
+
* otherwise overwrite the click with the state as it stood before it.
|
|
50
|
+
*/
|
|
51
|
+
const write = useCallback((next) => {
|
|
52
|
+
if (pending.current !== null) {
|
|
53
|
+
clearTimeout(pending.current);
|
|
54
|
+
pending.current = null;
|
|
55
|
+
}
|
|
56
|
+
router.push(href(next), { scroll: false });
|
|
57
|
+
}, [router, href]);
|
|
58
|
+
/**
|
|
59
|
+
* Typing in a day input is one edit, not a history of them: the committed value replaces
|
|
60
|
+
* the entry the picker already wrote rather than stacking one per keystroke pause.
|
|
61
|
+
*/
|
|
62
|
+
const writeLater = useCallback((next) => {
|
|
63
|
+
if (pending.current !== null) clearTimeout(pending.current);
|
|
64
|
+
pending.current = setTimeout(() => {
|
|
65
|
+
pending.current = null;
|
|
66
|
+
router.replace(href(next), { scroll: false });
|
|
67
|
+
}, COMMIT_DELAY_MS);
|
|
68
|
+
}, [router, href]);
|
|
69
|
+
useEffect(() => () => {
|
|
70
|
+
if (pending.current !== null) clearTimeout(pending.current);
|
|
71
|
+
}, []);
|
|
72
|
+
if (!source || !served) return /* @__PURE__ */ jsxs("div", {
|
|
73
|
+
className: "analytics-view",
|
|
74
|
+
children: [
|
|
75
|
+
/* @__PURE__ */ jsx(ViewStyles, {}),
|
|
76
|
+
/* @__PURE__ */ jsx("h1", {
|
|
77
|
+
className: "analytics-view__title",
|
|
78
|
+
children: t(keys.viewTitle)
|
|
79
|
+
}),
|
|
80
|
+
/* @__PURE__ */ jsx(NoSources, {})
|
|
81
|
+
]
|
|
82
|
+
});
|
|
83
|
+
const now = /* @__PURE__ */ new Date();
|
|
84
|
+
const range = rangeFor(state, props.timezone, now);
|
|
85
|
+
const sections = [
|
|
86
|
+
queries.cards,
|
|
87
|
+
queries.trend,
|
|
88
|
+
queries.breakdown,
|
|
89
|
+
...queries.goals ? [queries.goals] : []
|
|
90
|
+
];
|
|
91
|
+
const dimension = served.dimensionsFor(state.tab)[0] ?? null;
|
|
92
|
+
const canFilter = dimension !== null && served.canFilter(dimension);
|
|
93
|
+
const addFilter = (value) => {
|
|
94
|
+
if (dimension === null || state.filters.length >= 10) return;
|
|
95
|
+
if (state.filters.some((filter) => filter.dimension === dimension && filter.operator === "eq" && filter.value === value)) return;
|
|
96
|
+
write({
|
|
97
|
+
...state,
|
|
98
|
+
filters: [...state.filters, {
|
|
99
|
+
dimension,
|
|
100
|
+
operator: "eq",
|
|
101
|
+
value
|
|
102
|
+
}]
|
|
103
|
+
});
|
|
104
|
+
};
|
|
105
|
+
return /* @__PURE__ */ jsxs("div", {
|
|
106
|
+
className: "analytics-view",
|
|
107
|
+
children: [
|
|
108
|
+
/* @__PURE__ */ jsx(ViewStyles, {}),
|
|
109
|
+
/* @__PURE__ */ jsx("h1", {
|
|
110
|
+
className: "analytics-view__title",
|
|
111
|
+
children: t(keys.viewTitle)
|
|
112
|
+
}),
|
|
113
|
+
/* @__PURE__ */ jsx(Toolbar, {
|
|
114
|
+
clamped: sections.some((section) => section.data?.result.meta.clamped === true),
|
|
115
|
+
gate: served,
|
|
116
|
+
locale: props.locale,
|
|
117
|
+
now,
|
|
118
|
+
onChange: write,
|
|
119
|
+
onChangeDeferred: writeLater,
|
|
120
|
+
range,
|
|
121
|
+
sourceId: source.id,
|
|
122
|
+
sources: props.sources.sources,
|
|
123
|
+
stale: sections.some((section) => section.data?.result.meta.stale === true),
|
|
124
|
+
state,
|
|
125
|
+
stateKey: query(state),
|
|
126
|
+
timezone: props.timezone
|
|
127
|
+
}),
|
|
128
|
+
/* @__PURE__ */ jsx(OverviewCards, {
|
|
129
|
+
compare: state.compare,
|
|
130
|
+
locale: props.locale,
|
|
131
|
+
metrics: served.metrics,
|
|
132
|
+
onSelect: (metric) => write({
|
|
133
|
+
...state,
|
|
134
|
+
metric
|
|
135
|
+
}),
|
|
136
|
+
query: queries.cards,
|
|
137
|
+
selected: state.metric
|
|
138
|
+
}),
|
|
139
|
+
/* @__PURE__ */ jsx(Trend, {
|
|
140
|
+
compare: state.compare,
|
|
141
|
+
granularity: state.granularity ?? autoGranularity(range, source.capabilities),
|
|
142
|
+
locale: props.locale,
|
|
143
|
+
metric: state.metric,
|
|
144
|
+
query: queries.trend,
|
|
145
|
+
rangeCaption: dayRangeCaption(range, props.locale, props.timezone),
|
|
146
|
+
timezone: props.timezone
|
|
147
|
+
}),
|
|
148
|
+
/* @__PURE__ */ jsx(Breakdowns, {
|
|
149
|
+
canFilter,
|
|
150
|
+
dimension,
|
|
151
|
+
limit: state.limit,
|
|
152
|
+
locale: props.locale,
|
|
153
|
+
metric: state.metric,
|
|
154
|
+
onLimitChange: (limit) => write({
|
|
155
|
+
...state,
|
|
156
|
+
limit
|
|
157
|
+
}),
|
|
158
|
+
onRowSelect: addFilter,
|
|
159
|
+
onSortChange: (order) => write({
|
|
160
|
+
...state,
|
|
161
|
+
order
|
|
162
|
+
}),
|
|
163
|
+
onTabChange: (tab) => write({
|
|
164
|
+
...state,
|
|
165
|
+
tab
|
|
166
|
+
}),
|
|
167
|
+
...state.order === void 0 ? {} : { order: state.order },
|
|
168
|
+
query: queries.breakdown,
|
|
169
|
+
tab: state.tab,
|
|
170
|
+
tabs: served.tabs
|
|
171
|
+
}),
|
|
172
|
+
served.goals && queries.goals ? /* @__PURE__ */ jsx(GoalsPanel, {
|
|
173
|
+
goals: props.goals,
|
|
174
|
+
locale: props.locale,
|
|
175
|
+
query: queries.goals,
|
|
176
|
+
...queries.cards.data?.result.totals?.visitors === void 0 ? {} : { siteVisitors: queries.cards.data.result.totals.visitors }
|
|
177
|
+
}) : null,
|
|
178
|
+
served.realtime ? /* @__PURE__ */ jsx(RealtimeStrip, {
|
|
179
|
+
apiRoute: props.apiRoute,
|
|
180
|
+
locale: props.locale,
|
|
181
|
+
sourceId: source.id
|
|
182
|
+
}) : null
|
|
183
|
+
]
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
//#endregion
|
|
187
|
+
export { AnalyticsViewClient };
|
|
188
|
+
|
|
189
|
+
//# sourceMappingURL=AnalyticsViewClient.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"AnalyticsViewClient.js","names":[],"sources":["../../src/view/AnalyticsViewClient.tsx"],"sourcesContent":["'use client'\n\nimport { usePathname, useRouter, useSearchParams } from 'next/navigation'\nimport { useCallback, useEffect, useMemo, useRef } from 'react'\nimport type { MetricKey } from '../core/contract'\nimport { MAX_QUERY_FILTERS } from '../query/limits'\nimport { keys } from '../translations/keys'\nimport { useTranslation } from '../translations/useTranslation'\nimport { dayRangeCaption } from './dayRange'\nimport { autoGranularity, gate, resolveSource } from './gating'\nimport { Breakdowns } from './sections/Breakdowns'\nimport { NoSources } from './sections/EmptyStates'\nimport { GoalsPanel } from './sections/GoalsPanel'\nimport { OverviewCards } from './sections/OverviewCards'\nimport { RealtimeStrip } from './sections/RealtimeStrip'\nimport { ViewStyles } from './sections/styles'\nimport { Toolbar } from './sections/Toolbar'\nimport { Trend } from './sections/Trend'\nimport { coerceState, parseViewState, rangeFor, serializeViewState, type ViewState } from './state'\nimport { useViewQueries } from './useViewQueries'\nimport type { AnalyticsViewClientProps } from './viewProps'\n\n/** A day input fires on every keystroke; only the pause between them is worth a history entry. */\nconst COMMIT_DELAY_MS = 400\n\n/**\n * The analytics dashboard. Its whole state is the URL, so a link is a view: the query\n * string is parsed on every render, coerced to what the selected source serves, and\n * written back through `router.push` as the reader works (a debounced day edit uses\n * `replace`, so Back skips the typing). A coerced value is applied to\n * the reads but deliberately not written back, so a link built for a richer source still\n * opens as intended once that source is selected again.\n */\nexport function AnalyticsViewClient(props: AnalyticsViewClientProps) {\n\tconst { t } = useTranslation()\n\tconst router = useRouter()\n\tconst pathname = usePathname()\n\tconst searchParams = useSearchParams()\n\tconst search = searchParams.toString()\n\n\tconst parsed = useMemo(\n\t\t() => parseViewState(new URLSearchParams(search), props.defaults),\n\t\t[search, props.defaults]\n\t)\n\tconst source = resolveSource(props.sources, parsed.source)\n\tconst served = useMemo(() => (source ? gate(source.capabilities) : null), [source])\n\tconst state = served ? coerceState(parsed, served) : parsed\n\tconst queries = useViewQueries(props, state)\n\n\tconst query = useCallback(\n\t\t(next: ViewState) => serializeViewState(next, props.defaults).toString(),\n\t\t[props.defaults]\n\t)\n\n\tconst href = useCallback(\n\t\t(next: ViewState) => {\n\t\t\tconst search = query(next)\n\t\t\treturn search === '' ? pathname : `${pathname}?${search}`\n\t\t},\n\t\t[pathname, query]\n\t)\n\n\tconst pending = useRef<ReturnType<typeof setTimeout> | null>(null)\n\n\t/**\n\t * A click is a step the reader took, so Back undoes it rather than leaving the view. It\n\t * also drops any day edit still waiting out its debounce, whose later `replace` would\n\t * otherwise overwrite the click with the state as it stood before it.\n\t */\n\tconst write = useCallback(\n\t\t(next: ViewState) => {\n\t\t\tif (pending.current !== null) {\n\t\t\t\tclearTimeout(pending.current)\n\t\t\t\tpending.current = null\n\t\t\t}\n\t\t\trouter.push(href(next), { scroll: false })\n\t\t},\n\t\t[router, href]\n\t)\n\n\t/**\n\t * Typing in a day input is one edit, not a history of them: the committed value replaces\n\t * the entry the picker already wrote rather than stacking one per keystroke pause.\n\t */\n\tconst writeLater = useCallback(\n\t\t(next: ViewState) => {\n\t\t\tif (pending.current !== null) {\n\t\t\t\tclearTimeout(pending.current)\n\t\t\t}\n\t\t\tpending.current = setTimeout(() => {\n\t\t\t\tpending.current = null\n\t\t\t\trouter.replace(href(next), { scroll: false })\n\t\t\t}, COMMIT_DELAY_MS)\n\t\t},\n\t\t[router, href]\n\t)\n\tuseEffect(\n\t\t() => () => {\n\t\t\tif (pending.current !== null) {\n\t\t\t\tclearTimeout(pending.current)\n\t\t\t}\n\t\t},\n\t\t[]\n\t)\n\n\tif (!source || !served) {\n\t\treturn (\n\t\t\t<div className=\"analytics-view\">\n\t\t\t\t<ViewStyles />\n\t\t\t\t<h1 className=\"analytics-view__title\">{t(keys.viewTitle)}</h1>\n\t\t\t\t<NoSources />\n\t\t\t</div>\n\t\t)\n\t}\n\n\tconst now = new Date()\n\tconst range = rangeFor(state, props.timezone, now)\n\tconst sections = [\n\t\tqueries.cards,\n\t\tqueries.trend,\n\t\tqueries.breakdown,\n\t\t...(queries.goals ? [queries.goals] : []),\n\t]\n\tconst dimension = served.dimensionsFor(state.tab)[0] ?? null\n\tconst canFilter = dimension !== null && served.canFilter(dimension)\n\n\tconst addFilter = (value: string): void => {\n\t\tif (dimension === null || state.filters.length >= MAX_QUERY_FILTERS) {\n\t\t\treturn\n\t\t}\n\t\tconst already = state.filters.some(\n\t\t\t(filter) =>\n\t\t\t\tfilter.dimension === dimension && filter.operator === 'eq' && filter.value === value\n\t\t)\n\t\tif (already) {\n\t\t\treturn\n\t\t}\n\t\twrite({\n\t\t\t...state,\n\t\t\tfilters: [...state.filters, { dimension, operator: 'eq', value }],\n\t\t})\n\t}\n\n\treturn (\n\t\t<div className=\"analytics-view\">\n\t\t\t<ViewStyles />\n\t\t\t<h1 className=\"analytics-view__title\">{t(keys.viewTitle)}</h1>\n\t\t\t<Toolbar\n\t\t\t\tclamped={sections.some((section) => section.data?.result.meta.clamped === true)}\n\t\t\t\tgate={served}\n\t\t\t\tlocale={props.locale}\n\t\t\t\tnow={now}\n\t\t\t\tonChange={write}\n\t\t\t\tonChangeDeferred={writeLater}\n\t\t\t\trange={range}\n\t\t\t\tsourceId={source.id}\n\t\t\t\tsources={props.sources.sources}\n\t\t\t\tstale={sections.some((section) => section.data?.result.meta.stale === true)}\n\t\t\t\tstate={state}\n\t\t\t\tstateKey={query(state)}\n\t\t\t\ttimezone={props.timezone}\n\t\t\t/>\n\t\t\t<OverviewCards\n\t\t\t\tcompare={state.compare}\n\t\t\t\tlocale={props.locale}\n\t\t\t\tmetrics={served.metrics}\n\t\t\t\tonSelect={(metric: MetricKey) => write({ ...state, metric })}\n\t\t\t\tquery={queries.cards}\n\t\t\t\tselected={state.metric}\n\t\t\t/>\n\t\t\t<Trend\n\t\t\t\tcompare={state.compare}\n\t\t\t\tgranularity={state.granularity ?? autoGranularity(range, source.capabilities)}\n\t\t\t\tlocale={props.locale}\n\t\t\t\tmetric={state.metric}\n\t\t\t\tquery={queries.trend}\n\t\t\t\trangeCaption={dayRangeCaption(range, props.locale, props.timezone)}\n\t\t\t\ttimezone={props.timezone}\n\t\t\t/>\n\t\t\t<Breakdowns\n\t\t\t\tcanFilter={canFilter}\n\t\t\t\tdimension={dimension}\n\t\t\t\tlimit={state.limit}\n\t\t\t\tlocale={props.locale}\n\t\t\t\tmetric={state.metric}\n\t\t\t\tonLimitChange={(limit) => write({ ...state, limit })}\n\t\t\t\tonRowSelect={addFilter}\n\t\t\t\tonSortChange={(order) => write({ ...state, order })}\n\t\t\t\tonTabChange={(tab) => write({ ...state, tab })}\n\t\t\t\t{...(state.order === undefined ? {} : { order: state.order })}\n\t\t\t\tquery={queries.breakdown}\n\t\t\t\ttab={state.tab}\n\t\t\t\ttabs={served.tabs}\n\t\t\t/>\n\t\t\t{served.goals && queries.goals ? (\n\t\t\t\t<GoalsPanel\n\t\t\t\t\tgoals={props.goals}\n\t\t\t\t\tlocale={props.locale}\n\t\t\t\t\tquery={queries.goals}\n\t\t\t\t\t{...(queries.cards.data?.result.totals?.visitors === undefined\n\t\t\t\t\t\t? {}\n\t\t\t\t\t\t: { siteVisitors: queries.cards.data.result.totals.visitors })}\n\t\t\t\t/>\n\t\t\t) : null}\n\t\t\t{served.realtime ? (\n\t\t\t\t<RealtimeStrip apiRoute={props.apiRoute} locale={props.locale} sourceId={source.id} />\n\t\t\t) : null}\n\t\t</div>\n\t)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAuBA,MAAM,kBAAkB;;;;;;;;;AAUxB,SAAgB,oBAAoB,OAAiC;CACpE,MAAM,EAAE,MAAM,eAAe;CAC7B,MAAM,SAAS,UAAU;CACzB,MAAM,WAAW,YAAY;CAE7B,MAAM,SADe,gBACK,EAAE,SAAS;CAErC,MAAM,SAAS,cACR,eAAe,IAAI,gBAAgB,MAAM,GAAG,MAAM,QAAQ,GAChE,CAAC,QAAQ,MAAM,QAAQ,CACxB;CACA,MAAM,SAAS,cAAc,MAAM,SAAS,OAAO,MAAM;CACzD,MAAM,SAAS,cAAe,SAAS,KAAK,OAAO,YAAY,IAAI,MAAO,CAAC,MAAM,CAAC;CAClF,MAAM,QAAQ,SAAS,YAAY,QAAQ,MAAM,IAAI;CACrD,MAAM,UAAU,eAAe,OAAO,KAAK;CAE3C,MAAM,QAAQ,aACZ,SAAoB,mBAAmB,MAAM,MAAM,QAAQ,EAAE,SAAS,GACvE,CAAC,MAAM,QAAQ,CAChB;CAEA,MAAM,OAAO,aACX,SAAoB;EACpB,MAAM,SAAS,MAAM,IAAI;EACzB,OAAO,WAAW,KAAK,WAAW,GAAG,SAAS,GAAG;CAClD,GACA,CAAC,UAAU,KAAK,CACjB;CAEA,MAAM,UAAU,OAA6C,IAAI;;;;;;CAOjE,MAAM,QAAQ,aACZ,SAAoB;EACpB,IAAI,QAAQ,YAAY,MAAM;GAC7B,aAAa,QAAQ,OAAO;GAC5B,QAAQ,UAAU;EACnB;EACA,OAAO,KAAK,KAAK,IAAI,GAAG,EAAE,QAAQ,MAAM,CAAC;CAC1C,GACA,CAAC,QAAQ,IAAI,CACd;;;;;CAMA,MAAM,aAAa,aACjB,SAAoB;EACpB,IAAI,QAAQ,YAAY,MACvB,aAAa,QAAQ,OAAO;EAE7B,QAAQ,UAAU,iBAAiB;GAClC,QAAQ,UAAU;GAClB,OAAO,QAAQ,KAAK,IAAI,GAAG,EAAE,QAAQ,MAAM,CAAC;EAC7C,GAAG,eAAe;CACnB,GACA,CAAC,QAAQ,IAAI,CACd;CACA,sBACa;EACX,IAAI,QAAQ,YAAY,MACvB,aAAa,QAAQ,OAAO;CAE9B,GACA,CAAC,CACF;CAEA,IAAI,CAAC,UAAU,CAAC,QACf,OACC,qBAAC,OAAD;EAAK,WAAU;YAAf;GACC,oBAAC,YAAD,CAAa,CAAA;GACb,oBAAC,MAAD;IAAI,WAAU;cAAyB,EAAE,KAAK,SAAS;GAAM,CAAA;GAC7D,oBAAC,WAAD,CAAY,CAAA;EACR;;CAIP,MAAM,sBAAM,IAAI,KAAK;CACrB,MAAM,QAAQ,SAAS,OAAO,MAAM,UAAU,GAAG;CACjD,MAAM,WAAW;EAChB,QAAQ;EACR,QAAQ;EACR,QAAQ;EACR,GAAI,QAAQ,QAAQ,CAAC,QAAQ,KAAK,IAAI,CAAC;CACxC;CACA,MAAM,YAAY,OAAO,cAAc,MAAM,GAAG,EAAE,MAAM;CACxD,MAAM,YAAY,cAAc,QAAQ,OAAO,UAAU,SAAS;CAElE,MAAM,aAAa,UAAwB;EAC1C,IAAI,cAAc,QAAQ,MAAM,QAAQ,UAAA,IACvC;EAMD,IAJgB,MAAM,QAAQ,MAC5B,WACA,OAAO,cAAc,aAAa,OAAO,aAAa,QAAQ,OAAO,UAAU,KAEvE,GACT;EAED,MAAM;GACL,GAAG;GACH,SAAS,CAAC,GAAG,MAAM,SAAS;IAAE;IAAW,UAAU;IAAM;GAAM,CAAC;EACjE,CAAC;CACF;CAEA,OACC,qBAAC,OAAD;EAAK,WAAU;YAAf;GACC,oBAAC,YAAD,CAAa,CAAA;GACb,oBAAC,MAAD;IAAI,WAAU;cAAyB,EAAE,KAAK,SAAS;GAAM,CAAA;GAC7D,oBAAC,SAAD;IACC,SAAS,SAAS,MAAM,YAAY,QAAQ,MAAM,OAAO,KAAK,YAAY,IAAI;IAC9E,MAAM;IACN,QAAQ,MAAM;IACT;IACL,UAAU;IACV,kBAAkB;IACX;IACP,UAAU,OAAO;IACjB,SAAS,MAAM,QAAQ;IACvB,OAAO,SAAS,MAAM,YAAY,QAAQ,MAAM,OAAO,KAAK,UAAU,IAAI;IACnE;IACP,UAAU,MAAM,KAAK;IACrB,UAAU,MAAM;GAChB,CAAA;GACD,oBAAC,eAAD;IACC,SAAS,MAAM;IACf,QAAQ,MAAM;IACd,SAAS,OAAO;IAChB,WAAW,WAAsB,MAAM;KAAE,GAAG;KAAO;IAAO,CAAC;IAC3D,OAAO,QAAQ;IACf,UAAU,MAAM;GAChB,CAAA;GACD,oBAAC,OAAD;IACC,SAAS,MAAM;IACf,aAAa,MAAM,eAAe,gBAAgB,OAAO,OAAO,YAAY;IAC5E,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,OAAO,QAAQ;IACf,cAAc,gBAAgB,OAAO,MAAM,QAAQ,MAAM,QAAQ;IACjE,UAAU,MAAM;GAChB,CAAA;GACD,oBAAC,YAAD;IACY;IACA;IACX,OAAO,MAAM;IACb,QAAQ,MAAM;IACd,QAAQ,MAAM;IACd,gBAAgB,UAAU,MAAM;KAAE,GAAG;KAAO;IAAM,CAAC;IACnD,aAAa;IACb,eAAe,UAAU,MAAM;KAAE,GAAG;KAAO;IAAM,CAAC;IAClD,cAAc,QAAQ,MAAM;KAAE,GAAG;KAAO;IAAI,CAAC;IAC7C,GAAK,MAAM,UAAU,KAAA,IAAY,CAAC,IAAI,EAAE,OAAO,MAAM,MAAM;IAC3D,OAAO,QAAQ;IACf,KAAK,MAAM;IACX,MAAM,OAAO;GACb,CAAA;GACA,OAAO,SAAS,QAAQ,QACxB,oBAAC,YAAD;IACC,OAAO,MAAM;IACb,QAAQ,MAAM;IACd,OAAO,QAAQ;IACf,GAAK,QAAQ,MAAM,MAAM,OAAO,QAAQ,aAAa,KAAA,IAClD,CAAC,IACD,EAAE,cAAc,QAAQ,MAAM,KAAK,OAAO,OAAO,SAAS;GAC7D,CAAA,IACE;GACH,OAAO,WACP,oBAAC,eAAD;IAAe,UAAU,MAAM;IAAU,QAAQ,MAAM;IAAQ,UAAU,OAAO;GAAK,CAAA,IAClF;EACA;;AAEP"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { formatAdminURL } from "payload/shared";
|
|
2
|
+
//#region src/view/authRedirect.ts
|
|
3
|
+
/** The admin path the reader asked for, with the state they had, ready to come back to. */
|
|
4
|
+
const returnPath = (config, params, searchParams) => {
|
|
5
|
+
const segments = Array.isArray(params?.segments) ? params.segments : [];
|
|
6
|
+
const path = formatAdminURL({
|
|
7
|
+
adminRoute: config.routes.admin,
|
|
8
|
+
path: segments.length > 0 ? `/${segments.join("/")}` : null
|
|
9
|
+
});
|
|
10
|
+
const query = new URLSearchParams();
|
|
11
|
+
for (const [key, value] of Object.entries(searchParams ?? {})) {
|
|
12
|
+
if (key === "redirect" || value === void 0) continue;
|
|
13
|
+
for (const entry of Array.isArray(value) ? value : [value]) query.append(key, entry);
|
|
14
|
+
}
|
|
15
|
+
const queryString = query.toString();
|
|
16
|
+
return queryString ? `${path}?${queryString}` : path;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* Where to send a reader who is not signed in. Custom admin views bypass the root router's
|
|
20
|
+
* auth redirect, so the view enforces this itself. The view's whole state lives in the query
|
|
21
|
+
* string, so it travels along and the reader lands back on the same dashboard.
|
|
22
|
+
*/
|
|
23
|
+
const loginRedirectUrl = ({ config, params, searchParams }) => {
|
|
24
|
+
return `${formatAdminURL({
|
|
25
|
+
adminRoute: config.routes.admin,
|
|
26
|
+
path: config.admin.routes.login
|
|
27
|
+
})}?redirect=${encodeURIComponent(returnPath(config, params, searchParams))}`;
|
|
28
|
+
};
|
|
29
|
+
//#endregion
|
|
30
|
+
export { loginRedirectUrl };
|
|
31
|
+
|
|
32
|
+
//# sourceMappingURL=authRedirect.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authRedirect.js","names":[],"sources":["../../src/view/authRedirect.ts"],"sourcesContent":["import type { Params, SanitizedConfig } from 'payload'\nimport { formatAdminURL } from 'payload/shared'\n\n/** The admin path the reader asked for, with the state they had, ready to come back to. */\nconst returnPath = (config: SanitizedConfig, params?: Params, searchParams?: Params): string => {\n\tconst segments = Array.isArray(params?.segments) ? params.segments : []\n\tconst path = formatAdminURL({\n\t\tadminRoute: config.routes.admin,\n\t\tpath: segments.length > 0 ? `/${segments.join('/')}` : null,\n\t})\n\n\tconst query = new URLSearchParams()\n\tfor (const [key, value] of Object.entries(searchParams ?? {})) {\n\t\t// An inherited `redirect` would nest one round trip inside another.\n\t\tif (key === 'redirect' || value === undefined) continue\n\t\tfor (const entry of Array.isArray(value) ? value : [value]) query.append(key, entry)\n\t}\n\n\tconst queryString = query.toString()\n\treturn queryString ? `${path}?${queryString}` : path\n}\n\n/**\n * Where to send a reader who is not signed in. Custom admin views bypass the root router's\n * auth redirect, so the view enforces this itself. The view's whole state lives in the query\n * string, so it travels along and the reader lands back on the same dashboard.\n */\nexport const loginRedirectUrl = ({\n\tconfig,\n\tparams,\n\tsearchParams,\n}: {\n\tconfig: SanitizedConfig\n\tparams?: Params\n\tsearchParams?: Params\n}): string => {\n\tconst target = formatAdminURL({\n\t\tadminRoute: config.routes.admin,\n\t\tpath: config.admin.routes.login,\n\t})\n\treturn `${target}?redirect=${encodeURIComponent(returnPath(config, params, searchParams))}`\n}\n"],"mappings":";;;AAIA,MAAM,cAAc,QAAyB,QAAiB,iBAAkC;CAC/F,MAAM,WAAW,MAAM,QAAQ,QAAQ,QAAQ,IAAI,OAAO,WAAW,CAAC;CACtE,MAAM,OAAO,eAAe;EAC3B,YAAY,OAAO,OAAO;EAC1B,MAAM,SAAS,SAAS,IAAI,IAAI,SAAS,KAAK,GAAG,MAAM;CACxD,CAAC;CAED,MAAM,QAAQ,IAAI,gBAAgB;CAClC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,gBAAgB,CAAC,CAAC,GAAG;EAE9D,IAAI,QAAQ,cAAc,UAAU,KAAA,GAAW;EAC/C,KAAK,MAAM,SAAS,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,KAAK,GAAG,MAAM,OAAO,KAAK,KAAK;CACpF;CAEA,MAAM,cAAc,MAAM,SAAS;CACnC,OAAO,cAAc,GAAG,KAAK,GAAG,gBAAgB;AACjD;;;;;;AAOA,MAAa,oBAAoB,EAChC,QACA,QACA,mBAKa;CAKb,OAAO,GAJQ,eAAe;EAC7B,YAAY,OAAO,OAAO;EAC1B,MAAM,OAAO,MAAM,OAAO;CAC3B,CACe,EAAE,YAAY,mBAAmB,WAAW,QAAQ,QAAQ,YAAY,CAAC;AACzF"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
//#region src/view/conversionRate.ts
|
|
2
|
+
/**
|
|
3
|
+
* Share of the site's visitors a goal converted, as a 0..1 ratio rounded to four decimals.
|
|
4
|
+
* Null when either side is missing, unreadable, or the site total is zero, where a rate is
|
|
5
|
+
* undefined rather than zero. The two numbers come from separate reads (a goal breakdown
|
|
6
|
+
* row and the range totals), so a bucket wider than the total is clamped instead of
|
|
7
|
+
* reported as more than 100 percent.
|
|
8
|
+
*/
|
|
9
|
+
const conversionRate = (goalVisitors, siteVisitors) => {
|
|
10
|
+
if (goalVisitors === void 0 || siteVisitors === void 0) return null;
|
|
11
|
+
if (!Number.isFinite(goalVisitors) || !Number.isFinite(siteVisitors) || siteVisitors === 0) return null;
|
|
12
|
+
const ratio = Math.min(Math.max(goalVisitors / siteVisitors, 0), 1);
|
|
13
|
+
return Math.round(ratio * 1e4) / 1e4;
|
|
14
|
+
};
|
|
15
|
+
//#endregion
|
|
16
|
+
export { conversionRate };
|
|
17
|
+
|
|
18
|
+
//# sourceMappingURL=conversionRate.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"conversionRate.js","names":[],"sources":["../../src/view/conversionRate.ts"],"sourcesContent":["/**\n * Share of the site's visitors a goal converted, as a 0..1 ratio rounded to four decimals.\n * Null when either side is missing, unreadable, or the site total is zero, where a rate is\n * undefined rather than zero. The two numbers come from separate reads (a goal breakdown\n * row and the range totals), so a bucket wider than the total is clamped instead of\n * reported as more than 100 percent.\n */\nexport const conversionRate = (\n\tgoalVisitors: number | undefined,\n\tsiteVisitors: number | undefined\n): number | null => {\n\tif (goalVisitors === undefined || siteVisitors === undefined) {\n\t\treturn null\n\t}\n\tif (!Number.isFinite(goalVisitors) || !Number.isFinite(siteVisitors) || siteVisitors === 0) {\n\t\treturn null\n\t}\n\tconst ratio = Math.min(Math.max(goalVisitors / siteVisitors, 0), 1)\n\treturn Math.round(ratio * 10_000) / 10_000\n}\n"],"mappings":";;;;;;;;AAOA,MAAa,kBACZ,cACA,iBACmB;CACnB,IAAI,iBAAiB,KAAA,KAAa,iBAAiB,KAAA,GAClD,OAAO;CAER,IAAI,CAAC,OAAO,SAAS,YAAY,KAAK,CAAC,OAAO,SAAS,YAAY,KAAK,iBAAiB,GACxF,OAAO;CAER,MAAM,QAAQ,KAAK,IAAI,KAAK,IAAI,eAAe,cAAc,CAAC,GAAG,CAAC;CAClE,OAAO,KAAK,MAAM,QAAQ,GAAM,IAAI;AACrC"}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { parseDayOrInstant } from "../query/dates.js";
|
|
2
|
+
import { formatRangeCaption } from "../widgets/range.js";
|
|
3
|
+
//#region src/view/dayRange.ts
|
|
4
|
+
const DAY_MS = 864e5;
|
|
5
|
+
/** Epoch ms of a `YYYY-MM-DD` day read as UTC, or null when it is not one. */
|
|
6
|
+
const dayValue = (day) => {
|
|
7
|
+
const ms = Date.parse(`${day}T00:00:00.000Z`);
|
|
8
|
+
return Number.isNaN(ms) ? null : ms;
|
|
9
|
+
};
|
|
10
|
+
const asDay = (ms) => new Date(ms).toISOString().slice(0, 10);
|
|
11
|
+
/** Calendar days a window covers, counting both ends; 1 for an unreadable or inverted one. */
|
|
12
|
+
const dayRangeDays = (range) => {
|
|
13
|
+
const from = dayValue(range.from);
|
|
14
|
+
const to = dayValue(range.to);
|
|
15
|
+
if (from === null || to === null || to < from) return 1;
|
|
16
|
+
return Math.round((to - from) / DAY_MS) + 1;
|
|
17
|
+
};
|
|
18
|
+
/**
|
|
19
|
+
* The nearest window the source and the endpoint can both serve, keeping the bound the
|
|
20
|
+
* admin just picked and moving the other one. A window longer than the source's lookback
|
|
21
|
+
* would answer for a shorter span than the picker shows, and one past the endpoint's own
|
|
22
|
+
* cap would not answer at all.
|
|
23
|
+
*/
|
|
24
|
+
const clampDayRange = (range, edited, maxDays) => {
|
|
25
|
+
const from = dayValue(range.from);
|
|
26
|
+
const to = dayValue(range.to);
|
|
27
|
+
if (from === null || to === null) return range;
|
|
28
|
+
const cap = Math.max(1, Math.min(maxDays ?? 366, 366));
|
|
29
|
+
if (to < from) return edited === "from" ? {
|
|
30
|
+
from: range.from,
|
|
31
|
+
to: range.from
|
|
32
|
+
} : {
|
|
33
|
+
from: range.to,
|
|
34
|
+
to: range.to
|
|
35
|
+
};
|
|
36
|
+
if (Math.round((to - from) / DAY_MS) + 1 <= cap) return range;
|
|
37
|
+
return edited === "from" ? {
|
|
38
|
+
from: range.from,
|
|
39
|
+
to: asDay(from + (cap - 1) * DAY_MS)
|
|
40
|
+
} : {
|
|
41
|
+
from: asDay(to - (cap - 1) * DAY_MS),
|
|
42
|
+
to: range.to
|
|
43
|
+
};
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Caption for a day window, rendered in the reporting timezone the days are read in. Falls
|
|
47
|
+
* back to the raw days when a bound names no calendar day, so a hand-edited URL captions
|
|
48
|
+
* what it asked for rather than rendering `Invalid Date`.
|
|
49
|
+
*/
|
|
50
|
+
const dayRangeCaption = (range, locale, timezone) => {
|
|
51
|
+
const start = parseDayOrInstant(range.from, {
|
|
52
|
+
timezone,
|
|
53
|
+
edge: "start"
|
|
54
|
+
});
|
|
55
|
+
const end = parseDayOrInstant(range.to, {
|
|
56
|
+
timezone,
|
|
57
|
+
edge: "end"
|
|
58
|
+
});
|
|
59
|
+
if (!start || !end) return `${range.from} - ${range.to}`;
|
|
60
|
+
return formatRangeCaption({
|
|
61
|
+
start,
|
|
62
|
+
end
|
|
63
|
+
}, locale, timezone);
|
|
64
|
+
};
|
|
65
|
+
//#endregion
|
|
66
|
+
export { clampDayRange, dayRangeCaption, dayRangeDays };
|
|
67
|
+
|
|
68
|
+
//# sourceMappingURL=dayRange.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"dayRange.js","names":[],"sources":["../../src/view/dayRange.ts"],"sourcesContent":["import { parseDayOrInstant } from '../query/dates'\nimport { MAX_QUERY_RANGE_DAYS } from '../query/limits'\nimport { formatRangeCaption } from '../widgets/range'\nimport type { DayRange } from './gating'\n\nconst DAY_MS = 86_400_000\n\n/** Epoch ms of a `YYYY-MM-DD` day read as UTC, or null when it is not one. */\nconst dayValue = (day: string): number | null => {\n\tconst ms = Date.parse(`${day}T00:00:00.000Z`)\n\treturn Number.isNaN(ms) ? null : ms\n}\n\nconst asDay = (ms: number): string => new Date(ms).toISOString().slice(0, 10)\n\n/** Calendar days a window covers, counting both ends; 1 for an unreadable or inverted one. */\nexport const dayRangeDays = (range: DayRange): number => {\n\tconst from = dayValue(range.from)\n\tconst to = dayValue(range.to)\n\tif (from === null || to === null || to < from) {\n\t\treturn 1\n\t}\n\treturn Math.round((to - from) / DAY_MS) + 1\n}\n\n/**\n * The nearest window the source and the endpoint can both serve, keeping the bound the\n * admin just picked and moving the other one. A window longer than the source's lookback\n * would answer for a shorter span than the picker shows, and one past the endpoint's own\n * cap would not answer at all.\n */\nexport const clampDayRange = (\n\trange: DayRange,\n\tedited: 'from' | 'to',\n\tmaxDays: number | null\n): DayRange => {\n\tconst from = dayValue(range.from)\n\tconst to = dayValue(range.to)\n\tif (from === null || to === null) {\n\t\treturn range\n\t}\n\tconst cap = Math.max(1, Math.min(maxDays ?? MAX_QUERY_RANGE_DAYS, MAX_QUERY_RANGE_DAYS))\n\tif (to < from) {\n\t\treturn edited === 'from'\n\t\t\t? { from: range.from, to: range.from }\n\t\t\t: { from: range.to, to: range.to }\n\t}\n\tif (Math.round((to - from) / DAY_MS) + 1 <= cap) {\n\t\treturn range\n\t}\n\treturn edited === 'from'\n\t\t? { from: range.from, to: asDay(from + (cap - 1) * DAY_MS) }\n\t\t: { from: asDay(to - (cap - 1) * DAY_MS), to: range.to }\n}\n\n/**\n * Caption for a day window, rendered in the reporting timezone the days are read in. Falls\n * back to the raw days when a bound names no calendar day, so a hand-edited URL captions\n * what it asked for rather than rendering `Invalid Date`.\n */\nexport const dayRangeCaption = (range: DayRange, locale: string, timezone: string): string => {\n\tconst start = parseDayOrInstant(range.from, { timezone, edge: 'start' })\n\tconst end = parseDayOrInstant(range.to, { timezone, edge: 'end' })\n\tif (!start || !end) {\n\t\treturn `${range.from} - ${range.to}`\n\t}\n\treturn formatRangeCaption({ start, end }, locale, timezone)\n}\n"],"mappings":";;;AAKA,MAAM,SAAS;;AAGf,MAAM,YAAY,QAA+B;CAChD,MAAM,KAAK,KAAK,MAAM,GAAG,IAAI,eAAe;CAC5C,OAAO,OAAO,MAAM,EAAE,IAAI,OAAO;AAClC;AAEA,MAAM,SAAS,OAAuB,IAAI,KAAK,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,EAAE;;AAG5E,MAAa,gBAAgB,UAA4B;CACxD,MAAM,OAAO,SAAS,MAAM,IAAI;CAChC,MAAM,KAAK,SAAS,MAAM,EAAE;CAC5B,IAAI,SAAS,QAAQ,OAAO,QAAQ,KAAK,MACxC,OAAO;CAER,OAAO,KAAK,OAAO,KAAK,QAAQ,MAAM,IAAI;AAC3C;;;;;;;AAQA,MAAa,iBACZ,OACA,QACA,YACc;CACd,MAAM,OAAO,SAAS,MAAM,IAAI;CAChC,MAAM,KAAK,SAAS,MAAM,EAAE;CAC5B,IAAI,SAAS,QAAQ,OAAO,MAC3B,OAAO;CAER,MAAM,MAAM,KAAK,IAAI,GAAG,KAAK,IAAI,WAAA,KAAA,GAAqD,CAAC;CACvF,IAAI,KAAK,MACR,OAAO,WAAW,SACf;EAAE,MAAM,MAAM;EAAM,IAAI,MAAM;CAAK,IACnC;EAAE,MAAM,MAAM;EAAI,IAAI,MAAM;CAAG;CAEnC,IAAI,KAAK,OAAO,KAAK,QAAQ,MAAM,IAAI,KAAK,KAC3C,OAAO;CAER,OAAO,WAAW,SACf;EAAE,MAAM,MAAM;EAAM,IAAI,MAAM,QAAQ,MAAM,KAAK,MAAM;CAAE,IACzD;EAAE,MAAM,MAAM,MAAM,MAAM,KAAK,MAAM;EAAG,IAAI,MAAM;CAAG;AACzD;;;;;;AAOA,MAAa,mBAAmB,OAAiB,QAAgB,aAA6B;CAC7F,MAAM,QAAQ,kBAAkB,MAAM,MAAM;EAAE;EAAU,MAAM;CAAQ,CAAC;CACvE,MAAM,MAAM,kBAAkB,MAAM,IAAI;EAAE;EAAU,MAAM;CAAM,CAAC;CACjE,IAAI,CAAC,SAAS,CAAC,KACd,OAAO,GAAG,MAAM,KAAK,KAAK,MAAM;CAEjC,OAAO,mBAAmB;EAAE;EAAO;CAAI,GAAG,QAAQ,QAAQ;AAC3D"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { };
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { FILTER_OPERATORS } from "../core/contract.js";
|
|
2
|
+
import { GRANULARITY_ORDER } from "../core/granularity.js";
|
|
3
|
+
import { dayRangeDays } from "./dayRange.js";
|
|
4
|
+
//#region src/view/gating.ts
|
|
5
|
+
/** Every metric the view can show, in the order the overview cards read. */
|
|
6
|
+
const VIEW_METRIC_ORDER = [
|
|
7
|
+
"pageviews",
|
|
8
|
+
"visitors",
|
|
9
|
+
"visits",
|
|
10
|
+
"sessions",
|
|
11
|
+
"avgDuration",
|
|
12
|
+
"bounceRate",
|
|
13
|
+
"scrollDepth",
|
|
14
|
+
"events",
|
|
15
|
+
"conversions",
|
|
16
|
+
"revenue"
|
|
17
|
+
];
|
|
18
|
+
const BREAKDOWN_TABS = [
|
|
19
|
+
"pages",
|
|
20
|
+
"sources",
|
|
21
|
+
"technology",
|
|
22
|
+
"geography",
|
|
23
|
+
"events",
|
|
24
|
+
"goals"
|
|
25
|
+
];
|
|
26
|
+
/**
|
|
27
|
+
* The dimensions each breakdown tab offers, most useful first. Every contract dimension
|
|
28
|
+
* belongs to exactly one tab, so a source that serves a new dimension gains a column
|
|
29
|
+
* rather than an unreachable capability.
|
|
30
|
+
*/
|
|
31
|
+
const TAB_DIMENSIONS = {
|
|
32
|
+
pages: ["page"],
|
|
33
|
+
sources: [
|
|
34
|
+
"referrer",
|
|
35
|
+
"source",
|
|
36
|
+
"medium",
|
|
37
|
+
"campaign",
|
|
38
|
+
"utmSource",
|
|
39
|
+
"utmMedium",
|
|
40
|
+
"utmCampaign",
|
|
41
|
+
"utmContent",
|
|
42
|
+
"utmTerm"
|
|
43
|
+
],
|
|
44
|
+
technology: [
|
|
45
|
+
"device",
|
|
46
|
+
"browser",
|
|
47
|
+
"os"
|
|
48
|
+
],
|
|
49
|
+
geography: [
|
|
50
|
+
"country",
|
|
51
|
+
"region",
|
|
52
|
+
"city",
|
|
53
|
+
"language"
|
|
54
|
+
],
|
|
55
|
+
events: ["event"],
|
|
56
|
+
goals: ["goal"]
|
|
57
|
+
};
|
|
58
|
+
const HOUR_INDEX = GRANULARITY_ORDER.indexOf("hour");
|
|
59
|
+
const gate = (caps) => {
|
|
60
|
+
const metricSet = new Set(caps.metrics);
|
|
61
|
+
const dimensionSet = new Set(caps.dimensions);
|
|
62
|
+
const filterSet = new Set(caps.filters);
|
|
63
|
+
const operatorSet = new Set(caps.filterOperators);
|
|
64
|
+
const served = Object.fromEntries(BREAKDOWN_TABS.map((tab) => [tab, TAB_DIMENSIONS[tab].filter((d) => dimensionSet.has(d))]));
|
|
65
|
+
const finest = Math.max(GRANULARITY_ORDER.indexOf(caps.minGranularity), HOUR_INDEX);
|
|
66
|
+
const granularities = GRANULARITY_ORDER.slice(finest);
|
|
67
|
+
return {
|
|
68
|
+
metrics: VIEW_METRIC_ORDER.filter((metric) => metricSet.has(metric)),
|
|
69
|
+
tabs: BREAKDOWN_TABS.filter((tab) => served[tab].length > 0),
|
|
70
|
+
dimensionsFor: (tab) => served[tab],
|
|
71
|
+
canFilter: (dimension) => filterSet.has(dimension),
|
|
72
|
+
operators: FILTER_OPERATORS.filter((operator) => operatorSet.has(operator)),
|
|
73
|
+
granularities,
|
|
74
|
+
maxRangeDays: caps.maxLookbackDays,
|
|
75
|
+
canCompare: caps.comparison,
|
|
76
|
+
canHour: granularities.includes("hour"),
|
|
77
|
+
realtime: caps.realtime,
|
|
78
|
+
goals: metricSet.has("conversions") && dimensionSet.has("goal")
|
|
79
|
+
};
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* The bucket a range reads best at: hours for a window of a day or two, weeks past four
|
|
83
|
+
* months, days between. Never finer than the source serves, so the endpoint's granularity
|
|
84
|
+
* check cannot reject what the view picked for itself.
|
|
85
|
+
*/
|
|
86
|
+
const autoGranularity = (range, caps) => {
|
|
87
|
+
const days = dayRangeDays(range);
|
|
88
|
+
const finest = GRANULARITY_ORDER.indexOf(caps.minGranularity);
|
|
89
|
+
const serves = (granularity) => GRANULARITY_ORDER.indexOf(granularity) >= finest;
|
|
90
|
+
const candidate = days <= 2 && serves("hour") ? "hour" : days > 120 && serves("week") ? "week" : "day";
|
|
91
|
+
return serves(candidate) ? candidate : caps.minGranularity;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* The source a view state reads from: the selected one, else the scope's default, else
|
|
95
|
+
* the first readable one. Null when the scope has no readable source at all.
|
|
96
|
+
*/
|
|
97
|
+
const resolveSource = (sources, sourceId) => {
|
|
98
|
+
const selected = sourceId ? sources.sources.find((source) => source.id === sourceId) : void 0;
|
|
99
|
+
const fallback = sources.sources.find((source) => source.id === sources.defaultId);
|
|
100
|
+
return selected ?? fallback ?? sources.sources[0] ?? null;
|
|
101
|
+
};
|
|
102
|
+
//#endregion
|
|
103
|
+
export { BREAKDOWN_TABS, TAB_DIMENSIONS, VIEW_METRIC_ORDER, autoGranularity, gate, resolveSource };
|
|
104
|
+
|
|
105
|
+
//# sourceMappingURL=gating.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"gating.js","names":[],"sources":["../../src/view/gating.ts"],"sourcesContent":["import type { SerializedCapabilities } from '../core/capabilities'\nimport {\n\ttype DimensionKey,\n\tFILTER_OPERATORS,\n\ttype FilterOperator,\n\ttype Granularity,\n\ttype MetricKey,\n} from '../core/contract'\nimport { GRANULARITY_ORDER } from '../core/granularity'\nimport type { SourcesResponse, WireSource } from '../fields/config/fetchSources'\nimport { dayRangeDays } from './dayRange'\n\n/** Every metric the view can show, in the order the overview cards read. */\nexport const VIEW_METRIC_ORDER: MetricKey[] = [\n\t'pageviews',\n\t'visitors',\n\t'visits',\n\t'sessions',\n\t'avgDuration',\n\t'bounceRate',\n\t'scrollDepth',\n\t'events',\n\t'conversions',\n\t'revenue',\n]\n\nexport type BreakdownTab = 'pages' | 'sources' | 'technology' | 'geography' | 'events' | 'goals'\n\nexport const BREAKDOWN_TABS: BreakdownTab[] = [\n\t'pages',\n\t'sources',\n\t'technology',\n\t'geography',\n\t'events',\n\t'goals',\n]\n\n/**\n * The dimensions each breakdown tab offers, most useful first. Every contract dimension\n * belongs to exactly one tab, so a source that serves a new dimension gains a column\n * rather than an unreachable capability.\n */\nexport const TAB_DIMENSIONS: Record<BreakdownTab, DimensionKey[]> = {\n\tpages: ['page'],\n\tsources: [\n\t\t'referrer',\n\t\t'source',\n\t\t'medium',\n\t\t'campaign',\n\t\t'utmSource',\n\t\t'utmMedium',\n\t\t'utmCampaign',\n\t\t'utmContent',\n\t\t'utmTerm',\n\t],\n\ttechnology: ['device', 'browser', 'os'],\n\tgeography: ['country', 'region', 'city', 'language'],\n\tevents: ['event'],\n\tgoals: ['goal'],\n}\n\n/** An inclusive window of reporting-timezone calendar days, as the endpoint takes them. */\nexport interface DayRange {\n\tfrom: string\n\tto: string\n}\n\n/**\n * What one source lets the view offer. Every control reads this instead of the raw\n * capabilities, so a provider that serves less gets a smaller but coherent view rather\n * than controls that fail at the endpoint.\n */\nexport interface ViewGate {\n\tmetrics: MetricKey[]\n\ttabs: BreakdownTab[]\n\tdimensionsFor: (tab: BreakdownTab) => DimensionKey[]\n\tcanFilter: (dimension: DimensionKey) => boolean\n\toperators: FilterOperator[]\n\t/** Buckets the view offers, coarsest-inclusive, in contract order. Never finer than an hour. */\n\tgranularities: Granularity[]\n\t/**\n\t * Days the source can look back, or null for no limit. The engine clamps a longer read\n\t * and marks it `meta.clamped`, so this only lets the toolbar hide a range that would\n\t * silently answer for a shorter window than its label promises.\n\t */\n\tmaxRangeDays: number | null\n\tcanCompare: boolean\n\tcanHour: boolean\n\trealtime: boolean\n\tgoals: boolean\n}\n\nconst HOUR_INDEX = GRANULARITY_ORDER.indexOf('hour')\n\nexport const gate = (caps: SerializedCapabilities): ViewGate => {\n\tconst metricSet = new Set<string>(caps.metrics)\n\tconst dimensionSet = new Set<string>(caps.dimensions)\n\tconst filterSet = new Set<string>(caps.filters)\n\tconst operatorSet = new Set<string>(caps.filterOperators)\n\tconst served = Object.fromEntries(\n\t\tBREAKDOWN_TABS.map((tab) => [tab, TAB_DIMENSIONS[tab].filter((d) => dimensionSet.has(d))])\n\t) as Record<BreakdownTab, DimensionKey[]>\n\t// Floored at the hour: a minute-granular source over a year is hundreds of thousands of\n\t// buckets, and the endpoint only checks that a granularity is no finer than the source's.\n\tconst finest = Math.max(GRANULARITY_ORDER.indexOf(caps.minGranularity), HOUR_INDEX)\n\tconst granularities = GRANULARITY_ORDER.slice(finest)\n\treturn {\n\t\tmetrics: VIEW_METRIC_ORDER.filter((metric) => metricSet.has(metric)),\n\t\ttabs: BREAKDOWN_TABS.filter((tab) => served[tab].length > 0),\n\t\tdimensionsFor: (tab) => served[tab],\n\t\tcanFilter: (dimension) => filterSet.has(dimension),\n\t\toperators: FILTER_OPERATORS.filter((operator) => operatorSet.has(operator)),\n\t\tgranularities,\n\t\tmaxRangeDays: caps.maxLookbackDays,\n\t\tcanCompare: caps.comparison,\n\t\tcanHour: granularities.includes('hour'),\n\t\trealtime: caps.realtime,\n\t\tgoals: metricSet.has('conversions') && dimensionSet.has('goal'),\n\t}\n}\n\n/**\n * The bucket a range reads best at: hours for a window of a day or two, weeks past four\n * months, days between. Never finer than the source serves, so the endpoint's granularity\n * check cannot reject what the view picked for itself.\n */\nexport const autoGranularity = (range: DayRange, caps: SerializedCapabilities): Granularity => {\n\tconst days = dayRangeDays(range)\n\tconst finest = GRANULARITY_ORDER.indexOf(caps.minGranularity)\n\tconst serves = (granularity: Granularity): boolean =>\n\t\tGRANULARITY_ORDER.indexOf(granularity) >= finest\n\tconst candidate: Granularity =\n\t\tdays <= 2 && serves('hour') ? 'hour' : days > 120 && serves('week') ? 'week' : 'day'\n\treturn serves(candidate) ? candidate : caps.minGranularity\n}\n\n/**\n * The source a view state reads from: the selected one, else the scope's default, else\n * the first readable one. Null when the scope has no readable source at all.\n */\nexport const resolveSource = (sources: SourcesResponse, sourceId?: string): WireSource | null => {\n\tconst selected = sourceId ? sources.sources.find((source) => source.id === sourceId) : undefined\n\tconst fallback = sources.sources.find((source) => source.id === sources.defaultId)\n\treturn selected ?? fallback ?? sources.sources[0] ?? null\n}\n"],"mappings":";;;;;AAaA,MAAa,oBAAiC;CAC7C;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;AAIA,MAAa,iBAAiC;CAC7C;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;AAOA,MAAa,iBAAuD;CACnE,OAAO,CAAC,MAAM;CACd,SAAS;EACR;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACD;CACA,YAAY;EAAC;EAAU;EAAW;CAAI;CACtC,WAAW;EAAC;EAAW;EAAU;EAAQ;CAAU;CACnD,QAAQ,CAAC,OAAO;CAChB,OAAO,CAAC,MAAM;AACf;AAiCA,MAAM,aAAa,kBAAkB,QAAQ,MAAM;AAEnD,MAAa,QAAQ,SAA2C;CAC/D,MAAM,YAAY,IAAI,IAAY,KAAK,OAAO;CAC9C,MAAM,eAAe,IAAI,IAAY,KAAK,UAAU;CACpD,MAAM,YAAY,IAAI,IAAY,KAAK,OAAO;CAC9C,MAAM,cAAc,IAAI,IAAY,KAAK,eAAe;CACxD,MAAM,SAAS,OAAO,YACrB,eAAe,KAAK,QAAQ,CAAC,KAAK,eAAe,KAAK,QAAQ,MAAM,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,CAC1F;CAGA,MAAM,SAAS,KAAK,IAAI,kBAAkB,QAAQ,KAAK,cAAc,GAAG,UAAU;CAClF,MAAM,gBAAgB,kBAAkB,MAAM,MAAM;CACpD,OAAO;EACN,SAAS,kBAAkB,QAAQ,WAAW,UAAU,IAAI,MAAM,CAAC;EACnE,MAAM,eAAe,QAAQ,QAAQ,OAAO,KAAK,SAAS,CAAC;EAC3D,gBAAgB,QAAQ,OAAO;EAC/B,YAAY,cAAc,UAAU,IAAI,SAAS;EACjD,WAAW,iBAAiB,QAAQ,aAAa,YAAY,IAAI,QAAQ,CAAC;EAC1E;EACA,cAAc,KAAK;EACnB,YAAY,KAAK;EACjB,SAAS,cAAc,SAAS,MAAM;EACtC,UAAU,KAAK;EACf,OAAO,UAAU,IAAI,aAAa,KAAK,aAAa,IAAI,MAAM;CAC/D;AACD;;;;;;AAOA,MAAa,mBAAmB,OAAiB,SAA8C;CAC9F,MAAM,OAAO,aAAa,KAAK;CAC/B,MAAM,SAAS,kBAAkB,QAAQ,KAAK,cAAc;CAC5D,MAAM,UAAU,gBACf,kBAAkB,QAAQ,WAAW,KAAK;CAC3C,MAAM,YACL,QAAQ,KAAK,OAAO,MAAM,IAAI,SAAS,OAAO,OAAO,OAAO,MAAM,IAAI,SAAS;CAChF,OAAO,OAAO,SAAS,IAAI,YAAY,KAAK;AAC7C;;;;;AAMA,MAAa,iBAAiB,SAA0B,aAAyC;CAChG,MAAM,WAAW,WAAW,QAAQ,QAAQ,MAAM,WAAW,OAAO,OAAO,QAAQ,IAAI,KAAA;CACvF,MAAM,WAAW,QAAQ,QAAQ,MAAM,WAAW,OAAO,OAAO,QAAQ,SAAS;CACjF,OAAO,YAAY,YAAY,QAAQ,QAAQ,MAAM;AACtD"}
|